Merge pull request #195 from ocaisa/reset_in_new_shell

Allow EESSI to re-initialised in a subshell (since a subshell may restore a system module tool)

Author: boegel

.github/workflows/scripts/test_init_scripts.sh

@@ -49,7 +49,17 @@ for shell in ${SHELLS[@]}; do
       assert_raises "$shell -c '. init/lmod/$shell' 2>&1 | grep -E \"${expected_pattern}\""
     fi
 
-    # TEST 2: Check if module overviews first section is the loaded EESSI module
+    # TEST 2: Source Script again in an subshell and check Module Output
+    expected_pattern=".*EESSI has selected $EESSI_SOFTWARE_SUBDIR_OVERRIDE as the compatible CPU target for EESSI/$EESSI_VERSION.*"
+    if [ "$shell" = "csh" ]; then
+      # Cannot figure out how to chain shells with silenced output to test this in csh but it does work
+      # assert_raises "$shell -c 'setenv LMOD_QUIET 1 ; source init/lmod/$shell ; ($shell -c \"unsetenv LMOD_QUIET ; source init/lmod/$shell\")' 2>&1 | grep -E \"${expected_pattern}\""
+      echo "Skipping chained shell check for csh as can't figure out how to silence output in first call"
+    else
+      assert_raises "$shell -c '. init/lmod/$shell > /dev/null 2>&1; $shell -c \". init/lmod/$shell\"' 2>&1 | grep -E \"${expected_pattern}\""
+    fi
+
+    # TEST 3: Check if module overviews first section is the loaded EESSI module
     if [ "$shell" = "csh" ]; then
       # module is defined as alias, but aliases are only retained in interactive
       # shells we work around this by creating a .cshrc file (which sources the
@@ -63,10 +73,10 @@ for shell in ${SHELLS[@]}; do
     assert_raises 'echo "${MODULE_SECTIONS[1]}" | grep -E "$PATTERN"'
     # echo "${MODULE_SECTIONS[1]}" "$PATTERN"
 
-    # TEST 3: Check if module overviews second section is the EESSI init module
+    # TEST 4: Check if module overviews second section is the EESSI init module
     assert "echo ${MODULE_SECTIONS[4]}" "/cvmfs/software.eessi.io/init/modules"
 
-    # TEST 4: Load EasyBuild module and check version
+    # TEST 5: Load EasyBuild module and check version
     # 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
@@ -76,7 +86,7 @@ for shell in ${SHELLS[@]}; do
     fi
     assert "$command" "$EXPECTED_EASYBUILD_VERSION"
 
-    # TEST 5: Load EasyBuild module and check path
+    # TEST 6: Load EasyBuild module and check path
     if [ "$shell" = "csh" ]; then
       echo "source init/lmod/$shell" > ~/.cshrc
       EASYBUILD_PATH=$($shell -c "module load EasyBuild/${EXPECTED_EASYBUILD_VERSION}; which eb")
@@ -89,7 +99,7 @@ for shell in ${SHELLS[@]}; do
     assert_raises 'echo "$EASYBUILD_PATH" | grep -E "$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
+    # TEST 7 and 8: Check the various options (EESSI_DEFAULT_MODULES_APPEND, EESSI_DEFAULT_MODULES_APPEND, EESSI_EXTRA_MODULEPATH) all work
     if [ "$shell" = "csh" ]; then
       echo "setenv EESSI_DEFAULT_MODULES_APPEND append_module" > ~/.cshrc
       echo "setenv EESSI_DEFAULT_MODULES_PREPEND prepend_module" >> ~/.cshrc
@@ -115,7 +125,7 @@ for shell in ${SHELLS[@]}; do
     # echo "$TEST_MODULEPATH" AND "$MODULEPATH_PATTERN"
     assert_raises 'echo "$TEST_MODULEPATH" | grep -E "$MODULEPATH_PATTERN"'
 
-    # TEST 8 and 9: Add a conditional test depending on whether we have the Lmod command is available locally or not (Ubuntu-based location for CI)
+    # TEST 9 and 10: Add a conditional test depending on whether we have the Lmod command is available locally or not (Ubuntu-based location for CI)
     if [ -d "$LMOD_PKG/init" ]; then
         echo "Running check for locally available Lmod with purge"
         if [ "$shell" = "csh" ]; then
@@ -142,7 +152,7 @@ for shell in ${SHELLS[@]}; do
         assert_raises 'echo "$TEST_EESSI_WITHOUT_PURGE" | grep "$pattern"' 1
     fi
 
-    # Optional test 10, check if the prompt has been updated
+    # Optional test 11, check if the prompt has been updated
     if [ "$shell" = "bash" ] || [ "$shell" = "ksh" ] || [ "$shell" = "zsh" ] || [ "$shell" = "sh" ]; then
         # Typically this is a non-interactive shell, so manually unset PS1 and reset to a non-exported variable when testing
         TEST_EESSI_PS1_UPDATE=$($shell -c "unset PS1 ; PS1='$ ' ; . init/lmod/$shell 2>/dev/null ; echo \"\$PS1\"")

init/lmod/csh

@@ -13,6 +13,7 @@
 if ( ! $?EESSI_CVMFS_REPO) then
     set EESSI_CVMFS_REPO = "/cvmfs/software.eessi.io"
 endif
+set internal_cvmfs_repo = "$EESSI_CVMFS_REPO"
 
 # Choose an EESSI version (default is used if EESSI_VERSION is not provided)
 if ( ! $?__EESSI_VERSION_USED_FOR_INIT ) then
@@ -21,15 +22,13 @@ else
     set EESSI_VERSION_DEFAULT = "$__EESSI_VERSION_USED_FOR_INIT"
 endif
 if ( ! $?__Init_EESSI_Default_Modules ) then
-    if ( $?EESSI_VERSION ) then
-        # keep existing value
-    else
-        set EESSI_VERSION "$EESSI_VERSION_DEFAULT"
+    if ( ! $?EESSI_VERSION ) then
+        set EESSI_VERSION = "$EESSI_VERSION_DEFAULT"
     endif
 else
     # If we have already initialised and this is being called again,
     # then we must want the specific version
-    set EESSI_VERSION "__EESSI_VERSION_DEFAULT__"
+    set EESSI_VERSION = "__EESSI_VERSION_DEFAULT__"
 endif
 # On first run, record the EESSI version used for init as an environment variable.
 # We use setenv to ensure it is available to child processes (equivalent to export).
@@ -48,7 +47,7 @@ endif
 setenv LMOD_SYSTEM_DEFAULT_MODULES "${LMOD_SYSTEM_DEFAULT_MODULES}"
 
 if ( ! $?__Init_EESSI_Default_Modules ) then
-    setenv __Init_EESSI_Default_Modules 1
+    set __Init_EESSI_Default_Modules = 1
 
     # Lmod version in 2023.06 has a problem with newer Lmod caches, so let's stick to more recent Lmod
     # (has no effect except on Lmod itself, and compatible caches are still created/supported by EESSI)
@@ -67,15 +66,15 @@ if ( ! $?__Init_EESSI_Default_Modules ) then
     # and clear out any memory Lmod might have
     unsetenv _ModuleTable001_
     # Path to top-level module tree
-    set modulepath = "${EESSI_CVMFS_REPO}/init/modules"
+    set modulepath = "${internal_cvmfs_repo}/init/modules"
     if ( $?EESSI_EXTRA_MODULEPATH ) then
       # Now that we know it exists, check IF it is not empty
       if ( "$EESSI_EXTRA_MODULEPATH" != "" ) then
         set modulepath = "${modulepath}:${EESSI_EXTRA_MODULEPATH}"
       endif
     endif
     setenv MODULEPATH "$modulepath"
-    source "${EESSI_CVMFS_REPO}/versions/${LMOD_EESSI_VERSION}/compat/linux/`uname -m`/usr/share/Lmod/init/csh"
+    source "${internal_cvmfs_repo}/versions/${LMOD_EESSI_VERSION}/compat/linux/`uname -m`/usr/share/Lmod/init/csh"
 
     module --initial_load --no_redirect restore
 

init/lmod/fish

@@ -10,7 +10,7 @@
 # Please refer to the reference bash implementation for full documentation, only minimal comments are included here
 
 # Choose an EESSI CVMFS repository
-set EESSI_CVMFS_REPO (set -q EESSI_CVMFS_REPO; and echo "$EESSI_CVMFS_REPO"; or echo "/cvmfs/software.eessi.io")
+set internal_cvmfs_repo (set -q EESSI_CVMFS_REPO; and echo "$EESSI_CVMFS_REPO"; or echo "/cvmfs/software.eessi.io")
 
 # Choose an EESSI version
 if not set -q __EESSI_VERSION_USED_FOR_INIT
@@ -46,7 +46,7 @@ end
 set -x LMOD_SYSTEM_DEFAULT_MODULES $LMOD_SYSTEM_DEFAULT_MODULES
 
 if test -z "$__Init_EESSI_Default_Modules"
-    set -x __Init_EESSI_Default_Modules 1
+    set __Init_EESSI_Default_Modules 1
 
     # Lmod version in 2023.06 has a problem with newer Lmod caches, so let's stick to more recent Lmod
     # (has no effect except on Lmod itself, and compatible caches are still created/supported by EESSI)
@@ -64,12 +64,12 @@ if test -z "$__Init_EESSI_Default_Modules"
     # and clear out any memory Lmod might have
     set -e _ModuleTable001_
     # Path to top-level module tree
-    set modulepath "$EESSI_CVMFS_REPO/init/modules"
+    set modulepath "$internal_cvmfs_repo/init/modules"
     if set -q EESSI_EXTRA_MODULEPATH; and test -n "$EESSI_EXTRA_MODULEPATH"
         set modulepath "$modulepath:$EESSI_EXTRA_MODULEPATH"
     end
     set -x MODULEPATH $modulepath
-    . "$EESSI_CVMFS_REPO"/versions/"$LMOD_EESSI_VERSION"/compat/linux/(uname -m)/usr/share/Lmod/init/fish
+    . "$internal_cvmfs_repo"/versions/"$LMOD_EESSI_VERSION"/compat/linux/(uname -m)/usr/share/Lmod/init/fish
 
     module --initial_load --no_redirect restore
 

init/lmod/sh

@@ -43,13 +43,13 @@
 # - Lmod initialisation cannot be undone
 
 # Choose an EESSI CVMFS repository
-EESSI_CVMFS_REPO="${EESSI_CVMFS_REPO:-/cvmfs/software.eessi.io}"
+internal_cvmfs_repo="${EESSI_CVMFS_REPO:-/cvmfs/software.eessi.io}"
 
 # Choose an EESSI version (the default is only used if the EESSI_VERSION environment variable is not provided)
 # (Note: in the repository which is home to this file a template value __EESSI_VERSION_DEFAULT__ is present in
 #  the line below which is replaced within our deployment pipeline.)
 EESSI_VERSION_DEFAULT="${__EESSI_VERSION_USED_FOR_INIT:-__EESSI_VERSION_DEFAULT__}"
-if [ -z "$__Init_EESSI_Default_Modules" ]; then
+if [ "${__Init_EESSI_Default_Modules-}" != "1" ]; then
     EESSI_VERSION="${EESSI_VERSION:-${EESSI_VERSION_DEFAULT}}"
 else
     # If we have already initialised and this is being called again, then we must want the specific version
@@ -75,8 +75,10 @@ export __EESSI_VERSION_USED_FOR_INIT="${__EESSI_VERSION_USED_FOR_INIT:-${EESSI_V
 LMOD_SYSTEM_DEFAULT_MODULES="${EESSI_DEFAULT_MODULES_PREPEND:+$EESSI_DEFAULT_MODULES_PREPEND:}EESSI/$EESSI_VERSION${EESSI_DEFAULT_MODULES_APPEND:+:$EESSI_DEFAULT_MODULES_APPEND}"
 export LMOD_SYSTEM_DEFAULT_MODULES
 
-if [ -z "$__Init_EESSI_Default_Modules" ]; then
-    export __Init_EESSI_Default_Modules=1;
+if [ "${__Init_EESSI_Default_Modules-}" != "1" ]; then
+    # We do _not_ export this as we do not want it picked up by a new shell
+    # (since the system module tool may be restored in that scenario)
+    __Init_EESSI_Default_Modules=1
 
     # Lmod version in 2023.06 has a problem with newer Lmod caches, so let's stick to more recent Lmod
     # (has no effect except on Lmod itself, and compatible caches are still created/supported by EESSI)
@@ -122,8 +124,8 @@ if [ -z "$__Init_EESSI_Default_Modules" ]; then
     # Path to top-level module tree
     # - EESSI_EXTRA_MODULEPATH environment variable allows a site to append to MODULEPATH
     #   (lower priority than EESSI MODULEPATH)
-    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/${shell}"
+    export MODULEPATH="${internal_cvmfs_repo}/init/modules${EESSI_EXTRA_MODULEPATH:+:$EESSI_EXTRA_MODULEPATH}"
+    . "${internal_cvmfs_repo}/versions/${LMOD_EESSI_VERSION}/compat/linux/$(uname -m)/usr/share/Lmod/init/${shell}"
     module --initial_load --no_redirect restore
 
     # After initialising, we now know the architecture(s) that was/were selected so let's report them