Add Test Suite (#52)

* Start on test suite

* Fix test suite

Author: Buried-In-Code

pyproject.toml

@@ -2,6 +2,12 @@
 dev = [
   "pre-commit >= 4.5.0"
 ]
+tests = [
+  "pytest >= 9.0.0",
+  "pytest-cov >= 7.0.0",
+  "tox >= 4.32.0",
+  "tox-uv >= 1.29.0"
+]
 
 [project]
 dependencies = [
@@ -59,6 +65,7 @@ split-on-trailing-comma = false
 classmethod-decorators = ["classmethod"]
 
 [tool.ruff.lint.per-file-ignores]
+"tests/*" = ["PLR2004", "S101"]
 
 [tool.ruff.lint.pydocstyle]
 convention = "google"

tests/__init__.py

@@ -0,0 +1,44 @@
+from pathlib import Path
+
+import numpy as np
+
+import extract_dates as mod
+
+
+class FakeTextPage:
+    def extractWORDS(self, delimiters: str | None = None) -> list[tuple]:  # noqa: N802, ARG002
+        return [
+            (0, 0, 10, 10, "January"),
+            (11, 0, 20, 10, "2024"),
+            (30, 0, 40, 10, "February"),
+            (41, 0, 50, 10, "2024"),
+            (60, 0, 70, 10, "March"),
+            (71, 0, 80, 10, "2024"),
+        ]
+
+
+class FakePage:
+    def get_pixmap(self) -> "PM":  # noqa: F821
+        class PM:
+            def tobytes(self, fmt: str) -> bytes:  # noqa: ARG002
+                return b"\x89PNG\r\n\x1a\n"
+
+        return PM()
+
+    def get_textpage_ocr(self, tessdata=None) -> FakeTextPage:  # noqa: ARG002, ANN001
+        return FakeTextPage()
+
+
+class FakeDoc:
+    def __getitem__(self, idx: int) -> FakePage:
+        return FakePage()
+
+
+def test_extract_png_calendars(monkeypatch) -> None:  # noqa: ANN001
+    monkeypatch.setattr(mod.pymupdf, "open", lambda _: FakeDoc())
+    monkeypatch.setattr(mod.cv2, "imdecode", lambda *_: np.zeros((200, 300, 3)))
+
+    calendars = mod.extract_png_calendars(Path("fake.png"))
+
+    assert len(calendars) == 3
+    assert [(c.month, c.year) for c in calendars] == [(1, 2024), (2, 2024), (3, 2024)]

tests/test_extractors.py

@@ -0,0 +1,31 @@
+import cv2
+import numpy as np
+
+from extract_dates import keep_only_colours, remove_colours
+
+
+def test_remove_colours_masks_pixels(monkeypatch) -> None:  # noqa: ANN001
+    img = np.zeros((2, 2, 3), dtype=np.uint8)
+    img[:] = [10, 10, 10]
+
+    def fake_in_range(*args, **kwargs) -> np.array:  # noqa: ANN002, ANN003
+        return np.array([[255, 0], [0, 0]], dtype=np.uint8)
+
+    monkeypatch.setattr(cv2, "inRange", fake_in_range)
+
+    result = remove_colours(img, [(10, 10, 10)])
+
+    assert (result[0, 0] == [255, 255, 255]).all()
+
+
+def test_keep_only_colours(monkeypatch) -> None:  # noqa: ANN001
+    img = np.ones((2, 2, 3), dtype=np.uint8) * 50
+
+    def fake_in_range(*args, **kwargs) -> np.array:  # noqa: ANN002, ANN003
+        return np.array([[255, 0], [0, 0]], dtype=np.uint8)
+
+    monkeypatch.setattr(cv2, "inRange", fake_in_range)
+
+    result = keep_only_colours(img, [(50, 50, 50)])
+
+    assert result.shape == img.shape

tests/test_image_helpers.py

@@ -0,0 +1,16 @@
+from pathlib import Path
+
+import extract_dates as mod
+
+
+def test_main_writes_output(monkeypatch, tmp_path: Path) -> None:  # noqa: ANN001
+    monkeypatch.setattr(mod.Path, "glob", lambda self, pattern: [])  # noqa: ARG005
+    monkeypatch.setattr(mod, "extract_png_calendars", lambda *a, **k: [])
+    monkeypatch.setattr(mod, "extract_pdf_calendars", lambda *a, **k: [])
+
+    monkeypatch.chdir(tmp_path)
+
+    mod.main()
+
+    output_dir = tmp_path / "output"
+    assert output_dir.exists()

tests/test_main.py

@@ -0,0 +1,18 @@
+from extract_dates import adjust_mappings
+
+
+def test_adjust_mappings_single_row() -> None:
+    mapped = [
+        {"x0": 0, "y0": 0, "month": 1, "year": 2024},
+        {"x0": 100, "y0": 0, "month": 2, "year": 2024},
+        {"x0": 200, "y0": 0, "month": 3, "year": 2024},
+    ]
+
+    result = adjust_mappings(
+        mapped=mapped, edges=(300, 300), x_offset=10, y_offset=10, rows=1, columns=3
+    )
+
+    assert len(result) == 3
+    assert result[0]["x0"] == 0
+    assert result[0]["x1"] == 90
+    assert result[-1]["x1"] == 300

tests/test_mappings.py

@@ -0,0 +1,27 @@
+from datetime import date
+
+import numpy as np
+
+from extract_dates import Calendar, Cell
+
+
+def test_calendar_equality_and_hash() -> None:
+    img = np.zeros((10, 10, 3))
+    a = Calendar(month=1, year=2024, calendar_image=img)
+    b = Calendar(month=1, year=2024, calendar_image=img.copy())
+    c = Calendar(month=2, year=2024, calendar_image=img)
+
+    assert a == b
+    assert a != c
+    assert len({a, b, c}) == 2
+
+
+def test_cell_equality_and_hash() -> None:
+    d = date(2024, 1, 1)
+    a = Cell(datestamp=d, colour="red")
+    b = Cell(datestamp=d, colour="blue")
+    c = Cell(datestamp=date(2024, 1, 2), colour="red")
+
+    assert a == b
+    assert a != c
+    assert len({a, b, c}) == 2

tests/test_models.py

@@ -0,0 +1,12 @@
+from extract_dates import parse_month
+
+
+def test_parse_month_valid() -> None:
+    dt = parse_month("January2024")
+    assert dt.year == 2024
+    assert dt.month == 1
+
+
+def test_parse_month_invalid() -> None:
+    assert parse_month("FooBar") is None
+    assert parse_month("") is None

tests/test_parse.py

@@ -0,0 +1,17 @@
+import numpy as np
+
+from extract_dates import PNG_COLOURS, process_calendar_squares
+
+
+def test_process_calendar_single_day(monkeypatch) -> None:  # noqa: ANN001
+    img = np.zeros((100, 700, 3), dtype=np.uint8)
+
+    def fake_analyze_square(*args, **kwargs) -> tuple[int, int, int]:  # noqa: ANN002, ANN003
+        return (0, 0, 255)  # red (BGR)
+
+    monkeypatch.setattr("extract_dates.analyze_square", fake_analyze_square)
+
+    cells = process_calendar_squares(img=img, year=2024, month=1, colours=PNG_COLOURS)
+
+    assert len(cells) == 31
+    assert any(cell.is_recycling for cell in cells)