Add module load time env var to user module path

easybuild/framework/easyblock.py

@@ -1188,12 +1188,10 @@ def make_module_extend_modpath(self):
             if user_modpath:
                 # If a mod_path_suffix is being used, we should respect it
                 mod_path_suffix = build_option('suffix_modules_path')
-                user_modpath = os.path.join(user_modpath, mod_path_suffix)
                 user_modpath_exts = ActiveMNS().det_user_modpath_extensions(self.cfg)
-                user_modpath_exts = [os.path.join(user_modpath, e) for e in user_modpath_exts]
                 self.log.debug("Including user module path extensions returned by naming scheme: %s", user_modpath_exts)
                 txt += self.module_generator.use(user_modpath_exts, prefix=self.module_generator.getenv_cmd('HOME'),
-                                                 guarded=True)
+                                             guarded=True, user_modpath=user_modpath, mod_path_suffix=mod_path_suffix)
         else:
             self.log.debug("Not including module path extensions, as specified.")
         return txt

easybuild/tools/module_generator.py

@@ -307,12 +307,14 @@ def update_paths(self, key, paths, prepend=True, allow_abs=False, expand_relpath
         """
         raise NotImplementedError
 
-    def use(self, paths, prefix=None, guarded=False):
+    def use(self, paths, prefix=None, guarded=False, user_modpath=None, mod_path_suffix=None):
         """
         Generate module use statements for given list of module paths.
         :param paths: list of module path extensions to generate use statements for; paths will be quoted
         :param prefix: optional path prefix; not quoted, i.e., can be a statement
         :param guarded: use statements will be guarded to only apply if path exists
+        :param user_modpath: optional user subdir
+        :param mod_path_suffix: optional path suffix
         """
         raise NotImplementedError
 
@@ -643,12 +645,14 @@ def unload_module(self, mod_name):
         """
         return '\n'.join(['', "module unload %s" % mod_name])
 
-    def use(self, paths, prefix=None, guarded=False):
+    def use(self, paths, prefix=None, guarded=False, user_modpath=None, mod_path_suffix=None):
         """
         Generate module use statements for given list of module paths.
         :param paths: list of module path extensions to generate use statements for; paths will be quoted
         :param prefix: optional path prefix; not quoted, i.e., can be a statement
         :param guarded: use statements will be guarded to only apply if path exists
+        :param user_modpath: optional user subdir
+        :param mod_path_suffix: optional path suffix
         """
         use_statements = []
         for path in paths:
@@ -954,20 +958,46 @@ def unload_module(self, mod_name):
         """
         return '\n'.join(['', 'unload("%s")' % mod_name])
 
-    def use(self, paths, prefix=None, guarded=False):
+    def use(self, paths, prefix=None, guarded=False, user_modpath=None, mod_path_suffix=None):
         """
         Generate module use statements for given list of module paths.
         :param paths: list of module path extensions to generate use statements for; paths will be quoted
         :param prefix: optional path prefix; not quoted, i.e., can be a statement
         :param guarded: use statements will be guarded to only apply if path exists
+        :param user_modpath: optional user subdir path
+        :param mod_path_suffix: optional path suffix, only used with user_modpath
         """
         use_statements = []
+        if user_modpath:
+            # Check for occurenses of {RUNTIME_ENV::SOME_ENV_VAR}
+            # SOME_ENV_VAR will be expanded at module load time.
+            runtime_env_re = re.compile(r'{RUNTIME_ENV::(\w+)}')
+            sub_paths = []
+            expanded_user_modpath = []
+            for sub_path in re.split(os.path.sep, user_modpath):
+                matched_re = runtime_env_re.match(sub_path)
+                if matched_re:
+                    if sub_paths:
+                        path = quote_str(os.path.join(*sub_paths))
+                        expanded_user_modpath.extend([path])
+                        sub_paths = []
+                    expanded_user_modpath.extend(['os.getenv(%s)' % quote_str(matched_re.group(1))])
+                else:
+                    sub_paths.append(sub_path)
+            if sub_paths:
+                expanded_user_modpath.extend([quote_str(os.path.join(*sub_paths))])
+            if mod_path_suffix:
+                expanded_user_modpath.extend([quote_str(mod_path_suffix)])
+            user_modpath = ', '.join(expanded_user_modpath)
         for path in paths:
             quoted_path = quote_str(path)
+            if user_modpath:
+                quoted_path = 'pathJoin(%s, %s)' % (user_modpath, quoted_path)
             if prefix:
                 full_path = 'pathJoin(%s, %s)' % (prefix, quoted_path)
             else:
                 full_path = quoted_path
+
             prepend_modulepath = self.UPDATE_PATH_TEMPLATE % ('prepend', 'MODULEPATH', full_path)
             if guarded:
                 cond_statement = self.conditional_statement('isDir(%s)' % full_path, prepend_modulepath)

test/framework/easyblock.py

@@ -283,9 +283,9 @@ def test_make_module_extend_modpath(self):
             home = r'os.getenv\("HOME"\)'
             regexs.extend([
                 # extension for user modules is guarded
-                r'if isDir\(pathJoin\(%s, "%s/funky/Compiler/pi/3.14"\)\) then' % (home, usermodsdir),
+                r'if isDir\(pathJoin\(%s, "%s", "funky", "Compiler/pi/3.14"\)\) then' % (home, usermodsdir),
                 # no per-moduleclass extension for user modules
-                r'\s+prepend_path\("MODULEPATH", pathJoin\(%s, "%s/funky/Compiler/pi/3.14"\)\)' % (home, usermodsdir),
+                r'\s+prepend_path\("MODULEPATH", pathJoin\(%s, "%s", "funky", "Compiler/pi/3.14"\)\)' % (home, usermodsdir),
             ])
         else:
             self.assertTrue(False, "Unknown module syntax: %s" % get_module_syntax())