patchtest2: add logging support

This adds two mutually-exclusive flags:

- --log-results, for writing the same results as seen in STDOUT to file
- --log-json, for printing the Patchtest class' results member to file
  in json format

Also do a bit of reformatting and cleanup using black.

Signed-off-by: Trevor Gamblin <[email protected]>

Author: threexc

src/patchtest2/parser.py

@@ -23,13 +23,19 @@ def get_parser(cls):
         parser = argparse.ArgumentParser()
 
         target_patch_group = parser.add_mutually_exclusive_group(required=True)
+        log_type_group = parser.add_mutually_exclusive_group(required=False)
 
         target_patch_group.add_argument(
-            "--patch", metavar="PATCH", dest="patch_path", help="The patch to be tested"
+            "--patch",
+            action="store",
+            metavar="PATCH",
+            dest="patch_path",
+            help="The patch to be tested",
         )
 
         target_patch_group.add_argument(
             "--directory",
+            action="store",
             metavar="DIRECTORY",
             dest="patch_path",
             help="The directory containing patches to be tested",
@@ -60,10 +66,18 @@ def get_parser(cls):
             "--debug", "-d", action="store_true", help="Enable debug output"
         )
 
-        parser.add_argument(
+        log_type_group.add_argument(
             "--log-results",
+            dest="log_results",
             action="store_true",
             help='Enable logging to a file matching the target patch name with ".testresult" appended',
         )
 
+        log_type_group.add_argument(
+            "--log-json",
+            dest="log_json",
+            action="store_true",
+            help='Enable logging to a file matching the target patch name with ".testresult" appended, in json format',
+        )
+
         return parser

src/patchtest2/tests/core.py

@@ -4,6 +4,7 @@
 import unidiff
 from patchtest2.tests.results import patchtest_result
 
+
 @patchtest_result
 def test_mbox_has_signed_off_by(target):
     result = "FAIL"
@@ -12,6 +13,7 @@ def test_mbox_has_signed_off_by(target):
     reason = "mbox was missing a signed-off-by tag"
     return target.subject, result, reason
 
+
 @patchtest_result
 def test_mbox_shortlog_format(target):
     result = "PASS"
@@ -32,6 +34,7 @@ def test_mbox_shortlog_format(target):
 
     return target.subject, result, reason
 
+
 @patchtest_result
 def test_mbox_shortlog_length(target):
     shortlog = re.sub("^(\[.*?\])+ ", "", target.shortlog)
@@ -48,6 +51,7 @@ def test_mbox_shortlog_length(target):
 
     return target.subject, result, reason
 
+
 @patchtest_result
 def test_mbox_has_commit_message(target):
     result = "PASS"
@@ -66,6 +70,7 @@ def test_mbox_has_commit_message(target):
 
     return target.subject, result, reason
 
+
 @patchtest_result
 def test_mbox_unidiff_parse_error(target):
     result = "PASS"

src/patchtest2/tests/patchtest.py

@@ -1,13 +1,20 @@
 import inspect
+import json
+import os
 import patchtest2.tests.core as core
 from patchtest2.parser import PatchtestParser
 from patchtest2.mbox import PatchSeries, TargetRepo
 
+
 class Patchtest:
     def __init__(self, target_repo, series):
         self.target_repo = target_repo
         self.series = series
-        self.core_results = {k: self._results(v) for (k, v) in inspect.getmembers(core, inspect.isfunction) if k != "patchtest_result"}
+        self.core_results = {
+            k: self._results(v)
+            for (k, v) in inspect.getmembers(core, inspect.isfunction)
+            if k != "patchtest_result"
+        }
 
         self.results = dict(
             [
@@ -33,6 +40,26 @@ def print_results(self):
         for category in self.results.keys():
             self._print_results(category)
 
+    def _log_results(self, logfile):
+        result_str = ""
+        for category in self.results.keys():
+            for tag in self.results[category].keys():
+                for value in self.results[category][tag]:
+                    result_str += value + "\n"
+
+        with open(logfile + ".testresult", "w") as f:
+            f.write(result_str)
+
+    def _log_json(self, logfile):
+        with open(logfile + ".testresult", "w") as f:
+            f.write(json.dumps(self.results, indent=4, sort_keys=True))
+
+    def log_results(self, logfile, mode=None):
+        if mode == "json":
+            self._log_json(logfile)
+        else:
+            self._log_results(logfile)
+
 
 def run():
     parser = PatchtestParser.get_parser()
@@ -42,3 +69,8 @@ def run():
     results = Patchtest(target_repo, series)
 
     results.print_results()
+    if args.log_json:
+        results.log_results(os.path.basename(args.patch_path), mode="json")
+
+    if args.log_results:
+        results.log_results(os.path.basename(args.patch_path))

src/patchtest2/tests/results.py

@@ -1,6 +1,7 @@
 import inspect
 import functools
 
+
 def patchtest_result(func):
     @functools.wraps(func)
     def wrapper(*args, **kwargs):
@@ -9,5 +10,5 @@ def wrapper(*args, **kwargs):
             return f"{result}: {func.__name__} on {subject}"
         else:
             return f"{result}: {func.__name__} on {subject} ({reason})"
-    return wrapper
 
+    return wrapper