build/bin/sage-spkg, build/sage_bootstrap/uninstall.py: Prefix spkg-... script messages by '[spkg-...] ' instead of announcing 'Running spkg-... script'

Author: Matthias Koeppe

build/bin/sage-spkg

@@ -480,7 +480,7 @@ fi
 extract_the_package() { ##########################################
 
 cd "$SAGE_BUILD_DIR" || exit $?
-echo "Setting up build directory for $PKG_NAME"
+echo "Setting up build directory $SAGE_BUILD_DIR/$PKG_NAME"
 if [ -z "$PKG_NAME_UPSTREAM" ]; then
     # Not a normal or wheel package.
     # Transplant the 'src' symlink, copy scripts.
@@ -672,16 +672,15 @@ fi
 
 # First uninstall the previous version of this package, if any
 if [ "$KEEP_EXISTING" != "yes" ]; then
-    sage-spkg-uninstall "$PKG_BASE" "$SAGE_INST_LOCAL"
+    sage-spkg-uninstall "$PKG_BASE" "$SAGE_INST_LOCAL" --log-directory .
 fi
 
 # To work around #26996: Create lib and set a symlink so that writes into lib64/ end up in lib/
 (mkdir -p "$SAGE_DESTDIR_LOCAL/lib" && cd "$SAGE_DESTDIR_LOCAL" && ln -sf lib lib64)
 
 # Run the pre-install script, if any
 if [ -f spkg-preinst ]; then
-    echo "Running pre-install script for $PKG_NAME."
-    time $SAGE_SUDO ./spkg-preinst
+    sage-logger -p "$SAGE_SUDO ./spkg-preinst" spkg-preinst.log
     if [ $? -ne 0 ]; then
         error_msg "Error running the preinst script for $PKG_NAME."
         exit 1
@@ -690,19 +689,19 @@ fi
 
 if [ -f spkg-build ]; then
     # Package has both spkg-build and spkg-install; execute the latter with SAGE_SUDO
-    time ./spkg-build
+    sage-logger -p "./spkg-build" spkg-build.log
     if [ $? -ne 0 ]; then
         error_msg "Error building package $PKG_NAME" "make"
         exit 1
     fi
-    time $SAGE_SUDO ./spkg-install
+    sage-logger -p "$SAGE_SUDO ./spkg-install" spkg-install.log
     if [ $? -ne 0 ]; then
         error_msg "Error installing package $PKG_NAME" "make"
         exit 1
     fi
 else
     # Package only has spkg-install
-    time ./spkg-install
+    sage-logger -p "./spkg-install" spkg-install.log
     if [ $? -ne 0 ]; then
         error_msg "Error installing package $PKG_NAME" "make"
         exit 1
@@ -788,16 +787,14 @@ post_install() { #################################################
 # Run the post-install script, if any
 # But first complete the delayed installation of wheels.
 if [ -f spkg-pipinst ]; then
-    echo "Running pip-install script for $PKG_NAME."
-    $SAGE_SUDO ./spkg-pipinst
+    sage-logger -p "$SAGE_SUDO ./spkg-pipinst" spkg-pipinst.log
     if [ $? -ne 0 ]; then
         error_msg "Error running the pipinst script for $PKG_NAME."
         exit 1
     fi
 fi
 if [ -f spkg-postinst ]; then
-    echo "Running post-install script for $PKG_NAME."
-    time $SAGE_SUDO ./spkg-postinst
+    sage-logger -p "$SAGE_SUDO ./spkg-postinst" spkg-postinst.log
     if [ $? -ne 0 ]; then
         error_msg "Error running the postinst script for $PKG_NAME."
         exit 1
@@ -817,7 +814,7 @@ run_test_suite() { ###############################################
     if [ -f "$INSTALLED_SCRIPTS_DEST"/spkg-check ]; then
         echo "Running the test suite for $PKG_NAME..."
         export PKG_BASE
-        time "$INSTALLED_SCRIPTS_DEST"/spkg-check
+        sage-logger -p "$INSTALLED_SCRIPTS_DEST"/spkg-check spkg-check.log
         if [ $? -ne 0 ]; then
             TEST_SUITE_RESULT="failed"
             if [ "$SAGE_CHECK" = "warn" ]; then
@@ -873,8 +870,7 @@ __EOF__
 } ###################################### write_installation_record
 
 delete_the_temporary_build_directory() { #########################
-    echo "Deleting temporary build directory"
-    echo "$SAGE_BUILD_DIR/$PKG_NAME"
+    echo "Deleting temporary build directory $SAGE_BUILD_DIR/$PKG_NAME"
     # On Solaris, the current working directory cannot be deleted,
     # so we "cd" out of $SAGE_BUILD_DIR/$PKG_NAME. See #12637.
     cd "$SAGE_BUILD_DIR"
@@ -885,8 +881,7 @@ delete_the_temporary_build_directory_if_required() { #############
 if [ ! -e "$SAGE_BUILD_DIR/$PKG_NAME/.keep" ]; then
     delete_the_temporary_build_directory
 else
-    echo "You can safely delete the temporary build directory"
-    echo "$SAGE_BUILD_DIR/$PKG_NAME"
+    echo "You can safely delete the temporary build directory $SAGE_BUILD_DIR/$PKG_NAME"
 fi
 } ############### delete_the_temporary_build_directory_if_required
 

build/sage_bootstrap/uninstall.py

@@ -49,7 +49,8 @@
 """Directory where all spkg sources are found."""
 
 
-def uninstall(spkg_name, sage_local, keep_files=False, verbose=False):
+def uninstall(spkg_name, sage_local, keep_files=False,
+              verbose=False, log_directory=None):
     """
     Given a package name and path to an installation tree (SAGE_LOCAL or SAGE_VENV),
     uninstall that package from that tree if it is currently installed.
@@ -85,51 +86,44 @@ def uninstall(spkg_name, sage_local, keep_files=False, verbose=False):
 
     if 'files' not in spkg_meta:
         if stamp_file:
-            print("Old-style or corrupt stamp file '{0}'"
+            print("Old-style or corrupt stamp file {0}"
                   .format(stamp_file), file=sys.stderr)
         else:
             print("Package '{0}' is currently not installed"
                   .format(spkg_name), file=sys.stderr)
 
         # Run legacy uninstaller even if there is no stamp file: the
         # package may be partially installed without a stamp file
-        legacy_uninstall(spkg_name, verbose=verbose)
+        legacy_uninstall(spkg_name,
+                         verbose=verbose, log_directory=log_directory)
     else:
         files = spkg_meta['files']
         if not files:
             print("Warning: No files to uninstall for "
                   "'{0}'".format(spkg_name), file=sys.stderr)
 
-        modern_uninstall(spkg_name, sage_local, files, verbose=verbose)
+        modern_uninstall(spkg_name, sage_local, files,
+                         verbose=verbose, log_directory=log_directory)
 
     remove_stamp_files(stamp_files, verbose=verbose)
 
 
-def legacy_uninstall(spkg_name, verbose=False):
+def legacy_uninstall(spkg_name,
+                     verbose=False, log_directory=None):
     """
     Run the spkg's legacy uninstall script, if one exists; otherwise do
     nothing.
     """
-
     spkg_dir = pth.join(PKGS, spkg_name)
-    legacy_uninstall = pth.join(spkg_dir, 'spkg-legacy-uninstall')
-
-    if not pth.isfile(legacy_uninstall):
-        print("No legacy uninstaller found for '{0}'; nothing to "
-              "do".format(spkg_name), file=sys.stderr)
-        return
-
-    print("Uninstalling '{0}' with legacy uninstaller".format(spkg_name))
-    if verbose:
-        with open(legacy_uninstall) as f:
-            print(f.read())
 
     # Any errors from this, including a non-zero return code will
     # bubble up and exit the uninstaller
-    subprocess.check_call([legacy_uninstall])
+    run_spkg_script(spkg_name, spkg_dir, 'legacy-uninstall',
+                    if_does_not_exist='log', log_directory=log_directory)
 
 
-def modern_uninstall(spkg_name, sage_local, files, verbose=False):
+def modern_uninstall(spkg_name, sage_local, files,
+                     verbose=False, log_directory=None):
     """
     Remove all listed files from the given installation tree (SAGE_LOCAL or SAGE_VENV).
 
@@ -150,15 +144,17 @@ def modern_uninstall(spkg_name, sage_local, files, verbose=False):
     # so that we can easily remove a directory once it's been emptied
     files.sort(key=lambda f: (-f.count(os.sep), f))
 
-    print("Uninstalling existing '{0}'".format(spkg_name))
+    if verbose:
+        print("Uninstalling existing '{0}'".format(spkg_name))
 
     # Run the package's prerm script, if it exists.
     # If an error occurs here we abort the uninstallation for now.
     # This means a prerm script actually has the ability to abort an
     # uninstallation, for example, if some manual intervention is needed
     # to proceed.
     try:
-        run_spkg_script(spkg_name, spkg_scripts, 'prerm', 'pre-uninstall')
+        run_spkg_script(spkg_name, spkg_scripts, 'prerm',
+                        log_directory=log_directory)
     except Exception as exc:
         script_path = pth.join(spkg_scripts, 'spkg-prerm')
         print("Error: The pre-uninstall script for '{0}' failed; the "
@@ -177,7 +173,7 @@ def modern_uninstall(spkg_name, sage_local, files, verbose=False):
     # manifest, so this step has to happen before removing the files.
     try:
         run_spkg_script(spkg_name, spkg_scripts, 'piprm',
-                        'pip-uninstall')
+                        log_directory=log_directory)
     except Exception:
         print("Warning: Error running the pip-uninstall script for "
               "'{0}'; uninstallation may have left behind some files".format(
@@ -190,7 +186,7 @@ def rmdir(dirname):
                     print('rmdir "{}"'.format(dirname))
                 os.rmdir(dirname)
         else:
-            print("Warning: Directory '{0}' not found".format(
+            print("Warning: Directory {0} not found".format(
                 dirname), file=sys.stderr)
 
     # Remove the files; if a directory is empty after removing a file
@@ -205,7 +201,7 @@ def rmdir(dirname):
                 print('rm "{}"'.format(filename))
             os.remove(filename)
         else:
-            print("Warning: File '{0}' not found".format(filename),
+            print("Warning: File {0} not found".format(filename),
                   file=sys.stderr)
 
         # Remove file's directory if it is now empty
@@ -218,7 +214,7 @@ def rmdir(dirname):
     # files removed.
     try:
         run_spkg_script(spkg_name, spkg_scripts, 'postrm',
-                        'post-uninstall')
+                        log_directory=log_directory)
     except Exception:
         print("Warning: Error running the post-uninstall script for "
               "'{0}'; the package will still be uninstalled, but "
@@ -234,20 +230,30 @@ def rmdir(dirname):
 def remove_stamp_files(stamp_files, verbose=False):
     # Finally, if all went well, delete all the stamp files.
     for stamp_file in stamp_files:
-        print("Removing stamp file '{0}'".format(stamp_file))
+        print("Removing stamp file {0}".format(stamp_file))
         os.remove(stamp_file)
 
 
-def run_spkg_script(spkg_name, path, script_name, script_descr):
+def run_spkg_script(spkg_name, path, script_name,
+                    if_does_not_exist='ignore', log_directory=None):
     """
     Runs the specified ``spkg-<foo>`` script under the given ``path``,
     if it exists.
     """
-
-    script = pth.join(path, 'spkg-{0}'.format(script_name))
+    script_name = 'spkg-{0}'.format(script_name)
+    script = pth.join(path, script_name)
     if pth.exists(script):
-        print("Running {0} script for '{1}'".format(script_descr, spkg_name))
-        subprocess.check_call([script])
+        if log_directory:
+            log_file = pth.join(log_directory, script + '.log')
+            subprocess.check_call(['sage-logger', '-p', script, log_file])
+        else:
+            subprocess.check_call([script])
+    elif if_does_not_exist == 'ignore':
+        pass
+    elif if_does_not_exist == 'log':
+        print('No {0} script; nothing to do'.format(script_name), file=sys.stderr)
+    else:
+        raise ValueError('unknown if_does_not_exist value: {0}'.format(if_does_not_exist))
 
 
 def dir_type(path):
@@ -257,7 +263,7 @@ def dir_type(path):
 
     if path and not pth.isdir(path):
         raise argparse.ArgumentTypeError(
-            "'{0}' is not a directory".format(path))
+            "{0} is not a directory".format(path))
 
     return path
 
@@ -284,6 +290,8 @@ def make_parser():
                              "but do not remove files installed by the "
                              "package")
     parser.add_argument('--debug', action='store_true', help=argparse.SUPPRESS)
+    parser.add_argument('--log-directory', type=str,
+                        help="directory where to create log files (default: none)")
 
     return parser
 
@@ -301,7 +309,7 @@ def run(argv=None):
 
     try:
         uninstall(args.spkg, args.sage_local, keep_files=args.keep_files,
-                  verbose=args.verbose)
+                  verbose=args.verbose, log_directory=args.log_directory)
     except Exception as exc:
         print("Error during uninstallation of '{0}': {1}".format(
             args.spkg, exc), file=sys.stderr)