Work in review

Author: Flamefire

easybuild/framework/easyblock.py

@@ -1816,14 +1816,16 @@ def remove_module_file(self):
             self.log.info("Removing existing module file %s", self.mod_filepath)
             remove_file(self.mod_filepath)
 
-    def report_test_failure(self, msgOrError):
-        """Report a failing test either via an exception or warning depending on ignore-test-failure
+    def report_test_failure(self, msg_or_error):
+        """
+        Report a failing test either via an exception or warning depending on ignore-test-failure
 
-        msgOrError - Failure description. Either a string or an EasyBuildError"""
+        :param msg_or_error: failure description (string value or an EasyBuildError instance)
+        """
         if self.ignore_test_failure:
-            print_warning("Test failure ignored: " + str(msgOrError), log=self.log)
+            print_warning("Test failure ignored: " + str(msg_or_error), log=self.log)
         else:
-            exception = msgOrError if isinstance(msgOrError, EasyBuildError) else EasyBuildError(msgOrError)
+            exception = msg_or_error if isinstance(msg_or_error, EasyBuildError) else EasyBuildError(msg_or_error)
             raise exception
 
     #
@@ -2245,8 +2247,8 @@ def _test_step(self):
         """Run the test_step and handles failures"""
         try:
             self.test_step()
-        except EasyBuildError as e:
-            self.report_test_failure(e)
+        except EasyBuildError as err:
+            self.report_test_failure(err)
 
     def stage_install_step(self):
         """
@@ -3384,7 +3386,7 @@ def run_step(self, step, step_methods):
         for step_method in step_methods:
             # Remove leading underscore from e.g. "_test_step"
             method_name = extract_method_name(step_method).lstrip('_')
-            self.log.info("Running method %s part of step %s" % (method_name, step))
+            self.log.info("Running method %s part of step %s", method_name, step)
 
             if self.dry_run:
                 self.dry_run_msg("[%s method]", method_name)

easybuild/main.py

@@ -307,7 +307,7 @@ def main(args=None, logfile=None, do_build=None, testing=False, modtool=None):
 
     if options.skip_test_step:
         if options.ignore_test_failure:
-            raise EasyBuildError("Found both ignore-test-failure and skip-test-step being set. "
+            raise EasyBuildError("Found both ignore-test-failure and skip-test-step enabled. "
                                  "Please use only one of them.")
         else:
             print_warning("Will not run the test step as requested via skip-test-step. "

test/framework/options.py

@@ -398,6 +398,7 @@ def test_ignore_test_failure(self):
         """Test ignore failing tests (--ignore-test-failure)."""
 
         topdir = os.path.abspath(os.path.dirname(__file__))
+        # This EC uses a `runtest` command which does not exist and hence will make the test step fail
         toy_ec = os.path.join(topdir, 'easyconfigs', 'test_ecs', 't', 'toy', 'toy-0.0-test.eb')
 
         args = [toy_ec, '--ignore-test-failure', '--force']
@@ -407,13 +408,13 @@ def test_ignore_test_failure(self):
 
         msg = 'Test failure ignored'
         self.assertTrue(re.search(msg, outtxt),
-                        "Ignored test failure message in log not found, outtxt: %s" % outtxt)
+                        "Ignored test failure message in log should be found, outtxt: %s" % outtxt)
         self.assertTrue(re.search(msg, stderr.getvalue()),
-                        "Ignored test failure message in stderr not found, stderr: %s" % stderr.getvalue())
+                        "Ignored test failure message in stderr should be found, stderr: %s" % stderr.getvalue())
 
         # Passing skip and ignore options is disallowed
         args.append('--skip-test-step')
-        error_pattern = 'Found both ignore-test-failure and skip-test-step being set'
+        error_pattern = 'Found both ignore-test-failure and skip-test-step enabled'
         self.assertErrorRegex(EasyBuildError, error_pattern, self.eb_main, args, do_build=True, raise_error=True)
 
     def test_job(self):