add tests to get cov of testing.py

Author: rmorshea

src/idom/testing.py

@@ -179,7 +179,7 @@ class LogAssertionError(AssertionError):
 
 
 @contextmanager
-def assert_idom_did_log(
+def assert_idom_logged(
     match_message: str = "",
     error_type: type[Exception] | None = None,
     match_error: str = "",
@@ -247,9 +247,9 @@ def assert_idom_did_not_log(
     match_error: str = "",
     clear_matched_records: bool = False,
 ) -> Iterator[None]:
-    """Assert the inverse of :func:`assert_idom_did_log`"""
+    """Assert the inverse of :func:`assert_idom_logged`"""
     try:
-        with assert_idom_did_log(
+        with assert_idom_logged(
             match_message, error_type, match_error, clear_matched_records
         ):
             yield None
@@ -297,11 +297,15 @@ def capture_idom_logs(use_existing: bool = False) -> Iterator[list[logging.LogRe
                 return None
 
     handler = _LogRecordCaptor()
+    original_level = ROOT_LOGGER.level
+
+    ROOT_LOGGER.setLevel(logging.DEBUG)
     ROOT_LOGGER.addHandler(handler)
     try:
         yield handler.records
     finally:
         ROOT_LOGGER.removeHandler(handler)
+        ROOT_LOGGER.setLevel(original_level)
 
 
 class _LogRecordCaptor(logging.NullHandler):
@@ -314,9 +318,6 @@ def handle(self, record: logging.LogRecord) -> bool:
         return True
 
 
-_LOG_RECORD_CAPTOR_SINGLTON = _LogRecordCaptor()
-
-
 class HookCatcher:
     """Utility for capturing a LifeCycleHook from a component
 

tests/test_core/test_hooks.py

@@ -6,7 +6,7 @@
 import idom
 from idom.core.dispatcher import render_json_patch
 from idom.core.hooks import LifeCycleHook
-from idom.testing import HookCatcher, assert_idom_did_log
+from idom.testing import HookCatcher, assert_idom_logged
 from tests.general_utils import assert_same_items
 
 
@@ -590,7 +590,7 @@ def bad_cleanup():
 
         return idom.html.div()
 
-    with assert_idom_did_log(
+    with assert_idom_logged(
         match_message=r"Pre-unmount effect .*? failed",
         error_type=ValueError,
     ):

tests/test_core/test_layout.py

@@ -13,7 +13,7 @@
 from idom.testing import (
     HookCatcher,
     StaticEventHandler,
-    assert_idom_did_log,
+    assert_idom_logged,
     capture_idom_logs,
 )
 from tests.general_utils import assert_same_items
@@ -144,7 +144,7 @@ def OkChild():
     def BadChild():
         raise ValueError("error from bad child")
 
-    with assert_idom_did_log(
+    with assert_idom_logged(
         match_error="error from bad child",
         clear_matched_records=True,
     ):
@@ -188,7 +188,7 @@ def OkChild():
     def BadChild():
         raise ValueError("error from bad child")
 
-    with assert_idom_did_log(
+    with assert_idom_logged(
         match_error="error from bad child",
         clear_matched_records=True,
     ):
@@ -644,7 +644,7 @@ def ComponentReturnsDuplicateKeys():
             idom.html.div(key="duplicate"), idom.html.div(key="duplicate")
         )
 
-    with assert_idom_did_log(
+    with assert_idom_logged(
         error_type=ValueError,
         match_error=r"Duplicate keys \['duplicate'\] at '/'",
         clear_matched_records=True,
@@ -687,7 +687,7 @@ def raise_error():
 
         return idom.html.button({"onClick": raise_error})
 
-    with assert_idom_did_log(
+    with assert_idom_logged(
         match_error="bad event handler",
         clear_matched_records=True,
     ):
@@ -714,7 +714,7 @@ def Child(state):
         idom.hooks.use_effect(lambda: lambda: print("unmount", state))
         return idom.html.div(state)
 
-    with assert_idom_did_log(
+    with assert_idom_logged(
         r"Did not render component with model state ID .*? - component already unmounted",
     ):
         with idom.Layout(Parent()) as layout:
@@ -753,7 +753,7 @@ def Child():
         "component": Child(key="the-same-key"),
     }
 
-    with assert_idom_did_log(
+    with assert_idom_logged(
         error_type=ValueError,
         match_error="prior element with this key wasn't a component",
         clear_matched_records=True,
@@ -784,7 +784,7 @@ def Child():
         "component": Child(key="the-same-key"),
     }
 
-    with assert_idom_did_log(
+    with assert_idom_logged(
         error_type=ValueError,
         match_error="prior element with this key was a component",
         clear_matched_records=True,

tests/test_testing.py

@@ -0,0 +1,125 @@
+import logging
+
+import pytest
+
+from idom import testing
+from idom.log import ROOT_LOGGER as logger
+
+
+def test_assert_idom_logged_does_not_supress_errors():
+    with pytest.raises(RuntimeError, match="expected error"):
+        with testing.assert_idom_logged():
+            raise RuntimeError("expected error")
+
+
+def test_assert_idom_logged_message():
+    with testing.assert_idom_logged(match_message="my message"):
+        logger.info("my message")
+
+    with testing.assert_idom_logged(match_message=r".*"):
+        logger.info("my message")
+
+
+def test_assert_idom_logged_error():
+    with testing.assert_idom_logged(
+        match_message="log message",
+        error_type=ValueError,
+        match_error="my value error",
+    ):
+        try:
+            raise ValueError("my value error")
+        except ValueError:
+            logger.exception("log message")
+
+    with pytest.raises(
+        AssertionError,
+        match=r"Could not find a log record matching the given",
+    ):
+        with testing.assert_idom_logged(
+            match_message="log message",
+            error_type=ValueError,
+            match_error="my value error",
+        ):
+            try:
+                # change error type
+                raise RuntimeError("my value error")
+            except RuntimeError:
+                logger.exception("log message")
+
+    with pytest.raises(
+        AssertionError,
+        match=r"Could not find a log record matching the given",
+    ):
+        with testing.assert_idom_logged(
+            match_message="log message",
+            error_type=ValueError,
+            match_error="my value error",
+        ):
+            try:
+                # change error message
+                raise ValueError("something else")
+            except ValueError:
+                logger.exception("log message")
+
+    with pytest.raises(
+        AssertionError,
+        match=r"Could not find a log record matching the given",
+    ):
+        with testing.assert_idom_logged(
+            match_message="log message",
+            error_type=ValueError,
+            match_error="my value error",
+        ):
+            try:
+                # change error message
+                raise ValueError("my error message")
+            except ValueError:
+                logger.exception("something else")
+
+
+def test_assert_idom_logged_assertion_error_message():
+    with pytest.raises(
+        AssertionError,
+        match=r"Could not find a log record matching the given",
+    ):
+        with testing.assert_idom_logged(
+            # put in all possible params full assertion error message
+            match_message=r".*",
+            error_type=Exception,
+            match_error=r".*",
+        ):
+            pass
+
+
+def test_assert_idom_logged_ignores_level():
+    original_level = logger.level
+    logger.setLevel(logging.INFO)
+    try:
+        with testing.assert_idom_logged(match_message=r".*"):
+            # this log would normally be ignored
+            logger.debug("my message")
+    finally:
+        logger.setLevel(original_level)
+
+
+def test_assert_idom_did_not_log():
+    with testing.assert_idom_did_not_log(match_message="my message"):
+        pass
+
+    with testing.assert_idom_did_not_log(match_message=r"something else"):
+        logger.info("my message")
+
+    with pytest.raises(
+        AssertionError,
+        match=r"Did find a log record matching the given",
+    ):
+        with testing.assert_idom_did_not_log(
+            # put in all possible params full assertion error message
+            match_message=r".*",
+            error_type=Exception,
+            match_error=r".*",
+        ):
+            try:
+                raise Exception("something")
+            except Exception:
+                logger.exception("something")