[lit] [PATCH 1/2] Specify a common interface in a common base class for all report types

[gbedwell]

Summary

This is just a simple NFCI refactor in preparation for [PATCH 2/2]

[haowei]

LGTM. Please wait for the approval from @yln .

[yln]

LGTM, thanks!

• 1 whitespace nit
• abc package available everywhere? If not, can we do without?

llvm/utils/lit/lit/reports.py

1

Please make sure this is a "default" Python package. Otherwise it might not be available in every environment lit runs.

10

Python lint says top level elements should be separated by 2 lines *shrug*

llvm/utils/lit/lit/reports.py

+import abc
 import base64
 import datetime
 import itertools
 import json
 
 from xml.sax.saxutils import quoteattr as quo
 
 import lit.Test
 
-
 def by_suite_and_test_path(test):
     # Suite names are not necessarily unique.  Include object identity in sort
     # key to avoid mixing tests of different suites.
     return (test.suite.name, id(test.suite), test.path_in_suite)
 
 
-class JsonReport(object):
+class _ReportBase(abc.ABC):
     def __init__(self, output_file):
         self.output_file = output_file
+        self.skipped_codes = {lit.Test.EXCLUDED,
+                              lit.Test.SKIPPED, lit.Test.UNSUPPORTED}
+
+    @abc.abstractmethod
+    def write_results(self, tests, elapsed):
+        ...
 
+
+class JsonReport(_ReportBase):
     def write_results(self, tests, elapsed):
         unexecuted_codes = {lit.Test.EXCLUDED, lit.Test.SKIPPED}
         tests = [t for t in tests if t.result.code not in unexecuted_codes]
         # Construct the data we will write.
         data = {}
         # Encode the current lit version as a schema version.
         data['__version__'] = lit.__versioninfo__
         data['elapsed'] = elapsed
def remove_invalid_xml_chars(s):
     # (https://www.w3.org/TR/xml/#charsets) and therefore this function
     # removes them to produce a valid XML document.
     #
     # Note: In XML 1.1 only \0 is illegal (https://www.w3.org/TR/xml11/#charsets)
     # but lit currently produces XML 1.0 output.
     return s.translate(_invalid_xml_chars_dict)
 
 
-class XunitReport(object):
-    def __init__(self, output_file):
-        self.output_file = output_file
-        self.skipped_codes = {lit.Test.EXCLUDED,
-                              lit.Test.SKIPPED, lit.Test.UNSUPPORTED}
-
+class XunitReport(_ReportBase):
     def write_results(self, tests, elapsed):
         tests.sort(key=by_suite_and_test_path)
         tests_by_suite = itertools.groupby(tests, lambda t: t.suite)
 
         with open(self.output_file, 'w') as file:
             file.write('<?xml version="1.0" encoding="UTF-8"?>\n')
             file.write('<testsuites time="{time:.2f}">\n'.format(time=elapsed))
             for suite, test_iter in tests_by_suite:
elif (
         or result_code == lit.Test.EXCLUDED
     ):
         test_data['status'] = 'SKIP'
     elif result_code == lit.Test.UNRESOLVED or result_code == lit.Test.TIMEOUT:
         test_data['status'] = 'ABORT'
     return test_data
 
 
-class ResultDBReport(object):
-    def __init__(self, output_file):
-        self.output_file = output_file
-
+class ResultDBReport(_ReportBase):
     def write_results(self, tests, elapsed):
         unexecuted_codes = {lit.Test.EXCLUDED, lit.Test.SKIPPED}
         tests = [t for t in tests if t.result.code not in unexecuted_codes]
         data = {}
         data['__version__'] = lit.__versioninfo__
         data['elapsed'] = elapsed
         # Encode the tests.
         data['tests'] = tests_data = []
def write_results(self, tests, elapsed):
                         )
                     )
 
         with open(self.output_file, 'w') as file:
             json.dump(data, file, indent=2, sort_keys=True)
             file.write('\n')
 
 
-class TimeTraceReport(object):
-    def __init__(self, output_file):
-        self.output_file = output_file
-        self.skipped_codes = {lit.Test.EXCLUDED,
-                              lit.Test.SKIPPED, lit.Test.UNSUPPORTED}
-
+class TimeTraceReport(_ReportBase):
     def write_results(self, tests, elapsed):
+        del elapsed
+
         # Find when first test started so we can make start times relative.
         first_start_time = min([t.result.start for t in tests])
         events = [self._get_test_event(
             x, first_start_time) for x in tests if x.result.code not in self.skipped_codes]
 
         json_data = {'traceEvents': events}
 
         with open(self.output_file, "w") as time_trace_file: