Fix issues for locale, lesspipe and LD_LIBRARY_PATH in EESSI module

Author: ocaisa

.github/workflows/tests_eessi_module.yml

@@ -115,7 +115,7 @@ jobs:
           # EESSI_DEBUG_INIT/EESSI_ARCHDETECT_OPTIONS only relevant for Lmod init
           unset EESSI_DEBUG_INIT
           # Store all relevant environment variables
-          env | grep -E '(^EESSI_|^LMOD_RC|^LMOD_PACKAGE_PATH|^MODULEPATH)' | grep -v EESSI_ARCHDETECT_OPTIONS | sort > "${moduleoutfile}"
+          env | grep -E '(^EESSI_|^LMOD_RC|^LMOD_PACKAGE_PATH|^MODULEPATH)' | grep -v EESSI_ARCHDETECT_OPTIONS | grep -v EESSI_DEFAULT_HOST_LD_LIBRARY_PATH | sort > "${moduleoutfile}"
           module unload EESSI/${{matrix.EESSI_VERSION}}
 
           # We should only have two EESSI_* variables defined (which set the overrides)
@@ -315,3 +315,42 @@ jobs:
           module load "EESSI/${{matrix.EESSI_VERSION}}"
           GREP_PATTERN="Lmod is automatically replacing \"EESSI/${{matrix.EESSI_VERSION}}\" with \"${LOCAL_STACK_NAME}/${LOCAL_STACK_VERSION}\"."
           module load "${LOCAL_STACK_NAME}/${LOCAL_STACK_VERSION}" |& grep "${GREP_PATTERN}"
+
+  check_ld_library_path_eessi_module:
+    runs-on: ubuntu-24.04
+    strategy:
+      fail-fast: false
+      matrix:
+        EESSI_VERSION:
+          - '2023.06'
+          - '2025.06'
+
+    steps:
+      - name: Check out software-layer repository
+        uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1
+
+      - name: Mount EESSI CernVM-FS repository
+        uses: cvmfs-contrib/github-action-cvmfs@55899ca74cf78ab874bdf47f5a804e47c198743c # v4.0
+        with:
+          cvmfs_config_package: https://github.com/EESSI/filesystem-layer/releases/download/latest/cvmfs-config-eessi_latest_all.deb
+          cvmfs_http_proxy: DIRECT
+          cvmfs_repositories: software.eessi.io
+
+      - name: Make sure we are filtering LD_LIBRARY_PATH if necessary
+        run: |
+          # Initialise Lmod
+          . /cvmfs/software.eessi.io/versions/${{matrix.EESSI_VERSION}}/compat/linux/$(uname -m)/usr/share/Lmod/init/bash
+
+          # Make sure we are using the EESSI module file from the repository
+          export MODULEPATH=init/modules
+
+          # Create LD_LIBRARY_PATH to test with
+          export FAKE_PATH=/path/does/not/exist
+          export INITIAL_LD_LIBRARY_PATH="/usr/lib:$FAKE_PATH"
+          export LD_LIBRARY_PATH="$INITIAL_LD_LIBRARY_PATH"
+          module load "EESSI/${{matrix.EESSI_VERSION}}"
+          # Check we have a sanitised LD_LIBRARY_PATH
+          [ "$LD_LIBRARY_PATH" = "$FAKE_PATH" ] || (echo "LD_LIBRARY_PATH is not $FAKE_PATH but $LD_LIBRARY_PATH" && exit 1)
+          # Make sure things are back as we expect afterwards
+          module purge
+          [ "$LD_LIBRARY_PATH" = "$INITIAL_LD_LIBRARY__PATH" ] || (echo "LD_LIBRARY_PATH is not $INITIAL_LD_LIBRARY_PATH but $LD_LIBRARY_PATH" && exit 1)

init/modules/EESSI/2023.06.lua

@@ -210,6 +210,31 @@ if os.getenv("EESSI_MODULE_STICKY") then
     load_message = load_message .. " (requires '--force' option to unload or purge)"
 end
 
+-- make sure we are using a known locale
+pushenv ("LANG", "C.utf8")
+pushenv ("LC_ALL", "C.utf8")
+pushenv ("LC_CTYPE", "C.utf8")
+pushenv ("LC_MESSAGES", "C.utf8")
+
+-- avoid lesspipe problems on Debian system
+pushenv ("LESSOPEN", "")
+
+-- Filter system paths from LD_LIBRARY_PATH
+-- Needs to be reversible so first make a copy
+append_path ("EESSI_DEFAULT_HOST_LD_LIBRARY_PATH", os.getenv("LD_LIBRARY_PATH") or "")
+-- on unload the variable will no longer exist
+if mode() == "load" then
+    -- remove any standard paths
+    remove_path ("EESSI_DEFAULT_HOST_LD_LIBRARY_PATH", "/lib")
+    remove_path ("EESSI_DEFAULT_HOST_LD_LIBRARY_PATH", "/lib64")
+    remove_path ("EESSI_DEFAULT_HOST_LD_LIBRARY_PATH", "/usr/lib")
+    remove_path ("EESSI_DEFAULT_HOST_LD_LIBRARY_PATH", "/usr/lib64")
+    remove_path ("EESSI_DEFAULT_HOST_LD_LIBRARY_PATH", "/usr/local/lib")
+    remove_path ("EESSI_DEFAULT_HOST_LD_LIBRARY_PATH", "/usr/local/lib64")
+end
+-- now we can use pushenv to retain/restore the original value
+pushenv ("LD_LIBRARY_PATH", os.getenv("EESSI_DEFAULT_HOST_LD_LIBRARY_PATH") or "")
+
 if mode() == "load" then
     LmodMessage(load_message)
 end