pytest-testmap 0.2.0__tar.gz

pytest_testmap-0.2.0/PKG-INFO

@@ -0,0 +1,16 @@
+Metadata-Version: 2.3
+Name: pytest-testmap
+Version: 0.2.0
+Summary: Pytest plugin for testmap: annotate tests and collect the validation matrix.
+Author: Tyler Riccio
+Author-email: Tyler Riccio <tylerriccio8@gmail.com>
+Requires-Dist: pytest>=9.1.1
+Requires-Dist: testmap
+Requires-Python: >=3.14
+Description-Content-Type: text/markdown
+
+# pytest-testmap
+
+Pytest plugin for testmap. Provides the `@testmap(feature=..., kind=...)`
+decorator, collects annotated tests during a run, and exposes `--testmap`
+(terminal matrix) and `--testmap-json PATH` (machine-readable report).

pytest_testmap-0.2.0/README.md

@@ -0,0 +1,5 @@
+# pytest-testmap
+
+Pytest plugin for testmap. Provides the `@testmap(feature=..., kind=...)`
+decorator, collects annotated tests during a run, and exposes `--testmap`
+(terminal matrix) and `--testmap-json PATH` (machine-readable report).

pytest_testmap-0.2.0/pyproject.toml

@@ -0,0 +1,15 @@
+[project]
+name = "pytest-testmap"
+version = "0.2.0"
+description = "Pytest plugin for testmap: annotate tests and collect the validation matrix."
+readme = "README.md"
+authors = [{ name = "Tyler Riccio", email = "tylerriccio8@gmail.com" }]
+requires-python = ">=3.14"
+dependencies = ["pytest>=9.1.1", "testmap"]
+
+[project.entry-points.pytest11]
+testmap = "pytest_testmap.plugin"
+
+[build-system]
+requires = ["uv_build>=0.11.18,<0.12.0"]
+build-backend = "uv_build"

pytest_testmap-0.2.0/src/pytest_testmap/__init__.py

@@ -0,0 +1,11 @@
+from pytest import MarkDecorator, mark
+
+
+def testmap(feature: str, kind: str) -> MarkDecorator:
+    """Tag a test with its feature and kind (applies a `pytest.mark.testmap` marker)."""
+    return mark.testmap(feature=feature, kind=kind)
+
+
+# The name starts with "test", so without this pytest would try to collect the
+# decorator itself when it is imported into a test module.
+setattr(testmap, "__test__", False)  # noqa: B010

pytest_testmap-0.2.0/src/pytest_testmap/plugin.py

@@ -0,0 +1,79 @@
+"""Pytest plugin: collect `@testmap`-tagged tests and report the matrix.
+
+`--testmap` prints the feature x kind matrix (rendered by testmap's core, so the
+output matches the standalone CLI). `--testmap-json PATH` writes the raw records;
+the standalone `testmap` tool ingests that file and applies the config later.
+"""
+
+import json
+from pathlib import Path
+
+import pytest
+from testmap.report import build_report, load_config, render
+
+# Records collected during the run, stashed on the pytest config.
+_RECORDS = pytest.StashKey[list[dict[str, str]]]()
+
+
+def pytest_addoption(parser: pytest.Parser) -> None:
+    group = parser.getgroup("testmap")
+    group.addoption(
+        "--testmap", action="store_true", help="print the testmap feature x kind matrix"
+    )
+    group.addoption(
+        "--testmap-only",
+        action="store_true",
+        help="print the matrix without running any tests",
+    )
+    group.addoption(
+        "--testmap-json", metavar="PATH", help="write the testmap report as JSON to PATH"
+    )
+
+
+def pytest_configure(config: pytest.Config) -> None:
+    config.addinivalue_line(
+        "markers", "testmap(feature, kind): tag a test with its feature and kind"
+    )
+
+
+@pytest.hookimpl(tryfirst=True)
+def pytest_runtestloop(session: pytest.Session) -> bool | None:
+    # `--testmap-only` renders the report from collected metadata; skip execution.
+    if session.config.option.testmap_only:
+        return True
+    return None
+
+
+def pytest_collection_modifyitems(config: pytest.Config, items: list[pytest.Item]) -> None:
+    if not (config.option.testmap or config.option.testmap_only or config.option.testmap_json):
+        return
+    records = []
+    for item in items:
+        marker = item.get_closest_marker("testmap")
+        if marker is None:
+            continue
+        try:
+            records.append(
+                {
+                    "nodeid": item.nodeid,
+                    "feature": marker.kwargs["feature"],
+                    "kind": marker.kwargs["kind"],
+                }
+            )
+        except KeyError as e:
+            raise pytest.UsageError(f"{item.nodeid}: @testmap requires feature and kind") from e
+    config.stash[_RECORDS] = records
+
+
+def pytest_terminal_summary(terminalreporter, exitstatus: int, config: pytest.Config) -> None:
+    records = config.stash.get(_RECORDS, None)
+    if records is None:  # neither option was active this run
+        return
+    if config.option.testmap_json:
+        Path(config.option.testmap_json).write_text(
+            json.dumps({"tests": records}, indent=2), encoding="utf-8"
+        )
+    if config.option.testmap or config.option.testmap_only:
+        cfg = load_config(config.rootpath / "pyproject.toml")
+        terminalreporter.section("testmap")
+        terminalreporter.write_line(render(build_report(records, cfg), cfg))