Merge pull request #4350 from boegel/easystack_tmpdir_fix

reset `tempfile.tempdir` to `None` to avoid that tmpdir path gets progressively deeper with each easystack item

Author: ocaisa

easybuild/main.py

@@ -42,6 +42,7 @@
 import os
 import stat
 import sys
+import tempfile
 import traceback
 
 # IMPORTANT this has to be the first easybuild import as it customises the logging
@@ -254,8 +255,9 @@ def process_easystack(easystack_path, args, logfile, testing, init_session_state
         easyconfig._easyconfigs_cache.clear()
         easyconfig._easyconfig_files_cache.clear()
 
-        # restore environment
+        # restore environment and reset tempdir (to avoid tmpdir path getting progressively longer)
         restore_env(init_env)
+        tempfile.tempdir = None
 
         # If EasyConfig specific arguments were supplied in EasyStack file
         # merge arguments with original command line args

test/framework/easystack.py

@@ -31,6 +31,7 @@
 import os
 import re
 import sys
+import tempfile
 from unittest import TextTestRunner
 
 import easybuild.tools.build_log
@@ -129,11 +130,22 @@ def test_easystack_invalid_key2(self):
         self.assertErrorRegex(EasyBuildError, error_pattern, parse_easystack, test_easystack)
 
     def test_easystack_restore_env_after_each_build(self):
-        """Test that the build environment is reset for each easystack item"""
+        """Test that the build environment and tmpdir is reset for each easystack item"""
+
+        orig_tmpdir_tempfile = tempfile.gettempdir()
+        orig_tmpdir_env = os.getenv('TMPDIR')
+        orig_tmpdir_tempfile_len = len(orig_tmpdir_env.split(os.path.sep))
+        orig_tmpdir_env_len = len(orig_tmpdir_env.split(os.path.sep))
+
         test_es_txt = '\n'.join([
             "easyconfigs:",
             "  - toy-0.0-gompi-2018a.eb:",
             "  - libtoy-0.0.eb:",
+            # also include a couple of easyconfigs for which a module is already available in test environment,
+            # see test/framework/modules
+            "  - GCC-7.3.0-2.30",
+            "  - FFTW-3.3.7-gompi-2018a",
+            "  - foss-2018a",
         ])
         test_es_path = os.path.join(self.test_prefix, 'test.yml')
         write_file(test_es_path, test_es_txt)
@@ -143,10 +155,24 @@ def test_easystack_restore_env_after_each_build(self):
             '--easystack',
             test_es_path
         ]
-        stdout = self.eb_main(args, do_build=True, raise_error=True)
+        stdout = self.eb_main(args, do_build=True, raise_error=True, reset_env=False, redo_init_config=False)
         regex = re.compile(r"WARNING Loaded modules detected: \[.*gompi/2018.*\]\n")
         self.assertFalse(regex.search(stdout), "Pattern '%s' should not be found in: %s" % (regex.pattern, stdout))
 
+        # temporary directory after run should be exactly 2 levels deeper than original one:
+        # - 1 level added by setting up configuration in EasyBuild main function
+        # - 1 extra level added by first re-configuration for easystack item
+        #   (because $TMPDIR set by configuration done in main function is retained)
+        tmpdir_tempfile = tempfile.gettempdir()
+        tmpdir_env = os.getenv('TMPDIR')
+        tmpdir_tempfile_len = len(tmpdir_tempfile.split(os.path.sep))
+        tmpdir_env_len = len(tmpdir_env.split(os.path.sep))
+
+        self.assertEqual(tmpdir_tempfile_len, orig_tmpdir_tempfile_len + 2)
+        self.assertEqual(tmpdir_env_len, orig_tmpdir_env_len + 2)
+        self.assertTrue(tmpdir_tempfile.startswith(orig_tmpdir_tempfile))
+        self.assertTrue(tmpdir_env.startswith(orig_tmpdir_env))
+
     def test_missing_easyconfigs_key(self):
         """Test that EasyStack file that doesn't contain an EasyConfigs key will fail with sane error message"""
         topdir = os.path.dirname(os.path.abspath(__file__))