Files
msd-core/tests/lint-test-file-count.test.cjs
Tom Boucher a28dcec981 chore(#597): replace count-based ratchet guards with AST lint + named-set allowlists (#603)
The windows-test-parity ratchet greps test source for fs.rmSync-without-
maxRetries (and six other Windows-portability anti-patterns), failing when an
integer offender COUNT exceeds a frozen baseline (rmSync: 95). A count ratchet
is a Goodhart metric: fixing one offender and adding another keeps the count
constant, so a new defect slips through green. Replace it — and every other
count ratchet in the repo — with a layered, masking-proof design.

Behavioral seam test
- tests/helpers-cleanup.test.cjs proves helpers.cleanup() carries the Windows
  EBUSY retry budget. cleanup() delegates retries to Node's fs.rmSync via
  maxRetries (it owns no loop), so the test asserts the option contract
  (recursive/force/maxRetries>0/retryDelay>0) + real-FS removal + the cwd-guard,
  rather than a loop that does not exist. The EBUSY risk is now tested ONCE at
  the helper, not approximated textually at every call site.

Write-time ESLint rule (AST-accurate, replaces the grep)
- eslint-rules/no-raw-rmsync-in-tests.cjs (error in tests/**/*.test.cjs) bans
  raw fs.rmSync, steering to cleanup(). Catches member, computed (fs['rmSync']),
  destructured and aliased forms; escape hatch is inline
  `// eslint-disable-next-line local/no-raw-rmsync-in-tests -- <reason>` only.
- Migrated 336 raw fs.rmSync teardown calls across ~116 test files to cleanup().
  ~18 genuinely load-bearing sites (mid-test SUT/fault-injection removals,
  error-swallowing or name-colliding local teardown helpers) keep the raw call
  with an inline eslint-disable + reason.

Shared anti-ratchet primitive
- scripts/lib/allowlist-ratchet.cjs:
  - assertWithinAllowlist: fails on NOVEL ids (new offender introduced) AND on
    STALE ids (a known offender was fixed but not pruned) — identity, not count,
    and a ratchet DOWN toward zero.
  - assertTightCeiling: a size/length budget whose ceiling must stay within a
    grace band of the high-water mark, so budgets may only tighten, never creep.

Ratchets converted onto the primitive
- windows-test-parity-guard.test.cjs: rmSync rule deleted (now ESLint-enforced);
  the remaining six patterns moved from integer baselines to named-set
  allowlists with ratchet-down.
- scripts/lint-test-file-count.{cjs,allowlist.json}: per-module integer counts →
  named filename sets (closes the swap-a-file-keep-the-count blind spot); a
  module dropping under cap now FAILS to force pruning its allowlist entry.
- enh-2790 skill-count `<= 63` → named skill allowlist (ratchets toward ~58).

Size budgets hardened (tighten-only)
- agent-size / workflow-size / feat-3039 help-tiered: ceilings lowered to the
  current high-water mark and an assertTightCeiling anti-creep check added per
  tier. Fixed external-contract limits (description ≤100 chars, agent ≤100 KB)
  are intentionally left as-is — they are not grandfathered creeping budgets.

No user-facing behavior change (tests + tooling only); no USER_FACING_PREFIXES
touched, so no changeset fragment is required.

Co-authored-by: Claude Opus 4.8 <noreply@anthropic.com>
2026-06-01 22:43:49 -04:00

354 lines
12 KiB
JavaScript

'use strict';
/**
* Tests for scripts/lint-test-file-count.cjs
*
* Uses node --test + the exported evaluateLint() pure function.
* Also exercises the CLI via --json mode to verify end-to-end wiring.
*/
const { describe, test } = require('node:test');
const assert = require('node:assert/strict');
const fs = require('fs');
const os = require('os');
const path = require('path');
const { spawnSync } = require('child_process');
const ROOT = path.join(__dirname, '..');
const LINT_SCRIPT = path.join(ROOT, 'scripts', 'lint-test-file-count.cjs');
const {
Verdict,
evaluateLint,
testEffectivePrefix,
} = require(LINT_SCRIPT);
// ---------------------------------------------------------------------------
// Helpers
// ---------------------------------------------------------------------------
function makeFiles(prefix, names) {
return names.map(n => `/fake/tests/${n}`);
}
function runCliJson(extraArgs = []) {
const result = spawnSync(
process.execPath,
[LINT_SCRIPT, '--json', ...extraArgs],
{ encoding: 'utf8' }
);
const parsed = JSON.parse(result.stdout);
return { status: result.status, data: parsed };
}
// ---------------------------------------------------------------------------
// evaluateLint — core verdict logic
// ---------------------------------------------------------------------------
describe('evaluateLint — OK_UNDER_LIMIT', () => {
test('1-file module passes', () => {
const result = evaluateLint({
prefix: 'my-module',
testFiles: makeFiles('my-module', ['my-module.test.cjs']),
allowlist: {},
});
assert.strictEqual(result.verdict, Verdict.OK_UNDER_LIMIT);
assert.strictEqual(result.count, 1);
assert.strictEqual(result.knownFiles, null);
});
test('2-file module passes (primary + integration)', () => {
const result = evaluateLint({
prefix: 'my-module',
testFiles: makeFiles('my-module', [
'my-module.test.cjs',
'my-module.integration.test.ts',
]),
allowlist: {},
});
assert.strictEqual(result.verdict, Verdict.OK_UNDER_LIMIT);
assert.strictEqual(result.count, 2);
});
});
describe('evaluateLint — FAIL_EXCEEDS_LIMIT', () => {
test('3-file module fails when not in allowlist', () => {
const result = evaluateLint({
prefix: 'my-module',
testFiles: makeFiles('my-module', [
'my-module.test.cjs',
'my-module-edge-case.test.cjs',
'my-module-regression.test.cjs',
]),
allowlist: {},
});
assert.strictEqual(result.verdict, Verdict.FAIL_EXCEEDS_LIMIT);
assert.strictEqual(result.count, 3);
assert.strictEqual(result.knownFiles, null);
});
});
describe('evaluateLint — allowlist behaviour (identity-based)', () => {
test('3-file module allowlisted with exact filenames passes (OK_IN_ALLOWLIST)', () => {
const result = evaluateLint({
prefix: 'phase',
testFiles: makeFiles('phase', [
'phase.test.cjs',
'phase-edge.test.cjs',
'phase-regression.test.cjs',
]),
allowlist: {
phase: {
files: ['phase.test.cjs', 'phase-edge.test.cjs', 'phase-regression.test.cjs'],
issue: 'TBD',
},
},
});
assert.strictEqual(result.verdict, Verdict.OK_IN_ALLOWLIST);
assert.strictEqual(result.count, 3);
assert.deepStrictEqual(result.novel, []);
assert.deepStrictEqual(result.stale, []);
});
test('2-file module allowlisted fails (FAIL_STALE_ALLOWLIST — whole entry must be pruned)', () => {
const result = evaluateLint({
prefix: 'phase',
testFiles: makeFiles('phase', [
'phase.test.cjs',
'phase-edge.test.cjs',
]),
allowlist: {
phase: {
files: ['phase.test.cjs', 'phase-edge.test.cjs', 'phase-regression.test.cjs'],
issue: 'TBD',
},
},
});
// Ratchet-DOWN: dropping to ≤ MAX_FILES while allowlisted is a FAILURE, not a hint.
assert.strictEqual(result.verdict, Verdict.FAIL_STALE_ALLOWLIST);
assert.strictEqual(result.count, 2);
assert.deepStrictEqual(result.novel, []);
// stale should list all known files (the entire entry must be removed)
assert.deepStrictEqual(result.stale.sort(), [
'phase-edge.test.cjs',
'phase-regression.test.cjs',
'phase.test.cjs',
]);
});
test('novel file added to capped module fails (FAIL_NOVEL_FILES)', () => {
const result = evaluateLint({
prefix: 'phase',
testFiles: makeFiles('phase', [
'phase.test.cjs',
'phase-edge.test.cjs',
'phase-regression.test.cjs',
'phase-new-extra.test.cjs', // <-- novel
]),
allowlist: {
phase: {
files: ['phase.test.cjs', 'phase-edge.test.cjs', 'phase-regression.test.cjs'],
issue: 'TBD',
},
},
});
assert.strictEqual(result.verdict, Verdict.FAIL_NOVEL_FILES);
assert.deepStrictEqual(result.novel, ['phase-new-extra.test.cjs']);
assert.deepStrictEqual(result.stale, []);
});
test('allowlisted file removed from disk while dropping to cap fails (FAIL_STALE_ALLOWLIST)', () => {
const result = evaluateLint({
prefix: 'phase',
testFiles: makeFiles('phase', [
'phase.test.cjs',
'phase-edge.test.cjs',
// phase-regression.test.cjs removed — count now at MAX_FILES (2)
]),
allowlist: {
phase: {
files: ['phase.test.cjs', 'phase-edge.test.cjs', 'phase-regression.test.cjs'],
issue: 'TBD',
},
},
});
// count is 2 (≤ MAX_FILES=2) while still allowlisted — ratchet-DOWN FAILURE.
// All known files are stale; the entire entry must be pruned.
assert.strictEqual(result.verdict, Verdict.FAIL_STALE_ALLOWLIST);
assert.deepStrictEqual(result.novel, []);
assert.deepStrictEqual(result.stale.sort(), [
'phase-edge.test.cjs',
'phase-regression.test.cjs',
'phase.test.cjs',
]);
});
test('allowlisted file removed while still over cap fails (FAIL_STALE_ALLOWLIST)', () => {
// Module has 4 files allowlisted, one removed (3 remain, still > 2)
const result = evaluateLint({
prefix: 'phase',
testFiles: makeFiles('phase', [
'phase.test.cjs',
'phase-edge.test.cjs',
'phase-regression.test.cjs',
// phase-extra.test.cjs removed from disk
]),
allowlist: {
phase: {
files: [
'phase.test.cjs',
'phase-edge.test.cjs',
'phase-regression.test.cjs',
'phase-extra.test.cjs', // stale
],
issue: 'TBD',
},
},
});
assert.strictEqual(result.verdict, Verdict.FAIL_STALE_ALLOWLIST);
assert.deepStrictEqual(result.stale, ['phase-extra.test.cjs']);
assert.deepStrictEqual(result.novel, []);
});
test('ratchet: count equal to allowlisted set passes', () => {
const result = evaluateLint({
prefix: 'init',
testFiles: makeFiles('init', [
'init.test.cjs',
'init-manager.test.cjs',
'init-manager-deps.test.cjs',
]),
allowlist: {
init: {
files: ['init.test.cjs', 'init-manager.test.cjs', 'init-manager-deps.test.cjs'],
issue: 'TBD',
},
},
});
assert.strictEqual(result.verdict, Verdict.OK_IN_ALLOWLIST);
});
// -------------------------------------------------------------------
// Masking blind spot: count unchanged but SET changed → must FAIL
// -------------------------------------------------------------------
test('masking blind spot closed: swapped file (same count, different identity) fails', () => {
// Old allowlist grandfathers 3 files. One is deleted, one new one added.
// Count stays at 3 — the old count-ratchet would have passed. Identity must fail.
const result = evaluateLint({
prefix: 'phase',
testFiles: makeFiles('phase', [
'phase.test.cjs',
'phase-edge.test.cjs',
'phase-brand-new.test.cjs', // <-- replaces phase-regression (novel)
]),
allowlist: {
phase: {
files: [
'phase.test.cjs',
'phase-edge.test.cjs',
'phase-regression.test.cjs', // <-- no longer on disk (stale)
],
issue: 'TBD',
},
},
});
// The identity check must catch this: novel = ['phase-brand-new.test.cjs'],
// stale = ['phase-regression.test.cjs']. Count is the same (3), but the
// old count-ratchet would have silently passed. The identity ratchet fails.
assert.ok(
result.verdict === Verdict.FAIL_NOVEL_FILES || result.verdict === Verdict.FAIL_STALE_ALLOWLIST,
`expected FAIL_NOVEL_FILES or FAIL_STALE_ALLOWLIST, got ${result.verdict}`
);
assert.deepStrictEqual(result.novel, ['phase-brand-new.test.cjs']);
assert.deepStrictEqual(result.stale, ['phase-regression.test.cjs']);
});
});
// ---------------------------------------------------------------------------
// testEffectivePrefix — issue-stamp stripping
// ---------------------------------------------------------------------------
describe('testEffectivePrefix', () => {
test('normal test file returns bare prefix', () => {
assert.strictEqual(testEffectivePrefix('query-dispatch.test.cjs'), 'query-dispatch');
});
test('integration test file returns bare prefix', () => {
assert.strictEqual(testEffectivePrefix('init.integration.test.ts'), 'init');
});
test('bug-stamped file strips stamp', () => {
assert.strictEqual(testEffectivePrefix('bug-1736-local-install-commands.test.cjs'), 'local-install-commands');
});
test('feat-stamped file strips stamp', () => {
assert.strictEqual(testEffectivePrefix('feat-3347-graphify-auto-update-config.test.cjs'), 'graphify-auto-update-config');
});
test('enh-stamped file strips stamp', () => {
assert.strictEqual(testEffectivePrefix('enh-100-phase-runner-edge.test.cjs'), 'phase-runner-edge');
});
test('fix-stamped file strips stamp', () => {
assert.strictEqual(testEffectivePrefix('fix-200-config-merge.test.cjs'), 'config-merge');
});
test('double-numbered stamp is stripped correctly', () => {
assert.strictEqual(testEffectivePrefix('bug-2550-2552-discuss-phase-context.test.cjs'), 'discuss-phase-context');
});
});
// ---------------------------------------------------------------------------
// CLI — JSON mode end-to-end
// ---------------------------------------------------------------------------
describe('CLI --json', () => {
test('script parses without syntax errors', () => {
const result = spawnSync(process.execPath, ['--check', LINT_SCRIPT], { encoding: 'utf8' });
assert.strictEqual(result.status, 0, result.stderr);
});
test('exits 0 against real repo (allowlist covers all current violations)', () => {
const { status, data } = runCliJson();
assert.strictEqual(status, 0, `Expected clean run; failures: ${JSON.stringify(data.failures)}`);
assert.strictEqual(data.ok, true);
assert.strictEqual(data.failures.length, 0);
});
test('--json output has required fields', () => {
const { data } = runCliJson();
assert.ok(Array.isArray(data.results), 'results must be array');
assert.ok(Array.isArray(data.failures), 'failures must be array');
assert.ok(Array.isArray(data.hints), 'hints must be array');
assert.ok(typeof data.ok === 'boolean', 'ok must be boolean');
});
test('each result has verdict, prefix, count, knownFiles, files', () => {
const { data } = runCliJson();
for (const r of data.results) {
assert.ok(typeof r.verdict === 'string', `verdict missing on ${r.prefix}`);
assert.ok(typeof r.prefix === 'string', 'prefix must be string');
assert.ok(typeof r.count === 'number', 'count must be number');
assert.ok(Array.isArray(r.files), 'files must be array');
}
});
test('all verdicts are valid enum values', () => {
const valid = new Set(Object.values(Verdict));
const { data } = runCliJson();
for (const r of data.results) {
assert.ok(valid.has(r.verdict), `Unknown verdict "${r.verdict}" on prefix "${r.prefix}"`);
}
});
test('OK_IN_ALLOWLIST results have knownFiles array', () => {
const { data } = runCliJson();
const allowlisted = data.results.filter(r => r.verdict === Verdict.OK_IN_ALLOWLIST);
assert.ok(allowlisted.length > 0, 'expected at least one allowlisted module in real repo');
for (const r of allowlisted) {
assert.ok(Array.isArray(r.knownFiles), `knownFiles must be array on ${r.prefix}`);
assert.ok(r.knownFiles.length > 0, `knownFiles must be non-empty on ${r.prefix}`);
}
});
});