Files
gstack/ship/sections/test-coverage.md.tmpl
2026-10-30 01:37:02 +00:00

119 lines
7.8 KiB
Cheetah

## Step 7: Test Coverage Audit
### Shared subagent dispatch
For Steps 7, 8 and 10, use the Agent tool with `run_in_background: false`.
Omitting the flag runs the subagent in the background. The explicit flag waits
for a result while keeping a fresh context. Do not invoke the target as a Skill
or run it inline instead. Inline work is allowed only under that section's
documented fallback, after a failed subagent has stopped. The Step 7 and 8 audits
cannot block, so they run at `light` effort on the same model family (the host
default when `gstack-config get review_effort_tiers` prints `off`).
Dispatch the audit through Agent with `subagent_type: "general-purpose"` and
`run_in_background: false`, using the shared foreground-dispatch rule above.
**By packet:** write the subagent-prompt inputs below to `.gstack/tmp/audit-context.txt`,
run `~/.claude/skills/gstack/bin/gstack-review-packet build --audit test-coverage --base <base>
--out-dir .gstack/tmp/review-packets-audit --context .gstack/tmp/audit-context.txt
--passes-used <N>` (the packet holds the audit prompt and
the diff; an audit is one packet, never sharded) and brief the child only with the packet brief and its `read=` ranges:
"Turn 1: read <file> with your file-reading tool (never cat: shell output past ~35 KB spills to a log), one parallel call per line range its PACKET line lists as read=; load no skill and read no SKILL.md. The packet is your whole task and ends with END OF PACKET. Turn 2, only if needed: at most 2 more ranges, in parallel. Last turn: write your result to <out> in one write and reply with only the DONE line it names."
Wait for its `out=` file's LAST-line JSON before applying the coverage gate. `AUDIT_SKIPPED:` (no code path: docs,
data, tests) builds nothing: print it, dispatch nothing, apply the gate with zero paths.
The packet is read-only; with generation allowed,
the parent writes and runs the tests its diagram proposes (caps and value bar below)
and lists them in `tests_added`/`tests_extended` before item 3.
**Generation allowance:** Maximum 2 generation passes total per invocation.
Count each generation-authorized attempt before dispatch/inline execution, including
the initial audit, failures and zero-test results. Re-entry never resets it.
Two passes already used means no further generation; read-only reassessment uses no pass.
**Subagent prompt:** Supply `<base>`, Step 4's framework/bootstrap decision,
permitted paths/commands, remaining gaps, passes used and generation allowance,
plus the CLAUDE.md `## Test Coverage` values the gate below reads (`Generation cap:`,
`Base control:`, `Base control budget:`). No allowance means audit only; missing
permission is not approval. Preserve the 30-path/5-tests-per-pass/2-minute per-test caps.
**Before the first dispatch,** sweep base-control worktrees a previous interrupted run left behind:
```bash
git worktree prune
find "${TMPDIR:-/tmp}" -maxdepth 1 -name 'gstack-base-control.*' -mmin +10 2>/dev/null | while IFS= read -r d; do git worktree remove --force "$d/wt" >/dev/null 2>&1; rm -rf "$d"; done
```
The audit's prompt is `ship/sections/audit-test-coverage.md`; build inlines it into the packet, so
never read it yourself. Its `out=` file ends with one JSON line:
{"coverage_pct":N,"gaps":N,"diagram":"<full markdown coverage diagram for PR body>","tests_added":["path",...],"coverage_pct_value":N,"weak_gaps":[{"path":"...","existing_test":"...","reason":"star_one|gate_failed|unrated"}],"tests_extended":["path",...],"tests_rejected":[{"path_or_gap":"...","reason_code":"...","reason":"..."}],"regression_proof":{"red_at_head":N,"base_green":N,"base_unavailable":N}}
**Parent processing:**
1. Read the packet's `out=` file, never the transcript. Parse its LAST line as JSON.
2. Store `coverage_pct`, `coverage_pct_value`, `gaps`, `weak_gaps`, `tests_added`,
`tests_extended`, `tests_rejected` and `regression_proof`. A missing new key counts
as empty; say so in the summary (an older installed prompt must not fail the gate).
A key with the wrong type (for example `weak_gaps` not an array) is ignored the same
way and printed as: {{TEST_VALUE_MESSAGE:malformedKey}}
3. **Machine checks** on every test written in this run (`tests_added` and
`tests_extended`): a value-card header with the four required fields non-empty plus
an optional `no_claim` (an older four-field card stays valid; else
`incomplete_card`); `protects` unique across the run after casefolding and stripping
punctuation and repeated whitespace (a later duplicate is `duplicate_protects`); seam
`none`, or a named seam with at least one non-test caller (N = 0 or an unavailable
caller check is `needs_seam`). Move each failure to `tests_rejected` with its
`reason_code`, then remove it before anything else reads the diff: an untracked new
file is deleted; for a tracked file, revert only this run's hunk with Edit, never
the whole file. Write one rejected test path per line, relative to the repository
root, into a private file:
{{FREE_TEXT_FILE:REJECTED_FILE=rejected-tests}}
Then run, substituting the printed name for `<rejected-file-name>`:
```bash
REJECTED_FILE="$(git rev-parse --show-toplevel 2>/dev/null || pwd)/.gstack/tmp/<rejected-file-name>"
[ -s "$REJECTED_FILE" ] || { echo "Nothing removed: $REJECTED_FILE is empty; write the paths, then rerun." >&2; exit 1; }
while IFS= read -r f; do
[ -n "$f" ] || continue
case "$f" in /*|..|../*|*/..|*/../*) echo "SKIPPED (outside repo): $f"; continue ;; esac
if git ls-files --error-unmatch -- "$f" >/dev/null 2>&1; then echo "REVERT_HUNK: $f"; else rm -f -- "$f" && echo "REMOVED: $f"; fi
done < "$REJECTED_FILE"
rm -f "$REJECTED_FILE"
```
No `tests_rejected` path may remain on disk as a new file. If every test written in
a pass is rejected, print {{TEST_VALUE_MESSAGE:allRejected}}
4. **Rating dispatch.** When this run wrote tests that survived the machine checks,
dispatch one read-only Agent (`subagent_type: "general-purpose"`,
`run_in_background: false`) with no generation permission; it uses no generation
pass. Give it the diagram and the surviving test paths. It rates each against the
★ rubric and the test value bar and returns a LAST-line JSON
`{"coverage_pct_value":N,"weak_gaps":[...]}` recomputed with its ratings; use those
two values. Until rated, this run's tests count as weak (`unrated`). If it fails,
times out or returns invalid JSON, the gate is skipped for this run ("rating
unavailable").
5. Embed `diagram` verbatim in the PR body's `## Test Coverage` section (Step 19).
6. Print a one-line summary: `Coverage: {X}% value-weighted ({Y}% including {W} weakly covered paths), {gaps} gaps. {tests_added.length} tests added.`
Bindings for the PR body's Test value line: K = `tests_added.length`,
R = `tests_rejected.length`, E = `tests_extended.length`, W = `weak_gaps.length`.
7. **Rescan gate edits after the child returns.** A child's green is a claim until
you have read its gate hunks. Run the scan over the whole candidate; never scan
only the paths the child reported:
{{GATE_SCAN_BLOCK}}
Read every read-level hunk with the checklist's Gate Integrity question. Carry the
`GATE_SUMMARY:` line and any hunk that fails it into Step 9's Gate Integrity
category; the disposition question is asked there, never here. A relaxation the
child made in a test it did not author is a Step 9 finding even when its tests pass.
**Audit failure:** On failure, invalid JSON or no completion after ~10 minutes,
stop the child and confirm it stopped before running the same audit inline.
Fallback recovers the audit; it does not pass or bypass the coverage gate.
Apply that gate to the recovered results, including its undetermined-percentage
and test-only rules. Preserve partial results as incomplete, not passing coverage.
{{TEST_COVERAGE_GATE_SHIP}}
---