Add a mock log handler to collect formatted log messages

Author: chr1st1ank

tests/conftest.py

@@ -0,0 +1,6 @@
+"""Global fixtures and settings for the pytest test suite"""
+import sys
+import os
+
+# Add test helper modules to search path with out making "tests" a Python package
+sys.path.append(os.path.join(os.path.dirname(__file__), "helpers"))

tests/helpers/handler.py

@@ -0,0 +1,20 @@
+import logging
+from typing import List
+
+
+class FormattedMessageCollectorHandler(logging.Handler):
+    """A logging handler that stores formatted log records in its "messages" attribute."""
+
+    def __init__(self, level=logging.NOTSET) -> None:
+        """Create a new log handler."""
+        super().__init__(level=level)
+        self.level = level
+        self.messages: List[str] = []
+
+    def emit(self, record: logging.LogRecord) -> None:
+        """Keep the log records in a list in addition to the log text."""
+        self.messages.append(self.format(record))
+
+    def reset(self) -> None:
+        """Empty the list of messages"""
+        self.messages = []