Add argument to disable module purging

Author: hwikle-lanl

lib/pavilion/commands/run.py

@@ -107,6 +107,11 @@ def _generic_arguments(parser):
                  "should be necessary only if the system or user environment "
                  "under which Pavilion runs has changed."
         )
+        parser.add_argument(
+            '--no-purge', action='store_false', default=True, dest='purge',
+            help="Do not perform a module purge before running tests. Modules "
+                 "are purged by default."
+        )
         parser.add_argument(
             'tests', nargs='*', action='store', metavar='TEST_NAME',
             help='The name of the tests to run. These may be suite names (in '
@@ -193,7 +198,8 @@ def run(self, pav_cfg, args):
             series_obj.run(
                 build_only=self.BUILD_ONLY,
                 rebuild=args.rebuild,
-                local_builds_only=local_builds_only)
+                local_builds_only=local_builds_only,
+                purge=args.purge)
             self.last_tests = list(series_obj.tests.values())
         except TestSeriesError as err:
             self.last_tests = list(series_obj.tests.values())

lib/pavilion/series/series.py

@@ -418,7 +418,7 @@ def check_cancelled(self) -> bool:
         return False
 
     def run(self, build_only: bool = False, rebuild: bool = False,
-            local_builds_only: bool = False):
+            local_builds_only: bool = False, purge: bool = True):
         """Build and kickoff all of the test sets in the series.
 
         :param build_only: Only build the tests, do not run them.
@@ -471,7 +471,7 @@ def run(self, build_only: bool = False, rebuild: bool = False,
 
                 try:
                     self._run_set(test_set, build_only=build_only,
-                                  rebuild=rebuild, local_builds_only=local_builds_only)
+                                  rebuild=rebuild, local_builds_only=local_builds_only, purge=purge)
                 except TestSetError as err:
                     self.status.set(SERIES_STATES.ERROR,
                                     "Error running test set {}. See the series log "
@@ -506,15 +506,16 @@ def run(self, build_only: bool = False, rebuild: bool = False,
         # Completion will be set when looked for.
 
 
-    def _run_set(self, test_set: TestSet, build_only: bool, rebuild: bool, local_builds_only: bool):
+    def _run_set(self, test_set: TestSet, build_only: bool, rebuild: bool, local_builds_only: bool,
+                 purge: bool):
         """Run all requested tests in the given test set."""
 
         # Track which builds we've already marked as deprecated, when doing rebuilds.
         deprecated_builds = set()
         failed_builds = dict()
         tests_running = 0
 
-        for test_batch in test_set.make_iter(build_only, rebuild, local_builds_only):
+        for test_batch in test_set.make_iter(build_only, rebuild, local_builds_only, purge):
 
             # Add all the tests we created to this test set.
             self._add_tests(test_batch, test_set.iter_name)

lib/pavilion/series/test_set.py

@@ -189,7 +189,7 @@ def __ordered_split(self) -> List['TestSet']:
 
         return test_sets
 
-    def make_iter(self, build_only=False, rebuild=False, local_builds_only=False) \
+    def make_iter(self, build_only=False, rebuild=False, local_builds_only=False, purge=True) \
                   -> Iterator[List[TestRun]]:
         """Resolve the given tests names and options into actual test run objects, and print
         the test creation status.  This returns an iterator over batches tests, respecting the
@@ -277,7 +277,7 @@ def make_iter(self, build_only=False, rebuild=False, local_builds_only=False) \
                 try:
                     test_run = TestRun(pav_cfg=self.pav_cfg, config=ptest.config,
                                        var_man=ptest.var_man, rebuild=rebuild,
-                                       build_only=build_only)
+                                       build_only=build_only, purge=purge)
                     if not test_run.skipped:
                         test_run.save()
                         self.tests.append(test_run)
@@ -339,12 +339,12 @@ def make_iter(self, build_only=False, rebuild=False, local_builds_only=False) \
         self.all_tests_made = True
 
 
-    def make(self, build_only=False, rebuild=False, local_builds_only=False):
+    def make(self, build_only=False, rebuild=False, local_builds_only=False, purge=True):
         """As per make_iter(), but create all of the tests. This doesn't
         respect batch sizes, etc, and is entirely for simplifying unit testing."""
 
         all_tests = []
-        for test_batch in self.make_iter(build_only, rebuild, local_builds_only):
+        for test_batch in self.make_iter(build_only, rebuild, local_builds_only, purge):
             all_tests.extend(test_batch)
 
         return all_tests

lib/pavilion/test_run/test_attrs.py

@@ -374,6 +374,9 @@ def _get_status_file(self) -> Optional[TestStatusFile]:
     name = basic_attr(
         name='name',
         doc="The full name of the test.")
+    purge = basic_attr(
+        name='purge',
+        doc="Whether or not the test will perform a module purge before building/running.")
     rebuild = basic_attr(
         name='rebuild',
         doc="Whether or not this test will rebuild it's build.")

lib/pavilion/test_run/test_run.py

@@ -101,7 +101,8 @@ class TestRun(TestAttributes):
     """Directory that holds build templates."""
 
     def __init__(self, pav_cfg: PavConfig, config: Dict, var_man: VariableSetManager = None,
-                 _id: int = None, rebuild: bool = False, build_only: bool = False):
+                 _id: int = None, rebuild: bool = False, build_only: bool = False,
+                 purge: bool = True):
         """Create an new TestRun object. If loading an existing test
     instance, use the ``TestRun.from_id()`` method.
 
@@ -110,6 +111,7 @@ def __init__(self, pav_cfg: PavConfig, config: Dict, var_man: VariableSetManager
     :param bool build_only: Only build this test run, do not run it.
     :param bool rebuild: After determining the build name, deprecate it and
         select a new, non-deprecated build.
+    :param bool purge: Whether or not to perform a module purge before running/building
     :param int _id: The test id of an existing test. (You should be using
         TestRun.load)."""
 
@@ -150,6 +152,7 @@ def __init__(self, pav_cfg: PavConfig, config: Dict, var_man: VariableSetManager
             # Set basic attributes
             self.id = id_tmp  # pylint: disable=invalid-name
             self.build_only = build_only
+            self.purge = purge
             self._complete = False
             self.created = time.time()
             self.name = self.make_name(config)
@@ -1148,13 +1151,14 @@ def _write_script(self, stype: str, path: Path, config: dict, module_wrappers: d
 
         script.command(f'echo "(pav) Setting up {stype} environment."')
 
-
-        modules = config.get('modules', [])
-        if modules:
+        if self.purge:
             script.newline()
             script.comment("Start with a fresh environment")
             script.module_purge()
 
+        modules = config.get('modules', [])
+
+        if modules:
             script.newline()
             script.comment('Perform module related changes to the environment.')
 

lib/pavilion/unittest.py

@@ -313,7 +313,7 @@ def _load_test(self, name: str, platform: str = 'this', host: str = 'this',
     del __config_lines
 
     def _quick_test(self, cfg=None, name="quick_test",
-                    build=True, finalize=True):
+                    build=True, finalize=True, purge=False):
         """Create a test run object to work with.
         The default is a simple hello world test with the raw scheduler.
 
@@ -347,7 +347,7 @@ def _quick_test(self, cfg=None, name="quick_test",
 
         cfg = resolve.test_config(cfg, var_man)
 
-        test = TestRun(pav_cfg=self.pav_cfg, config=cfg, var_man=var_man)
+        test = TestRun(pav_cfg=self.pav_cfg, config=cfg, var_man=var_man, purge=purge)
         if test.skipped:
             # You can't proceed further with a skipped test.
             return test

test/tests/mod_wrapper_tests.py

@@ -319,7 +319,7 @@ def test_module_purge(self):
             '[[ $(module -t list 2>&1) = "No modules loaded" ]] || exit 1',
         ]
 
-        test = self._quick_test(test_cfg)
+        test = self._quick_test(test_cfg, purge=True)
         run_result = test.run()
 
         self.assertEqual(run_result, 0)