Files
msd-core/docs/adr/2966-loop-qa-walk.md
Tom Boucher 33fd203ccd test(#2966): loop QA walk — drive real scenarios across all five loop steps (#2976)
* test(#2966): loop QA walk — drive real scenarios across all five loop steps

Adds a headless walk that carries accumulating project state across
discuss -> plan -> execute -> verify -> ship against one temp project,
layered over the existing tests/helpers.cjs runGsdTools substrate.

Findings carry severity. A violation breaks a stated contract and fails
the build; a smell is legal under today's implementation but structurally
questionable, is recorded, and never reddens CI. Without that split an
oracle set derived from current behavior can only ever confirm current
behavior -- the harness could not say "this works and is still wrong".

The end-to-end test asserts the walk produces at least one smell: a QA
harness that reports nothing on a first run against a real engine is far
more likely mis-specified than the engine is perfect. It deliberately does
not pin smell ids or counts, which would re-freeze current behavior.

First run against the real engine: 0 violations, 3 smell classes --
init returns agents_dir outside the project tree; smart-entry emits prose
unconditionally so routing cannot be asserted; state-snapshot reports a
missing STATE.md through a payload key with exit 0.

Also fixes tests/fixtures/index.cjs: createFixture with git:true and
planning:false staged nothing, so the commit failed with "nothing to
commit". That combination was unreachable until greenfield needed it.

Extends RULESET.TESTS.feedback-loop-convergence from estimation to the
loop itself. Design lock: docs/adr/2966-loop-qa-walk.md.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>

* test(#2966): wire fault injection, make perturbations discriminating

Independent review found tests/qa/mutations.cjs entirely unwired: 462
lines exercised only by their own unit tests, with no mutation hook in
the scenario DSL and no scenario applying one, while the module header
and the ADR described fault injection in the present tense. Dead code
documented as live.

Adds a `mutate` step field, three perturbation scenarios, and a wiring
detector: a self-test scenario whose expectations are known-false and
which MUST fail. The previous anti-vacuity check asserted only that the
walk produced a smell, which passes on well-known engine behavior
regardless of whether the harness wiring works.

First perturbation attempt produced zero signal -- progress does not
structurally parse ROADMAP.md, so a corrupted roadmap sailed through. A
perturbation that cannot fail is the same defect in a new costume.
Probes now target roadmap get-phase, and each mutated step runs a clean
baseline first so `mutationObserved` records whether the corruption
changed anything at all.

Also clears four review findings: classify() returned PROSE for exit-0
with empty stdout; `warnings` was structurally unpopulatable on the
success path (execFileSync discards it) and is now documented as
error-path-only; read-only-idempotence passed vacuously when asked to
check idempotence without the data to check it; the ADR miscounted the
oracles.

Discrimination matrix across 8 mutations x 6 commands: bom,
duplicate-phase-id and escaped-pipes are absorbed silently by every
probed surface, and progress / smart-entry / roadmap validate never
reacted to any mutation.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>

* test(#2966): add path-containment guard for scenario-supplied targets

Security review found scenario-supplied paths joined to the temp project
with no containment check. step.mutate.target and agent.write keys were
validated only as non-empty strings, so a target of ../../../../etc/hosts
reached fs.unlinkSync / fs.writeFileSync / fs.symlinkSync outside the
project. The symlink mutation was worst: it read the traversed file, wrote
a sibling copy, deleted the original and symlinked it back.

Not exploitable today -- all shipped scenarios target .planning/ROADMAP.md
and scenarios are repo-committed, not runtime input. Fixed anyway: it is a
live primitive any future scenario or copied helper can reach.

Adds tests/qa/paths.cjs with resolveWithin(): rejects absolute paths, NUL
bytes and empty input, normalizes separators unconditionally, and requires
containment by path segment so a sibling like <base>-evil is not treated as
inside. Non-existent targets resolve via nearest existing ancestor rather
than falling back to a lexical compare. Scenario load now rejects traversing
or absolute targets up front.

oracles.cjs previously carried its own copy of the containment logic; both
now share paths.cjs, since a duplicated containment check is exactly the
divergence class this repo calls out.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>

* test(#2966): complete trajectory corpus, report emission, boundary-aware oracle

Adds the remaining trajectories and drives all 11 mutations end-to-end.
20 scenarios, 72 steps, 0 violations, 25 smells.

Adds qa-report.json with per-step verdicts and a copy-pasteable repro
command, plus --keep / GSD_QA_KEEP=1 to preserve a failing tree. A repro
line for a tree that was not preserved is marked NOT RUNNABLE rather than
emitting a command pointing at a deleted directory.

monotonic-progress is now boundary-aware. Two scenarios had been trimmed
to stop the oracle complaining at a milestone rollover, which destroys the
signal the trajectory exists to produce. Evidence: counters legitimately
reset to zero at milestone complete, but the payload milestone_version
lags until a new ROADMAP.md is written. So the oracle now scopes by
milestone plus workstream, keeps a same-scope decrease as a violation, and
records a boundary crossing as a smell. Both scenarios walk the real
boundary again.

Standards review fixes: oracle findings now carry a structured subject so
tests assert on typed fields instead of substring-matching the free-form
detail string, resolveWithin throws a typed EPATHESCAPE error, and the
absolute-path predicate scenario.cjs had re-implemented now comes from
paths.cjs.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>

* test(#2966): fix silently-vacuous fixtures and guard the class

Every fixture carried its #2371 provenance comment BEFORE the frontmatter
block, and extractFrontmatter returns {} when anything precedes the opening
---. So every scenario reading status/phase/name was operating on an empty
object and reporting green. Nine fixtures repositioned; the comment stays,
it just moves below the closing ---.

Both UAT fixtures lacked a parser-recognized result block, so
evaluateUatPassed saw checks.length===0 and could never return passed:true.
The uat-fail-then-remediate scenario could not have proven a remediation.
Its expect block only inspected blockers, which is empty before AND after,
which is why the corpus never noticed. Both fixtures now carry real result
blocks and the scenario asserts passed and no_uat_artifacts on each side of
the flip.

The actual deliverable is the guard: a fixture-integrity block asserting
every fixture with a frontmatter shape parses to a non-empty object, that
every fixture carries its provenance marker, and that the two UAT fixtures
produce opposite verdicts through the real evaluateUatPassed. The first
guard written required --- at byte 0, which would never have fired on the
regression it exists to prevent; it was rewritten and proven by deliberately
re-breaking a fixture.

No engine defect here. no_uat_artifacts means no parsed check items, not no
UAT files, and it was reporting correctly on fixtures that had none.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>

* test(#2966): make the walk report — smell ratchet, baseline, CI job

The harness computed smells into a gitignored qa-report.json that nothing
read. In CI it surfaced nothing at all: violations failed the build, but the
half of the tool that says "this works and is still wrong" was inert. A QA
tool nobody hears is decoration.

Adds a ratchet on the same idiom this repo already uses three times over
(the regression-test-name allowlist, the emitted-drift acks, the size
baseline): a committed smell-baseline.json, per-PR acknowledgment fragments
under tests/qa/smell-acks/, and a ratchet script wired into CI.

The design invariant is preserved exactly. A smell still never fails a build
on its own merits. What fails is an UNACKNOWLEDGED NEW smell -- the absence
of a decision -- leaving an author two honest exits: fix it, or record a
fragment with a real reason. An empty reason is rejected. The baseline is
shrink-only, so a fixed smell must prune its entry. Violations remain
unacknowledgeable.

Fingerprints are composed only from stable fields (oracle id, scenario,
argv, subject discriminator) -- never temp paths, timestamps or counts.
Verified byte-identical across two runs in separate temp dirs; an unstable
fingerprint would have false-positived every CI run.

CI gains a qa-loop-walk job that runs the suite and the ratchet, uploads the
report with `if: always()` (it matters most when it failed), and renders a
summary a reviewer reads without downloading anything.

Also fixes the report runner invoking main() unconditionally on require, so
importing it double-ran every scenario and clobbered its own output.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>

* test(#2966): every smell terminates in a defect or a fixed detector

The baseline accepted a smell with a free-text reason. That is a mechanism
for designing smells in -- an allowlist nobody revisits. The harness is
brand new, so nothing it found is inherited legacy; every finding is a
FIRST finding. Each must now terminate in exactly one of two states:

  REAL           -> an assigned defect, entry carries the issue number
  FALSE POSITIVE -> the detector is wrong and gets fixed, never baselined

There is no third "accepted with a good explanation" state, so the ratchet
now requires a positive-integer `issue` on every entry. A reason may remain
as a human note but can never substitute. `--update` refuses to invent
issue numbers: a new smell is written with `issue: null` and a TODO, and
the next plain run rejects it, forcing triage rather than accumulation.

Working the 21 existing entries through that rule found 16 were my own
detectors being wrong:

value-hygiene (10) flagged $.agents_dir, a field whose entire contract is
to point at the install tree outside any project. Fixed with a leaf-key
allowlist of contractually-external fields, verified as the only such key
in the init payload. Genuinely unexpected out-of-project paths still smell.

monotonic-progress (6) fired on legitimate boundary crossings -- milestone
v1.0 to v2.0, workstream beta to alpha -- and on one payload carrying no
scope fields at all, where a change cannot even be known. Scope changes now
reset silently and scope-less observations are skipped. The same-scope
decrease remains a violation; that is the real invariant and is regression-
guarded.

The five survivors are real and now tracked: soft-error-exit-zero (#2980),
untyped-success (#2979). Baseline 25 -> 5.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>

* test(#2966): keep the ratchet out of the tarball, unpin the qa CI job

The remote matrix returned failed -- 3 unique failures, identical on
node22 and node24, both root causes in this branch's own diff.

The ratchet lives under scripts/, which ships in the npm tarball, and it
requires three modules under tests/, which does not. In a published
install it is MODULE_NOT_FOUND at load. This is exactly the class the
#2858 guard was added to catch, and it caught it. Fixed the way #2858
fixed the same shape for its own repo-only CI script: a targeted files[]
negation, so the ratchet stays in the repo for CI and out of the tarball.
Not solved by moving or inlining the required modules -- the ratchet must
keep using the same code the harness uses, or the two drift.

Verified both directions: the script is no longer in the pack list, and
build-hooks.js, fix-slash-commands.cjs and gen-capability-registry.cjs are
all still shipped. Over-negating there would have broken installs, since
bin/install.js requires them.

The qa-loop-walk job also carried CI_REBASE_BASE_SHA copied from a
neighbouring job without the paired GSD_EMITTED_BASE, which the #2854
invariant forbids by name: diverging them makes the differential compare a
tree against a baseline from a different commit. The job runs only the qa
suite and the ratchet and invokes no emitted-attribution test, so it needs
no rebase-pinned base at all -- the step was removed rather than paired.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>

* test(#2966): stop monotonic-progress going blind on scope-less payloads

The full remote suite caught a false NEGATIVE I introduced while fixing a
false positive. Silencing the boundary-crossing noise had made the oracle
skip ANY observation lacking milestone fields -- so a minimal payload like
{total_summaries: n} produced no violation at all, and the oracle stopped
catching the exact defect it exists to catch. For a QA tool that is
strictly worse than the noise it replaced.

Scope is only indeterminate when the two observations DISAGREE about
having it:

  both scoped, same scope, decrease -> VIOLATION
  both scoped, different scope      -> reset silently
  NEITHER scoped, decrease          -> VIOLATION   (the regression)
  mixed                             -> skip the comparison

Implementing the mixed case surfaced a second blind spot: advancing the
reference point on a skipped pair lets a scope-less observation sitting
between two same-scope ones mask a real decrease. Mixed now leaves the
reference untouched. All four branches carry explicit coverage; only one
did before, which is why this shipped.

The self-test that failed was right and the code was wrong, so the code
moved. Corpus behavior is unchanged: still 5 smells, 0 new, 0 stale, 0
violations.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>

---------

Co-authored-by: Claude Opus 5 <noreply@anthropic.com>
2026-08-01 16:13:28 -04:00

12 KiB

ADR-2966: Test the five-step loop as a continuous walk, not isolated points

  • Status: Accepted
  • Date: 2026-08-01
  • Issue: #2966
  • Supersedes: —
  • Relationship to prior work: Extends RULESET.TESTS.feedback-loop-convergence (CONTEXT.md) from its existing single instance, tests/estimate-loop-convergence.test.cjs, to the full five-step loop.

Context

131 of roughly 705 test files already drive the real gsd-tools binary through runGsdTools in tests/helpers.cjs — CLI-altitude testing is solved and well trodden. What no existing test does is carry one project's accumulating state across all five loop steps in a single run. Every loop test today asserts a step in isolation, against state fabricated for that step alone. CONTEXT.md's RULESET.TESTS.feedback-loop-convergence already names the alternative — assert convergence across an accumulating sequence — and one instance of it exists for estimation (tests/estimate-loop-convergence.test.cjs). This ADR extends that pattern to the loop itself.

Decision

1. Walk the loop as a continuous trajectory

Build a walk driver, tests/qa/loop-walk.cjs, that runs the five loop steps in order against one project's accumulating on-disk state, rather than five independent point tests each seeded from scratch. This is RULESET.TESTS.feedback-loop-convergence generalized from estimation to the loop, anchored to the existing convergence instance rather than invented fresh.

2. Layer over tests/helpers.cjs; do not build a second substrate

runGsdTools already invokes the real subprocess with a 60s timeout and env injection, and 131 files depend on it. The walk driver is built strictly on top of it. The rejected alternative — a standalone harness re-implementing subprocess invocation — was considered and rejected as duplication (Gall's Law: a working complex system evolves from a working simple one).

3. The stub agent seam, and its limit stated plainly

gsd-tools init new-project (and the other loop init commands) write nothing — they are read-only context projections; the agent is the one that authors artifacts (STATE.md, phase files, etc.). A scripted stub writer standing in for the agent is therefore faithful to the real division of labor, and the entire engine — routing, state transitions, gates — runs for real behind it.

The limit is stated plainly and not glossed over: this walk proves the engine's state machine is coherent across all five steps. It proves nothing about whether a real LLM agent emits artifacts of the shape the walk's fixtures assume.

4. Oracles read a typed IR only, never rendered text

tests/qa/oracles.cjs's ten invariant oracles (seven SEVERITY.VIOLATION oracles plus three SEVERITY.SMELL oracles — see §5) assert exclusively against tests/qa/result.cjs's typed RunResult IR, never against raw stdout/stderr text. This is forced, not stylistic: CONTRIBUTING.md → "Prohibited: Raw Text Matching on Test Outputs" and RULESET.TESTS.no-source-grep.tmp-file-traps both ban it. The same constraint governs the tree-idempotence oracle: it compares fs.statSync facts (size, mtimeMs, isFile()) across runs, never content hashing or reading the SUT's own tmp-file output, which would trip the identical lint.

5. Findings carry severity; the harness reports evidence, it does not adjudicate

tests/qa/oracles.cjs's check(ctx) outcomes carry a severity:

  • SEVERITY.VIOLATION — the documented contract is broken. Fails runOracles(ctx).failed and therefore fails the build.
  • SEVERITY.SMELL — legal under today's implementation but structurally questionable. Recorded in .smells, never folded into .failed, and never fails a build.

Rationale: an oracle set derived from current behavior can only ever confirm current behavior — that framing turns the harness into a conformance test for the status quo. Severity is what lets the harness say "this works and is still wrong," which is the sentence a quality tool must be able to form. The maintainer decides which smells become fixes; the tool's job is to make the trade visible instead of invisible.

Consequence, stated as an explicit safety property: runOracles(ctx).failed is a getter that deliberately aliases violations only — it never includes smells. Adding a smell oracle, or a new smell case to an existing oracle, can therefore never redden CI. The severity split is what makes it safe to keep adding observational oracles without turning every new observation into a build break.

6. output({error: …}) is not changed here — its cost is now visible on every occurrence

42 call sites use output({error: …}): a JSON payload carrying an error key on stdout, exit 0. This is deliberately distinct from error(msg, reason), which writes {ok:false, reason, message} to stderr and exits 1. get_impact rates cmdStateSnapshot — the function this idiom threads through — CRITICAL (55 affected symbols, 23 processes). Normalizing all 42 sites to the hard-failure path was considered and rejected: it would flip exit codes 0 → 1 across a seam that workflows and agents currently treat as a soft signal — Hyrum's Law applies directly, since the exit-0 behavior is observable and already depended on.

This is not left alone because it is judged fine. It is not changed here because a blast radius of that size warrants a separate, deliberate decision, not one folded into a QA-harness ADR — and the soft-error-exit-zero smell (§5) now fires on every occurrence so the cost stays visible instead of quietly disappearing back into the status quo. The concrete cost for a caller: a shell caller's if ! cmd; then is blind to a failure reported through a payload key with exit 0 — the process exits 0, so the conditional never trips. The walk's RunResult IR types this shape explicitly (kind: 'soft-error') so it can be reported as a smell rather than silently swallowed.

7. The docs/json-errors.md vs. src/cli-exit.cts contract conflict is surfaced, not resolved

docs/json-errors.md states that every error emits exactly one JSON line to stderr and exits 1. src/cli-exit.cts's runMain returns before reaching the json-error branch for ExitError, so CLI usage errors deliberately emit plain text instead. Both behaviors are current and they contradict each other.

This ADR does not pick a side — resolving it means changing every ExitError throw site, which is a separate decision with its own blast radius. What changes is how the conflict is surfaced: the contract-conflict smell (§5) fires on every occurrence in json-error mode and quotes both sides in its detail — the docs/json-errors.md sentence and the src/cli-exit.cts runMain early-return that produces the breach — so a reader gets the evidence needed to decide, not a bare note that a conflict exists. This is layered on top of json-contract, which already reports the same observation as a VIOLATION of the documented contract (RunResult.kind: 'unstructured-error' on rows the doc says should be structured); contract-conflict adds the reason it is ambiguous rather than a clear-cut bug.

8. Fixture provenance is honest, not borrowed

Scenario artifacts live at tests/qa/fixtures/, template-derived, carrying an explicit provenance comment. They deliberately do not live at tests/fixtures/representative/, which asserts real-user provenance this repo cannot substantiate — no .planning/ directory exists in this repo and no real loop-artifact fixtures exist to source from. Per #2371, template-derived provenance is adequate for happy-path and sequence scenarios, because templates are exactly what agents are instructed to emit. It is not adequate for a negative fixture asserting that the engine correctly rejects malformed input — a rejection test needs to be grounded in what the engine's grammar actually forbids, not a plausible guess at malformed shape. Perturbations (tests/qa/mutations.cjs) are exempt from this constraint: a CRLF/BOM/truncate transform is drawn from a generic corruption catalog, not from the engine's grammar, so it carries no provenance claim to substantiate.

9. New qa test-suite marker, excluded from the default unit lane

scripts/run-tests.cjs gains a qa suite marker for tests/loop-walk.qa.test.cjs and its dependents, excluded from the default unit lane. The walk's subprocess fan-out is deliberately bounded and run sequentially within a file: RULESET.HARNESS.test-memory-guard denies node spawns above 4 GiB aggregate RSS, and parallelizing scenario runs would risk crossing it.

What the first run found

Running the walk driver against the real engine — not a mock — produced 0 violations and three smell classes on this first pass:

  • value-hygiene — init returns agents_dir pointing outside the project tree.
  • untyped-success — smart-entry emits prose unconditionally (gsd-core/bin/lib/smart-entry.cjs:577-587), so the routing oracle cannot assert on it until a --json mode exists.
  • soft-error-exit-zero — state-snapshot reports a missing STATE.md through a payload key with exit 0.

These are observations for a maintainer to weigh, not defects this PR fixes.

Consequences

  • Positive — makes easy. A defect that only manifests as accumulated state drifting across loop steps (a stale pointer, a field one step wrote that a later step misreads) is now catchable by a single walk instead of requiring a human to hand-construct multi-step state. The RunResult IR gives every future loop-facing test a typed, lint-compliant surface to assert against instead of re-deriving raw-text parsing per test. The convergence pattern (RULESET.TESTS.feedback-loop-convergence) now has a second, load-bearing instance beyond estimation, making it a demonstrated pattern rather than a one-off.
  • Positive — anti-vacuity guard. The end-to-end test (tests/loop-walk.qa.test.cjs) asserts the walk produces at least one smell, because a QA harness reporting nothing on a first run against a real engine is more likely mis-specified than the engine is perfect. It deliberately does not assert exact smell ids or counts — pinning those would re-freeze current behavior, the same failure mode the severity split (§5) exists to avoid.
  • Negative — makes harder. The walk is one more thing to keep in sync with the five-step loop's actual shape; LOOP_HOST_CONTRACT is consumed from the generated module rather than re-listed, specifically to prevent this from becoming a second copy that drifts (per the design's known-defect gauntlet). The qa suite's sequential-only execution bounds wall-clock cost as scenario count grows.
  • Known limits, stated rather than hidden.
    • The stub agent is not an LLM. The walk validates the engine's state machine; it says nothing about whether a real agent produces artifacts of the assumed shape.
    • ship has no runnable predicate evaluator (tests/loop-hooks-ship-pre-e2e.test.cjs: "enforcement is ship.md prose only"), so the ship step is asserted at contract-shape level only, not behaviorally.
    • smart-entry emits prose unconditionally on success (gsd-core/bin/lib/smart-entry.cjs:577-587), which is one of several untyped-success commands (config-path, audit-open, skill-manifest, and others). The routing oracle cannot assert on smart-entry's routing decision until it gains a --json mode; that is future work, not covered here.
    • The open docs/json-errors.md vs. src/cli-exit.cts contract conflict (§6) remains unresolved by this ADR.

References

  • CONTEXT.md → RULESET.TESTS.feedback-loop-convergence
  • tests/estimate-loop-convergence.test.cjs — the existing convergence instance this ADR generalizes
  • tests/helpers.cjs — runGsdTools, the substrate the walk is layered over
  • tests/qa/loop-walk.cjs, tests/qa/result.cjs, tests/qa/oracles.cjs, tests/qa/mutations.cjs, tests/qa/fixtures/**, tests/qa/scenarios/*.json
  • tests/loop-walk.qa.test.cjs
  • src/io.cts — output (output({error}) soft-failure idiom, 42 sites, CRITICAL per get_impact), error
  • src/state.cts:1388 — cmdStateSnapshot
  • src/cli-exit.cts — runMain, the ExitError early-return that produces the §6 conflict
  • docs/json-errors.md
  • CONTRIBUTING.md → "Prohibited: Raw Text Matching on Test Outputs"
  • gsd-core/bin/lib/smart-entry.cjs:577-587
  • Issue #2371 (fixture provenance standard)
  • .gsd/phase/test-2966-loop-qa-walk/40-design.md — the design this ADR records