add diagnostics to ok test (#148)

Co-authored-by: Cody D'Ambrosio <[email protected]>

AUTHORS

@@ -7,6 +7,7 @@ Contributors
 * Allison Karlitskaya
 * Andrew McNamara
 * Chris Clarke
+* Cody D'Ambrosio
 * Erik Cederstrand
 * Marc Abramowitz
 * Mark E. Hamilton

docs/releases.rst

@@ -18,6 +18,7 @@ Version 3.2, To Be Released
 * Add support for Python 3.11.
 * Add support for Python 3.12.
 * Add support for Python 3.13.
+* Add support for adding diagnostics to ok test
 
 Version 3.1, Released December 29, 2021
 ---------------------------------------

src/tap/tracker.py

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

tests/test_tracker.py

@@ -283,6 +283,12 @@ def test_sanitizes_tap_file_path(self):
         file_path = tracker._get_tap_file_path("an awful \\ testcase / name\n")
         self.assertEqual("an-awful---testcase---name-.tap", file_path)
 
+    def test_adds_ok_with_diagnostics(self):
+        tracker = Tracker()
+        tracker.add_ok("FakeTestCase", "a description", diagnostics="# more info\n")
+        line = tracker._test_cases["FakeTestCase"][0]
+        self.assertEqual("# more info\n", line.diagnostics)
+
     def test_adds_not_ok_with_diagnostics(self):
         tracker = Tracker()
         tracker.add_not_ok("FakeTestCase", "a description", diagnostics="# more info\n")