Clean up sage-spkg

[jdemeyer]

This ticket aims to do a simply clean-up of sage-spkg and nothing more. The goal is to provide a solid base for future enhancements to sage-spkg, not fix all issues regarding sage-spkg.

Mostly, this patch reorganizes things. Some diagnostics are added, for example a warning when spkg-install or spkg-check isn't executable. Also, the line

TEST SUITE: not available

being printed to spkg/installed/$PKG_NAME when SAGE_CHECK=yes but there is no spkg-check file.

Follow-ups:

1. Mechanism to skip self-tests (spkg-check) for certain packages #12579: allow selective SAGE_CHECK
2. Rework download/extract code in sage-spkg #12602: rework downloading/extracting of .spkg files
3. Fix sage --info <package> #12606: Fix sage --info
4. Add option "-c" to sage-spkg to run the test-suite #12613: Add '-c' option so sage -i -c <pkg> installs the package and runs its test suite.

Depends on #4949
Depends on #10192

Component: build

Author: Jeroen Demeyer

Reviewer: John Palmieri

Merged: sage-5.0.beta7

Issue created by migration from https://trac.sagemath.org/ticket/12479

[jhpalmieri]

comment:1

See also #11021.

[jdemeyer]

comment:2

Thanks for the link. I think that ticket is now too bitrotted. We should consider the ideas from that ticket and apply them (better in separate tickets instead of one "fix everything" ticket).

[jdemeyer]

Description changed:

--- 
+++ 
@@ -1 +1 @@
-
+This ticket aims to do a simply clean-up of `sage-spkg` and nothing more.  The goal is to provide a solid base for future enhancements to `sage-spkg`, not fix all issues regarding `sage-spkg`.

[jdemeyer]

Dependencies: #4949

[jdemeyer]

Changed dependencies from #4949 to #4949, #10192

[jhpalmieri]

comment:5

What is the file SAGE.txt referred to in this script? Should it be SPKG.txt instead? For example:

        echo >&2 "No file SAGE.txt in $PKG_NAME"

By the way, #12579 also modifies sage-spkg; you might take a look at that ticket if you have time.

What do you think of replacing ./spkg-check with time ./spkg-check?

[jdemeyer]

comment:6

Replying to @jhpalmieri:

What is the file SAGE.txt referred to in this script? Should it be SPKG.txt instead?

Of course, but I don't want to mistake of #11021: fixing too many things on one ticket. On this ticket, I essentially just want to clean things up, with little or none functional difference.

What do you think of replacing ./spkg-check with time ./spkg-check?

[jdemeyer]

comment:7

Replying to @jhpalmieri:

What do you think of replacing ./spkg-check with time ./spkg-check?

Done.

[jdemeyer]

Description changed:

--- 
+++ 
@@ -1 +1,8 @@
 This ticket aims to do a simply clean-up of `sage-spkg` and nothing more.  The goal is to provide a solid base for future enhancements to `sage-spkg`, not fix all issues regarding `sage-spkg`.
+
+Mostly, this patch reorganizes things.  Some diagnostics are added, for example a warning when `spkg-install` or `spkg-check` isn't executable.  Also, the line
+
+```
+TEST SUITE: not available
+```
+being printed to `spkg/installed/$PKG_NAME` when `SAGE_CHECK=yes` but there is no `spkg-check` file.

[jdemeyer]

comment:9

John, could you please review this?