Ticket #10494: 10494.patch

sdist

@@ -1 @@
-#!/bin/bash
-set -e
+#!/usr/bin/env bash
 
+# Just curious: *Which* 'sage' is supposed to be called here?
+# Should we check if SAGE_LOCAL or SAGE_ROOT is defined?
+# ... and perhaps call $SAGE_ROOT/sage or $SAGE_LOCAL/bin/...? -leif
+
+# At least check that 'sage' is in the path to specifically catch
+# one potential error [earlier, with an appropriate error message]:
+if ! command -v sage >/dev/null; then
+    echo >&2 "Error: $0 requires 'sage' to be in your PATH"
+    echo >&2 "Maybe first call 'SAGE_ROOT/sage -sh'"
+    exit 1
+fi
+
+echo "Trying to commit changes (if any)..."
 sage -hg ci
+status=$?
+if [ $status -eq 1 ]; then
+    # 'hg ci' returns 1 (!) if there are no changes to commit...
+    echo "No changes to commit (not an error)"
+elif [ $status -ne 0 ]; then
+    echo >&2 "Error: $0: Couldn't commit changes" \
+             "('hg ci' failed with exit code $status)"
+    exit 1
+else
+    # $status == 0
+    echo "Successfully committed the changes"
+fi
 
+echo "Running 'python setup.py sdist'..."
 sage -python setup.py sdist
+if [ $? -ne 0 ]; then
+    echo >&2 "Error: $0: 'python setup.py sdist' failed"
+    exit 1
+fi
+
 
 echo "**********************************************************"
 echo "* If this is an official SageNB release, don't forget to *"

setup.py

@@ -5 +5 @@
 import os, sys, time
 from setuptools import setup
 
+
+import distutils.log
+
+if os.environ.get("SAGE_SETUPTOOLS_DEBUG","no")=="yes":
+    distutils.log.set_threshold(distutils.log.DEBUG)
+
+
 def all_files(dir, lstrip):
     """
     Return list of all filenames in the given directory, with lstrip

spkg-dist

@@ -1 +1 @@
 #!/usr/bin/env python
 # Create a new Sage Notebook spkg.
 
+# Since the 'sdist' shell script called below requires (at least) 'sage'
+# to be in the path, we could equally check *here* if it is; SAGE_ROOT
+# or SAGE_LOCAL don't have to be set, since 'sdist' calls 'sage -hg ...'
+# and 'sage -python ...'.
+# (We also later run 'sage -pkg ...' from *this* script.)
+#
+# We *might* get import errors earlier if some system-wide Python executes
+# this script (which is probably not intended), so we could really check
+# here first if SAGE_LOCAL is defined, which is a strong indication that
+# we're actually using Sage's Python. -leif
+
 import os
 import sys
 import stat
@@ -13 +24 @@
 from setuptools.package_index import PackageIndex
 
 # Get the version from setup.py.
-version_line = [f for f in open('setup.py').readlines() if 'version' in f][0]
+try:
+    version_line = [f for f in open('setup.py').readlines() if 'version' in f][0]
+except IndexError:
+    sys.stderr.write("Error: Found no version string in 'setup.py'\n")
+    sys.exit(1)
 i = version_line.find("'")
 j = version_line.rfind("'")
+if i==-1 or j==-1 or j-i<3:
+    sys.stderr.write(
+      "Error: Illegal version string in 'setup.py':\n    %s\n" % version_line)
+    sys.stderr.write("Perhaps no single quotes used?\n")
+    sys.exit(1)
 version = version_line[i + 1:j]
+print "New SageNB version: %s" % version
 
 # Create the source distribution.
+print "Creating the new source tarball..."
+sys.stdout.flush()
 proc = subprocess.Popen([os.path.join(os.path.curdir, 'sdist')], shell=True)
 if proc.wait():
-    print "Uncommitted changes in repository.  Stopping."
+    # The previous error message was most probably inadequate, since
+    # 'sdist' tries to commit any changes, and 'hg ci' returns 1 (!) (which
+    # usually indicates an error) if there are *no changes to commit*.
+    # The other potential error in 'sdist' was that 'python setup.py sdist'
+    # failed, in which case the error message would have also been wrong.
+    #print "Uncommitted changes in repository.  Stopping."
+    sys.stderr.write(
+      "Error: './sdist' failed. See message(s) above for the specific error.\n")
     sys.exit(1)
 
 # Create the spkg.
@@ -31 +61 @@
     shutil.rmtree(path)
 os.makedirs(path)
 
-file = 'sagenb-%s.tar.gz' % version
-print "Extracting %s" % file
+file = 'sagenb-%s.tar.gz' % version # created by 'sdist' above
+print "Extracting %s..." % file
+sys.stdout.flush()
 t = tarfile.open(os.path.join('dist', file))
 t.extractall(path)
+print "Finished extraction."
+sys.stdout.flush()
 
-os.chdir(path)
+os.chdir(path) # cd dist/sagenb-x.y.z
 os.mkdir('src')
-shutil.move(base, os.path.join('src', 'sagenb'))
+print "Moving new source tree..."
+sys.stdout.flush()
+shutil.move(base, os.path.join('src', 'sagenb')) # mv sagenb-x.y.z src/sagenb
 
+print "Copying 'SPKG.txt'..."
+sys.stdout.flush()
+shutil.copy(os.path.join(os.path.pardir, os.path.pardir, 'SPKG.txt'),
+            os.path.curdir) # cp ../../SPKG.txt . (which is dist/sagenb-x.y.z)
+
+print "Creating 'spkg-install'..."
+sys.stdout.flush()
 spkg_install = os.path.abspath(os.path.join(os.path.curdir, 'spkg-install'))
 spkg_install_fd = open(spkg_install, 'w')
-spkg_install_fd.write("cd src\n")
-
-shutil.copy(os.path.join(os.path.pardir, os.path.pardir, 'SPKG.txt'),
-            os.path.curdir)
-
 
 
 def fetch_packages():
     # This block is here in case we ever need it again.
+    # XXX Then also make sure the easy_install commands
+    # XXX get written to the correct part of spkg-install!
+    # XXX (We currently use a single string for the whole file.)
     print "Fetching the required packages"
     pkg_index = PackageIndex()
 
     tmp_dir = mkdtemp()
 
-
     required_packages = ()
 
     pkg_locations = []
@@ -73 +112 @@
 
     return [os.path.basename(location) for location in pkg_locations]
 
-os.chdir(os.path.pardir)
 
-spkg_install_fd.write("""
+os.chdir(os.path.pardir) # cd .. (now in dist/)
+
+# Write the whole file from a single raw Python string:
+# (The #! has to be on the first line of the script.)
+spkg_install_fd.write(
+r"""#!/usr/bin/env bash
+
+# spkg-install for SageNB, generated by SageNB's spkg-dist
+
+if [ -z "$SAGE_LOCAL" ]; then
+    echo >&2 "SAGE_LOCAL undefined - exiting..."
+    exit 1
+fi
+
+cd src
+
 cd sagenb
 python setup.py install
-
-mkdir -p "$SAGE_ROOT/devel"
-
-echo "Copying SageNB package to '$SAGE_ROOT/devel/sagenb-main'."
-if [ -d "$SAGE_ROOT/devel/sagenb-main" ]; then
-  echo "Copying old SageNB package to '$SAGE_ROOT/devel/sagenb-main-old'."
-  rm -rf "$SAGE_ROOT/devel/sagenb-main-old"
-  cp -pr "$SAGE_ROOT/devel/sagenb-main" "$SAGE_ROOT/devel/sagenb-main-old"
+if [ $? -ne 0 ]; then
+    echo >&2 "Error running 'setup.py install'."
+    exit 1
 fi
 
-rm -f "$SAGE_ROOT/devel/sagenb"
+mkdir -p "$SAGE_ROOT/devel" # Create if it doesn't already exist
+if [ $? -ne 0 ]; then
+    echo >&2 "Error creating '$SAGE_ROOT/devel'."
+    exit 1
+fi
 
-cd ..
-cp -pr sagenb "$SAGE_ROOT/devel/sagenb-main"
+echo "Copying SageNB package to '$SAGE_ROOT/devel/sagenb-main'..."
+
+if [ -d "$SAGE_ROOT/devel/sagenb-main" ]; then
+    echo "Moving old SageNB package to '$SAGE_ROOT/devel/sagenb-main-old'..."
+    rm -rf "$SAGE_ROOT/devel/sagenb-main-old"
+    mv "$SAGE_ROOT/devel/sagenb-main" "$SAGE_ROOT/devel/sagenb-main-old"
+    if [ $? -ne 0 ]; then
+        echo >&2 "Error moving the old 'sagenb-main' branch."
+        exit 1
+    fi
+fi
+
+rm -f "$SAGE_ROOT/devel/sagenb" # Delete just the link itself (if it exists)
+
+cd .. # Back to sagenb-x.y.z/src/
+cp -pr sagenb "$SAGE_ROOT/devel/sagenb-main" # Creates new sagenb-main dir
+if [ $? -ne 0 ]; then
+    echo >&2 "Error copying the new SageNB package."
+    exit 1
+fi
 
 cd "$SAGE_ROOT/devel"
-ln -snf sagenb-main sagenb
+ln -s sagenb-main sagenb # Create new symbolic link (deleted above)
+if [ $? -ne 0 ]; then
+    echo >&2 "Error creating symbolic link to '$SAGE_ROOT/devel/sagenb-main'."
+    exit 1
+fi
 
 # We use relative paths for relocatability.
 cd "$SAGE_ROOT/devel/sagenb"
 python setup.py develop --egg-path ../../../../devel/sagenb
+if [ $? -ne 0 ]; then
+    echo >&2 "Error running 'setup.py develop'."
+    exit 1
+fi
 
 cd "$SAGE_ROOT/local/lib/python/site-packages"
-sed 's/^.*sagenb.*$/..\/..\/..\/..\/devel\/sagenb/' easy-install.pth > easy-install.pth.new
-mv -f easy-install.pth.new easy-install.pth
+# Dave says Solaris' non-POSIX grep in the default path
+# doesn't understand "-q" (which *is* POSIX):
+if ! grep sagenb easy-install.pth >/dev/null; then
+    # Ugly work-around, we haven't found the real cause yet (see #10176):
+    echo "No sagenb path found in 'easy-install.pth'"'!'
+    echo "Adding relative sagenb path to 'easy-install.pth'..."
+    sed -e '$ i \../../../../devel/sagenb' easy-install.pth > easy-install.pth.$$
+    if [ $? -ne 0 ]; then
+        echo >&2 "Error adding relative sagenb path to 'easy-install.pth'."
+        exit 1
+    fi
+else
+    echo "Making sagenb path in 'easy-install.pth' relative..."
+    sed 's/^.*sagenb.*$/..\/..\/..\/..\/devel\/sagenb/' easy-install.pth > easy-install.pth.$$
+    if [ $? -ne 0 ]; then
+        echo >&2 "Error patching 'easy-install.pth' to have relative path to SageNB."
+        exit 1
+    fi
+fi
+if true; then # Aids debugging (cf. #10176)
+    echo "Old path: \"`grep sagenb easy-install.pth`\""
+    echo "New path: \"`grep sagenb easy-install.pth.$$`\""
+fi
+# The following fails only on wrong file permissions etc.:
+mv -f easy-install.pth.$$ easy-install.pth
+if [ $? -ne 0 ]; then
+    echo >&2 "Error overwriting original 'easy-install.pth'."
+    exit 1
+fi
 """)
 spkg_install_fd.close()
 os.chmod(spkg_install, stat.S_IRWXU | stat.S_IRGRP | stat.S_IXGRP |
-         stat.S_IROTH | stat.S_IXOTH)
+         stat.S_IROTH | stat.S_IXOTH) # -rwxr-xr-x
 
+# We are still in dist/, now package sagenb-x.y.z/ :
+print "Running 'sage -pkg %s'..."%base
+sys.stdout.flush()
 subprocess.call(['sage -pkg ' + base], shell=True)
+# XXX Perhaps also check exit code here... (but 'sage -pkg' is verbose)
+