Print some more details on first initialisation

Author: ocaisa

.github/workflows/scripts/test_init_scripts.sh

@@ -42,8 +42,8 @@ for shell in ${SHELLS[@]}; do
     fi
 
     # TEST 1: Source Script and check Module Output
-    expected="Module for EESSI/$EESSI_VERSION loaded successfully"
-    assert "$shell -c 'source init/lmod/$shell' 2>&1 " "${expected}"
+    expected_pattern=".*EESSI has selected $EESSI_SOFTWARE_SUBDIR_OVERRIDE as the compatible CPU target for EESSI/$EESSI_VERSION.*"
+    assert_raises "$shell -c 'source init/lmod/$shell' 2>&1 | grep -E \"${expected_pattern}\""
 
     # TEST 2: Check if module overviews first section is the loaded EESSI module
     if [ "$shell" = "csh" ]; then
@@ -53,11 +53,11 @@ for shell in ${SHELLS[@]}; do
       echo "source init/lmod/$shell" > ~/.cshrc
       MODULE_SECTIONS=($($shell -c "module ov" 2>&1 | grep -e '---'))
     else
-      MODULE_SECTIONS=($($shell -c "source init/lmod/$shell 2>/dev/null; module ov 2>&1 | grep -e '---'"))
+      MODULE_SECTIONS=($($shell -c "source init/lmod/$shell >/dev/null 2>&1; module ov 2>&1 | grep -e '---'"))
     fi
     PATTERN="/cvmfs/software\.eessi\.io/versions/$EESSI_VERSION/software/linux/$EESSI_SOFTWARE_SUBDIR_OVERRIDE/modules/all"
     assert_raises 'echo "${MODULE_SECTIONS[1]}" | grep -E "$PATTERN"'
-    echo "${MODULE_SECTIONS[1]}" "$PATTERN"
+    # echo "${MODULE_SECTIONS[1]}" "$PATTERN"
 
     # TEST 3: Check if module overviews second section is the EESSI init module
     assert "echo ${MODULE_SECTIONS[4]}" "/cvmfs/software.eessi.io/init/modules"
@@ -66,9 +66,9 @@ for shell in ${SHELLS[@]}; do
     # eb --version outputs: "This is EasyBuild 5.1.1 (framework: 5.1.1, easyblocks: 5.1.1) on host ..."
     if [ "$shell" = "csh" ]; then
       echo "source init/lmod/$shell" > ~/.cshrc
-      command="$shell -c 'module load EasyBuild/${EXPECTED_EASYBUILD_VERSION}; eb --version' | cut -d \" \" -f4"
+      command="$shell -c 'module load EasyBuild/${EXPECTED_EASYBUILD_VERSION}; eb --version' | tail -n 1 | awk '{print \$4}'"
     else
-      command="$shell -c 'source init/lmod/$shell 2>/dev/null; module load EasyBuild/${EXPECTED_EASYBUILD_VERSION}; eb --version | cut -d \" \" -f4'"
+      command="$shell -c 'source init/lmod/$shell >/dev/null 2>&1; module load EasyBuild/${EXPECTED_EASYBUILD_VERSION}; eb --version' | tail -n 1 | awk '{print \$4}'"
     fi
     assert "$command" "$EXPECTED_EASYBUILD_VERSION"
 
@@ -81,9 +81,9 @@ for shell in ${SHELLS[@]}; do
     fi
     # escape the dots in ${EASYBUILD_VERSION}
     PATTERN="/cvmfs/software\.eessi\.io/versions/$EESSI_VERSION/software/linux/$EESSI_SOFTWARE_SUBDIR_OVERRIDE/software/EasyBuild/${EXPECTED_EASYBUILD_VERSION//./\\.}/bin/eb"
-    echo "$EASYBUILD_PATH" | grep -E "$PATTERN"
+    # echo "$EASYBUILD_PATH" | grep -E "$PATTERN"
     assert_raises 'echo "$EASYBUILD_PATH" | grep -E "$PATTERN"'
-    echo "$EASYBUILD_PATH" "$PATTERN"
+    # echo "$EASYBUILD_PATH" "$PATTERN"
 
     # TEST 6 and 7: Check the various options (EESSI_DEFAULT_MODULES_APPEND, EESSI_DEFAULT_MODULES_APPEND, EESSI_EXTRA_MODULEPATH) all work
     if [ "$shell" = "csh" ]; then
@@ -101,14 +101,14 @@ for shell in ${SHELLS[@]}; do
       TEST_MODULEPATH=$($shell -c 'export EESSI_DEFAULT_MODULES_APPEND=append_module ; export EESSI_DEFAULT_MODULES_PREPEND=prepend_module ; export EESSI_EXTRA_MODULEPATH=.github/workflows/modules ; source init/lmod/'"$shell"' 2>/dev/null; echo $MODULEPATH')
     fi
     LMOD_SYSTEM_DEFAULT_MODULES_PATTERN='^prepend_module:.*:append_module$'
-    echo "$TEST_LMOD_SYSTEM_DEFAULT_MODULES" AND "$LMOD_SYSTEM_DEFAULT_MODULES_PATTERN"
+    # echo "$TEST_LMOD_SYSTEM_DEFAULT_MODULES" AND "$LMOD_SYSTEM_DEFAULT_MODULES_PATTERN"
     assert_raises 'echo "$TEST_LMOD_SYSTEM_DEFAULT_MODULES" | grep -E "$LMOD_SYSTEM_DEFAULT_MODULES_PATTERN"'
     if [ "$shell" = "fish" ]; then
       MODULEPATH_PATTERN='\.github/workflows/modules$'
     else
       MODULEPATH_PATTERN=':\.github/workflows/modules$'
     fi
-    echo "$TEST_MODULEPATH" AND "$MODULEPATH_PATTERN"
+    # echo "$TEST_MODULEPATH" AND "$MODULEPATH_PATTERN"
     assert_raises 'echo "$TEST_MODULEPATH" | grep -E "$MODULEPATH_PATTERN"'
 
     # End Test Suite

.github/workflows/tests_eessi_module.yml

@@ -109,11 +109,11 @@ jobs:
           # First do (and undo) the Lmod initialisation
           export MODULEPATH=init/modules
           # Turn on debug output in case we want to take a look
-          export EESSI_DEBUG_INIT=true
+          export EESSI_MODULE_DEBUG_INIT=true
           CPU_ARCH=$(./init/eessi_archdetect.sh -a cpupath)
           module load EESSI/${{matrix.EESSI_VERSION}}
-          # EESSI_DEBUG_INIT/EESSI_ARCHDETECT_OPTIONS only relevant for Lmod init
-          unset EESSI_DEBUG_INIT
+          # EESSI_MODULE_DEBUG_INIT/EESSI_ARCHDETECT_OPTIONS only relevant for Lmod init
+          unset EESSI_MODULE_DEBUG_INIT
           # Store all relevant environment variables
           env | grep -E '(^EESSI_|^LMOD_RC|^LMOD_PACKAGE_PATH|^MODULEPATH)' | grep -v EESSI_ARCHDETECT_OPTIONS | sort > "${moduleoutfile}"
           module unload EESSI/${{matrix.EESSI_VERSION}}
@@ -200,7 +200,7 @@ jobs:
           fi
 
           # Turn on debug output in case we want to take a look
-          export EESSI_DEBUG_INIT=true
+          export EESSI_MODULE_DEBUG_INIT=true
 
           initial_env_file="initial_env.txt"
           module_cycled_file="load_unload_cycle.txt"

init/lmod/bash

@@ -25,6 +25,7 @@
 #   - EESSI_MODULE_FAMILY_NAME: use the value of the environment variable to set an Lmod family for the EESSI module
 #   - EESSI_MODULE_STICKY: make the EESSI module sticky
 #   - EESSI_MODULE_UPDATE_PS1: have the EESSI module update PS1 to give a prompt that is prepended with "{EESSI/...} "
+#  (- EESSI_MODULE_DEBUG_INIT: enable debug print statements when loading the EESSI module)
 #
 # Effects:
 # - Should always succeed
@@ -86,6 +87,17 @@ if [ -z "$__Init_EESSI_Default_Modules" ]; then
     export MODULEPATH="${EESSI_CVMFS_REPO}/init/modules${EESSI_EXTRA_MODULEPATH:+:$EESSI_EXTRA_MODULEPATH}"
     . "${EESSI_CVMFS_REPO}/versions/${LMOD_EESSI_VERSION}/compat/linux/$(uname -m)/usr/share/Lmod/init/bash"
     module --initial_load --no_redirect restore
+
+    # After initialising, we now know the architecture(s) that was/were selected so let's report them
+    echo "EESSI has selected ${EESSI_SOFTWARE_SUBDIR} as the compatible CPU target for EESSI/${EESSI_VERSION}"
+    if [ -n "$EESSI_ACCEL_SUBDIR" ]; then
+        echo "EESSI has selected ${EESSI_ACCEL_SUBDIR} as the compatible accelerator target for EESSI/${EESSI_VERSION}"
+    else
+        echo "EESSI did not identify an accelerator on the system"
+    fi
+    # If people want more detailed information about what EESSI is doing, they can also set an environment variable
+    # for additional information.
+    echo "(for debug information when loading the EESSI module, set the environment variable EESSI_MODULE_DEBUG_INIT)"
 else
     module reset
 fi

init/lmod/csh

@@ -65,6 +65,18 @@ if ( ! $?__Init_EESSI_Default_Modules ) then
     source "${EESSI_CVMFS_REPO}/versions/${LMOD_EESSI_VERSION}/compat/linux/`uname -m`/usr/share/Lmod/init/csh"
 
     module --initial_load --no_redirect restore
+
+    echo "EESSI has selected ${EESSI_SOFTWARE_SUBDIR} as the compatible CPU target for EESSI/${EESSI_VERSION}"
+    if ( $?EESSI_ACCEL_SUBDIR ) then
+        if ( "$EESSI_ACCEL_SUBDIR" != "" ) then
+            echo "EESSI has selected ${EESSI_ACCEL_SUBDIR} as the compatible accelerator target for EESSI/${EESSI_VERSION}"
+        else
+            echo "EESSI did not identify an accelerator on the system"
+        endif
+    else
+        echo "EESSI did not identify an accelerator on the system"
+    endif
+    echo "(for debug information when loading the EESSI module, set the environment variable EESSI_MODULE_DEBUG_INIT)"
 else
     module reset
 endif

init/lmod/fish

@@ -57,6 +57,14 @@ if test -z "$__Init_EESSI_Default_Modules"
     . "$EESSI_CVMFS_REPO"/versions/"$LMOD_EESSI_VERSION"/compat/linux/(uname -m)/usr/share/Lmod/init/fish
 
     module --initial_load --no_redirect restore
+
+    echo "EESSI has selected $EESSI_SOFTWARE_SUBDIR as the compatible CPU target for EESSI/$EESSI_VERSION"
+    if test -n "$EESSI_ACCEL_SUBDIR"
+        echo "EESSI has selected $EESSI_ACCEL_SUBDIR as the compatible accelerator target for EESSI/$EESSI_VERSION"
+    else
+        echo "EESSI did not identify an accelerator on the system"
+    end
+    echo "(for debug information when loading the EESSI module, set the environment variable EESSI_MODULE_DEBUG to 1)"
 else
     module reset
 end

init/lmod/ksh

@@ -43,6 +43,17 @@ if [ -z "$__Init_EESSI_Default_Modules" ]; then
     . "${EESSI_CVMFS_REPO}/versions/${LMOD_EESSI_VERSION}/compat/linux/$(uname -m)/usr/share/Lmod/init/ksh"
 
     module --initial_load --no_redirect restore
+
+    # After initialising, we now know the architecture(s) that was/were selected so let's report them
+    echo "EESSI has selected ${EESSI_SOFTWARE_SUBDIR} as the compatible CPU target for EESSI/${EESSI_VERSION}"
+    if [ -n "$EESSI_ACCEL_SUBDIR" ]; then
+        echo "EESSI has selected ${EESSI_ACCEL_SUBDIR} as the compatible accelerator target for EESSI/${EESSI_VERSION}"
+    else
+        echo "EESSI did not identify an accelerator on the system"
+    fi
+    # If people want more detailed information about what EESSI is doing, they can also set an environment variable
+    # for additional information.
+    echo "(for debug information when loading the EESSI module, set the environment variable EESSI_MODULE_DEBUG_INIT)"
 else
     module reset
 fi

init/lmod/zsh

@@ -43,6 +43,17 @@ if [ -z "$__Init_EESSI_Default_Modules" ]; then
     . "${EESSI_CVMFS_REPO}/versions/${LMOD_EESSI_VERSION}/compat/linux/$(uname -m)/usr/share/Lmod/init/zsh"
 
     module --initial_load --no_redirect restore
+
+    # After initialising, we now know the architecture(s) that was/were selected so let's report them
+    echo "EESSI has selected ${EESSI_SOFTWARE_SUBDIR} as the compatible CPU target for EESSI/${EESSI_VERSION}"
+    if [ -n "$EESSI_ACCEL_SUBDIR" ]; then
+        echo "EESSI has selected ${EESSI_ACCEL_SUBDIR} as the compatible accelerator target for EESSI/${EESSI_VERSION}"
+    else
+        echo "EESSI did not identify an accelerator on the system"
+    fi
+    # If people want more detailed information about what EESSI is doing, they can also set an environment variable
+    # for additional information.
+    echo "(for debug information when loading the EESSI module, set the environment variable EESSI_MODULE_DEBUG_INIT)"
 else
     module reset
 fi

init/modules/EESSI/2023.06.lua

@@ -57,7 +57,8 @@ setenv("EESSI_VERSION", eessi_version)
 setenv("EESSI_CVMFS_REPO", eessi_repo)
 setenv("EESSI_OS_TYPE", eessi_os_type)
 function eessiDebug(text)
-    if (mode() == "load" and os.getenv("EESSI_DEBUG_INIT")) then
+    -- Allow the old environment or the new one (EESSI_MODULE_...) to enable the debug print statements
+    if (mode() == "load" and (os.getenv("EESSI_DEBUG_INIT") or os.getenv("EESSI_MODULE_DEBUG_INIT"))) then
         LmodMessage(text)
     end
 end