Support raw yaml block in tracker (#167)

* Update tracker.py

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* add yaml to result

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* add unit tests

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* add mocks

* fix unittests

* Update test_line.py

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* fix formatting and test

* Update test_line.py

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* remove indent variable

---------

Co-authored-by: Cody D'Ambrosio <cody.dambrosio@hpe.com>
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>

Author: 3 people

src/tap/line.py

@@ -111,7 +111,16 @@ def __str__(self):
         diagnostics = ""
         if self.diagnostics is not None:
             diagnostics = "\n" + self.diagnostics.rstrip()
-        return f"{is_not}ok {self.number} {self.description}{directive}{diagnostics}"
+        yaml_block = ""
+        if self._yaml_block is not None:
+            indented_yaml_block = "\n".join(
+                f" {line}" for line in self._yaml_block.splitlines()
+            )
+            yaml_block = f"\n ---\n{indented_yaml_block}\n ..."
+        return (
+            f"{is_not}ok {self.number} {self.description}{directive}"
+            f"{diagnostics}{yaml_block}"
+        )
 
 
 class Plan(Line):

src/tap/tracker.py

@@ -73,23 +73,39 @@ def _track(self, class_name):
             if self.combined:
                 self.combined_test_cases_seen.append(class_name)
 
-    def add_ok(self, class_name, description, directive="", diagnostics=None):
+    def add_ok(
+        self,
+        class_name,
+        description,
+        directive="",
+        diagnostics=None,
+        raw_yaml_block=None,
+    ):
         result = Result(
             ok=True,
             number=self._get_next_line_number(class_name),
             description=description,
             diagnostics=diagnostics,
             directive=Directive(directive),
+            raw_yaml_block=raw_yaml_block,
         )
         self._add_line(class_name, result)
 
-    def add_not_ok(self, class_name, description, directive="", diagnostics=None):
+    def add_not_ok(
+        self,
+        class_name,
+        description,
+        directive="",
+        diagnostics=None,
+        raw_yaml_block=None,
+    ):
         result = Result(
             ok=False,
             number=self._get_next_line_number(class_name),
             description=description,
             diagnostics=diagnostics,
             directive=Directive(directive),
+            raw_yaml_block=raw_yaml_block,
         )
         self._add_line(class_name, result)
 

tests/test_line.py

@@ -3,6 +3,14 @@
 from tap.directive import Directive
 from tap.line import Line, Result
 
+try:
+    import yaml  # noqa
+    from more_itertools import peekable  # noqa
+
+    have_yaml = True
+except ImportError:
+    have_yaml = False
+
 
 class TestLine(unittest.TestCase):
     """Tests for tap.line.Line"""
@@ -38,5 +46,19 @@ def test_str_directive(self):
         self.assertEqual("ok 44 passing # SKIP a reason", str(result))
 
     def test_str_diagnostics(self):
-        result = Result(False, 43, "failing", diagnostics="# more info")
-        self.assertEqual("not ok 43 failing\n# more info", str(result))
+        result = Result(False, 45, "failing", diagnostics="# more info")
+        self.assertEqual("not ok 45 failing\n# more info", str(result))
+
+    def test_yaml_block(self):
+        raw_yaml_block = """\
+message: test_message
+severity: fail
+"""
+        result = Result(False, 46, "passing", raw_yaml_block=raw_yaml_block)
+        if have_yaml:
+            self.assertEqual(result.yaml_block["message"], "test_message")
+            self.assertIn(
+                " ---\n message: test_message\n severity: fail\n ...", str(result)
+            )
+        else:
+            self.assertIsNone(result.yaml_block)

tests/test_tracker.py

@@ -7,6 +7,14 @@
 from tap.tests import TestCase
 from tap.tracker import Tracker
 
+try:
+    import yaml  # noqa
+    from more_itertools import peekable  # noqa
+
+    have_yaml = True
+except ImportError:
+    have_yaml = False
+
 
 class TestTracker(TestCase):
     def _make_header(self, test_case):
@@ -295,6 +303,38 @@ def test_adds_not_ok_with_diagnostics(self):
         line = tracker._test_cases["FakeTestCase"][0]
         self.assertEqual("# more info\n", line.diagnostics)
 
+    def test_adds_ok_with_yaml_block(self):
+        tracker = Tracker()
+        tracker.add_ok(
+            "FakeTestCase",
+            "a description",
+            raw_yaml_block="""\
+message: test_message
+severity: pass
+""",
+        )
+        line = tracker._test_cases["FakeTestCase"][0]
+        if have_yaml:
+            self.assertEqual("test_message", line.yaml_block["message"])
+        else:
+            self.assertIsNone(line.yaml_block)
+
+    def test_adds_not_ok_with_yaml_block(self):
+        tracker = Tracker()
+        tracker.add_not_ok(
+            "FakeTestCase",
+            "a description",
+            raw_yaml_block="""\
+message: test_message
+severity: fail
+""",
+        )
+        line = tracker._test_cases["FakeTestCase"][0]
+        if have_yaml:
+            self.assertEqual("test_message", line.yaml_block["message"])
+        else:
+            self.assertIsNone(line.yaml_block)
+
     def test_header_displayed_by_default(self):
         tracker = Tracker()
         self.assertTrue(tracker.header)