Disable trace output by default in tests

This is usually not desired and requires frequent mocking of stdout
or repeated calls to `init_config` disabling "trace"

Author: Flamefire

test/framework/run.py

@@ -541,9 +541,6 @@ def test_run_shell_cmd_fail(self):
         def handler(signum, _):
             raise RuntimeError("Signal handler called with signal %s" % signum)
 
-        # disable trace output for this test (so stdout remains empty)
-        update_build_option('trace', False)
-
         orig_sigalrm_handler = signal.getsignal(signal.SIGALRM)
 
         try:
@@ -837,8 +834,6 @@ def test_run_cmd_trace(self):
         regex = re.compile('\n'.join(pattern))
         self.assertTrue(regex.search(stdout), "Pattern '%s' found in: %s" % (regex.pattern, stdout))
 
-        init_config(build_options={'trace': False})
-
         self.mock_stdout(True)
         self.mock_stderr(True)
         (out, ec) = run_cmd("echo hello")
@@ -851,8 +846,6 @@ def test_run_cmd_trace(self):
         self.assertTrue(stderr.strip().startswith("WARNING: Deprecated functionality"))
         self.assertEqual(stdout, '')
 
-        init_config(build_options={'trace': True})
-
         # also test with command that is fed input via stdin
         self.mock_stdout(True)
         self.mock_stderr(True)
@@ -869,8 +862,6 @@ def test_run_cmd_trace(self):
         regex = re.compile('\n'.join(pattern))
         self.assertTrue(regex.search(stdout), "Pattern '%s' found in: %s" % (regex.pattern, stdout))
 
-        init_config(build_options={'trace': False})
-
         self.mock_stdout(True)
         self.mock_stderr(True)
         (out, ec) = run_cmd('cat', inp='hello')
@@ -925,8 +916,6 @@ def test_run_shell_cmd_trace(self):
         regex = re.compile('\n'.join(pattern))
         self.assertTrue(regex.search(stdout), "Pattern '%s' found in: %s" % (regex.pattern, stdout))
 
-        init_config(build_options={'trace': False})
-
         self.mock_stdout(True)
         self.mock_stderr(True)
         res = run_shell_cmd("echo hello")
@@ -939,8 +928,6 @@ def test_run_shell_cmd_trace(self):
         self.assertEqual(stderr, '')
         self.assertEqual(stdout, '')
 
-        init_config(build_options={'trace': True})
-
         # trace output can be disabled on a per-command basis via 'hidden' option
         for trace in (True, False):
             init_config(build_options={'trace': trace})
@@ -2059,9 +2046,6 @@ def post_run_shell_cmd_hook(cmd, *args, **kwargs):
         write_file(hooks_file, hooks_file_txt)
         update_build_option('hooks', hooks_file)
 
-        # disable trace output to make checking of generated output produced by hooks easier
-        update_build_option('trace', False)
-
         with self.mocked_stdout_stderr():
             run_cmd("make")
             stdout = self.get_stdout()
@@ -2133,9 +2117,6 @@ def post_run_shell_cmd_hook(cmd, *args, **kwargs):
         write_file(hooks_file, hooks_file_txt)
         update_build_option('hooks', hooks_file)
 
-        # disable trace output to make checking of generated output produced by hooks easier
-        update_build_option('trace', False)
-
         with self.mocked_stdout_stderr():
             run_shell_cmd("make")
             stdout = self.get_stdout()

test/framework/toolchain.py

@@ -2023,8 +2023,7 @@ def test_old_new_iccifort(self):
         scalapack_mt_shared_libs_fosscuda = scalapack_mt_static_libs_fosscuda.replace('.a', '.' + shlib_ext)
 
         tc = self.get_toolchain('fosscuda', version='2018a')
-        with self.mocked_stdout_stderr():
-            tc.prepare()
+        tc.prepare()
         self.assertEqual(os.environ['BLAS_SHARED_LIBS'], blas_shared_libs_fosscuda)
         self.assertEqual(os.environ['BLAS_STATIC_LIBS'], blas_static_libs_fosscuda)
         self.assertEqual(os.environ['BLAS_MT_SHARED_LIBS'], blas_mt_shared_libs_fosscuda)
@@ -2116,8 +2115,7 @@ def test_old_new_iccifort(self):
         self.modtool.purge()
 
         tc = self.get_toolchain('intel', version='2018a')
-        with self.mocked_stdout_stderr():
-            tc.prepare()
+        tc.prepare()
         self.assertEqual(os.environ.get('BLAS_SHARED_LIBS', "(not set)"), blas_shared_libs_intel4)
         self.assertEqual(os.environ.get('BLAS_STATIC_LIBS', "(not set)"), blas_static_libs_intel4)
         self.assertEqual(os.environ.get('LAPACK_SHARED_LIBS', "(not set)"), blas_shared_libs_intel4)
@@ -2130,22 +2128,19 @@ def test_old_new_iccifort(self):
         self.modtool.purge()
 
         tc = self.get_toolchain('intel', version='2012a')
-        with self.mocked_stdout_stderr():
-            tc.prepare()
+        tc.prepare()
         self.assertEqual(os.environ.get('LIBBLAS_MT', "(not set)"), libblas_mt_intel3)
         self.assertIn(libscalack_intel3, os.environ['LIBSCALAPACK'])
         self.modtool.purge()
 
         tc = self.get_toolchain('intel', version='2018a')
-        with self.mocked_stdout_stderr():
-            tc.prepare()
+        tc.prepare()
         self.assertEqual(os.environ.get('LIBBLAS_MT', "(not set)"), libblas_mt_intel4)
         self.assertIn(libscalack_intel4, os.environ['LIBSCALAPACK'])
         self.modtool.purge()
 
         tc = self.get_toolchain('intel', version='2012a')
-        with self.mocked_stdout_stderr():
-            tc.prepare()
+        tc.prepare()
         self.assertEqual(os.environ.get('LIBBLAS_MT', "(not set)"), libblas_mt_intel3)
         self.assertIn(libscalack_intel3, os.environ['LIBSCALAPACK'])
         self.modtool.purge()
@@ -2154,15 +2149,13 @@ def test_old_new_iccifort(self):
         tc = self.get_toolchain('intel', version='2018a')
         opts = {'i8': True}
         tc.set_options(opts)
-        with self.mocked_stdout_stderr():
-            tc.prepare()
+        tc.prepare()
         self.assertIn(libscalack_intel4, os.environ['LIBSCALAPACK'])
         self.modtool.purge()
 
         tc = self.get_toolchain('fosscuda', version='2018a')
         tc.set_options({'openmp': True})
-        with self.mocked_stdout_stderr():
-            tc.prepare()
+        tc.prepare()
         self.assertEqual(os.environ['BLAS_SHARED_LIBS'], blas_shared_libs_fosscuda)
         self.assertEqual(os.environ['BLAS_STATIC_LIBS'], blas_static_libs_fosscuda)
         self.assertEqual(os.environ['BLAS_MT_SHARED_LIBS'], blas_mt_shared_libs_fosscuda)

test/framework/utilities.py

@@ -137,6 +137,8 @@ def setUp(self):
         # disable progress bars when running the tests,
         # since it messes with test suite progress output when test installations are performed
         os.environ['EASYBUILD_DISABLE_SHOW_PROGRESS_BAR'] = '1'
+        # Also disable trace output to keep stdout clean during tests
+        os.environ['EASYBUILD_DISABLE_TRACE'] = '1'
 
         # Store the environment as setup (including the above paths) for tests to restore
         self.orig_environ = copy.deepcopy(os.environ)
@@ -487,25 +489,24 @@ def init_config(args=None, build_options=None, with_include=True, clear_caches=T
     eb_go = eboptions.parse_options(args=args, with_include=with_include)
     config.init(eb_go.options, eb_go.get_options_by_section('config'))
 
-    # initialize build options
-    if build_options is None:
-        build_options = {}
-
-    default_build_options = {
+    # initialize default build options
+    options = {
         'extended_dry_run': False,
         'external_modules_metadata': ConfigObj(),
         'local_var_naming_check': 'error',
+        'show_progress_bar': False,
         'silence_deprecation_warnings': eb_go.options.silence_deprecation_warnings,
         'suffix_modules_path': GENERAL_CLASS,
+        'trace': False,
         'unit_testing_mode': True,
         'valid_module_classes': module_classes(),
         'valid_stops': [x[0] for x in EasyBlock.get_steps()],
     }
-    for key in default_build_options:
-        if key not in build_options:
-            build_options[key] = default_build_options[key]
 
-    config.init_build_options(build_options=build_options)
+    if build_options is not None:
+        options.update(build_options)
+
+    config.init_build_options(build_options=options)
 
     return eb_go.options