feat: add junit output callback

openhtf/output/callbacks/junit.py

@@ -0,0 +1,85 @@
+"""Module for outputting test record to JUNIT-formatted files."""
+
+import base64
+import six
+from junit_xml import TestSuite, TestCase
+
+from openhtf.output import callbacks
+from openhtf.util import data
+
+
+class OutputToJUNIT(callbacks.OutputToFile):
+  """Return an output callback that writes JUNIT Test Records.
+  Example filename_patterns might be:
+    '/data/test_records/{dut_id}.{metadata[test_name]}.xml', indent=4)) or
+    '/data/test_records/%(dut_id)s.%(start_time_millis)s'
+  To use this output mechanism:
+    test = openhtf.Test(PhaseOne, PhaseTwo)
+    test.add_output_callback(openhtf.output.callbacks.OutputToJUNIT(
+        '/data/test_records/{dut_id}.{metadata[test_name]}.xml'))
+
+  Args:
+    filename_pattern: A format string specifying the filename to write to,
+      will be formatted with the Test Record as a dictionary.  May also be a
+      file-like object to write to directly.
+    inline_attachments: Whether attachments should be included inline in the
+      output. Set to False if you expect to have large binary attachments. If
+      True (the default), then attachments are base64 encoded to allow for
+      binary data that's not supported by JUNIT directly.
+  """
+
+  def __init__(self, filename_pattern=None, **kwargs):
+    super(OutputToJUNIT, self).__init__(filename_pattern)
+    self.test_cases = []
+
+  def serialize_test_record(self, test_record):
+    dict_test_record = self.convert_to_dict(test_record)
+    test_case = None
+
+    for phase in dict_test_record["phases"]:
+      output = []
+      for _, phase_data in phase["measurements"].items():
+        log_output = []
+
+        for log_data in dict_test_record["log_records"]:
+          if phase["name"] in log_data["logger_name"]:
+            log_output.append(log_data["message"])
+
+        output.extend(["name: " + phase_data["name"],
+                       "validators: " + str(phase_data["validators"]),
+                       "measured_value: " + str(phase_data["measured_value"]),
+                       "outcome: " + phase_data["outcome"],
+                       "log: " + "\n".join(log_output), "\n"])
+
+      if phase["outcome"] == "PASS":
+        test_case = TestCase(phase["name"],
+                             dict_test_record["dut_id"] + "." +
+                             dict_test_record["metadata"]["test_name"],
+                             (phase["end_time_millis"] -
+                              phase["start_time_millis"]) / 1000,
+                             "\n".join(output),
+                             '')
+      else:
+        test_case = TestCase(phase["name"],
+                             dict_test_record["dut_id"] + "." +
+                             dict_test_record["metadata"]["test_name"],
+                             (phase["end_time_millis"] -
+                              phase["start_time_millis"]) / 1000,
+                             '',
+                             "\n".join(output))
+
+        test_case.add_failure_info("failure message")
+
+      self.test_cases.append(test_case)
+
+    return TestSuite.to_xml_string([TestSuite("test", self.test_cases)])
+
+  def convert_to_dict(self, test_record):
+    as_dict = data.convert_to_base_types(test_record)
+
+    for phase, original_phase in zip(as_dict['phases'], test_record.phases):
+      for name, attachment in six.iteritems(phase['attachments']):
+        original_data = original_phase.attachments[name].data
+        attachment['data'] = base64.standard_b64encode(
+            original_data).decode('utf-8')
+    return as_dict

setup.py

@@ -128,6 +128,7 @@ def run(self):
     'colorama>=0.3.9,<1.0',
     'contextlib2>=0.5.1,<1.0',
     'future>=0.16.0',
+    'junit-xml>=1.8.0',
     'mutablerecords>=0.4.1,<2.0',
     'oauth2client>=1.5.2,<2.0',
     'protobuf>=3.0.0,<4.0',