Restructure log location

Resolves #7 (closed)

mpsd-software-environment.py

@@ -12,6 +12,7 @@ import time
 from pathlib import Path
 from typing import List, Tuple, Union
 import re
+from string import Template
 
 # If 'rich' is available ("pip install rich" or "apt-get install python3-rich"),
 # then use coloured output, otherwise proceed as before
@@ -31,19 +32,80 @@ for given system architecture and MPSD software stack version.\n
 The toolchains
 are built using the bash script spack_setup.sh, and the results are logged. """
 
+call_date_iso = (
+    datetime.datetime.now().replace(microsecond=0).isoformat().replace(":", "-")
+)
 config_vars = {
-    "cmd_log_file": "install.log",
-    "build_log_file": (
-        "logs/mpsd_spack_ver_toolchains_"
-        f"{datetime.datetime.now().replace(microsecond=0).isoformat()}.log"
+    #  kept inside the mpsd_release folder
+    "cmd_log_file": "script_execution_summary.log",
+    #  Placeholder installer log file name, placed at mpsd_microarch/logs
+    "installer_log_template": Template(
+        "${mpsd_release}_${mpsd_microarch}_${date}_APEX_${action}.log"
+    ),
+    #  Placeholder build log file name, placed at mpsd_microarch/logs
+    "build_log_template": Template(
+        "${mpsd_release}_${mpsd_microarch}_${date}_BUILD_${toolchain}_${action}.log"
     ),
     "metadata_tag_open": "!<meta>",
     "metadata_tag_close": "</meta>!",
-    # TODO: modify toolchains,mpsd_spack_ver when the variable is available
     "spack_environments_repo": "https://gitlab.gwdg.de/mpsd-cs/spack-environments.git",
 }
 
 
+def create_log_file_names(
+    mpsd_release: str,
+    mpsd_microarch: str,
+    action: str,
+    date: str = call_date_iso,
+    toolchain: str = None,
+) -> Tuple[str, str]:
+    """Create log file names.
+
+    This function creates the log file names for the installer and
+    the build log files.
+    The installer log file is created
+    from the output of this script except
+    the toolchain build log that is handled by the spack_setup.sh script.
+    The build log `tee`'s the output of the spack_setup.sh script to the log file.
+    The log file names are created using the
+    template strings defined in config_vars.
+
+    Parameters
+    ----------
+    mpsd_release : str
+        MPSD software stack version
+    mpsd_microarch : str
+        system architecture
+    date : str
+        date of the call ins iso format
+    action : str
+        action performed (install,remove,reinstall,prepare,status)
+        only install and remove are valid for build log file.
+    toolchain : str
+        toolchain name (only for build log file)
+    returns : tuple
+        tuple containing installer_log_file, build_log_file, file names
+    """
+    installer_log_file = config_vars["installer_log_template"].substitute(
+        mpsd_release=mpsd_release,
+        mpsd_microarch=mpsd_microarch,
+        date=date,
+        action=action,
+    )
+    if toolchain and action in ["install", "remove"]:
+        build_log_file = config_vars["build_log_template"].substitute(
+            mpsd_release=mpsd_release,
+            mpsd_microarch=mpsd_microarch,
+            date=date,
+            action=action,
+            toolchain=toolchain,
+        )
+    else:
+        build_log_file = None
+        logging.warning("Incorrect action or toolchain name.")
+    return installer_log_file, build_log_file
+
+
 def log_metadata(key: str, value: str) -> None:
     """Log metadata to the log file.
 
@@ -91,7 +153,29 @@ def read_metadata_from_logfile(logfile: Union[str, Path]) -> dict:
     }
 
 
-def set_up_logging(loglevel="warning", filename=None):
+def get_installer_log_file_path(mpsd_release: str, cmd: str, script_dir: str) -> str:
+    """Get installer log file path."""
+    # Get machine configs
+    os.environ.get("MPSD_OS", "UNKNOWN_OS")
+    mpsd_microarch = get_native_microarchitecture()
+    # parse logging first
+    # decide the log_file_name
+    installer_log_name, build_log_name = create_log_file_names(
+        mpsd_release=mpsd_release, mpsd_microarch=mpsd_microarch, action=cmd
+    )
+    log_folder = script_dir / mpsd_release / "logs"
+    # if the log_folder dosent exist, dont log this message if
+    #  the command is a info-only command
+    if cmd not in ["status", "available"]:
+        if not os.path.exists(log_folder):
+            os.makedirs(log_folder)
+        installer_log_file = log_folder / installer_log_name
+    else:
+        installer_log_file = None
+    return installer_log_file
+
+
+def set_up_logging(loglevel="warning", file_path=None):
     """Set up logging.
 
     This function sets up the logging configuration for the script.
@@ -106,7 +190,7 @@ def set_up_logging(loglevel="warning", filename=None):
          - warning (default): only print statements if something is unexpected
          - info (show more detailed progress)
          - debug (show very detailed output)
-    filename : str
+    file_path : str
          - filename to save logging messages into
 
     If loglevel is 'debug', save line numbers in log messages.
@@ -188,11 +272,16 @@ def set_up_logging(loglevel="warning", filename=None):
     shell_handler.setFormatter(shell_formatter)
     # use the log_level_numeric to decide how much logging is sent to shell
     shell_handler.setLevel(log_level_numeric)
-    logger.addHandler(shell_handler)
+
+    # Here we set the handlers of the RootLogger to be just the one we want.
+    # The reason is that the logging module will add a <StreamHandler <stderr>
+    # (NOTSET)> handler if logging.info/logging.debug/... is used before we
+    # come across this line. And we do not want that additional handler.
+    logger.handlers = [shell_handler]
 
     # if filename provided, write log messages to that file, too.
-    if filename:
-        file_handler = logging.FileHandler(filename)
+    if file_path:
+        file_handler = logging.FileHandler(file_path)
         # if we have a file, we write all information in there.
         # We could change the level, for example restrict to only DEBUG and above with
         # file_handler.setLevel(logging.DEBUG)
@@ -216,9 +305,9 @@ def set_up_logging(loglevel="warning", filename=None):
     print_log.addHandler(ch)
 
     # if filename provided, write output of print_log to that file, too
-    if filename:
+    if file_path:
         # create, format and add file handler
-        fh = logging.FileHandler(filename)
+        fh = logging.FileHandler(file_path)
         fh.setFormatter(formatter)
         print_log.addHandler(fh)
 
@@ -226,8 +315,8 @@ def set_up_logging(loglevel="warning", filename=None):
     # short message
     #
     logging.debug(
-        f"Logging has been setup, loglevel={loglevel.upper()}"
-        + f"{filename=} {rich_available=}"
+        f"Logging has been setup, loglevel={loglevel.upper()} "
+        + f"{file_path=} {rich_available=}"
     )
 
 
@@ -658,8 +747,7 @@ def install_environment(
 
     # Set required variables
     release_base_dir = script_dir / mpsd_release
-    os.environ.get("MPSD_OS", "UNKNOWN_OS")
-    mpsd_microarch = os.environ.get("MPSD_MICROARCH", "UNKNOWN_MICROARCH")
+    mpsd_microarch = get_native_microarchitecture()
     toolchain_dir = release_base_dir / mpsd_microarch
     toolchain_dir.mkdir(parents=True, exist_ok=True)
     spack_setup_script = release_base_dir / "spack-environments" / "spack_setup.sh"
@@ -697,33 +785,35 @@ def install_environment(
         if not os.path.exists("logs"):
             os.mkdir("logs")
         for toolchain in toolchains:
-            # Set the install log file name to config_vars["install_log_file"]
-            # and replace _toolchains_ with the toolchain name and
-            # _mpsd_spack_ver_ with mpsd_release
+            # Set the install log file name from create_log_file_names
+            _, build_log_file_name = create_log_file_names(
+                mpsd_release, mpsd_microarch, "install", toolchain=toolchain
+            )
+            build_log_folder = release_base_dir / "logs"
+            build_log_path = build_log_folder / build_log_file_name
+            # if logs folder dosent exist, create it
+            if not os.path.exists(build_log_folder):
+                os.makedirs(build_log_folder)
 
             logging.info(f"Installing toolchain {toolchain} to {toolchain_dir}")
-            install_log_file = (
-                config_vars["build_log_file"]
-                .replace("mpsd_spack_ver_", f"{mpsd_release}_")
-                .replace("_toolchains_", f"_{toolchain}_")
-            )
+
             # log the command
             setup_log_cmd(
                 mpsd_release,
                 script_dir,
-                msg=f"installing {toolchain} and logging at {install_log_file}",
+                msg=f"installing {toolchain} and logging at {build_log_path}",
             )
             setup_log_cmd(
                 mpsd_release,
                 script_dir,
                 msg=(
-                    f"CMD: bash {spack_setup_script} {' '.join(install_flags)}"
-                    "{toolchain}"
+                    f"CMD: bash {spack_setup_script} {' '.join(install_flags)} "
+                    f"{toolchain}"
                 ),
             )
             run(
                 f"bash {spack_setup_script} {' '.join(install_flags)} {toolchain} 2>&1 "
-                f"| tee -a {install_log_file} ",
+                f"| tee -a {build_log_path} ",
                 shell=True,
                 check=True,
             )
@@ -824,13 +914,14 @@ def main():
     # Carry out the action
     args = parser.parse_args()
 
-    # parse logging first
-    set_up_logging(args.loglevel)
-
     # target dir is the place where this script exists. the
-    # release `dev` in script_dir/dev-23a
     script_dir = Path(os.path.dirname(os.path.realpath(__file__)))
 
+    set_up_logging(
+        args.loglevel,
+        get_installer_log_file_path(args.release, args.action, script_dir),
+    )
+
     # Check the command and run related function
     if args.action == "remove":
         remove_environment(args.release, args.toolchains, script_dir)