use new ModEnvVarType.STRICT_PATH_WITH_FILES for CMAKE_LIBRARY_PATH to avoid spurious default paths injected into generated module files

Author: lexming

easybuild/framework/easyblock.py

@@ -1770,6 +1770,12 @@ def expand_module_search_path(self, search_path, path_type=ModEnvVarType.PATH_WI
               - PATH_WITH_FILES: must contain at least one file in them (default)
               - PATH_WITH_TOP_FILES: increase stricness to require files in top level directory
         """
+        populated_path_types = (
+            ModEnvVarType.PATH_WITH_FILES,
+            ModEnvVarType.PATH_WITH_TOP_FILES,
+            ModEnvVarType.STRICT_PATH_WITH_FILES,
+        )
+
         if os.path.isabs(search_path):
             abs_glob = search_path
         else:
@@ -1780,10 +1786,17 @@ def expand_module_search_path(self, search_path, path_type=ModEnvVarType.PATH_WI
 
         retained_search_paths = []
         for abs_path in exp_search_paths:
-            check_dir_files = path_type in (ModEnvVarType.PATH_WITH_FILES, ModEnvVarType.PATH_WITH_TOP_FILES)
-            if os.path.isdir(abs_path) and check_dir_files:
+            # avoid going through symlink for strict path types
+            if path_type is ModEnvVarType.STRICT_PATH_WITH_FILES and abs_path != os.path.realpath(abs_path):
+                self.log.debug(
+                    f"Discarded strict search path '{search_path} of type '{path_type}' that does not correspond "
+                    f"to its real path: {abs_path}"
+                )
+                continue
+
+            if os.path.isdir(abs_path) and path_type in populated_path_types:
                 # only retain paths to directories that contain at least one file
-                recursive = path_type == ModEnvVarType.PATH_WITH_FILES
+                recursive = path_type in (ModEnvVarType.PATH_WITH_FILES, ModEnvVarType.STRICT_PATH_WITH_FILES)
                 if not dir_contains_files(abs_path, recursive=recursive):
                     self.log.debug("Discarded search path to empty directory: %s", abs_path)
                     continue

easybuild/tools/modules.py

@@ -144,8 +144,10 @@ class ModEnvVarType(Enum):
       one or more files
     - PATH_WITH_TOP_FILES: (list of) of paths to existing directories
       containing one or more files in its top directory
+    - STRICT_PATH_WITH_FILES: (list of) of paths to existing directories
+      containing one or more files, given paths must correspond to real paths
     - """
-    STRING, PATH, PATH_WITH_FILES, PATH_WITH_TOP_FILES = range(0, 4)
+    STRING, PATH, PATH_WITH_FILES, PATH_WITH_TOP_FILES, STRICT_PATH_WITH_FILES = range(0, 5)
 
 
 class ModuleEnvironmentVariable:
@@ -239,6 +241,7 @@ def is_path(self):
             ModEnvVarType.PATH,
             ModEnvVarType.PATH_WITH_FILES,
             ModEnvVarType.PATH_WITH_TOP_FILES,
+            ModEnvVarType.STRICT_PATH_WITH_FILES,
         ]
         return self.type in path_like_types
 
@@ -286,7 +289,8 @@ def __init__(self, aliases=None):
         self._env_vars = {}
         self.ACLOCAL_PATH = [os.path.join('share', 'aclocal')]
         self.CLASSPATH = ['*.jar']
-        self.CMAKE_LIBRARY_PATH = ['lib64']  # only needed for installations with standalone lib64
+        # CMAKE_LIBRARY_PATH only needed for installations outside of 'lib'
+        self.CMAKE_LIBRARY_PATH = {'contents': ['lib64'], 'var_type': "STRICT_PATH_WITH_FILES"}
         self.CMAKE_PREFIX_PATH = ['']
         self.GI_TYPELIB_PATH = [os.path.join(x, 'girepository-*') for x in SEARCH_PATH_LIB_DIRS]
         self.LD_LIBRARY_PATH = SEARCH_PATH_LIB_DIRS
@@ -374,7 +378,7 @@ def _set_module_environment_variable(self, name, value):
         if not self.regex['env_var_name'].match(name):
             raise EasyBuildError(
                 "Name of ModuleLoadEnvironment attribute does not conform to shell naming rules, "
-                f"it must only have upper-case letters and underscores: '{name}'"
+                f"it must only have upper-case letters, numbers and underscores: '{name}'"
             )
 
         if not isinstance(value, dict):

test/framework/easyblock.py

@@ -490,16 +490,20 @@ def test_make_module_req(self):
         # -- No Files
         if get_module_syntax() == 'Tcl':
             self.assertFalse(re.search(r"^prepend-path\s+CMAKE_LIBRARY_PATH\s+\$root/lib64$", guess, re.M))
+            self.assertFalse(re.search(r"^prepend-path\s+CMAKE_LIBRARY_PATH\s+\$root/lib$", guess, re.M))
         elif get_module_syntax() == 'Lua':
             self.assertNotIn('prepend_path("CMAKE_LIBRARY_PATH", pathJoin(root, "lib64"))', guess)
+            self.assertNotIn('prepend_path("CMAKE_LIBRARY_PATH", pathJoin(root, "lib"))', guess)
         # -- With files
         write_file(os.path.join(eb.installdir, 'lib64', 'libfoo.so'), 'test')
         with eb.module_generator.start_module_creation():
             guess = eb.make_module_req()
         if get_module_syntax() == 'Tcl':
             self.assertTrue(re.search(r"^prepend-path\s+CMAKE_LIBRARY_PATH\s+\$root/lib64$", guess, re.M))
+            self.assertFalse(re.search(r"^prepend-path\s+CMAKE_LIBRARY_PATH\s+\$root/lib$", guess, re.M))
         elif get_module_syntax() == 'Lua':
             self.assertIn('prepend_path("CMAKE_LIBRARY_PATH", pathJoin(root, "lib64"))', guess)
+            self.assertNotIn('prepend_path("CMAKE_LIBRARY_PATH", pathJoin(root, "lib"))', guess)
         # -- With files in lib and lib64 symlinks to lib
         write_file(os.path.join(eb.installdir, 'lib', 'libfoo.so'), 'test')
         shutil.rmtree(os.path.join(eb.installdir, 'lib64'))
@@ -508,8 +512,10 @@ def test_make_module_req(self):
             guess = eb.make_module_req()
         if get_module_syntax() == 'Tcl':
             self.assertFalse(re.search(r"^prepend-path\s+CMAKE_LIBRARY_PATH\s+\$root/lib64$", guess, re.M))
+            self.assertFalse(re.search(r"^prepend-path\s+CMAKE_LIBRARY_PATH\s+\$root/lib$", guess, re.M))
         elif get_module_syntax() == 'Lua':
             self.assertNotIn('prepend_path("CMAKE_LIBRARY_PATH", pathJoin(root, "lib64"))', guess)
+            self.assertNotIn('prepend_path("CMAKE_LIBRARY_PATH", pathJoin(root, "lib"))', guess)
 
         # With files in /lib and /lib64 symlinked to /lib there should be exactly 1 entry for (LD_)LIBRARY_PATH
         # pointing to /lib