pytest-digline 0.2.1__tar.gz → 0.2.2__tar.gz

{pytest_digline-0.2.1 → pytest_digline-0.2.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.5
 Name: pytest-digline
-Version: 0.2.1
+Version: 0.2.2
 Summary: Gate a pytest run on a digline comparison: one row per check, against the baseline committed in your repo.
 Project-URL: Homepage, https://digline.dev/
 Project-URL: Documentation, https://digline.dev/product/pytest/

{pytest_digline-0.2.1 → pytest_digline-0.2.2}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "pytest-digline"
-version = "0.2.1"
+version = "0.2.2"
 description = "Gate a pytest run on a digline comparison: one row per check, against the baseline committed in your repo."
 readme = "README.md"
 requires-python = ">=3.12"

{pytest_digline-0.2.1 → pytest_digline-0.2.2}/src/pytest_digline/plugin.py

@@ -76,6 +76,7 @@ RUN_SCOPE = "<run>"
 #: Set by `pytest_collection_modifyitems`, read by `pytest_terminal_summary`.
 #: On the config's stash rather than a module global: a module global is shared
 #: by every `Config` in the process, and `pytester` runs several in one.
+#: Each suite's headline, followed by its `latest` note when there is one.
 HEADLINES: pytest.StashKey[list[str]] = pytest.StashKey()
 
 
@@ -204,6 +205,8 @@ def pytest_collection_modifyitems(
         node = _child(session, DiglineSuite, path=opened.path, opened=opened)
         items.extend(node.collect())
         config.stash[HEADLINES].append(opened.headline)
+        if opened.note:
+            config.stash[HEADLINES].append(f"note: {opened.note}")
 
 
 def _child[N: pytest.Item | pytest.File](
@@ -242,6 +245,11 @@ class _Opened:
     #: The calibration cases of the run that left their band, read off the run
     #: by the report's own function. (ADR 0024 §4.7)
     lost: Sequence[ScaleLost] = ()
+    #: What resolving `latest` stepped over, or empty. Its sharpest case is a
+    #: baseline promoted from a run newer than the one compared: every row is
+    #: then an older run held against a newer reference, and a red there is
+    #: not a regression. (#433)
+    note: str = ""
 
 
 def _open(spec: str, config: pytest.Config) -> _Opened:
@@ -286,8 +294,8 @@ def _opened(spec: str, root: Path, *, run_first: bool) -> _Opened:
     if run_first:
         _measure(suite, loaded, spec, path, store, root=root)
 
-    key = resolve_key(store, suite, "latest").key
-    run = read_run(store, suite, key)
+    resolved = resolve_key(store, suite, "latest")
+    run = read_run(store, suite, resolved.key)
     baseline = need_baseline(store, suite)
     comparison = compare(run, baseline)
     head = headline(comparison, run, baseline, locale=LOCALE)
@@ -299,6 +307,7 @@ def _opened(spec: str, root: Path, *, run_first: bool) -> _Opened:
         headline=head.sentence,
         reasons_available=head.reasons_available,
         lost=scale_lost(run),
+        note=resolved.note,
     )
 
 
@@ -665,6 +674,10 @@ def pytest_terminal_summary(
     It is `headline().sentence`, byte for byte the sentence `digline compare`
     prints and the report shows, because a gate and a document must never say
     two different things about one run.
+
+    Under it, the note `latest` left, as `note: …`, the line `digline compare`
+    prints on stderr. Here and not as a warning: under `-W error` a warning
+    fails the session, and a note is not a verdict. (#433)
     """
     none: list[str] = []
     sentences = config.stash.get(HEADLINES, none)

pytest_digline-0.2.2/tests/test_summary_note.py

@@ -0,0 +1,54 @@
+"""The note `latest` leaves, under the headline it qualifies. (#433)
+
+This plugin compares `latest` against the baseline, and until #433 it took the
+key and dropped the note. The case that matters: the baseline was promoted from
+a run newer than `latest`, so every row holds an older run against a newer
+reference, and a red row there is not a regression.
+"""
+
+from __future__ import annotations
+
+from collections.abc import Callable
+from pathlib import Path
+
+import pytest
+from _cycle import cycle
+
+FINE = {"alpha": "Acme, SATISFIED", "beta": "Acme, SATISFIED"}
+
+
+def test_the_note_follows_the_headline_in_the_summary(
+    pytester: pytest.Pytester, repo: Callable[[dict[str, str]], Path]
+) -> None:
+    path = repo(FINE)
+    older = cycle(path, pytester.path, promote=False)
+    newer = cycle(path, pytester.path, promote=True)
+    (gone,) = (pytester.path / ".digline").glob(f"*/runs/**/{newer}.json")
+    gone.unlink()
+
+    # `-W error` too: the note is not a warning, so it cannot fail a session
+    # that turns warnings into errors.
+    result = pytester.runpytest_subprocess("--digline-suite", str(path), "-W", "error")
+
+    expected = (
+        f"note: the baseline was promoted from run {newer}, newer than {older}, "
+        "and that run was not read here"
+    )
+    text = result.stdout.str()
+    assert expected in text
+    assert text.index("= digline =") < text.index(expected)
+    assert result.ret == 0, text
+
+
+def test_no_note_when_latest_steps_over_nothing(
+    pytester: pytest.Pytester, repo: Callable[[dict[str, str]], Path]
+) -> None:
+    """The control: a note on every session would be a line people learn to
+    skip, and would pass the test above."""
+    path = repo(FINE)
+    cycle(path, pytester.path, promote=True)
+    cycle(path, pytester.path, promote=False)
+
+    result = pytester.runpytest_subprocess("--digline-suite", str(path))
+
+    assert "note:" not in result.stdout.str()