Rework, rename Python3TestResult

As the module name suggests, this is a test "double" for the stdlib
unittest.TestResult that logs calls. Make it inherit from the test case
so we can see this at a typing level.

Signed-off-by: Stephen Finucane <stephen@that.guru>

Author: stephenfin

doc/for-framework-folk.rst

@@ -362,7 +362,7 @@ Test Doubles
 ------------
 
 In testtools.testresult.doubles there are several test doubles that testtools
-uses for its own testing: ``Python3TestResult``, and ``ExtendedTestResult``.
+uses for its own testing: ``LoggingTestResult``, and ``ExtendedTestResult``.
 These TestResult objects implement a single variation of
 the TestResult API each, and log activity to a list ``self._events``. These are
 made available for the convenience of people writing their own extensions.

tests/test_testcase.py

@@ -48,7 +48,8 @@
 )
 from testtools.testresult.doubles import (
     ExtendedTestResult,
-    Python3TestResult,
+    LogEvent,
+    TestResult,
 )
 
 from .helpers import (
@@ -1270,7 +1271,7 @@ def test(self):
 
     def test_raising__UnexpectedSuccess_py3(self):
         case = self.make_unexpected_case()
-        result = Python3TestResult()
+        result = TestResult()
         case.run(result)
         case = result._events[0][1]
         self.assertEqual(
@@ -1775,8 +1776,8 @@ class SkippingTest(TestCase):
             def test_that_raises_skipException(self):
                 self.skipTest("skipping this test")
 
-        events: list[tuple[str, ...]] = []
-        result = Python3TestResult(events)
+        events: list[LogEvent] = []
+        result = TestResult(events)
         test = SkippingTest("test_that_raises_skipException")
         test.run(result)
         case = result._events[0][1]
@@ -1796,8 +1797,8 @@ class SkippingTest(TestCase):
             def test_that_raises_skipException(self):
                 self.skipTest("skipping this test")
 
-        events: list[tuple[str, ...]] = []
-        result = Python3TestResult(events)
+        events: list[LogEvent] = []
+        result = TestResult(events)
         test = SkippingTest("test_that_raises_skipException")
         test.run(result)
         case = result._events[0][1]
@@ -1819,8 +1820,8 @@ def setUp(self):
             def test_that_raises_skipException(self):
                 pass
 
-        events: list[tuple[str, ...]] = []
-        result = Python3TestResult(events)
+        events: list[LogEvent] = []
+        result = TestResult(events)
         test = SkippingTest("test_that_raises_skipException")
         test.run(result)
         self.assertEqual("addSkip", events[1][0])
@@ -1830,8 +1831,8 @@ class SkippingTest(TestCase):
             def test_that_raises_skipException(self):
                 raise self.skipException("skipping this test")
 
-        events: list[tuple[str, ...]] = []
-        result = Python3TestResult(events)
+        events: list[LogEvent] = []
+        result = TestResult(events)
         test = SkippingTest("test_that_raises_skipException")
         test.run(result)
         self.assertEqual("addSkip", events[1][0])
@@ -1842,8 +1843,8 @@ class SkippingTest(TestCase):
             def test_that_is_decorated_with_skip(self):
                 self.fail()
 
-        events: list[tuple[str, ...]] = []
-        result = Python3TestResult(events)
+        events: list[LogEvent] = []
+        result = TestResult(events)
         test = SkippingTest("test_that_is_decorated_with_skip")
         test.run(result)
         self.assertEqual("addSkip", events[1][0])
@@ -1854,8 +1855,8 @@ class SkippingTest(TestCase):
             def test_that_is_decorated_with_skipIf(self):
                 self.fail()
 
-        events: list[tuple[str, ...]] = []
-        result = Python3TestResult(events)
+        events: list[LogEvent] = []
+        result = TestResult(events)
         test = SkippingTest("test_that_is_decorated_with_skipIf")
         test.run(result)
         self.assertEqual("addSkip", events[1][0])
@@ -1866,8 +1867,8 @@ class SkippingTest(TestCase):
             def test_that_is_decorated_with_skipUnless(self):
                 self.fail()
 
-        events: list[tuple[str, ...]] = []
-        result = Python3TestResult(events)
+        events: list[LogEvent] = []
+        result = TestResult(events)
         test = SkippingTest("test_that_is_decorated_with_skipUnless")
         test.run(result)
         self.assertEqual("addSkip", events[1][0])
@@ -1882,14 +1883,14 @@ class SkippingTest(TestCase):
         class NotSkippingTest(TestCase):
             test_no_skip = skipIf(False, "skipping this test")(shared)
 
-        events: list[tuple[str, ...]] = []
-        result = Python3TestResult(events)
+        events: list[LogEvent] = []
+        result = TestResult(events)
         test = SkippingTest("test_skip")
         test.run(result)
         self.assertEqual("addSkip", events[1][0])
 
-        events2: list[tuple[str, ...]] = []
-        result2 = Python3TestResult(events2)
+        events2: list[LogEvent] = []
+        result2 = TestResult(events2)
         test2 = NotSkippingTest("test_no_skip")
         test2.run(result2)
         self.assertEqual("addFailure", events2[1][0])
@@ -1900,8 +1901,8 @@ class SkippingTest(TestCase):
             def test_that_is_decorated_with_skip(self):
                 self.fail()
 
-        events: list[tuple[str, ...]] = []
-        result = Python3TestResult(events)
+        events: list[LogEvent] = []
+        result = TestResult(events)
         try:
             test = SkippingTest("test_that_is_decorated_with_skip")
         except unittest.SkipTest:
@@ -1915,8 +1916,8 @@ class SkippingTest(TestCase):
             def test_that_is_decorated_with_skipIf(self):
                 self.fail()
 
-        events: list[tuple[str, ...]] = []
-        result = Python3TestResult(events)
+        events: list[LogEvent] = []
+        result = TestResult(events)
         try:
             test = SkippingTest("test_that_is_decorated_with_skipIf")
         except unittest.SkipTest:
@@ -1930,8 +1931,8 @@ class SkippingTest(TestCase):
             def test_that_is_decorated_with_skipUnless(self):
                 self.fail()
 
-        events: list[tuple[str, ...]] = []
-        result = Python3TestResult(events)
+        events: list[LogEvent] = []
+        result = TestResult(events)
         try:
             test = SkippingTest("test_that_is_decorated_with_skipUnless")
         except unittest.SkipTest:
@@ -2024,7 +2025,7 @@ def method(self):
         self.assertThat(events, Equals([True]))
 
     def test_added_handler_works(self):
-        events: list[tuple[str, ...]] = []
+        events: list[LogEvent] = []
 
         class Case(TestCase):
             def method(self):
@@ -2036,7 +2037,7 @@ def method(self):
         self.assertThat(events, Equals([an_exc_info]))
 
     def test_handler_that_raises_is_not_caught(self):
-        events: list[tuple[str, ...]] = []
+        events: list[LogEvent] = []
 
         class Case(TestCase):
             def method(self):

tests/test_testresult.py

@@ -64,13 +64,13 @@
 )
 from testtools.testresult.doubles import (
     ExtendedTestResult,
-    Python3TestResult,
     TwistedTestResult,
     _StatusEvent,
 )
 from testtools.testresult.doubles import (
     StreamResult as LoggingStreamResult,
 )
+from testtools.testresult.doubles import TestResult as LoggingTestResult
 from testtools.testresult.real import (
     _details_to_str,
     _merge_tags,
@@ -470,14 +470,14 @@ def makeResult(self):
         return ExtendedTestResult()
 
 
-class TestPython3TestResultContract(TestCase, Python3Contract):
+class TestLoggingTestResultContract(TestCase, Python3Contract):
     def makeResult(self):
-        return Python3TestResult()
+        return LoggingTestResult()
 
 
-class TestAdaptedPython3TestResultContract(TestCase, DetailsContract):
+class TestAdaptedLoggingTestResultContract(TestCase, DetailsContract):
     def makeResult(self):
-        return ExtendedToOriginalDecorator(Python3TestResult())
+        return ExtendedToOriginalDecorator(LoggingTestResult())
 
 
 class TestAdaptedTwistedTestResultContract(TestCase, DetailsContract):
@@ -497,21 +497,21 @@ def makeResult(self):
         return TestResultDecorator(TestResult())
 
 
-class TestPython3TestResultDuration(TestCase):
-    """Tests for addDuration functionality in Python3TestResult."""
+class TestLoggingTestResultDuration(TestCase):
+    """Tests for addDuration functionality in LoggingTestResult."""
 
     def test_addDuration_logging(self):
-        # Python3TestResult should log addDuration calls
-        result = Python3TestResult()
+        # LoggingTestResult should log addDuration calls
+        result = LoggingTestResult()
         test = make_erroring_test()
 
         result.addDuration(test, 1.5)
         expected_call = ("addDuration", test, 1.5)
         self.assertIn(expected_call, result._events)
 
     def test_addDuration_stores_in_collectedDurations(self):
-        # Python3TestResult should store durations in collectedDurations
-        result = Python3TestResult()
+        # LoggingTestResult should store durations in collectedDurations
+        result = LoggingTestResult()
         test = make_erroring_test()
 
         result.addDuration(test, 2.3)
@@ -2896,7 +2896,7 @@ def testStopTestRun(self):
 
 class TestExtendedToOriginalResultDecoratorBase(TestCase):
     def make_result(self):
-        self.result = Python3TestResult()
+        self.result = LoggingTestResult()
         self.make_converter()
 
     def make_converter(self):

tests/test_testsuite.py

@@ -15,7 +15,7 @@
     iterate_tests,
 )
 from testtools.matchers import DocTestMatches, Equals
-from testtools.testresult.doubles import StreamResult as LoggingStream
+from testtools.testresult.doubles import StreamResult
 from testtools.testsuite import FixtureSuite, sorted_tests
 
 from .helpers import LoggingResult
@@ -106,7 +106,7 @@ def split_suite(self, suite):
 
 class TestConcurrentStreamTestSuiteRun(TestCase):
     def test_trivial(self):
-        result = LoggingStream()
+        result = StreamResult()
         test1 = Sample("test_method1")
         test2 = Sample("test_method2")
 
@@ -196,7 +196,7 @@ def __call__(self):
             def run(self):
                 pass
 
-        result = LoggingStream()
+        result = StreamResult()
 
         def cases():
             return [(BrokenTest(), "0")]

testtools/runtest.py

@@ -112,7 +112,7 @@ def _run_one(self, result: "TestResult") -> "TestResult":
         """
         return self._run_prepared_result(ExtendedToOriginalDecorator(result))  # type: ignore[arg-type]
 
-    def _run_prepared_result(self, result: "TestResult") -> "TestResult":
+    def _run_prepared_result(self, result: TestResult) -> TestResult:
         """Run one test reporting to result.
 
         :param result: A testtools.TestResult to report activity to.
@@ -189,7 +189,7 @@ def _run_core(self) -> None:
                             self.case, details=self.case.getDetails()
                         )
 
-    def _run_cleanups(self, result: "TestResult") -> object | None:
+    def _run_cleanups(self, result: TestResult) -> object | None:
         """Run the cleanups that have been added with addCleanup.
 
         See the docstring for addCleanup for more information.