Volt
e64a40dbec
selftest_sweep compared a tool's printed count with a number in the same file, so a commit that deleted fixtures and decremented the docstring agreed with itself: doc_command_check.py cut 15 cells -> 12 read clean (sweep: 21 tools, 21 OK, 0 fatal, rc 0). tools/selftest_baseline.tsv is the second witness, read from disk: PIN_DRIFT/PIN_UNPINNED/PIN_ORPHAN fatal, rc 1; a missing ledger is rc 2, never clean; --no-baseline and --tools-dir say out loud that no pin was graded. +283/-4; selftest 30 -> 39 cells, 39/39.
1142 lines
56 KiB
Python
1142 lines
56 KiB
Python
#!/usr/bin/env python3
|
|
"""selftest_sweep.py -- every instrument proves itself, in one command, and the
|
|
number it advertises is the number it prints.
|
|
|
|
WHY THIS EXISTS
|
|
`tools/append_only_audit.py` carried, on its own usage line, the words
|
|
"synthetic repo, N cells" beside a selftest that printed a different N.
|
|
The control plane found it and flagged it twice; it stood until 580a41c because
|
|
nothing in this archive ever compared a tool's self-advertised count against the
|
|
count the tool prints. `doc_census_check.py` now checks that class -- but its
|
|
subject is the census blocks (AMBIGUOUS / MATCHES / NOT_PRINTED / ...) and it
|
|
drives every tool against a revision, so a full run is minutes, not seconds.
|
|
|
|
The selftest cell count is a cheaper and more basic claim: it is the number a
|
|
reader uses to decide whether a tool is worth trusting, and the number a
|
|
check-in quotes as proof. Eight tools carry one. One was wrong for days. This
|
|
is the gate for that sentence, and it runs in seconds because a selftest is a
|
|
unit test, not a census.
|
|
|
|
WHAT IT MEASURES -- one row per tracked tool, one verdict per row
|
|
NO_SELFTEST_FLAG the source never mentions "--selftest"; the tool is not run
|
|
(a tool without the flag may do real work on `--selftest`).
|
|
TIMEOUT the selftest did not finish inside --timeout seconds.
|
|
RUN_FAILED non-zero exit and no count line: the run died, or failed
|
|
before it could report.
|
|
NO_COUNT_LINE exit 0 but nothing matching
|
|
`selftest: <n> cells|fixtures, <n> passed, <n> failed`.
|
|
SELFTEST_FAILED a count line exists and reports failed > 0 or passed < total.
|
|
SPLIT two different values of one unit on the tool's own
|
|
`--selftest` usage line(s) -- the four-hundred-and-seventy-one
|
|
over-count defect, at
|
|
selftest scale.
|
|
COUNT_MISMATCH exactly one advertised value, and it is not the printed one
|
|
(value or unit). This is the append_only_audit defect.
|
|
NO_CLAIM prints a count, advertises none. ADVISORY, not a fault: an
|
|
absent claim cannot be false.
|
|
OK printed a count, every advertised value agrees with it.
|
|
|
|
FATAL = every class above except NO_CLAIM. Exit 1 if any row is fatal, else 0.
|
|
|
|
THE READ-REFUSAL AXIS, ADDED 2026-10-17
|
|
The same command asks every tool the second question this archive kept
|
|
getting wrong: what exit code does it give an input it cannot read? The
|
|
contract is three codes and no others -- rc 0 ran clean, rc 1 ran and graded
|
|
a fault, rc 2 could not grade. The axis runs each tool against a path that
|
|
does not exist (and, for the four file readers, against bytes that are not
|
|
UTF-8) and grades the answer OK / RC_NOT_2 / TRACEBACK / SILENT; the last
|
|
three are fatal. So is NO_PROBE (below): a tool the tables never name is a
|
|
tool this axis never graded, and an ungraded tool may not be reported clean.
|
|
rc 3 is retired: the two queue readers used it for "cannot
|
|
read the queue", so one meaning carried two codes and a stale index (rc 1)
|
|
could be confused with a queue that was never read.
|
|
|
|
THE WRITE PATH, ADDED 2026-10-21
|
|
The read axis grades what a tool does with an input it cannot read. It says
|
|
nothing about the other end: every tool in this directory also carries
|
|
`--json PATH`, and at `67f94cc` -- the last revision before the guards landed
|
|
-- **18 of the 20 tools then tracked answered an unwritable target with an
|
|
uncaught FileNotFoundError at rc 1**. `gate_blame.py` returned rc 2 from its
|
|
input and never reached the write (UNNAMED: ungraded, not passed), and
|
|
`queue_append_audit.py` already refused (rc 2, "cannot write json"). That
|
|
number has been wrong twice in this file's own history (a draft said "five",
|
|
another said "13 of 20"); it is measured now by `tools/write_probe.py`, which
|
|
is the instrument, and it prints the count on every run. The rule the guards
|
|
implement, and the one a new tool must follow: the grade happens first and
|
|
its stdout report stands; the write is wrapped, so a target this host cannot
|
|
write prints one line naming the path and returns **2** ("could not grade" --
|
|
the artifact was asked for and not delivered). rc 2 outranks the rc 1 the
|
|
report may have earned, because a caller who asked for a file and got a stack
|
|
trace has no way to know a grade happened at all. `write_probe.py` is leg 6
|
|
of `verify.py`; this file covers it the way it covers every other tool, with
|
|
a read probe and a malformed probe, and a tool the tables do not name is
|
|
NO_PROBE here exactly as it is NO_PROBE there.
|
|
|
|
THE MALFORMED-INPUT CLASS, ADDED 2026-10-18
|
|
A missing path and non-UTF-8 bytes are the easy two. The class the axis left
|
|
unmeasured was the one in between: an input that DECODES but cannot be made
|
|
sense of -- a `.json` that is not JSON, a valid `{}` where an audit file
|
|
should be, a directory that is not a git repository, a queue file with no
|
|
records. Those are the inputs where a tool is most tempted to answer "0" and
|
|
return 0, which reads exactly like a clean pass (`doc_census_check`'s
|
|
`--tools` bug, `76043b7`, was this class). The axis runs one such probe per
|
|
tool and grades each against ITS OWN stated answer, because "must exit 2" is
|
|
not a universal truth: most tools must refuse at rc 2, while `check_lint` grades
|
|
a junk log MISSING (rc 0 in report mode, rc 1 under --fail-on-fault),
|
|
`checkin_check` grades a heading-less check-in as an advisory (rc 0, stated
|
|
in its docstring) and `queue_claim_check` reports 0 opening records (rc 0,
|
|
its --fail-on-stale is the gate). The axis asserts the message too, so a
|
|
silent 0 cannot pass as a refusal.
|
|
|
|
THE COUNT PIN, ADDED 2026-10-22 -- the docstring was not a witness
|
|
Every verdict above compares a tool's printed count with a number in the SAME
|
|
file. That catches a stale number; it does not catch a shrinking corpus,
|
|
because a commit that deletes three fixtures and decrements the docstring
|
|
agrees with itself, and every leg stays green. Measured on a clone of this
|
|
repository: `doc_command_check.py` cut from 15 cells to 12 at both the print
|
|
and the usage line reads `OK 12 cells` and `sweep: 21 tools, 21 OK, 0 fatal,
|
|
rc 0` -- a third of its fixtures gone, reported clean.
|
|
`tools/selftest_baseline.tsv` is the second witness: one row per tool, the
|
|
count its selftest prints, committed and read from disk. The sweep compares
|
|
every row against it and prints four classes --
|
|
PIN_OK / PIN_DRIFT (printed differs from pinned) / PIN_UNPINNED (a tool with
|
|
no pinned row) / PIN_ORPHAN (a pinned row whose tool is gone). DRIFT,
|
|
UNPINNED and ORPHAN are FATAL: a corpus may not shrink silently, and a new
|
|
tool may not arrive unmeasured. PIN_NA (a tool with no --selftest) and
|
|
PIN_NO_COUNT (its run already failed above) are printed and not counted
|
|
twice. A missing baseline in repo mode is rc 2 -- could not grade -- never a
|
|
clean run; `--no-baseline` is the explicit way to sweep without one, and
|
|
`--write-baseline PATH` re-pins after a deliberate change.
|
|
|
|
WHAT COUNTS AS A CLAIM, PRECISELY
|
|
Only the module docstring (read through `ast.get_docstring`, so a fixture
|
|
string in the BODY is not a claim -- `doc_census_check.py` contains the literal
|
|
"selftest: N cells, N passed, N failed" inside a test, and reading the file as
|
|
text would call that a claim), and only on a line that also contains the token
|
|
`--selftest`. Prose elsewhere in the docstring is not a claim: the same
|
|
doc_census_check docstring quotes a thirteen-cell claim as the defect the tool
|
|
itself catches, and a scanner that flagged its own bug report would be wrong.
|
|
|
|
DISCOVERY, AND WHY UNTRACKED FILES ARE PRINTED
|
|
Tracked paths only, from `git ls-files` in --repo -- the lesson doc_census_check
|
|
paid for: an untracked tool is invisible to a revision-scoped census, and this
|
|
gate inherits that blindness rather than pretending to fix it. Every `tools/*.py`
|
|
that IS present but untracked is therefore listed as SKIPPED_UNTRACKED with its
|
|
name, never silently dropped. With --tools-dir, or with no git, discovery is a
|
|
plain glob of that directory and the row says so.
|
|
|
|
READ-ONLY: the only write path is `--json PATH`. It does not edit a tool, and it
|
|
does not decide that a claim SHOULD exist -- NO_CLAIM is advisory by design.
|
|
NO_PROBE is not: an ungraded tool cannot be reported clean (see the read axis).
|
|
|
|
USAGE:
|
|
python3 selftest_sweep.py --repo /root/troupe-standup
|
|
python3 selftest_sweep.py --repo /root/troupe-standup --write-baseline tools/selftest_baseline.tsv
|
|
python3 selftest_sweep.py --tools-dir /tmp/fake --json /tmp/sweep.json
|
|
python3 selftest_sweep.py --selftest # 39 cells, parser, sweep, pin and both input axes
|
|
"""
|
|
from __future__ import annotations
|
|
|
|
import argparse
|
|
import ast
|
|
import contextlib
|
|
import glob
|
|
import io
|
|
import json
|
|
import os
|
|
import re
|
|
import subprocess
|
|
import sys
|
|
import tempfile
|
|
|
|
UNITS = ("cells", "fixtures")
|
|
|
|
# `selftest: 18 cells, 18 passed, 0 failed`
|
|
# `self-test: 19 fixtures, 19 passed, 0 failed`
|
|
# `selftest: 14 fixtures (10 claim-check, 4 unit), 14 passed, 0 failed`
|
|
PRINTED_RE = re.compile(
|
|
r"(?:selftest|self-test)\s*:\s*([\d,]+)\s+(cells|fixtures)\b"
|
|
r"[^\n]*?\b([\d,]+)\s+passed\b[^\n]*?\b([\d,]+)\s+failed\b"
|
|
)
|
|
CLAIM_RE = re.compile(r"(?<![\w.])([\d,]+)\s+(cells|fixtures)\b")
|
|
SELFTEST_FLAG_RE = re.compile(r"""["']--selftest["']""")
|
|
|
|
FATAL = (
|
|
"SELFTEST_FAILED",
|
|
"RUN_FAILED",
|
|
"TIMEOUT",
|
|
"NO_COUNT_LINE",
|
|
"NO_SELFTEST_FLAG",
|
|
"COUNT_MISMATCH",
|
|
"SPLIT",
|
|
"UNREADABLE",
|
|
)
|
|
|
|
# the count pin (2026-10-22): the second witness, kept out of the tool it grades
|
|
BASELINE_NAME = "selftest_baseline.tsv"
|
|
PIN_FAULT = ("PIN_DRIFT", "PIN_UNPINNED", "PIN_ORPHAN")
|
|
|
|
# --------------------------------------------------------------- read axis
|
|
# THE SECOND GATE, ADDED 2026-10-17: the exit code a tool gives an input it
|
|
# cannot read. The repo-wide contract is three codes and no others --
|
|
# rc 0 ran, nothing to report
|
|
# rc 1 ran, and GRADED something as faulty (STALE, TAUTOLOGY, MISMATCH, ...)
|
|
# rc 2 COULD NOT GRADE: usage error, precondition unmet, input unreadable
|
|
# Before this axis existed the third class was spread over rc 1 (check_lint,
|
|
# census_row_delta, both append-only tools as a raw traceback, this sweep) and
|
|
# rc 3 (the two queue readers), so "1" meant both "bad verdict" and "no
|
|
# verdict" and an operator could not tell them apart. The axis re-measures the
|
|
# class on every tool, from the outside, against the real CLI.
|
|
READ_AXIS_UNIT = 2
|
|
# NO_PROBE is fatal, not advisory (2026-10-18): a tool the tables never name is
|
|
# a tool neither axis graded, and the pre-fix sweep reported a 15th tool with no
|
|
# probe entry as "15 tools, 14 OK, 0 fatal ... rc 0" -- two NO_PROBE rows and a
|
|
# green gate. An ungraded tool may not be reported clean; the tables are the
|
|
# gate's only cover, so a gap in them has to fail like a fault in a tool.
|
|
FATAL_READ = ("TRACEBACK", "RC_NOT_2", "SILENT", "NO_TOOL", "RC_WRONG",
|
|
"UNEXPLAINED", "NO_PROBE")
|
|
NO_PROBE = "NO_PROBE" # fatal: a tool with no probe defined
|
|
|
|
# {nope} = a path that does not exist; {bin} = a file that is not UTF-8;
|
|
# {bindir} = a directory holding one non-UTF-8 *.md (added 2026-10-18 with
|
|
# checkin_check.py, whose input is a directory of UTF-8 files -- a {bin} file
|
|
# would only have proven it refuses a non-directory).
|
|
READ_PROBES = (
|
|
("append_only_audit.py", ["--repo", "{nope}"]),
|
|
("append_only_owners.py", ["{nope}/audit.json"]),
|
|
("census_row_delta.py", ["{nope}/a.json", "{nope}/b.json"]),
|
|
("check_lint.py", ["--log", "{nope}/log.txt"]),
|
|
("checkin_check.py", ["--dir", "{nope}", "--roster", "volt"]),
|
|
("citation_hash_class.py", ["--repo", "{nope}"]),
|
|
("citation_resolve_check.py", ["--repo", "{nope}"]),
|
|
("doc_command_check.py", ["--repo", "{nope}"]),
|
|
("doc_census_check.py", ["--repo", "{nope}", "--no-run"]),
|
|
("gate_blame.py", ["--repo", "{nope}"]),
|
|
("landing_check.py", ["--repo", "{nope}"]),
|
|
("path_claim_check.py", ["--repo", "{nope}"]),
|
|
("queue_claim_check.py", ["--queue", "{nope}/q.md"]),
|
|
("queue_index.py", ["--queue", "{nope}/q.md", "--check", "{nope}/i.md"]),
|
|
("queue_append_audit.py", ["--repo", "{nope}"]),
|
|
("reply_check.py", ["--dir", "{nope}"]),
|
|
("selftest_sweep.py", ["--repo", "{nope}"]),
|
|
("served_drift_check.py", ["--root", "{nope}", "--base-url", "file:///nonexistent"]),
|
|
("tool_map.py", ["--repo", "{nope}"]),
|
|
("verify.py", ["--repo", "{nope}"]),
|
|
# write_probe.py's input is the tree it discovers tools from: a path that is
|
|
# not there is the read refusal, and it must not be graded as "no tools".
|
|
("write_probe.py", ["--repo", "{nope}"])
|
|
)
|
|
NOT_UTF8_PROBES = (
|
|
("append_only_owners.py", ["{bin}"]),
|
|
("census_row_delta.py", ["{bin}", "{bin}"]),
|
|
("checkin_check.py", ["--dir", "{bindir}", "--roster", "volt"]),
|
|
("queue_claim_check.py", ["--queue", "{bin}"]),
|
|
("queue_index.py", ["--queue", "{bin}", "--check", "{bin}"]),
|
|
)
|
|
|
|
# THE THIRD CLASS (2026-10-18): input that decodes as UTF-8 but cannot be made
|
|
# sense of. Each entry carries the answer the TOOL's own contract states --
|
|
# (tool, label, argv, expected rc, a substring the output must contain) -- so
|
|
# the axis measures the documented behaviour instead of imposing one. Most
|
|
# tools must refuse at rc 2; the ones that grade a malformed input are listed
|
|
# with the rc and the word their grade prints, which is what makes a silent
|
|
# rc 0 (the doc_census_check --tools bug class) fail here.
|
|
# The counts are deliberately NOT written here: a number in a comment has no
|
|
# reader, which is the defect class this file's own docstring names, and the
|
|
# two counts that used to sit on these lines were both stale ("eleven",
|
|
# "Fourteen") before gate_blame.py's row was added on 2026-10-20.
|
|
# Fixtures: {notrepo} = a directory with a file and no .git; {badjson} = a
|
|
# UTF-8 file that is not JSON; {emptyjson} = "{}" (valid JSON, wrong shape);
|
|
# {junklog} = a log with no CHECK: line; {junkqueue} = 3 prose lines, no
|
|
# records; {junkindex} = a file with no pinned parse; {badcheckins} = a
|
|
# directory holding one heading-less check-in.
|
|
MALFORMED_PROBES = (
|
|
("append_only_audit.py", "not-a-repo", ["--repo", "{notrepo}"],
|
|
2, "cannot read repo"),
|
|
("append_only_owners.py", "malformed-json", ["{badjson}"],
|
|
2, "cannot read audit"),
|
|
("append_only_owners.py", "wrong-shape", ["{emptyjson}"],
|
|
2, "no 'rows' list"),
|
|
("census_row_delta.py", "malformed-json", ["{badjson}", "{badjson}"],
|
|
2, "cannot read census"),
|
|
("census_row_delta.py", "wrong-shape", ["{emptyjson}", "{emptyjson}"],
|
|
2, "no 'reports' list"),
|
|
("check_lint.py", "junk-log", ["--log", "{junklog}"],
|
|
0, "MISSING"),
|
|
("check_lint.py", "junk-log-gated", ["--log", "{junklog}", "--fail-on-fault"],
|
|
1, "MISSING"),
|
|
("checkin_check.py", "no-headings", ["--dir", "{badcheckins}", "--roster", "volt"],
|
|
0, "advisory"),
|
|
("citation_hash_class.py", "not-a-repo", ["--repo", "{notrepo}"],
|
|
2, "not a git"),
|
|
("citation_resolve_check.py", "not-a-repo", ["--repo", "{notrepo}"],
|
|
2, "not a git"),
|
|
("doc_census_check.py", "not-a-repo", ["--repo", "{notrepo}", "--no-run"],
|
|
2, "no tools found"),
|
|
("doc_command_check.py", "not-a-repo", ["--repo", "{notrepo}"],
|
|
2, "cannot read repo"),
|
|
# gate_blame.py's input is a git work tree: a directory that is not one is the
|
|
# malformed shape, and it must name that rather than pass a window of nothing.
|
|
("gate_blame.py", "not-a-repo", ["--repo", "{notrepo}"],
|
|
2, "not a git work tree"),
|
|
("landing_check.py", "not-a-repo", ["--repo", "{notrepo}"],
|
|
2, "not a git work tree"),
|
|
# path_claim_check.py's input is a git work tree whose markdown names paths:
|
|
# a directory that is not one must be named, not graded as an empty census.
|
|
("path_claim_check.py", "not-a-repo", ["--repo", "{notrepo}"],
|
|
2, "not a git work tree"),
|
|
("queue_claim_check.py", "junk-queue", ["--queue", "{junkqueue}"],
|
|
0, "0 opening records"),
|
|
("queue_index.py", "junk-index", ["--queue", "{junkqueue}", "--check", "{junkindex}"],
|
|
2, "UNVERIFIABLE"),
|
|
("queue_append_audit.py", "not-a-repo", ["--repo", "{notrepo}"],
|
|
2, "not a git repository"),
|
|
# reply_check.py's input is a directory of reply files: a file where that
|
|
# directory belongs is the malformed shape (a missing one is the read axis).
|
|
("reply_check.py", "not-a-dir", ["--dir", "{bin}"],
|
|
2, "not a directory"),
|
|
# served_drift_check.py's input is a git work tree that a host is supposed to
|
|
# be serving: a directory that is not one must be named, not graded as empty.
|
|
("served_drift_check.py", "not-a-repo", ["--root", "{notrepo}", "--base-url", "file:///nonexistent"],
|
|
2, "not a git work tree"),
|
|
("selftest_sweep.py", "not-a-repo", ["--repo", "{notrepo}"],
|
|
2, "no tools discovered"),
|
|
("tool_map.py", "not-a-repo", ["--repo", "{notrepo}"],
|
|
2, "cannot read repo"),
|
|
# verify.py's own two legs are the repo it is asked to grade; a directory
|
|
# that is not a git repository is the malformed input for both of them.
|
|
("verify.py", "not-a-repo", ["--repo", "{notrepo}"],
|
|
2, "cannot read repo"),
|
|
# write_probe.py's input is a tree to discover tools in; a directory that is
|
|
# not a repository is the malformed shape, and it must say so rather than
|
|
# report an empty probe as clean.
|
|
("write_probe.py", "not-a-repo", ["--repo", "{notrepo}"],
|
|
2, "not a git repository"),
|
|
)
|
|
|
|
|
|
def _int(text: str) -> int:
|
|
return int(text.replace(",", ""))
|
|
|
|
|
|
def parse_printed(text: str):
|
|
"""(count, unit, passed, failed) from the first count line, or None."""
|
|
m = PRINTED_RE.search(text or "")
|
|
if not m:
|
|
return None
|
|
return _int(m.group(1)), m.group(2), _int(m.group(3)), _int(m.group(4))
|
|
|
|
|
|
def usage_claims(doc: str):
|
|
"""[(value, unit, line)] -- claims on lines that name --selftest."""
|
|
out = []
|
|
for line in (doc or "").splitlines():
|
|
if "--selftest" not in line:
|
|
continue
|
|
for m in CLAIM_RE.finditer(line):
|
|
out.append((_int(m.group(1)), m.group(2), line.strip()))
|
|
return out
|
|
|
|
|
|
def module_docstring(path: str):
|
|
"""(docstring, source). The docstring is AST-read so body fixtures are not claims."""
|
|
try:
|
|
with open(path, "r", encoding="utf-8", errors="replace") as fh:
|
|
src = fh.read()
|
|
except OSError as exc:
|
|
return None, f"<unreadable: {exc}>"
|
|
try:
|
|
tree = ast.parse(src)
|
|
except SyntaxError:
|
|
return None, src
|
|
return (ast.get_docstring(tree) or ""), src
|
|
|
|
|
|
# ---------------------------------------------------------------- discovery
|
|
|
|
def discover(repo: str, tools_dir: str | None):
|
|
"""(rows, source, untracked).
|
|
|
|
rows: [(display_name, path)] -- path is absolute, display_name is tools/x.py.
|
|
"""
|
|
if tools_dir:
|
|
d = os.path.abspath(tools_dir)
|
|
paths = sorted(p for p in glob.glob(os.path.join(d, "*.py"))
|
|
if os.path.isfile(p))
|
|
return ([(os.path.basename(p), p) for p in paths],
|
|
f"glob of --tools-dir {d} (no git consulted)", [])
|
|
|
|
d = os.path.join(os.path.abspath(repo), "tools")
|
|
have_git = subprocess.run(["git", "-C", os.path.abspath(repo), "rev-parse",
|
|
"--git-dir"], capture_output=True).returncode == 0
|
|
if not have_git:
|
|
paths = sorted(p for p in glob.glob(os.path.join(d, "*.py"))
|
|
if os.path.isfile(p))
|
|
return ([(os.path.basename(p), p) for p in paths],
|
|
f"glob of {d} (not a git tree)", [])
|
|
|
|
tracked = subprocess.run(
|
|
["git", "-C", os.path.abspath(repo), "ls-files", "--", "tools"],
|
|
capture_output=True, text=True).stdout.splitlines()
|
|
named = [t for t in tracked
|
|
if t.startswith("tools/") and t.endswith(".py") and "/" not in t[6:]]
|
|
rows = [(os.path.basename(t), os.path.join(os.path.abspath(repo), t))
|
|
for t in sorted(named)]
|
|
|
|
untracked = subprocess.run(
|
|
["git", "-C", os.path.abspath(repo), "ls-files", "--others",
|
|
"--exclude-standard", "--", "tools"],
|
|
capture_output=True, text=True).stdout.splitlines()
|
|
stray = [t for t in untracked
|
|
if t.startswith("tools/") and t.endswith(".py") and "/" not in t[6:]]
|
|
|
|
rev = subprocess.run(["git", "-C", os.path.abspath(repo), "rev-parse",
|
|
"--short", "HEAD"], capture_output=True, text=True).stdout.strip()
|
|
return rows, f"git ls-files at {rev or 'HEAD'} ({len(rows)} tracked in tools/)", sorted(stray)
|
|
|
|
|
|
# ------------------------------------------------------------------- judging
|
|
|
|
def judge(doc, out: str, rc: int, timed_out: bool):
|
|
"""One verdict dict from a completed run. Pure: no I/O, no clock."""
|
|
printed = parse_printed(out)
|
|
claims = usage_claims(doc or "")
|
|
rec = {
|
|
"printed": ({"count": printed[0], "unit": printed[1],
|
|
"passed": printed[2], "failed": printed[3]} if printed else None),
|
|
"claims": [{"value": v, "unit": u, "line": ln} for v, u, ln in claims],
|
|
"verdict": None,
|
|
"detail": "",
|
|
}
|
|
|
|
if timed_out:
|
|
rec["verdict"] = "TIMEOUT"
|
|
rec["detail"] = "selftest did not finish"
|
|
return rec
|
|
|
|
if printed is None:
|
|
if rc != 0:
|
|
rec["verdict"] = "RUN_FAILED"
|
|
tail = [l for l in (out or "").splitlines() if l.strip()][-1:] or [""]
|
|
rec["detail"] = f"rc={rc}; last line: {tail[0][:160]}"
|
|
else:
|
|
rec["verdict"] = "NO_COUNT_LINE"
|
|
rec["detail"] = "rc=0 but no '<n> cells|fixtures, <n> passed, <n> failed' line"
|
|
return rec
|
|
|
|
count, unit, passed, failed = printed
|
|
if failed > 0 or passed < count:
|
|
rec["verdict"] = "SELFTEST_FAILED"
|
|
rec["detail"] = f"{passed}/{count} passed, {failed} failed"
|
|
return rec
|
|
|
|
same_unit = [(v, ln) for v, u, ln in claims if u == unit]
|
|
values = sorted({v for v, _ in same_unit})
|
|
if len(values) > 1:
|
|
rec["verdict"] = "SPLIT"
|
|
rec["detail"] = ("advertises " + " and ".join(f"{v} {unit}" for v in values)
|
|
+ f"; prints {count}")
|
|
return rec
|
|
if not claims:
|
|
rec["verdict"] = "NO_CLAIM"
|
|
rec["detail"] = f"prints {count} {unit}; advertises none (advisory)"
|
|
return rec
|
|
if values and values[0] == count:
|
|
rec["verdict"] = "OK"
|
|
rec["detail"] = f"{count} {unit}"
|
|
return rec
|
|
|
|
rec["verdict"] = "COUNT_MISMATCH"
|
|
adv = ", ".join(f"{v} {u}" for v, u, _ in claims)
|
|
rec["detail"] = f"advertises {adv}; prints {count} {unit}"
|
|
return rec
|
|
|
|
|
|
def sweep(rows, repo: str, timeout: int, verbose: bool):
|
|
results = []
|
|
for name, path in rows:
|
|
doc, src = module_docstring(path)
|
|
rec = {"tool": name, "path": path}
|
|
if doc is None and not SELFTEST_FLAG_RE.search(src or ""):
|
|
rec.update({"verdict": "UNREADABLE", "detail": "source unreadable",
|
|
"printed": None, "claims": []})
|
|
results.append(rec)
|
|
continue
|
|
if not SELFTEST_FLAG_RE.search(src or ""):
|
|
rec.update({"verdict": "NO_SELFTEST_FLAG", "printed": None,
|
|
"claims": [{"value": v, "unit": u, "line": ln}
|
|
for v, u, ln in usage_claims(doc or "")],
|
|
"detail": "no \"--selftest\" in source; not run"})
|
|
results.append(rec)
|
|
continue
|
|
|
|
timed_out = False
|
|
rc, out = 0, ""
|
|
try:
|
|
proc = subprocess.run([sys.executable, path, "--selftest"],
|
|
cwd=repo, capture_output=True, text=True,
|
|
errors="replace", timeout=timeout)
|
|
rc, out = proc.returncode, (proc.stdout or "") + (proc.stderr or "")
|
|
except subprocess.TimeoutExpired:
|
|
timed_out = True
|
|
except OSError as exc:
|
|
rc, out = 127, f"<exec failed: {exc}>"
|
|
|
|
verdict = judge(doc, out, rc, timed_out)
|
|
rec.update(verdict)
|
|
rec["rc"] = rc
|
|
results.append(rec)
|
|
if verbose:
|
|
print(f" . {name}: {rec['verdict']} rc={rc}")
|
|
return results
|
|
|
|
|
|
# --------------------------------------------------------------------- report
|
|
|
|
def report(results, source, untracked, quiet=False):
|
|
fatal = [r for r in results if r["verdict"] in FATAL]
|
|
if not quiet:
|
|
print(f"discovery: {source}")
|
|
for name in untracked:
|
|
print(f" SKIPPED_UNTRACKED {name} (present in tools/, not in the tree)")
|
|
width = max([len(r["tool"]) for r in results] + [4])
|
|
print()
|
|
print(f"{'tool':<{width}} {'verdict':<16} {'claim':>12} {'printed':>12} detail")
|
|
for r in results:
|
|
claims = r.get("claims") or []
|
|
claim_s = (", ".join(f"{c['value']} {c['unit']}" for c in claims)
|
|
if claims else "-")
|
|
p = r.get("printed")
|
|
printed_s = f"{p['count']} {p['unit']}" if p else "-"
|
|
print(f"{r['tool']:<{width}} {r['verdict']:<16} {claim_s:>12} "
|
|
f"{printed_s:>12} {r['detail']}")
|
|
print()
|
|
ok = sum(1 for r in results if r["verdict"] == "OK")
|
|
print(f"sweep: {len(results)} tools, {ok} OK, {len(fatal)} fatal"
|
|
+ (f" ({', '.join(sorted({r['verdict'] for r in fatal}))})" if fatal else ""))
|
|
return 1 if fatal else 0, ok, len(fatal)
|
|
|
|
|
|
# --------------------------------------------------------------- count pin
|
|
# WHY THIS IS A FILE. Every verdict in `report()` compares the tool's printed
|
|
# count with a number inside the tool. That is a real check on a stale number
|
|
# and no check at all on a shrinking corpus: delete three fixtures, decrement
|
|
# the docstring, and the file agrees with itself. Measured on a clone of this
|
|
# repository at 2026-10-22 -- `doc_command_check.py` cut 15 cells -> 12 on both
|
|
# the print and the usage line still reads `OK 12 cells`, `sweep: 21 tools, 21
|
|
# OK, 0 fatal`, rc 0. The ledger is the witness the tool cannot edit in the
|
|
# same commit without the change being visible in the diff.
|
|
|
|
def default_baseline(repo: str) -> str:
|
|
return os.path.join(os.path.abspath(repo), "tools", BASELINE_NAME)
|
|
|
|
|
|
def load_baseline(path: str):
|
|
"""({tool: (count, unit)}, None) or (None, reason). Blank and # lines skipped."""
|
|
rows = {}
|
|
try:
|
|
with open(path, "r", encoding="utf-8") as fh:
|
|
lines = fh.read().splitlines()
|
|
except OSError as exc:
|
|
return None, f"cannot read baseline {path}: {exc}"
|
|
for n, line in enumerate(lines, 1):
|
|
if not line.strip() or line.lstrip().startswith("#"):
|
|
continue
|
|
parts = line.split("\t")
|
|
if len(parts) != 3:
|
|
return None, (f"{path}:{n}: want 3 tab-separated columns "
|
|
f"(tool, count, unit), got {len(parts)}")
|
|
name, count_s, unit = (p.strip() for p in parts)
|
|
if unit not in UNITS:
|
|
return None, f"{path}:{n}: unit {unit!r} is not one of {UNITS}"
|
|
try:
|
|
count = _int(count_s)
|
|
except ValueError:
|
|
return None, f"{path}:{n}: count {count_s!r} is not an integer"
|
|
if name in rows:
|
|
return None, f"{path}:{n}: duplicate row for {name}"
|
|
rows[name] = (count, unit)
|
|
if not rows:
|
|
return None, f"{path}: no pinned rows"
|
|
return rows, None
|
|
|
|
|
|
def render_baseline(results) -> str:
|
|
"""The ledger text for these results. Rows the selftest never printed are
|
|
skipped here and named by grade_pin() instead -- a pin cannot invent a
|
|
number the tool did not print."""
|
|
head = [
|
|
"# selftest_baseline.tsv -- the cell count each tool's selftest prints, pinned.",
|
|
"# Written by: python3 tools/selftest_sweep.py --repo . --write-baseline tools/selftest_baseline.tsv",
|
|
"#",
|
|
"# WHY THIS FILE EXISTS: the count a tool advertises lives in its own docstring,",
|
|
"# so a commit that deletes fixtures and decrements that number agrees with",
|
|
"# itself and every leg stays green. This ledger is the outside witness.",
|
|
"# `selftest_sweep.py` reads it on every run: a printed count that differs is",
|
|
"# PIN_DRIFT and fatal; a tool with no row is PIN_UNPINNED and fatal; a row",
|
|
"# whose tool is gone is PIN_ORPHAN and fatal. Re-pin on purpose, in the diff.",
|
|
"#",
|
|
"# tool<TAB>count<TAB>unit",
|
|
]
|
|
for r in sorted(results, key=lambda r: r["tool"]):
|
|
p = r.get("printed")
|
|
if not p:
|
|
continue
|
|
head.append(f"{r['tool']}\t{p['count']}\t{p['unit']}")
|
|
return "\n".join(head) + "\n"
|
|
|
|
|
|
def pin_faults(rows):
|
|
return [r for r in rows if r["verdict"] in PIN_FAULT]
|
|
|
|
|
|
def grade_pin(results, baseline):
|
|
"""One row per tool plus one per orphaned pin. Pure: no I/O, no clock."""
|
|
rows = []
|
|
for r in sorted(results, key=lambda r: r["tool"]):
|
|
name, printed = r["tool"], r.get("printed")
|
|
pin = baseline.get(name)
|
|
pinned = {"count": pin[0], "unit": pin[1]} if pin else None
|
|
seen = ({"count": printed["count"], "unit": printed["unit"]}
|
|
if printed else None)
|
|
row = {"tool": name, "pinned": pinned, "printed": seen}
|
|
if r.get("verdict") == "NO_SELFTEST_FLAG":
|
|
row.update(verdict="PIN_NA",
|
|
detail="no --selftest to pin; not counted")
|
|
elif pin is None:
|
|
row.update(verdict="PIN_UNPINNED",
|
|
detail=(f"prints {seen['count']} {seen['unit']}; no pinned row"
|
|
if seen else "no pinned row, and no count to pin"))
|
|
elif seen is None:
|
|
row.update(verdict="PIN_NO_COUNT",
|
|
detail=(f"pinned {pin[0]} {pin[1]}; the run printed no count "
|
|
"(graded above)"))
|
|
elif (seen["count"], seen["unit"]) == (pin[0], pin[1]):
|
|
row.update(verdict="PIN_OK", detail=f"{pin[0]} {pin[1]}")
|
|
else:
|
|
row.update(verdict="PIN_DRIFT",
|
|
detail=(f"pinned {pin[0]} {pin[1]}; prints "
|
|
f"{seen['count']} {seen['unit']}"))
|
|
rows.append(row)
|
|
seen_tools = {r["tool"] for r in results}
|
|
for name in sorted(set(baseline) - seen_tools):
|
|
rows.append({"tool": name, "pinned": {"count": baseline[name][0],
|
|
"unit": baseline[name][1]},
|
|
"printed": None, "verdict": "PIN_ORPHAN",
|
|
"detail": (f"pinned {baseline[name][0]} {baseline[name][1]}; "
|
|
"no tool of that name at this rev")})
|
|
return rows
|
|
|
|
|
|
def report_pin(rows, path, quiet=False):
|
|
bad = pin_faults(rows)
|
|
if not quiet:
|
|
print()
|
|
print(f"count pin: {path} -- the number each selftest prints, pinned "
|
|
"outside the tool it grades")
|
|
width = max([len(r["tool"]) for r in rows] + [4])
|
|
for r in rows:
|
|
pin, seen = r["pinned"], r["printed"]
|
|
pin_s = f"{pin['count']} {pin['unit']}" if pin else "-"
|
|
seen_s = f"{seen['count']} {seen['unit']}" if seen else "-"
|
|
print(f"{r['tool']:<{width}} {r['verdict']:<13} "
|
|
f"pinned {pin_s:>12} printed {seen_s:>12} {r['detail']}")
|
|
agree = sum(1 for r in rows if r["verdict"] == "PIN_OK")
|
|
pinned = sum(1 for r in rows if r["pinned"])
|
|
print(f"pin: {pinned} pinned, {agree} agree, {len(bad)} drift"
|
|
+ (f" ({', '.join(sorted({r['verdict'] for r in bad}))})" if bad else ""))
|
|
return (1 if bad else 0), len(bad)
|
|
|
|
|
|
# ------------------------------------------------------- read-refusal axis
|
|
|
|
def _first_line(text: str) -> str:
|
|
for line in (text or "").splitlines():
|
|
if line.strip():
|
|
return line.strip()[:96]
|
|
return ""
|
|
|
|
|
|
def judge_read(rc, text):
|
|
"""One probe's verdict. Three classes, in this order on purpose: a
|
|
traceback is a defect whatever its exit code, and a silent rc 2 is a
|
|
refusal an operator cannot read."""
|
|
if "Traceback (most recent call last)" in (text or ""):
|
|
return {"verdict": "TRACEBACK", "rc": rc, "detail": _first_line(text)}
|
|
if rc != READ_AXIS_UNIT:
|
|
return {"verdict": "RC_NOT_2", "rc": rc,
|
|
"detail": _first_line(text) or f"rc {rc}, no output"}
|
|
if not (text or "").strip():
|
|
return {"verdict": "SILENT", "rc": rc, "detail": "rc 2 with no message"}
|
|
return {"verdict": "OK", "rc": rc, "detail": _first_line(text)}
|
|
|
|
|
|
def run_read_probe(path: str, argv, timeout: int):
|
|
"""(rc, combined output) for one probe, run in a throwaway cwd."""
|
|
with tempfile.TemporaryDirectory() as td:
|
|
binpath = os.path.join(td, "not-utf8.bin")
|
|
with open(binpath, "wb") as fh:
|
|
fh.write(b"\xff\xfe\x00binary\x00\n")
|
|
bindir = os.path.join(td, "not-utf8-dir")
|
|
os.makedirs(bindir, exist_ok=True)
|
|
with open(os.path.join(bindir, "2026-01-01-volt.md"), "wb") as fh:
|
|
fh.write(b"\xff\xfe\x00binary\x00\n")
|
|
nope = os.path.join(td, "there-is-no-such-path")
|
|
|
|
# the malformed class: each of these DECODES, none of it parses
|
|
notrepo = os.path.join(td, "not-a-repo")
|
|
os.makedirs(notrepo, exist_ok=True)
|
|
with open(os.path.join(notrepo, "README.txt"), "w") as fh:
|
|
fh.write("files, but no .git here\n")
|
|
paths = {"badjson": os.path.join(td, "bad.json"),
|
|
"emptyjson": os.path.join(td, "empty.json"),
|
|
"junklog": os.path.join(td, "log.txt"),
|
|
"junkqueue": os.path.join(td, "q.md"),
|
|
"junkindex": os.path.join(td, "i.md")}
|
|
bodies = {"badjson": "not json at all\n",
|
|
"emptyjson": "{}\n",
|
|
"junklog": "garbage line\nnot a lint entry\n",
|
|
"junkqueue": "this is not a queue\nno headings here at all\nQ\n",
|
|
"junkindex": "not an index either\n"}
|
|
for key, body in bodies.items():
|
|
with open(paths[key], "w", encoding="utf-8") as fh:
|
|
fh.write(body)
|
|
badcheckins = os.path.join(td, "checkins")
|
|
os.makedirs(badcheckins, exist_ok=True)
|
|
with open(os.path.join(badcheckins, "2026-01-01-volt.md"), "w",
|
|
encoding="utf-8") as fh:
|
|
fh.write("no heading, no template\n")
|
|
|
|
repl = {"{nope}": nope, "{bin}": binpath, "{bindir}": bindir,
|
|
"{notrepo}": notrepo, "{badcheckins}": badcheckins}
|
|
repl.update({"{" + k + "}": v for k, v in paths.items()})
|
|
real = []
|
|
for a in argv:
|
|
for key, val in repl.items():
|
|
a = a.replace(key, val)
|
|
real.append(a)
|
|
try:
|
|
p = subprocess.run([sys.executable, path] + real, cwd=td,
|
|
capture_output=True, text=True, errors="replace",
|
|
timeout=timeout)
|
|
except subprocess.TimeoutExpired:
|
|
return None, "<timeout>"
|
|
except OSError as exc:
|
|
return 127, f"<exec failed: {exc}>"
|
|
return p.returncode, (p.stdout or "") + (p.stderr or "")
|
|
|
|
|
|
def judge_malformed(rc, text, expect_rc, need):
|
|
"""One malformed probe's verdict, against the answer its tool states.
|
|
Graded in this order: a traceback is a defect whatever the code; a code
|
|
that is not the documented one is the defect this class exists to catch
|
|
(the silent rc 0); a refusal with no message cannot be acted on; and a
|
|
right code with the wrong verdict word is not the documented answer."""
|
|
if "Traceback (most recent call last)" in (text or ""):
|
|
return {"verdict": "TRACEBACK", "rc": rc, "detail": _first_line(text)}
|
|
if rc != expect_rc:
|
|
return {"verdict": "RC_WRONG", "rc": rc,
|
|
"detail": "rc %s, contract says %s: %s"
|
|
% (rc, expect_rc, _first_line(text) or "no output")}
|
|
if not (text or "").strip():
|
|
return {"verdict": "SILENT", "rc": rc, "detail": "rc %s with no message" % rc}
|
|
if need and need not in (text or ""):
|
|
return {"verdict": "UNEXPLAINED", "rc": rc,
|
|
"detail": "wanted %r, got: %s" % (need, _first_line(text))}
|
|
return {"verdict": "OK", "rc": rc, "detail": _first_line(text)}
|
|
|
|
|
|
def axis_faults(axis):
|
|
"""The rows that make the axis red. NO_PROBE is one of them: a tool with no
|
|
probe entry has not been graded, and 'not graded' is not 'clean'."""
|
|
return [r for r in axis if r["verdict"] in FATAL_READ]
|
|
|
|
|
|
def read_axis(rows, timeout: int):
|
|
"""One row per (tool, probe). Tools the sweep discovered are probed by path;
|
|
a probe naming a tool that was not discovered is NO_TOOL (fatal -- the table
|
|
and the probes have drifted apart), and a discovered tool the tables never
|
|
name is NO_PROBE on each axis (also fatal: the tool is uncovered)."""
|
|
paths = dict(rows)
|
|
out = []
|
|
for probe, specs in (("missing", READ_PROBES), ("not-utf8", NOT_UTF8_PROBES)):
|
|
for name, argv in specs:
|
|
rec: dict = {"tool": name, "probe": probe}
|
|
if name not in paths:
|
|
rec.update({"verdict": "NO_TOOL", "rc": None,
|
|
"detail": "probe names a tool the sweep did not discover"})
|
|
else:
|
|
rc, text = run_read_probe(paths[name], argv, timeout)
|
|
rec.update(judge_read(rc, text))
|
|
out.append(rec)
|
|
for name, label, argv, expect_rc, need in MALFORMED_PROBES:
|
|
rec = {"tool": name, "probe": label, "expect_rc": expect_rc}
|
|
if name not in paths:
|
|
rec.update({"verdict": "NO_TOOL", "rc": None,
|
|
"detail": "probe names a tool the sweep did not discover"})
|
|
else:
|
|
rc, text = run_read_probe(paths[name], argv, timeout)
|
|
rec.update(judge_malformed(rc, text, expect_rc, need))
|
|
out.append(rec)
|
|
probed = {n for n, _ in READ_PROBES}
|
|
malformed = {t for t, *_ in MALFORMED_PROBES}
|
|
for name, _p in rows:
|
|
if name not in probed:
|
|
out.append({"tool": name, "probe": "missing", "verdict": NO_PROBE,
|
|
"rc": None,
|
|
"detail": "no read probe defined -- ungraded, fatal"})
|
|
if name not in malformed:
|
|
out.append({"tool": name, "probe": "malformed", "verdict": NO_PROBE,
|
|
"rc": None,
|
|
"detail": "no malformed probe defined -- ungraded, fatal"})
|
|
return out
|
|
|
|
|
|
def report_read(axis, quiet=False):
|
|
fatal = axis_faults(axis)
|
|
hard = [r for r in axis if r["probe"] in ("missing", "not-utf8")]
|
|
soft = [r for r in axis if r["probe"] not in ("missing", "not-utf8")]
|
|
if not quiet:
|
|
print()
|
|
print(f"read-refusal axis: an unreadable input exits {READ_AXIS_UNIT}, "
|
|
"never 1 (a graded fault)")
|
|
width = max([len(r["tool"]) for r in axis] + [4])
|
|
for r in axis:
|
|
rc = "-" if r["rc"] is None else str(r["rc"])
|
|
print(f"{r['tool']:<{width}} {r['probe']:<15} rc={rc:<4} "
|
|
f"{r['verdict']:<11} {r['detail']}")
|
|
for label, group in (("read-refusal", hard), ("malformed-input", soft)):
|
|
ok = sum(1 for r in group if r["verdict"] == "OK")
|
|
bad = [r for r in group if r["verdict"] in FATAL_READ]
|
|
print(f"{label}: {len(group)} probes, {ok} ok, {len(bad)} fault"
|
|
+ (f" ({', '.join(sorted({r['verdict'] for r in bad}))})" if bad else ""))
|
|
return 1 if fatal else 0, len(fatal)
|
|
|
|
|
|
# ------------------------------------------------------------------- selftest
|
|
|
|
def selftest():
|
|
bad = []
|
|
|
|
def cell(name, ok, detail=""):
|
|
print(f"{'PASS' if ok else 'FAIL'} {name}"
|
|
+ (f" [{detail}]" if (detail and not ok) else ""))
|
|
if not ok:
|
|
bad.append(name)
|
|
|
|
cell("c1 parse plain cells line",
|
|
parse_printed("selftest: 18 cells, 18 passed, 0 failed") == (18, "cells", 18, 0))
|
|
cell("c2 parse fixtures with parenthetical",
|
|
parse_printed("selftest: 14 fixtures (10 claim-check, 4 unit), 14 passed, 0 failed")
|
|
== (14, "fixtures", 14, 0))
|
|
cell("c3 parse hyphenated self-test",
|
|
parse_printed("self-test: 19 fixtures, 19 passed, 0 failed")
|
|
== (19, "fixtures", 19, 0))
|
|
cell("c4 parse thousands separator",
|
|
parse_printed("selftest: 1,204 cells, 1,204 passed, 0 failed")
|
|
== (1204, "cells", 1204, 0))
|
|
cell("c5 no count line -> None",
|
|
parse_printed("all good, everything fine") is None)
|
|
|
|
doc = ("USAGE:\n python3 t.py --selftest # synthetic repo, 18 cells\n")
|
|
cell("c6 claim on the --selftest usage line",
|
|
usage_claims(doc) and usage_claims(doc)[0][:2] == (18, "cells"))
|
|
prose = (" returned a docstring claim of `13 cells` against a selftest that\n"
|
|
" prints `18`\n")
|
|
cell("c7 prose beside the word selftest is not a claim",
|
|
usage_claims(prose) == [])
|
|
cell("c8 claim with a unit the tool never prints is still a claim",
|
|
usage_claims(" --selftest # 7 fixtures\n")[0][:2] == (7, "fixtures"))
|
|
|
|
j = judge(doc, "selftest: 13 cells, 13 passed, 0 failed", 0, False)
|
|
cell("c9 advertised 18 vs printed 13 -> COUNT_MISMATCH",
|
|
j["verdict"] == "COUNT_MISMATCH", j["verdict"])
|
|
j = judge(doc, "selftest: 18 cells, 18 passed, 0 failed", 0, False)
|
|
cell("c10 advertised 18 vs printed 18 -> OK", j["verdict"] == "OK", j["verdict"])
|
|
j = judge(" --selftest # 7 fixtures\n", "selftest: 7 cells, 7 passed, 0 failed", 0, False)
|
|
cell("c11 unit mismatch is a mismatch, not a pass",
|
|
j["verdict"] == "COUNT_MISMATCH", j["verdict"])
|
|
j = judge(" --selftest # 18 cells\n --selftest # 13 cells\n",
|
|
"selftest: 18 cells, 18 passed, 0 failed", 0, False)
|
|
cell("c12 two advertised values -> SPLIT", j["verdict"] == "SPLIT", j["verdict"])
|
|
j = judge("", "selftest: 8 cells, 7 passed, 1 failed", 0, False)
|
|
cell("c13 failed>0 is fatal even at rc=0",
|
|
j["verdict"] == "SELFTEST_FAILED", j["verdict"])
|
|
j = judge("", "Traceback (most recent call last):", 1, False)
|
|
cell("c14 rc!=0 with no count line -> RUN_FAILED", j["verdict"] == "RUN_FAILED", j["verdict"])
|
|
j = judge("", "", 0, False)
|
|
cell("c15 rc=0 with no count line -> NO_COUNT_LINE", j["verdict"] == "NO_COUNT_LINE", j["verdict"])
|
|
|
|
# c16/c17: end to end through main(), on a directory of fake instruments.
|
|
good = ('#!/usr/bin/env python3\n"""fake_good.py -- a fake.\n\nUSAGE:\n'
|
|
' python3 fake_good.py --selftest # 7 cells\n"""\n'
|
|
'import sys\nif "--selftest" in sys.argv:\n'
|
|
' print("selftest: 7 cells, 7 passed, 0 failed")\n sys.exit(0)\n')
|
|
bad_tool = ('#!/usr/bin/env python3\n"""fake_bad.py -- a fake.\n\nUSAGE:\n'
|
|
' python3 fake_bad.py --selftest # 13 cells\n"""\n'
|
|
'import sys\nif "--selftest" in sys.argv:\n'
|
|
' print("selftest: 18 cells, 18 passed, 0 failed")\n sys.exit(0)\n')
|
|
flagless = ('#!/usr/bin/env python3\n"""fake_flagless.py -- no selftest."""\n'
|
|
'print("did some work")\n')
|
|
with tempfile.TemporaryDirectory() as td:
|
|
for nm, body in (("fake_good.py", good), ("fake_bad.py", bad_tool),
|
|
("fake_flagless.py", flagless)):
|
|
with open(os.path.join(td, nm), "w") as fh:
|
|
fh.write(body)
|
|
rc_bad = main(["--tools-dir", td, "--quiet"])
|
|
rows, source, untracked = discover(td, td)
|
|
res = sweep(rows, td, 30, False)
|
|
verdicts = {r["tool"]: r["verdict"] for r in res}
|
|
cell("c16 end to end: a wrong claim is fatal",
|
|
rc_bad == 1 and verdicts.get("fake_bad.py") == "COUNT_MISMATCH",
|
|
f"rc={rc_bad} {verdicts}")
|
|
cell("c17 end to end: correct claim OK, flagless caught, exit 1",
|
|
verdicts.get("fake_good.py") == "OK"
|
|
and verdicts.get("fake_flagless.py") == "NO_SELFTEST_FLAG",
|
|
str(verdicts))
|
|
jd = os.path.join(td, "sweep.json")
|
|
main(["--tools-dir", td, "--quiet", "--json", jd])
|
|
try:
|
|
with open(jd) as fh:
|
|
blob = json.load(fh)
|
|
ok_json = (isinstance(blob, dict) and len(blob.get("tools", [])) == 3
|
|
and blob.get("fatal") == 2)
|
|
except (OSError, ValueError):
|
|
ok_json = False
|
|
cell("c18 --json carries every row and the fatal count", ok_json)
|
|
|
|
# c19-c22: the read-refusal axis's judgement, one cell per class. The axis
|
|
# is the gate on "an input I cannot read must not exit 1"; these cells are
|
|
# the gate on the gate.
|
|
jr = judge_read(2, "cannot read census /nope/a.json: [Errno 2]")
|
|
cell("c19 a refusal at rc 2 with a message -> OK", jr["verdict"] == "OK", jr["verdict"])
|
|
jr = judge_read(1, "MISSING: the check has a fault")
|
|
cell("c20 a graded fault's rc 1 on an unreadable input -> RC_NOT_2",
|
|
jr["verdict"] == "RC_NOT_2", jr["verdict"])
|
|
jr = judge_read(2, "Traceback (most recent call last):\n File x")
|
|
cell("c21 a traceback is fatal even when it exits 2",
|
|
jr["verdict"] == "TRACEBACK", jr["verdict"])
|
|
jr = judge_read(2, "")
|
|
cell("c22 rc 2 with no message -> SILENT", jr["verdict"] == "SILENT", jr["verdict"])
|
|
|
|
# c23-c28: the malformed class's judgement, and its coverage. A decodable
|
|
# input has no single right answer -- each tool's contract decides -- so
|
|
# these cells pin the judgement itself: the documented rc passes, a wrong
|
|
# code fails, and a right code with no explanation fails too.
|
|
jm = judge_malformed(0, "0 opening records; 0 closed; 0 open.", 0, "0 opening records")
|
|
cell("c23 a documented rc 0 grade on malformed input -> OK",
|
|
jm["verdict"] == "OK", jm["verdict"])
|
|
jm = judge_malformed(0, "no tools found at HEAD", 2, "no tools found")
|
|
cell("c24 the silent-zero: rc 0 where the contract says 2 -> RC_WRONG",
|
|
jm["verdict"] == "RC_WRONG", jm["verdict"])
|
|
jm = judge_malformed(2, " ", 2, "")
|
|
cell("c25 a refusal with no message -> SILENT", jm["verdict"] == "SILENT", jm["verdict"])
|
|
jm = judge_malformed(2, "something went wrong", 2, "cannot read")
|
|
cell("c26 the right code with the wrong reason -> UNEXPLAINED",
|
|
jm["verdict"] == "UNEXPLAINED", jm["verdict"])
|
|
jm = judge_malformed(2, "Traceback (most recent call last):", 2, "")
|
|
cell("c27 a traceback is fatal even at the documented code",
|
|
jm["verdict"] == "TRACEBACK", jm["verdict"])
|
|
|
|
missing_probed = {t for t, _ in READ_PROBES}
|
|
malformed_probed = {t for t, *_ in MALFORMED_PROBES}
|
|
cell("c28 every tool with a missing-probe also has a malformed probe",
|
|
missing_probed == malformed_probed,
|
|
str(sorted(missing_probed ^ malformed_probed)))
|
|
|
|
# c29/c30: the NO_PROBE hole, measured from the other side -- a tool the
|
|
# tables never name must come out uncovered on BOTH axes and must make the
|
|
# axis red. Before this cell existed, read_axis emitted two advisory rows and
|
|
# a 15-tool directory graded "14 OK, 0 fatal, rc 0".
|
|
alone = read_axis([("zzz_unprobed.py", "/nonexistent/zzz_unprobed.py")], 5)
|
|
mine = [r for r in alone if r["tool"] == "zzz_unprobed.py"]
|
|
cell("c29 an unprobed tool is NO_PROBE on both axes and is a fault",
|
|
sorted(r["probe"] for r in mine) == ["malformed", "missing"]
|
|
and len(axis_faults(mine)) == 2,
|
|
str([(r["probe"], r["verdict"]) for r in mine]))
|
|
cell("c30 every FATAL_READ verdict is red and OK is not",
|
|
all(axis_faults([{"verdict": v}]) for v in FATAL_READ)
|
|
and not axis_faults([{"verdict": "OK"}])
|
|
and NO_PROBE in FATAL_READ,
|
|
str(FATAL_READ))
|
|
|
|
# c31-c37: the count pin. The defect these grade is the one the classes
|
|
# above cannot see: a corpus that shrinks while every number in the tool
|
|
# agrees with every other number in the tool.
|
|
pin_one = {"fake_good.py": (7, "cells")}
|
|
pr = grade_pin([{"tool": "fake_good.py", "verdict": "OK",
|
|
"printed": {"count": 7, "unit": "cells"}}], pin_one)
|
|
cell("c31 a printed count that matches its pinned row -> PIN_OK",
|
|
pr[0]["verdict"] == "PIN_OK" and not pin_faults(pr), pr[0]["verdict"])
|
|
pr = grade_pin([{"tool": "fake_good.py", "verdict": "OK",
|
|
"printed": {"count": 4, "unit": "cells"}}], pin_one)
|
|
cell("c32 four cells against a pin of seven -> PIN_DRIFT, fatal",
|
|
pr[0]["verdict"] == "PIN_DRIFT" and len(pin_faults(pr)) == 1,
|
|
f"{pr[0]['verdict']} {pr[0]['detail']}")
|
|
pr = grade_pin([{"tool": "new_tool.py", "verdict": "OK",
|
|
"printed": {"count": 3, "unit": "cells"}}], pin_one)
|
|
mine = [r for r in pr if r["tool"] == "new_tool.py"]
|
|
cell("c33 a tool with no pinned row -> PIN_UNPINNED, fatal",
|
|
mine and mine[0]["verdict"] == "PIN_UNPINNED" and mine[0] in pin_faults(pr),
|
|
mine[0]["verdict"] if mine else "no row")
|
|
pr = grade_pin([], pin_one)
|
|
cell("c34 a pinned row whose tool is gone -> PIN_ORPHAN, fatal",
|
|
pr[0]["verdict"] == "PIN_ORPHAN" and len(pin_faults(pr)) == 1,
|
|
pr[0]["verdict"])
|
|
pr = grade_pin([{"tool": "flagless.py", "verdict": "NO_SELFTEST_FLAG",
|
|
"printed": None}], pin_one)
|
|
mine = [r for r in pr if r["tool"] == "flagless.py"]
|
|
cell("c35 a tool with no --selftest is PIN_NA, not a fault",
|
|
mine and mine[0]["verdict"] == "PIN_NA" and mine[0] not in pin_faults(pr),
|
|
mine[0]["verdict"] if mine else "no row")
|
|
|
|
with tempfile.TemporaryDirectory() as td:
|
|
bp = os.path.join(td, "pin.tsv")
|
|
blob = render_baseline([{"tool": "b.py", "printed": {"count": 9, "unit": "fixtures"}},
|
|
{"tool": "a.py", "printed": {"count": 2, "unit": "cells"}}])
|
|
with open(bp, "w", encoding="utf-8") as fh:
|
|
fh.write(blob)
|
|
round_trip, why = load_baseline(bp)
|
|
cell("c36 render/load round-trip keeps both rows and their units",
|
|
round_trip == {"b.py": (9, "fixtures"), "a.py": (2, "cells")},
|
|
f"{round_trip} {why}")
|
|
with open(bp, "w", encoding="utf-8") as fh:
|
|
fh.write("a.py\tnine\tcells\n")
|
|
bad_pin, why = load_baseline(bp)
|
|
cell("c37 a non-integer count is refused, naming the line",
|
|
bad_pin is None and ":1:" in (why or "") and "not an integer" in (why or ""),
|
|
str(why))
|
|
|
|
with tempfile.TemporaryDirectory() as td:
|
|
for nm, body in (("fake_good.py", good), ("fake_flagless.py", flagless)):
|
|
with open(os.path.join(td, nm), "w") as fh:
|
|
fh.write(body)
|
|
bp = os.path.join(td, "pin.tsv")
|
|
buf = io.StringIO()
|
|
with contextlib.redirect_stdout(buf):
|
|
main(["--tools-dir", td, "--write-baseline", bp, "--quiet"])
|
|
written, why = load_baseline(bp)
|
|
cell("c38 --write-baseline pins exactly what the run printed",
|
|
written == {"fake_good.py": (7, "cells")}, f"{written} {why}")
|
|
with open(bp, "w", encoding="utf-8") as fh:
|
|
fh.write("fake_good.py\t9\tcells\n")
|
|
buf = io.StringIO()
|
|
with contextlib.redirect_stdout(buf):
|
|
rc_pin = main(["--tools-dir", td, "--baseline", bp, "--quiet"])
|
|
out = buf.getvalue()
|
|
cell("c39 end to end: a drifted pin names PIN_DRIFT and turns the run red",
|
|
"PIN_DRIFT" in out and "1 drift (PIN_DRIFT)" in out and rc_pin == 1,
|
|
(out.strip().splitlines() or ["no output"])[-1])
|
|
|
|
print(f"selftest: 39 cells, {39 - len(bad)} passed, {len(bad)} failed")
|
|
return 1 if bad else 0
|
|
|
|
|
|
# ----------------------------------------------------------------------- main
|
|
|
|
def main(argv=None):
|
|
ap = argparse.ArgumentParser(
|
|
description="Run every tool's --selftest and check its advertised cell count.")
|
|
ap.add_argument("--repo", default="/root/troupe-standup")
|
|
ap.add_argument("--tools-dir", default=None,
|
|
help="sweep this directory instead of the repo's tracked tools/")
|
|
ap.add_argument("--timeout", type=int, default=120, metavar="S")
|
|
ap.add_argument("--json", default=None, metavar="PATH")
|
|
ap.add_argument("--baseline", default=None, metavar="PATH",
|
|
help="the pinned counts to grade against "
|
|
f"(default: <repo>/tools/{BASELINE_NAME} in repo mode)")
|
|
ap.add_argument("--no-baseline", action="store_true",
|
|
help="do not grade the count pin (the run says so out loud)")
|
|
ap.add_argument("--write-baseline", default=None, metavar="PATH",
|
|
help="write the pinned counts from this run to PATH")
|
|
ap.add_argument("--quiet", action="store_true")
|
|
ap.add_argument("--verbose", action="store_true")
|
|
ap.add_argument("--selftest", action="store_true")
|
|
a = ap.parse_args(argv)
|
|
|
|
if a.selftest:
|
|
return selftest()
|
|
|
|
rows, source, untracked = discover(a.repo, a.tools_dir)
|
|
if not rows:
|
|
# A sweep that discovered nothing has verified nothing. It is not a
|
|
# clean run (rc 0) and not a fatal verdict (rc 1): it is rc 2, the
|
|
# repo-wide code for "could not grade" -- the same contract the
|
|
# read-refusal axis below measures on every other tool.
|
|
print("cannot read: no tools discovered in %s (%s)"
|
|
% (a.tools_dir or os.path.join(a.repo, "tools"), source),
|
|
file=sys.stderr)
|
|
return 2
|
|
results = sweep(rows, a.repo if not a.tools_dir else os.path.abspath(a.tools_dir),
|
|
a.timeout, a.verbose)
|
|
rc, ok, fatal = report(results, source, untracked, a.quiet)
|
|
axis = read_axis(rows, a.timeout)
|
|
rrc, read_fatal = report_read(axis, a.quiet)
|
|
|
|
# ---- the count pin: the witness outside the tool's own docstring
|
|
if a.no_baseline:
|
|
pin_path, pin_note = None, "pin: not graded (--no-baseline)"
|
|
elif a.baseline:
|
|
pin_path, pin_note = a.baseline, None
|
|
elif a.write_baseline:
|
|
pin_path, pin_note = a.write_baseline, None
|
|
elif a.tools_dir:
|
|
pin_path, pin_note = None, ("pin: not graded (--tools-dir: a synthetic "
|
|
"directory carries no pinned counts)")
|
|
else:
|
|
pin_path, pin_note = default_baseline(a.repo), None
|
|
|
|
pin_rc, pin_fatal, pin_rows = 0, 0, None
|
|
if pin_path is None:
|
|
if not a.quiet and pin_note:
|
|
print()
|
|
print(pin_note)
|
|
else:
|
|
if a.write_baseline:
|
|
text = render_baseline(results)
|
|
try:
|
|
with open(a.write_baseline, "w", encoding="utf-8") as fh:
|
|
fh.write(text)
|
|
except OSError as exc:
|
|
print("cannot write --write-baseline " + a.write_baseline
|
|
+ ": " + str(exc), file=sys.stderr)
|
|
return 2
|
|
first = [l for l in text.splitlines() if l and not l.startswith("#")]
|
|
print(f"pin: wrote {a.write_baseline} ({len(first)} row(s))")
|
|
pinned, why = load_baseline(pin_path)
|
|
if pinned is None:
|
|
# A missing or malformed ledger is not a clean run: the pin graded
|
|
# nothing. rc 2 (could not grade), never rc 1 and never 0.
|
|
print("pin: cannot grade -- " + str(why)
|
|
+ " (run --write-baseline to create one, or --no-baseline to sweep without)",
|
|
file=sys.stderr)
|
|
pin_rc = 2
|
|
else:
|
|
pin_rows = grade_pin(results, pinned)
|
|
pin_rc, pin_fatal = report_pin(pin_rows, pin_path, a.quiet)
|
|
|
|
if a.json:
|
|
try:
|
|
with open(a.json, "w") as fh:
|
|
json.dump({"repo": os.path.abspath(a.repo),
|
|
"tools_dir": a.tools_dir,
|
|
"discovery": source,
|
|
"untracked": untracked,
|
|
"tools": results,
|
|
"fatal": fatal,
|
|
"ok": ok,
|
|
"read_axis": axis,
|
|
"read_fatal": read_fatal,
|
|
"pin": {"path": pin_path, "rows": pin_rows,
|
|
"fatal": pin_fatal}}, fh, indent=1)
|
|
except OSError as exc:
|
|
print("cannot write --json " + a.json + ": " + str(exc), file=sys.stderr)
|
|
return 2
|
|
if pin_rc == 2:
|
|
return 2
|
|
return 1 if (rc or rrc or pin_rc) else 0
|
|
|
|
|
|
if __name__ == "__main__":
|
|
sys.exit(main())
|