Merge pull request #1656 from teojgo/bugfix/module_collections_cli_usepath

[bugfix] Restore module paths specified in command line when restoring module collections

Author: Vasileios Karakasis

reframe/core/modules.py

@@ -744,6 +744,7 @@ def __init__(self):
                 (version, self.MIN_VERSION))
 
         self._version = version
+        self._extra_module_paths = []
 
     def name(self):
         return 'tmod4'
@@ -770,6 +771,15 @@ def _execute(self, cmd, *args):
     def load_module(self, module):
         if module.collection:
             self.execute('restore', str(module))
+
+            # Here the module search path removal/addition is repeated since
+            # 'restore' discards previous module path manipulations
+            for op, mp in self._extra_module_paths:
+                if op == '+':
+                    super().searchpath_add(mp)
+                else:
+                    super().searchpath_remove(mp)
+
             return []
         else:
             return super().load_module(module)
@@ -792,7 +802,15 @@ def conflicted_modules(self, module):
 
     def emit_load_instr(self, module):
         if module.collection:
-            return f'module restore {module}'
+            cmds = [f'module restore {module}']
+
+            # Here we append module searchpath removal/addition commands
+            # since 'restore' discards previous module path manipulations
+            for op, mp in self._extra_module_paths:
+                operation = 'use' if op == '+' else 'unuse'
+                cmds += [f'module {operation} {mp}']
+
+            return '\n'.join(cmds)
 
         return super().emit_load_instr(module)
 
@@ -802,6 +820,18 @@ def emit_unload_instr(self, module):
 
         return super().emit_unload_instr(module)
 
+    def searchpath_add(self, *dirs):
+        if dirs:
+            self._extra_module_paths += [('+', mp) for mp in dirs]
+
+        super().searchpath_add(*dirs)
+
+    def searchpath_remove(self, *dirs):
+        if dirs:
+            self._extra_module_paths += [('-', mp) for mp in dirs]
+
+        super().searchpath_remove(*dirs)
+
 
 class LModImpl(TMod4Impl):
     '''Module system for Lmod (Tcl/Lua).'''
@@ -836,6 +866,8 @@ def __init__(self):
             raise ConfigError('Python is not supported by '
                               'this Lmod installation')
 
+        self._extra_module_paths = []
+
     def name(self):
         return 'lmod'
 
@@ -891,20 +923,6 @@ def conflicted_modules(self, module):
 
         return ret
 
-    def load_module(self, module):
-        if module.collection:
-            self.execute('restore', str(module))
-            return []
-        else:
-            return super().load_module(module)
-
-    def unload_module(self, module):
-        if module.collection:
-            # Module collection are not unloaded
-            return
-
-        super().unload_module(module)
-
     def unload_all(self):
         # Currently, we don't take any provision for sticky modules in Lmod, so
         # we forcefully unload everything.

unittests/test_modules.py

@@ -3,17 +3,13 @@
 #
 # SPDX-License-Identifier: BSD-3-Clause
 
-import abc
 import os
 import pytest
 
 import reframe.core.environments as env
 import reframe.core.modules as modules
-import reframe.utility as util
-import reframe.utility.osext as osext
 import unittests.fixtures as fixtures
-from reframe.core.exceptions import (ConfigError, EnvironError)
-from reframe.core.runtime import runtime
+from reframe.core.exceptions import ConfigError, EnvironError
 
 
 @pytest.fixture(params=['tmod', 'tmod4', 'lmod', 'nomod'])
@@ -130,6 +126,18 @@ def test_module_load_force_collection(modules_system, module_collection):
     assert modules_system.is_module_loaded('testmod_foo')
 
 
+def test_module_load_collection_searchpath(modules_system, tmpdir,
+                                           module_collection):
+    p1 = str(tmpdir.mkdir('path1'))
+    p2 = str(tmpdir.mkdir('path2'))
+    modules_system.searchpath_add(p1)
+    modules_system.searchpath_add(p2)
+    modules_system.searchpath_remove(p1)
+    modules_system.load_module(module_collection, collection=True)
+    assert p1 not in modules_system.searchpath
+    assert p2 in modules_system.searchpath
+
+
 def test_module_unload_all(modules_system):
     if modules_system.name == 'nomod':
         modules_system.unload_all()