fix(runner): don't surface benign LVS-config warnings as fail summary (1.3.1)

The runner captures every WARNING+ log emitted during a check and uses the
first one as the one-line FAIL summary when the check itself hasn't set
`details`. "Missing LVS configuration variable EXTRACT_CREATE_SUBCUT" (and
the eight sibling messages from config.start_be_check) fire on almost every
project whose lvs_config.*.json omits the optional LVS optimisation keys,
and they fire before run_oeb_check / run_be_checks starts — so they always
win the first-captured-warning race and mask the real failure reason.

Filter them out of `fallback_detail` (and the dim trailing hint line) via a
small substring allow-list. Messages still go to the log at WARNING level
so a curious user can still see them. Factored the classifier into
_warning_filters.py so tests can import it without dragging in pya/KLayout
through check_manager.

Includes 3 unit tests covering the benign-match, real-error, and
no-regex-in-substring-list invariants.

Made-with: Cursor

Author: jdicorpo

src/cf_precheck/__init__.py

@@ -1 +1 @@
-__version__ = "1.3.0"
+__version__ = "1.3.1"

src/cf_precheck/_warning_filters.py

@@ -0,0 +1,26 @@
+"""Classifiers for the captured-warning fallback used by runner.py.
+
+Lives in its own tiny module so unit tests can import the classifier without
+pulling in the full check stack (which transitively imports pya/KLayout and
+only works inside the precheck Docker image).
+"""
+
+from __future__ import annotations
+
+
+# Warnings emitted during setup that must stay visible in the log but must
+# NOT become the one-line FAIL summary for a check. Each entry is a plain
+# substring match against the captured log message.
+#
+# Example: "Missing LVS configuration variable EXTRACT_CREATE_SUBCUT" fires
+# for almost every user project whose lvs_config.*.json doesn't populate the
+# optional LVS optimisation keys, and it always fires before the real OEB
+# or LVS failure reason. Without this filter the real error gets masked.
+BENIGN_WARNING_SUBSTRINGS: tuple[str, ...] = (
+    "Missing LVS configuration variable ",
+)
+
+
+def is_benign_warning(message: str) -> bool:
+    """Return True if a captured WARNING shouldn't be surfaced as fail detail."""
+    return any(needle in message for needle in BENIGN_WARNING_SUBSTRINGS)

src/cf_precheck/runner.py

@@ -12,6 +12,7 @@
 from rich.text import Text
 
 from cf_precheck import __version__
+from cf_precheck._warning_filters import is_benign_warning
 from cf_precheck.check_manager import ALL_CHECKS, build_sequence, get_check_manager
 from cf_precheck.config import file_hash, get_project_config, uncompress_gds
 from cf_precheck.logging import console, error_capture
@@ -161,6 +162,11 @@ def run_precheck(
             devnull.close()
 
         captured_errors = error_capture.stop()
+        # Benign setup warnings (e.g. "Missing LVS configuration variable FOO")
+        # get logged before the real failure reason, so without this filter
+        # they end up as the FAIL summary line and mask the actual problem.
+        # Keep them in the log — just don't surface them as the fail summary.
+        significant_errors = [m for m in captured_errors if not is_benign_warning(m)]
 
         check_report = getattr(check, "report", None)
         check_details = getattr(check, "details", None)
@@ -177,7 +183,7 @@ def run_precheck(
             )
         else:
             status_str = "[fail]FAIL[/fail]"
-            fallback_detail = captured_errors[0] if captured_errors else None
+            fallback_detail = significant_errors[0] if significant_errors else None
             result = CheckResult(
                 name=ref,
                 surname=surname,
@@ -195,8 +201,8 @@ def run_precheck(
             console.file.flush()
         console.print(_format_check_line(prefix, dots, status_str, elapsed))
 
-        if not passed and captured_errors:
-            brief = captured_errors[0]
+        if not passed and significant_errors:
+            brief = significant_errors[0]
             if len(brief) > 120:
                 brief = brief[:117] + "..."
             console.print(f"         [dim]{brief}[/dim]")

tests/test_runner_warnings.py

@@ -0,0 +1,40 @@
+"""Tests for the fail-summary benign-warning filter.
+
+The runner captures any WARNING/ERROR logs emitted during a check and uses
+the first one as the user-visible fail summary when the check itself did not
+set ``details``. Benign setup warnings (e.g. missing optional LVS config
+variables) must be excluded from that fallback so real failure reasons
+remain visible.
+"""
+
+from __future__ import annotations
+
+from cf_precheck._warning_filters import (
+    BENIGN_WARNING_SUBSTRINGS,
+    is_benign_warning,
+)
+
+
+def test_missing_lvs_config_variable_is_benign() -> None:
+    assert is_benign_warning(
+        "Missing LVS configuration variable EXTRACT_CREATE_SUBCUT"
+    )
+    assert is_benign_warning(
+        "Missing LVS configuration variable LVS_FLATTEN"
+    )
+
+
+def test_real_error_is_not_benign() -> None:
+    assert not is_benign_warning(
+        "OEB FAILED: could not find LVS configuration file lvs_config.json"
+    )
+    assert not is_benign_warning("Magic DRC reported 12 errors in layout")
+    assert not is_benign_warning("")
+
+
+def test_benign_substrings_are_plain_strings_not_regex() -> None:
+    # Sanity: keep the filter a plain-substring list so it's easy to reason
+    # about and impossible to accidentally disable via user-supplied text.
+    for needle in BENIGN_WARNING_SUBSTRINGS:
+        assert isinstance(needle, str) and needle
+        assert not any(c in needle for c in "()[]{}.*+?^$\\|")