Files
msd-core/tests/test-gate-watch-mode.test.cjs
Tom Boucher 603593d41d fix(#1857): test gates normalize to one-shot + bounded timeout (no watch-mode hang)
A GSD verification gate resolves a project's test command and runs it. vitest
defaults to WATCH mode in an interactive TTY — exactly where a user runs
`gsd-execute-phase` — so a resolved `npm test`/`pnpm test` backed by vitest never
exited and the orchestrator waited indefinitely. Recovery needed the user to
manually prompt "something blocking?".

Fix — one shared helper + a bounded, surfacing timeout on the test-command gates:
- New pure module src/normalize-test-command.cts + `gsd-tools query
  normalize-test-command` verb: rewrites a resolved command to a best-effort
  one-shot form (direct vitest → `vitest run`; jest `--watch` → `--watchAll=false`;
  a package-manager `test` script whose package.json runner is watch-vitest →
  `CI=true` prefix; handles `--dir`; already-one-shot commands unchanged —
  never double-flagged). Named `normalize-test-command` (not `test-*`) so the
  file does not match node --test's default `test-*` discovery glob.
- The three gates that HUNG or silently-continued route through that ONE helper
  and bound execution with `timeout $(config-get workflow.test_gate_timeout)`
  (new config key, default 600s): the regression gate (extracted to
  execute-phase/steps/regression-gate.md since execute-phase.md is size-frozen —
  it shrank 93528→93132; ABORTS on exit 124), the post-merge gate, and the
  audit-fix gate (previously an UNBOUNDED `eval`). All name watch/dev mode on 124.
- verify-phase's gate was ALREADY bounded (a fixed `timeout 300`, not a hang), so
  it only gains the normalizer (so a watch runner exits fast) + a watch-mode hint
  on 124, staying under its frozen 40960-byte tier cap.

Security hardening (review): the normalizer only rewrites a runner named as a
standalone command TOKEN (so `run-vitest.js`/`make test-vitest`/paths are never
mangled), is length-capped and uses only linear-time split-based scanning (no
super-linear backtracking on an adversarial `workflow.test_command`), and reads
package.json only when it is a regular file (never blocks on a FIFO via `--dir`).

Config key `workflow.test_gate_timeout` (seconds, default 600) registered in the
schema manifest + templates/config.json + docs/CONFIGURATION.md (mirrors
workflow.cross_ai_timeout). New module registered in .gitignore, eslint ignores,
inventory manifest/index. All 16 golden-install-parity fixtures + workflow size
baseline regenerated for the changed shipped files; bin/lib is excluded from the
parity manifest.

Tests: tests/normalize-test-command.test.cjs (normalizer units incl. security
hardening) and tests/test-gate-watch-mode.test.cjs (the three core gates route
through the shared helper + configured timeout + exit-124 watch-mode hint;
verify-phase asserted as normalize-only/already-bounded).
tests/execute-phase-active-flags.test.cjs repointed at the extracted step;
tests/planner-language-regression.test.cjs allowlist comment updated.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
2026-07-07 12:14:43 -04:00

94 lines
4.7 KiB
JavaScript

// allow-test-rule: source-text-is-the-product #1857
// Workflow .md files — their text IS the deployed contract the orchestrator runs.
/**
* #1857: a GSD test gate must not hang forever on a watch-mode runner.
*
* Three gates were UNBOUNDED or silently-continued and are the core fix. They must:
* - route the resolved command through the shared `normalize-test-command`
* helper (defeats vitest/jest watch mode), so the paths cannot drift,
* - bound execution with `timeout` using the `workflow.test_gate_timeout`
* budget, and
* - surface a timeout (exit 124) with a watch-mode hint — the regression gate
* ABORTS, the others surface clearly (never silently ignored).
*
* verify-phase's gate was ALREADY bounded (a fixed `timeout 300`, not a hang), so
* it only needs the normalizer (so a watch runner exits fast) and keeps its own
* fixed 5-minute bound — asserted separately below.
*/
'use strict';
const { test, describe } = require('node:test');
const assert = require('node:assert/strict');
const fs = require('node:fs');
const path = require('node:path');
const ROOT = path.join(__dirname, '..');
const REGRESSION_GATE = path.join(ROOT, 'gsd-core', 'workflows', 'execute-phase', 'steps', 'regression-gate.md');
const POST_MERGE_GATE = path.join(ROOT, 'gsd-core', 'workflows', 'execute-phase', 'steps', 'post-merge-gate.md');
const AUDIT_FIX = path.join(ROOT, 'gsd-core', 'workflows', 'audit-fix.md');
const VERIFY_PHASE = path.join(ROOT, 'gsd-core', 'workflows', 'verify-phase.md');
const EXECUTE_PHASE = path.join(ROOT, 'gsd-core', 'workflows', 'execute-phase.md');
function read(p) { return fs.readFileSync(p, 'utf-8'); }
// The three gates that were unbounded/silently-continued: full normalize + configured timeout.
const FULL_GATES = [
['regression gate', REGRESSION_GATE],
['post-merge gate', POST_MERGE_GATE],
['audit-fix gate', AUDIT_FIX],
];
describe('#1857: test gates normalize to one-shot and bound with a timeout', () => {
for (const [label, file] of FULL_GATES) {
describe(label, () => {
test('routes the resolved command through the shared normalize-test-command helper', () => {
const c = read(file);
assert.match(c, /normalize-test-command/, `${label} must call the shared normalize-test-command helper`);
});
test('bounds execution with a timeout using the workflow.test_gate_timeout budget', () => {
const c = read(file);
assert.match(c, /workflow\.test_gate_timeout/, `${label} must read workflow.test_gate_timeout`);
assert.match(c, /timeout "\$TEST_GATE_TIMEOUT"/, `${label} must wrap the test command in a timeout with the configured budget`);
});
test('surfaces a timeout (exit 124) with a watch-mode hint — never a silent hang', () => {
const c = read(file);
assert.match(c, /-eq 124/, `${label} must handle the timeout exit code (124)`);
assert.match(c, /watch\/dev mode/, `${label} must name watch/dev mode as the likely cause on timeout`);
});
});
}
// verify-phase is already bounded (fixed `timeout 300`, not a hang); it only
// needs the normalizer so a watch runner exits fast, and names watch mode on 124.
describe('verify-phase gate (already bounded — normalize-only)', () => {
test('routes the resolved command through the shared normalize-test-command helper', () => {
assert.match(read(VERIFY_PHASE), /normalize-test-command/, 'verify-phase must call the shared normalize-test-command helper');
});
test('surfaces its fixed timeout (exit 124) naming watch/dev mode', () => {
const c = read(VERIFY_PHASE);
assert.match(c, /-eq 124/, 'verify-phase must handle the timeout exit code (124)');
assert.match(c, /watch\/dev mode/, 'verify-phase must name watch/dev mode as the likely cause on timeout');
});
});
test('the regression gate ABORTS (halts) on a watch-mode timeout', () => {
const c = read(REGRESSION_GATE);
assert.match(c, /REGRESSION GATE ABORTED/, 'regression gate must abort (not continue) on timeout');
});
test('execute-phase.md delegates the regression gate to the extracted step (size-frozen file stays lean)', () => {
const c = read(EXECUTE_PHASE);
assert.match(c, /steps\/regression-gate\.md/, 'execute-phase.md must reference the extracted regression-gate step');
});
test('the gates share ONE normalizer — the helper is a single source of truth', () => {
// The behaviour lives in src/normalize-test-command.cts; every gate invokes it
// by the same verb name, so a change to watch-defeat logic touches one place.
for (const file of [REGRESSION_GATE, POST_MERGE_GATE, AUDIT_FIX, VERIFY_PHASE]) {
assert.match(read(file), /gsd_run query normalize-test-command/);
}
});
});