From d3f4673c1a1c3f5213840e756c5f35f7c70d46f6 Mon Sep 17 00:00:00 2001
From: Sebastiaan Zeeff <33516116+SebastiaanZ@users.noreply.github.com>
Date: Sun, 23 Feb 2020 12:39:25 +0100
Subject: Use mixin-composition not inheritance for LoggingTestCase

We used inheritence to add additional logging assertion methods to unittest's TestCase class. However, with the introduction of the new IsolatedAsyncioTestCase this extension strategy means we'd have to create multiple child classes to be able to use the extended functionality in all of the TestCase variants.

Since that leads to undesirable code reuse and an inheritance relationship is not at all needed, I've switched to a mixin-composition based approach that allows the user to extend the functionality of any TestCase variant with a mixin where needed.
---
 tests/base.py | 10 +++++++---
 1 file changed, 7 insertions(+), 3 deletions(-)

(limited to 'tests/base.py')

diff --git a/tests/base.py b/tests/base.py
index 029a249ed..21a57716a 100644
--- a/tests/base.py
+++ b/tests/base.py
@@ -1,5 +1,4 @@
 import logging
-import unittest
 from contextlib import contextmanager
 
 
@@ -16,8 +15,13 @@ class _CaptureLogHandler(logging.Handler):
         self.records.append(record)
 
 
-class LoggingTestCase(unittest.TestCase):
-    """TestCase subclass that adds more logging assertion tools."""
+class LoggingTestsMixin:
+    """
+    A mixin that defines additional test methods for logging behavior.
+
+    This mixin relies on the availability of the `fail` attribute defined by the
+    test classes included in Python's unittest method to signal test failure.
+    """
 
     @contextmanager
     def assertNotLogs(self, logger=None, level=None, msg=None):
-- 
cgit v1.2.3