Add exit code

Author: John Nonweiler

scripts/filter_expected_warnings.py

@@ -29,6 +29,11 @@ def is_in_list(self, warnings_list):
                 return True
         return False
 
+    def print_with_prefix(self, prefix):
+        print(prefix + self.firstline)
+        for line in self.otherlines:
+            print(prefix + '  ' + line)
+
 
 def build_warnings_list(all_lines):
     """Create a list of the warnings in this file."""
@@ -70,6 +75,15 @@ def ignore_too_many_nodes(all_lines):
     return [x for x in all_lines if not too_many_nodes_expr.match(x)]
 
 
+def list1_is_in_list2(list1, list2, prefix):
+    missing_element_found = False
+    for warning in list1:
+        if not warning.is_in_list(list2):
+            missing_element_found = True
+            warning.print_with_prefix(prefix)
+    return missing_element_found
+
+
 def filter_expected_warnings(expected_warnings_path):
     """Filter lines from stdin and print to stdout."""
     with open(expected_warnings_path, "r") as warnings_file:
@@ -79,26 +93,27 @@ def filter_expected_warnings(expected_warnings_path):
         ignore_too_many_nodes(sys.stdin.readlines()))
 
     # print unexpected warnings
-    for warning in new_warnings:
-        if not warning.is_in_list(expected_warnings):
-            print(warning.firstline)
-            for line in warning.otherlines:
-                print('  ' + line)
+    unexpected_warning_found = list1_is_in_list2(
+        new_warnings, expected_warnings, '')
+
+    # print expected warnings which aren't found
+    expected_warning_not_found = list1_is_in_list2(
+        expected_warnings, new_warnings, '-')
+
+    if expected_warning_not_found:
+        print('NOTE: Warnings prefixed with \'-\' are expected ' +
+              'warnings which weren\'t found.')
+        print('      Please update the list of expected warnings.')
 
-    # complain if expected warnings aren't found
-    for warning in expected_warnings:
-        if not warning.is_in_list(new_warnings):
-            print('Expected warning not found:')
-            print('-' + warning.firstline)
-            for line in warning.otherlines:
-                print('-  ' + line)
+    return unexpected_warning_found or expected_warning_not_found
 
 
 if __name__ == "__main__":
 
     if len(sys.argv) != 2:
         print('usage: filter_expected_warnings.py <expected_warnings_file>')
         print('(warnings from stdin are filtered and printed to stdout)')
-        sys.exit()
+        sys.exit(1)
 
-    filter_expected_warnings(sys.argv[1])
+    problem_found = filter_expected_warnings(sys.argv[1])
+    sys.exit(1 if problem_found else 0)