Add tests for ContextReporter

Author: lagru

src/docstub/_report.py

@@ -17,12 +17,11 @@ class ContextReporter:
 
     Attributes
     ----------
+    logger
     path :
         Path to a file for the current context.
     line :
         The line in the given file.
-    column :
-        The column in the given line.
 
     Examples
     --------
@@ -52,7 +51,6 @@ class ContextReporter:
     logger: logging.Logger
     path: Path | None = None
     line: int | None = None
-    column: int | None = None
 
     def copy_with(self, *, logger=None, path=None, line=None, line_offset=None):
         """Return a new copy with the modified attributes.

tests/test_report.py

@@ -0,0 +1,69 @@
+import logging
+from pathlib import Path
+
+import pytest
+
+from docstub._report import ContextReporter
+
+
+class Test_ContextReporter:
+    @pytest.mark.parametrize("level", ["debug", "info", "warn", "error"])
+    def test_basic(self, level, caplog):
+        caplog.set_level(logging.DEBUG)
+        logger = logging.getLogger(__name__)
+        rep = ContextReporter(logger=logger)
+
+        func = getattr(rep, level)
+
+        func("Message")
+        assert len(caplog.records) == 1
+
+        record = caplog.records[0]
+        assert record.message == "Message"
+        assert record.details is None
+        assert not hasattr(record, "src_location")
+        assert record.levelname.startswith(level.upper())
+
+    def test_details(self, caplog):
+        logger = logging.getLogger(__name__)
+        rep = ContextReporter(logger=logger)
+
+        rep.info("Message", details="More\nmultiline details.")
+        assert len(caplog.records) == 1
+
+        record = caplog.records[0]
+        assert record.message == "Message"
+        assert record.details == "More\nmultiline details."
+        assert not hasattr(record, "src_location")
+
+    def test_src_location(self, caplog):
+        logger = logging.getLogger(__name__)
+        rep = ContextReporter(logger=logger, path=Path("foo.py"), line=3)
+
+        rep.info("Message")
+        assert len(caplog.records) == 1
+
+        record = caplog.records[0]
+        assert record.message == "Message"
+        assert record.details is None
+        assert record.src_location == "foo.py:3"
+
+    def test_copy_with(self, caplog):
+        logger = logging.getLogger(__name__)
+
+        rep = ContextReporter(logger=logger, path=Path("foo.py"), line=3)
+        rep_new_path = rep.copy_with(path=Path("bar.py"))
+        rep_new_line = rep.copy_with(line=7)
+        rep_line_offset = rep.copy_with(line_offset=8)
+
+        rep_new_path.info("Message")
+        rep_new_line.info("Message")
+        rep_line_offset.info("Message")
+        assert len(caplog.records) == 3
+
+        assert caplog.records[0].src_location == "bar.py:3"
+        assert caplog.records[1].src_location == "foo.py:7"
+        assert caplog.records[2].src_location == "foo.py:11"
+
+
+# TODO test ReportHandler