* test(#3909): failing-first suite for the fabricated probe fallbacks Binds the four fabrication sites found by executing the surfaces (ADR-3889 failure class (c)), each with a positive control so an over-firing fix goes red: - the blocking api-coverage.verify-pre gate certifying "no external-API integration" from a zero-byte phase scope - the assumption-delta query route scanning an unresolvable phase section as the empty string and reporting it as an examined negative - both capability fragments' probe fallbacks, which append a fabricated verdict rather than replacing, and fire on the legitimate exit-1 negative Verification runs on the remote runner. Refs #3909 * enhance(#3909): a probe that could not run no longer asserts a verdict ADR-3889 Phase 5. Four sites turned a failed or unexamined probe into a confident negative; each now reports what it could not establish. - check api-coverage.verify-pre: a phase with no plan body and no roadmap section ran detection over zero bytes and PASSED the blocking seal gate, certifying "no external-API integration" from input it never read. It now holds with scope_unavailable. The discriminator is bytes examined, never signals found, so a phase whose plans are real and simply carry no API vocabulary passes exactly as before. - query assumption-delta scan: an unresolvable phase section was scanned as the empty string and reported as an examined negative. It now returns {skipped, reason: phase_unresolved}, still at exit 0 — an ADR-2980 degraded result in the payload, leaving the gsd-tools exit projection to P8. - both capability fragments: `|| echo '{"detected":false}'` appended rather than replaced, and fired on the legitimate exit-1 negative, so a correct answer and an honest skip both arrived as two concatenated objects. They now keep the probe's own payload and manufacture only an explicit probe_unavailable skip when the probe produced nothing at all. Every registered outcome is more restrictive on a blocking gate, so this can turn a false green red and never a red green. Docs: FEATURES 156, CONFIGURATION (both keys), references/api-coverage.md seal-time outcome table, and a new how-to for the reason-code vocabulary. Verification runs on the remote runner. Closes #3909 * test(#3909): correct the stale unknown-phase assertion `unknown phase → detected:false, no throw (graceful)` scanned phase 999 against a two-phase roadmap and asserted `detected === false`. That pinned the fabrication as intended behavior: the phase does not exist, so the detector was handed the empty string and its "no core assumption changed" answer described nothing that was ever read. It now asserts the skipped-with-reason shape. The graceful-degradation contract the test was actually protecting — the query succeeds and does not throw on an unknown phase — is unchanged. Found by code review, not by the author. Refs #3909 * docs(#3909): author the FEATURES entry in its generator source `docs/FEATURES.md` is generated by `scripts/gen-features.cjs` from the per-feature fragments in `docs/features/`. The API-coverage entry was edited in the generated file, so the next regeneration silently dropped it. The text now lives in `docs/features/api-coverage-gate.md` and `docs/FEATURES.md` is regenerated from it, leaving the shipped file byte-identical and its content actually derivable. Caught by `lint:generated-sync`. Refs #3909 * test(#3909): bind the skip to "not found", and pin the discriminator The first verification run went red on one case, and the case was wrong rather than the code. `getRoadmapPhaseWithFallback` returns `null` for an unknown phase and for a missing ROADMAP.md, but for a section whose body is whitespace-only it returns the heading line alone — which is not empty. So a body-less section WAS found, and reporting `detected:false` over its heading is a real negative, not a fabrication. The test had assumed the resolver yielded `''` there. Correcting the test rather than the resolver keeps `skipped` bound to the distinction the issue asks for — found versus not found — and avoids diverging `assumption-delta scan` from `roadmap.get-phase`, which the fragment documents as sharing one resolver. Also adds the seeded property the test matrix had promised: for any plan body, the scope read back is whitespace-only exactly when the body was. That pins the gate's discriminator to bytes examined, so it cannot quietly become "no signals found", across unicode whitespace and CRLF. `docs/INVENTORY.md` picks up the reference doc's new seal-time outcome table — surfaced by the co-change gate, not by a lint failure. Refs #3909 * chore(#3909): backfill the changeset PR number Refs #3909 --------- Co-authored-by: sim <sim@local>
This commit is contained in:
Tom Boucher
@@ -16,6 +16,7 @@
|
||||
|
||||
const { describe, test, afterEach } = require('node:test');
|
||||
const assert = require('node:assert/strict');
|
||||
const fc = require('fast-check');
|
||||
const fs = require('node:fs');
|
||||
const os = require('node:os');
|
||||
const path = require('node:path');
|
||||
@@ -369,3 +370,162 @@ describe('readPhaseScope — fail-closed on a real read failure (#2365 review)',
|
||||
assert.strictEqual(res.text, '');
|
||||
});
|
||||
});
|
||||
|
||||
// ─── Unestablished scope is not a negative verdict (#3909, ADR-3889 P5) ───────
|
||||
// The gate's two neighbouring arms already fail closed (unresolvable phase →
|
||||
// block; unreadable plan → block). Certifying "no external-API integration"
|
||||
// from ZERO examined bytes was the remaining fabrication: nothing was read, yet
|
||||
// the blocking seal gate cleared. The discriminator is BYTES EXAMINED, never
|
||||
// SIGNALS FOUND — a phase with real plans and no API vocabulary must keep
|
||||
// passing exactly as it did before.
|
||||
describe('api-coverage.verify-pre — unestablished scope blocks (#3909)', () => {
|
||||
let tmpDir;
|
||||
afterEach(() => { if (tmpDir) { cleanup(tmpDir); tmpDir = null; } });
|
||||
|
||||
function gateJson(phaseDir) {
|
||||
return JSON.parse(runGate(tmpDir, phaseDir).output);
|
||||
}
|
||||
|
||||
test('CONTROL: a real plan with no API vocabulary still passes', () => {
|
||||
tmpDir = makeProject({ api_coverage_gate: true });
|
||||
const phaseDir = makePhaseDir(tmpDir, '01-refactor');
|
||||
writePlan(phaseDir, '01-PLAN.md', '# Plan\nRefactor the internal state machine and rename fields.');
|
||||
const j = gateJson(phaseDir);
|
||||
assert.strictEqual(j.block, false, 'an examined phase with no signal must still pass');
|
||||
assert.strictEqual(j.passed, true);
|
||||
assert.strictEqual(j.detected, false);
|
||||
assert.strictEqual(
|
||||
j.scope_unavailable,
|
||||
undefined,
|
||||
'an examined scope must NOT be reported as unavailable',
|
||||
);
|
||||
});
|
||||
|
||||
test('a phase dir with no plans and no roadmap section BLOCKS instead of certifying', () => {
|
||||
tmpDir = makeProject({ api_coverage_gate: true });
|
||||
const phaseDir = makePhaseDir(tmpDir, '02-empty');
|
||||
const j = gateJson(phaseDir);
|
||||
assert.strictEqual(j.block, true, 'zero examined bytes must not clear the blocking seal gate');
|
||||
assert.strictEqual(j.passed, false);
|
||||
assert.strictEqual(j.scope_unavailable, true, 'the reason must be reported, not implied');
|
||||
assert.strictEqual(
|
||||
j.detected,
|
||||
false,
|
||||
'detected stays false — nothing was found because nothing was examined',
|
||||
);
|
||||
assert.match(j.message, /scope/i);
|
||||
});
|
||||
|
||||
test('BOUNDARY: whitespace-only scope is unestablished', () => {
|
||||
tmpDir = makeProject({ api_coverage_gate: true });
|
||||
const phaseDir = makePhaseDir(tmpDir, '03-ws');
|
||||
writePlan(phaseDir, '01-PLAN.md', ' \n\t\n ');
|
||||
const j = gateJson(phaseDir);
|
||||
assert.strictEqual(j.block, true, 'whitespace is not examined content');
|
||||
assert.strictEqual(j.scope_unavailable, true);
|
||||
});
|
||||
|
||||
test('BOUNDARY: CRLF-only scope is unestablished', () => {
|
||||
tmpDir = makeProject({ api_coverage_gate: true });
|
||||
const phaseDir = makePhaseDir(tmpDir, '04-crlf');
|
||||
writePlan(phaseDir, '01-PLAN.md', '\r\n\r\n');
|
||||
const j = gateJson(phaseDir);
|
||||
assert.strictEqual(j.block, true, 'CRLF-only content carries no scope');
|
||||
assert.strictEqual(j.scope_unavailable, true);
|
||||
});
|
||||
|
||||
test('BOUNDARY: a single non-whitespace character IS examined content', () => {
|
||||
tmpDir = makeProject({ api_coverage_gate: true });
|
||||
const phaseDir = makePhaseDir(tmpDir, '05-one');
|
||||
writePlan(phaseDir, '01-PLAN.md', 'x');
|
||||
const j = gateJson(phaseDir);
|
||||
assert.strictEqual(j.block, false, 'one byte of real scope is examined — normal detection applies');
|
||||
assert.strictEqual(j.scope_unavailable, undefined);
|
||||
});
|
||||
|
||||
test('a COVERAGE.md matrix short-circuits before scope is ever read', () => {
|
||||
tmpDir = makeProject({ api_coverage_gate: true });
|
||||
const phaseDir = makePhaseDir(tmpDir, '06-matrix');
|
||||
// No plans at all — scope would be unestablished, but the matrix decides.
|
||||
writeCoverage(phaseDir, [
|
||||
'# API Coverage — Stripe',
|
||||
'',
|
||||
'| capability | decision | reason |',
|
||||
'|---|---|---|',
|
||||
'| charge | INTEGRATE | |',
|
||||
].join('\n'));
|
||||
const j = gateJson(phaseDir);
|
||||
assert.strictEqual(j.block, false, 'a valid matrix passes regardless of scope readability');
|
||||
assert.strictEqual(j.coverage_present, true);
|
||||
assert.strictEqual(j.scope_unavailable, undefined);
|
||||
});
|
||||
|
||||
test('a no-integration DECLARATION passes even with an unestablished scope', () => {
|
||||
tmpDir = makeProject({ api_coverage_gate: true });
|
||||
const phaseDir = makePhaseDir(tmpDir, '07-decl');
|
||||
writeCoverage(phaseDir, 'No external API integration: pure internal refactor.\n');
|
||||
const j = gateJson(phaseDir);
|
||||
assert.strictEqual(j.block, false, 'the human declaration is the reasoned overrule');
|
||||
assert.strictEqual(j.none_declared, true);
|
||||
assert.strictEqual(j.scope_unavailable, undefined);
|
||||
});
|
||||
|
||||
test('a project with no .planning/phases tree still fails OPEN (not a scope block)', () => {
|
||||
const noPhases = fs.mkdtempSync(path.join(os.tmpdir(), 'gsd-apicov-nophases-'));
|
||||
try {
|
||||
fs.mkdirSync(path.join(noPhases, '.planning'), { recursive: true });
|
||||
fs.writeFileSync(
|
||||
path.join(noPhases, '.planning', 'config.json'),
|
||||
JSON.stringify({ workflow: { api_coverage_gate: true } }),
|
||||
'utf8',
|
||||
);
|
||||
const r = runTools(['check', 'api-coverage.verify-pre', '01-x', '--raw'], noPhases);
|
||||
const j = JSON.parse(r.output);
|
||||
assert.strictEqual(j.block, false, 'a non-GSD layout must stay fail-open');
|
||||
assert.strictEqual(j.passed, true);
|
||||
assert.strictEqual(
|
||||
j.scope_unavailable,
|
||||
undefined,
|
||||
'the new block must not widen to swallow the non-GSD-project pass',
|
||||
);
|
||||
} finally {
|
||||
cleanup(noPhases);
|
||||
}
|
||||
});
|
||||
});
|
||||
|
||||
// ─── Property: the scope discriminator is emptiness, nothing else (#3909) ─────
|
||||
// The gate reports `scope_unavailable` exactly when the scope it read is
|
||||
// whitespace-only. This pins that predicate against arbitrary input — unicode
|
||||
// whitespace, CRLF, strings that merely look blank — so the discriminator can
|
||||
// never quietly become "no signals found" instead of "nothing examined".
|
||||
describe('api-coverage scope emptiness — properties (#3909)', () => {
|
||||
let tmpDir;
|
||||
afterEach(() => { if (tmpDir) { cleanup(tmpDir); tmpDir = null; } });
|
||||
|
||||
test('P1: the scope read back is whitespace-only iff the plan body was', () => {
|
||||
fc.assert(
|
||||
fc.property(fc.string(), (body) => {
|
||||
tmpDir = makeProject({ api_coverage_gate: true });
|
||||
try {
|
||||
const phaseDir = makePhaseDir(tmpDir, '01-prop');
|
||||
writePlan(phaseDir, '01-PLAN.md', body);
|
||||
// No ROADMAP.md is written, so the roadmap fallback contributes
|
||||
// nothing and the plan body is the entire scope.
|
||||
const res = readPhaseScope(tmpDir, phaseDir, '01');
|
||||
assert.strictEqual(res.readError, null, 'a written plan file must always be readable');
|
||||
assert.strictEqual(
|
||||
res.text.trim() === '',
|
||||
body.trim() === '',
|
||||
'the gate blocks on an unestablished scope, so its emptiness test must agree '
|
||||
+ 'with the emptiness of what the author actually wrote',
|
||||
);
|
||||
} finally {
|
||||
cleanup(tmpDir);
|
||||
tmpDir = null;
|
||||
}
|
||||
}),
|
||||
{ numRuns: 200, seed: 3909 },
|
||||
);
|
||||
});
|
||||
});
|
||||
|
||||
Reference in New Issue
Block a user