Adress review comments

Rename variables
Accept only strings not compiled regExps
Split function in 2 for reuse

Author: Flamefire

easybuild/tools/run.py

@@ -591,57 +591,56 @@ def parse_log_for_error(txt, regExp=None, stdout=True, msg=None):
     return res
 
 
-def check_log_for_errors(logTxt, regExps):
+def extract_errors_from_log(log_txt, reg_exps):
     """
-    Check logTxt for messages matching regExps in order and do appropriate action
-    :param logTxt: String containing the log, will be split into individual lines
-    :param regExps: List of: regular expressions (as RE or string) to error on,
+    Check log_txt for messages matching regExps and return warnings and errors
+    :param log_txt: String containing the log, will be split into individual lines
+    :param reg_exps: List of: regular expressions (as strings) to error on,
                     or tuple of regular expression and action (any of [IGNORE, WARN, ERROR])
+    :return (warnings, errors) as lists of lines containing a match
     """
-    global errors_found_in_log
-
-    def is_regexp_object(objToTest):
-        try:
-            objToTest.match('')
-            return True
-        except AttributeError:
-            return False
 
     # Avoid accidentally passing a single element
-    assert isinstance(regExps, list), "regExps must be a list"
-    regExpTuples = []
-    for cur in regExps:
+    assert isinstance(reg_exps, list), "reg_exps must be a list"
+    re_tuples = []
+    for cur in reg_exps:
         try:
             if isinstance(cur, str):
-                regExpTuples.append((re.compile(cur), ERROR))
-            elif is_regexp_object(cur):
-                regExpTuples.append((cur, ERROR))
-            elif len(cur) != 2:
-                raise TypeError("Invalid tuple")
-            elif not isinstance(cur[0], str) and not is_regexp_object(cur[0]):
-                raise TypeError("Invalid RegExp in tuple")
-            elif cur[1] not in (IGNORE, WARN, ERROR):
-                raise TypeError("Invalid action in tuple")
+                reg_exp, action = cur, ERROR
             else:
-                regExpTuples.append((re.compile(cur[0]) if isinstance(cur[0], str) else cur[0], cur[1]))
-        except TypeError:
-            raise EasyBuildError("Invalid input: No RegExp or tuple of RegExp and action: %s" % str(cur))
+                reg_exp, action = cur
+            if not isinstance(reg_exp, str) or action not in (IGNORE, WARN, ERROR):
+                raise TypeError("Invalid types")
+            re_tuples.append((re.compile(reg_exp), action))
+        except Exception as e:
+            raise EasyBuildError("Invalid input: No RegExp or tuple of RegExp and action '%s' (%s)", str(cur), e)
     warnings = []
     errors = []
-    for l in logTxt.split('\n'):
-        for regExp, action in regExpTuples:
-            m = regExp.search(l)
-            if m:
+    for line in log_txt.split('\n'):
+        for reg_exp, action in re_tuples:
+            if reg_exp.search(line):
                 if action == ERROR:
-                    errors.append(l)
+                    errors.append(line)
                 elif action == WARN:
-                    warnings.append(l)
+                    warnings.append(line)
                 break
+    return warnings, errors
+
+
+def check_log_for_errors(log_txt, reg_exps):
+    """
+    Check log_txt for messages matching regExps in order and do appropriate action
+    :param log_txt: String containing the log, will be split into individual lines
+    :param reg_exps: List of: regular expressions (as strings) to error on,
+                    or tuple of regular expression and action (any of [IGNORE, WARN, ERROR])
+    """
+    global errors_found_in_log
+    warnings, errors = extract_errors_from_log(log_txt, reg_exps)
+
     errors_found_in_log += len(warnings) + len(errors)
     if warnings:
-        _log.warning("Found %s potential errors in command output (output: %s)" %
-                     (len(warnings), ", ".join(warnings)))
+        _log.warning("Found %s potential error(s) in command output (output: %s)",
+                     len(warnings), ", ".join(warnings))
     if errors:
-        raise EasyBuildError("Found %s errors in command output (output: %s)" %
-                             (len(errors), ", ".join(errors)))
-
+        raise EasyBuildError("Found %s error(s) in command output (output: %s)",
+                             len(errors), ", ".join(errors))

test/framework/run.py

@@ -526,40 +526,31 @@ def test_check_log_for_errors(self):
             "enabling -Werror",
             "the process crashed with 0"
         ])
-        expected_error_msg = r"Found 2 errors in command output \(output: error found, the process crashed with 0\)"
+        expected_error_msg = r"Found 2 error\(s\) in command output \(output: error found, the process crashed with 0\)"
 
         self.assertErrorRegex(EasyBuildError, expected_error_msg, check_log_for_errors, input_text,
                               [r"\b(error|crashed)\b"])
-        self.assertErrorRegex(EasyBuildError, expected_error_msg, check_log_for_errors, input_text,
-                              [re.compile(r"\b(error|crashed)\b")])
         self.assertErrorRegex(EasyBuildError, expected_error_msg, check_log_for_errors, input_text,
                               [(r"\b(error|crashed)\b", ERROR)])
-        self.assertErrorRegex(EasyBuildError, expected_error_msg, check_log_for_errors, input_text,
-                              [(re.compile(r"\b(error|crashed)\b"), ERROR)])
 
-        expected_error_msg = "Found 2 potential errors in command output " \
+        expected_error_msg = "Found 2 potential error(s) in command output " \
                              "(output: error found, the process crashed with 0)"
         init_logging(logfile, silent=True)
         check_log_for_errors(input_text, [(r"\b(error|crashed)\b", WARN)])
         stop_logging(logfile)
         self.assertTrue(expected_error_msg in read_file(logfile))
-        write_file(logfile, '')
-        init_logging(logfile, silent=True)
-        check_log_for_errors(input_text, [(re.compile(r"\b(error|crashed)\b"), WARN)])
-        stop_logging(logfile)
-        self.assertTrue(expected_error_msg in read_file(logfile))
 
-        expected_error_msg = r"Found 2 errors in command output \(output: error found, test failed\)"
+        expected_error_msg = r"Found 2 error\(s\) in command output \(output: error found, test failed\)"
         write_file(logfile, '')
         init_logging(logfile, silent=True)
         self.assertErrorRegex(EasyBuildError, expected_error_msg, check_log_for_errors, input_text, [
             r"\berror\b",
             (r"\ballowed-test failed\b", IGNORE),
-            (re.compile(r"\bCRASHED\b", re.I), WARN),
+            (r"(?i)\bCRASHED\b", WARN),
             "fail"
         ])
         stop_logging(logfile)
-        expected_error_msg = "Found 1 potential errors in command output (output: the process crashed with 0)"
+        expected_error_msg = "Found 1 potential error(s) in command output (output: the process crashed with 0)"
         self.assertTrue(expected_error_msg in read_file(logfile))