Files
msd-core/tests/tdd-red-evidence.test.cjs
Tom Boucher fb3e228a0d fix(#4724): classify Surefire/Failsafe XML as RED evidence (#4825)
* test(#4724): add failing-first coverage for Surefire XML RED evidence

* fix(#4724): classify Surefire/Failsafe XML as RED evidence

check tdd-red-evidence parsed only node:test TAP, so a JVM project's
genuine Maven red scored INVALID_RED while hand-written synthetic TAP
scored RED_EVIDENCE_OK — the gate was passable only by fabricating its
input (issue #4724's measured repro).

classifyRedEvidence detects Surefire/Failsafe XML (a <testsuite> element)
and parses it by TAG-BOUNDARY scanning: each <testcase> owns its own tag
(self-closing) or the segment up to its </testcase> closer, so the
issue's warned-about spanning trap (a lazy lazy match from a green
self-closing case to the next closing tag) cannot misreport names. A
<failure> or <error> child marks the case failing; the target matches at
class granularity (exact classname, dotted-suffix, or method name). Any
parse anomaly degrades to not-failing — the module stays fail-closed and
PURE (no fs/clock; report freshness remains the workflow's run-start
check per the issue's implementation notes).

TAP classification is byte-identical: all existing fixtures stay green.

* test(#4724): pin the scanner hardening — truncation, TAP-message flip, CDATA phantom

* docs(#4724): backfill changeset PR number

---------

Co-authored-by: sim <sim@local>
2026-09-17 11:30:23 -04:00

423 lines
17 KiB
JavaScript

'use strict';
/**
* RED-evidence classification for `type: tdd` plans (#3770).
*
* Module: gsd-core/bin/lib/tdd-red-evidence.cjs (compiled from src/tdd-red-evidence.cts)
* Router: `check tdd-red-evidence <record.json>` in check-command-router.cjs
*
* #3770: the TDD executor accepted ANY nonzero test command as RED. Syntax
* errors, zero-test discovery, fixture crashes, parser errors, and unrelated
* assertions all authorized production edits (GREEN). Only an intentional
* failure of the TARGET test for the planned behavior may advance to GREEN;
* every other nonzero outcome is INVALID_RED.
*
* Row numbers map to .gsd/bug/fix-3770-tdd-red-evidence/50-test-matrix.md.
* TAP fixtures below are captured verbatim from `node --test --test-reporter tap`
* (Node v26) for each failure class.
*/
const { describe, test, before, after } = require('node:test');
const assert = require('node:assert/strict');
const fs = require('node:fs');
const os = require('node:os');
const path = require('node:path');
const { cleanup, runGsdTools } = require('./helpers.cjs');
const {
classifyRedEvidence,
buildRedEvidenceRecord,
} = require('../gsd-core/bin/lib/tdd-red-evidence.cjs');
// ─── TAP fixtures (captured from node --test --test-reporter tap) ─────────────
/** Row 1: intentional target failure — `not ok 1 - rejects empty email`, # fail 1, exit 1. */
const TARGET_FAILURE_TAP = [
'TAP version 13',
'# Subtest: rejects empty email',
'not ok 1 - rejects empty email',
' ---',
' duration_ms: 1.15',
" error: 'Expected values to be strictly equal. 1 !== 2'",
" code: 'ERR_ASSERTION'",
' ...',
'1..1',
'# tests 1',
'# suites 0',
'# pass 0',
'# fail 1',
'# cancelled 0',
'# skipped 0',
'# todo 0',
'# duration_ms 46.8',
'',
].join('\n');
/** Rows 2: zero-test discovery — discovery matched zero tests, harness exits nonzero. */
const ZERO_TESTS_TAP = [
'TAP version 13',
'1..0',
'# tests 0',
'# suites 0',
'# pass 0',
'# fail 0',
'# cancelled 0',
'# skipped 0',
'# todo 0',
'# duration_ms 3.1',
'',
].join('\n');
/** Row 3: fixture crash / load throw — the failure is FILE-NAMED, not the target test. */
const FIXTURE_CRASH_TAP = [
'TAP version 13',
'# Subtest: crash.test.cjs',
'not ok 1 - crash.test.cjs',
' ---',
' duration_ms: 28.3',
" type: 'test'",
' location: \'crash.test.cjs:1:1\'',
" failureType: 'testCodeFailure'",
' exitCode: 1',
" error: 'test failed'",
" code: 'ERR_TEST_FAILURE'",
' ...',
'1..1',
'# tests 1',
'# suites 0',
'# pass 0',
'# fail 1',
'# cancelled 0',
'# skipped 0',
'# todo 0',
'# duration_ms 28.3',
'',
].join('\n');
/** Row 6: an unrelated test fails — a real assertion, but not the target test. */
const UNRELATED_FAILURE_TAP = TARGET_FAILURE_TAP.replaceAll(
'rejects empty email',
'unrelated legacy behavior',
);
function validRedInput(overrides = {}) {
return {
command: 'node --test tests/email.test.cjs',
exitCode: 1,
output: TARGET_FAILURE_TAP,
targetTest: 'rejects empty email',
targetFile: 'tests/email.test.cjs',
expected: 'ValidationError for empty input',
actual: '1 !== 2',
...overrides,
};
}
// ─── Pure classifier (#3770 regression rows) ─────────────────────────────────
describe('classifyRedEvidence (#3770)', () => {
test('row 1 — classifyRedEvidence accepts intentional target failure', () => {
const result = classifyRedEvidence(validRedInput());
assert.equal(result.verdict, 'RED_EVIDENCE_OK', 'an intentional target failure is the only valid RED');
assert.equal(result.reason, 'target_test_failed');
assert.equal(result.evidence.failing_tests[0], 'rejects empty email');
assert.equal(result.evidence.exit_code, 1);
});
test('row 2 — classifyRedEvidence rejects zero-test discovery', () => {
const result = classifyRedEvidence(validRedInput({ output: ZERO_TESTS_TAP }));
assert.equal(result.verdict, 'INVALID_RED');
assert.equal(result.reason, 'zero_tests_discovered');
});
test('row 3 — classifyRedEvidence rejects fixture crash', () => {
const result = classifyRedEvidence(
validRedInput({ output: FIXTURE_CRASH_TAP, targetFile: 'tests/crash.test.cjs' }),
);
assert.equal(result.verdict, 'INVALID_RED');
assert.equal(result.reason, 'fixture_or_load_failure');
});
test('row 4 — classifyRedEvidence rejects nonzero exit without a failing test', () => {
const result = classifyRedEvidence(validRedInput({ output: TARGET_FAILURE_TAP.replace('# fail 1', '# fail 0') }));
assert.equal(result.verdict, 'INVALID_RED');
assert.equal(result.reason, 'nonzero_exit_without_test_failure');
});
test('row 5 — classifyRedEvidence rejects unexpected green', () => {
const result = classifyRedEvidence(validRedInput({ exitCode: 0 }));
assert.equal(result.verdict, 'INVALID_RED');
assert.equal(result.reason, 'unexpected_green');
});
test('row 6 — classifyRedEvidence rejects unrelated failing test', () => {
const result = classifyRedEvidence(validRedInput({ output: UNRELATED_FAILURE_TAP }));
assert.equal(result.verdict, 'INVALID_RED');
assert.equal(result.reason, 'no_target_test_failure');
});
test('fail-closed — malformed record fields are INVALID_RED, never a crash', () => {
const result = classifyRedEvidence({ command: null, exitCode: '1', output: 42, targetTest: '' });
assert.equal(result.verdict, 'INVALID_RED');
assert.equal(result.reason, 'invalid_record');
});
});
// ─── Persisted record (acceptance: command, exit code, failing test, expected, actual) ──
describe('buildRedEvidenceRecord (#3770)', () => {
test('row 7 — buildRedEvidenceRecord persists the RED evidence fields', () => {
const input = validRedInput();
const result = classifyRedEvidence(input);
const record = buildRedEvidenceRecord(input, result);
assert.equal(record.command, 'node --test tests/email.test.cjs');
assert.equal(record.exit_code, 1);
assert.equal(record.failing_test, 'rejects empty email');
assert.equal(record.expected, 'ValidationError for empty input');
assert.equal(record.actual, '1 !== 2');
assert.equal(record.verdict, 'RED_EVIDENCE_OK');
assert.equal(record.reason, 'target_test_failed');
});
});
// ─── check tdd-red-evidence router arm ────────────────────────────────────────
describe('check tdd-red-evidence verb (#3770)', () => {
/** Root for record-file fixtures; removed in after(). */
let ROOT = '';
before(() => { ROOT = fs.mkdtempSync(path.join(os.tmpdir(), 'tdd-red-evidence-')); });
after(() => cleanup(ROOT));
function writeRecord(name, record) {
const file = path.join(ROOT, name);
fs.writeFileSync(file, JSON.stringify(record), 'utf8');
return file;
}
test('row 8 — check tdd-red-evidence accepts a valid persisted record', () => {
const file = writeRecord('valid.json', validRedInput());
const result = runGsdTools(['check', 'tdd-red-evidence', file, '--raw'], ROOT);
assert.ok(result.success, `expected success, stderr: ${result.error}`);
const payload = JSON.parse(result.output);
assert.equal(payload.passed, true);
assert.equal(payload.verdict, 'RED_EVIDENCE_OK');
assert.equal(payload.reason, 'target_test_failed');
});
test('row 9 — check tdd-red-evidence rejects a crash record', () => {
const file = writeRecord(
'crash.json',
validRedInput({ output: FIXTURE_CRASH_TAP, targetFile: 'tests/crash.test.cjs' }),
);
const result = runGsdTools(['check', 'tdd-red-evidence', file, '--raw'], ROOT);
const payload = JSON.parse(result.output);
assert.equal(payload.passed, false);
assert.equal(payload.verdict, 'INVALID_RED');
assert.equal(payload.reason, 'fixture_or_load_failure');
});
test('row 10 — check tdd-red-evidence fails closed on missing record', () => {
const result = runGsdTools(
['check', 'tdd-red-evidence', path.join(ROOT, 'does-not-exist.json'), '--raw'],
ROOT,
);
const payload = JSON.parse(result.output);
assert.equal(payload.passed, false);
assert.equal(payload.verdict, 'INVALID_RED');
assert.equal(payload.reason, 'unreadable_record');
});
});
// ─── Spec surfaces (#3770 acceptance: gate must require evidence before GREEN) ─
describe('executor spec requires intentional RED evidence before GREEN (#3770)', () => {
const read = (p) => fs.readFileSync(path.join(__dirname, '..', p), 'utf8');
test('row 11 — executor spec names INVALID_RED and blocks GREEN without evidence', () => {
const agent = read('agents/gsd-executor.md');
const tddRef = read('gsd-core/references/tdd.md');
const mvpRef = read('gsd-core/references/execute-mvp-tdd.md');
for (const [name, content] of [['gsd-executor.md', agent], ['tdd.md', tddRef], ['execute-mvp-tdd.md', mvpRef]]) {
assert.match(content, /INVALID_RED/, `${name} must name the INVALID_RED verdict`);
assert.match(content, /tdd-red-evidence/, `${name} must wire the check tdd-red-evidence gate`);
}
// The gate must block GREEN on invalid RED, not merely warn.
assert.match(mvpRef, /INVALID_RED[^\n]{0,120}(block|halt|trip|STOP)/i,
'execute-mvp-tdd.md must halt GREEN on INVALID_RED');
});
});
// ── #4724 — Surefire/Failsafe XML RED evidence ────────────────────────────────
// A JVM project's genuine red is a Surefire/Failsafe XML report, not node:test
// TAP. The gate used to parse only TAP, so a real Maven red scored
// INVALID_RED while hand-written synthetic TAP scored RED_EVIDENCE_OK — the
// gate was passable only by fabricating its input. The XML scanner walks
// <testcase> tag boundaries (NOT a lazy spanning regex: Surefire writes
// passing cases self-closing, so `(.*?)</testcase>` spans from a green case
// to the next closing tag and reports wrong method names).
describe('#4724 — Surefire/Failsafe XML RED evidence', () => {
const XML_HEAD = '<?xml version="1.0" encoding="UTF-8"?>\n';
function surefire(cases) {
const body = cases.join('\n');
return `${XML_HEAD}<testsuite name="com.example.AppTest" tests="${cases.length}" failures="1" errors="0">\n${body}\n</testsuite>`;
}
const failingCase = (cls, name) =>
`<testcase name="${name}" classname="${cls}" time="0.01"><failure message="expected 1 was 2">1 != 2</failure></testcase>`;
const errorCase = (cls, name) =>
`<testcase name="${name}" classname="${cls}" time="0.01"><error message="boom">NullPointerException</error></testcase>`;
const greenCase = (cls, name) =>
`<testcase name="${name}" classname="${cls}" time="0.01"/>`;
const INPUT = {
command: 'mvn -Dtest=AppTest test',
exitCode: 1,
targetTest: 'AppTest',
targetFile: 'src/test/java/com/example/AppTest.java',
};
test('a genuine Surefire red with the target class failing classifies RED_EVIDENCE_OK (#4724)', () => {
const result = classifyRedEvidence({
...INPUT,
output: surefire([failingCase('com.example.AppTest', 'divides_by_zero')]),
});
assert.equal(result.verdict, 'RED_EVIDENCE_OK');
assert.equal(result.reason, 'target_test_failed');
assert.equal(result.evidence.fail, 1);
assert.ok(
result.evidence.failing_tests.some((n) => n.includes('AppTest')),
'failing_tests must carry the classname so the target matches',
);
});
test('an unrelated Surefire failure is not the target test', () => {
const result = classifyRedEvidence({
...INPUT,
output: surefire([failingCase('com.other.UnrelatedTest', 'unrelated_case')]),
});
assert.equal(result.verdict, 'INVALID_RED');
assert.equal(result.reason, 'no_target_test_failure');
});
test('an all-green self-closing Surefire report is unexpected_green', () => {
const result = classifyRedEvidence({
...INPUT,
exitCode: 0,
output: surefire([greenCase('com.example.AppTest', 'passes'), greenCase('com.example.AppTest', 'passes2')]),
});
assert.equal(result.verdict, 'INVALID_RED');
assert.equal(result.reason, 'unexpected_green');
});
test('self-closing passing cases are not spanned into failing names (#4725-class trap)', () => {
// The issue's trap: a lazy /(.*?)<\/testcase>/ regex starting at the green
// self-closing case spans to the NEXT closing tag, misreporting the green
// case's name beside the failing one. Boundary scanning must not.
const result = classifyRedEvidence({
...INPUT,
output: surefire([
greenCase('com.example.AppTest', 'green_before_failure'),
failingCase('com.example.AppTest', 'the_real_failure'),
]),
});
assert.equal(result.verdict, 'RED_EVIDENCE_OK');
assert.deepEqual(
result.evidence.failing_tests,
['com.example.AppTest#the_real_failure'],
'exactly the failing case is reported — no spanned green-case names',
);
});
test('an <error> child counts as a failing testcase', () => {
const result = classifyRedEvidence({
...INPUT,
output: surefire([errorCase('com.example.AppTest', 'explodes')]),
});
assert.equal(result.verdict, 'RED_EVIDENCE_OK');
assert.equal(result.evidence.fail, 1);
});
test('a testcase-free Surefire report is zero_tests_discovered', () => {
const result = classifyRedEvidence({
...INPUT,
output: `${XML_HEAD}<testsuite name="com.example.AppTest" tests="0" failures="0" errors="0"></testsuite>`,
});
assert.equal(result.verdict, 'INVALID_RED');
assert.equal(result.reason, 'zero_tests_discovered');
});
test('Failsafe XML (same schema) classifies like Surefire', () => {
const result = classifyRedEvidence({
command: 'mvn -Dtest=AppIT verify',
exitCode: 1,
targetTest: 'AppIT',
targetFile: 'src/test/java/com/example/AppIT.java',
output: `${XML_HEAD}<testsuite name="com.example.AppIT" tests="1" failures="1" errors="0">\n${failingCase('com.example.AppIT', 'integration_red')}\n</testsuite>`,
});
assert.equal(result.verdict, 'RED_EVIDENCE_OK');
assert.equal(result.reason, 'target_test_failed');
});
});
// ── #4724 review hardening — scanner edge cases ──────────────────────────────
test('#4724: a <testcase with no > (truncated output) terminates and fails closed', () => {
// Pre-hardening this hung forever: indexOf('<testcase', -1) clamps to 0 and
// re-found the same tag. Degrade to what was scanned — an incomplete report
// proves nothing.
const result = classifyRedEvidence({
command: 'mvn test',
exitCode: 1,
targetTest: 'AppTest',
output: '<?xml version="1.0"?><testsuite><testcase name="x" classname="C"',
});
assert.equal(result.verdict, 'INVALID_RED');
});
test('#4724: a TAP red whose message quotes <testsuite> stays on the TAP path', () => {
// Format detection requires BOTH <testsuite and <testcase: a genuine TAP
// red whose error message merely quotes "<testsuite>" must not flip to the
// XML path (which would misread it as zero_tests_discovered).
const tap = [
'TAP version 13',
'# Subtest: the test',
'not ok 1 - expected <testsuite> was 2',
' ---',
' error: |-',
' expected <testsuite> was 2',
' ...',
'# tests 1',
'# pass 0',
'# fail 1',
].join('\n');
const result = classifyRedEvidence({
command: 'node --test',
exitCode: 1,
targetTest: 'the test',
output: tap,
});
assert.equal(result.status ?? result.verdict, 'INVALID_RED');
assert.equal(result.reason, 'no_target_test_failure',
'the TAP path must classify it (fail=1), not the XML path (zero tests)');
assert.equal(result.evidence.fail, 1);
});
test('#4724: CDATA sections in a passing case are never scanned as failures', () => {
// A passing case whose captured System.out (CDATA) echoes an <error .../>
// literal must not count as failing — CDATA is verbatim content.
const cd = '<testcase name="prints" classname="com.example.AppTest"><system-out><![CDATA[echo <error x/></system-out>]]></testcase>';
const fl = '<testcase name="x" classname="com.other.Unrelated"><failure message="e">1 != 2</failure></testcase>';
const result = classifyRedEvidence({
command: 'mvn test',
exitCode: 1,
targetTest: 'UnrelatedTest',
output: `<?xml version="1.0"?>\n<testsuite>\n${cd}\n${fl}\n</testsuite>`,
});
assert.equal(result.reason, 'no_target_test_failure',
'the CDATA phantom must not flip the unrelated failure into a target match');
assert.equal(result.evidence.fail, 1, 'only the real failing case counts');
});