Files
msd-core/tests/bug-3441-path-action-projection.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

109 lines
3.6 KiB
JavaScript

'use strict';
process.env.GSD_TEST_MODE = '1';
const { describe, test } = require('node:test');
const assert = require('node:assert/strict');
const path = require('node:path');
const fs = require('node:fs');
const os = require('node:os');
const projection = require(path.join(
__dirname,
'..',
'get-shit-done',
'bin',
'lib',
'shell-command-projection.cjs',
));
const install = require(path.join(__dirname, '..', 'bin', 'install.js'));
const { withIsolatedProcessState, cleanup } = require('./helpers.cjs');
function createTempHome() {
return fs.mkdtempSync(path.join(os.tmpdir(), 'gsd-home-3441-'));
}
describe('bug #3441: PATH guidance is projected from typed shell action IR', () => {
test('projection module exports PATH action projection helper', () => {
assert.equal(typeof projection.projectPathActionProjection, 'function');
});
// (formatSdkPathDiagnostic removed with the gsd-sdk shim, #191 — the PATH
// action projection it wrapped is still covered by the tests below.)
test('persistent PATH export guidance is projected via the same seam', () => {
const posix = projection.projectPathActionProjection({
mode: 'persist',
targetDir: '/tmp/with quote',
platform: 'linux',
});
assert.ok(Array.isArray(posix.shellActions));
assert.equal(posix.shellActions.length, 2);
assert.equal(posix.shellActions[0].label, 'zsh');
assert.equal(posix.shellActions[1].label, 'bash');
assert.ok(posix.shellActions[0].command.includes('~/.zshrc'));
assert.ok(posix.shellActions[1].command.includes('~/.bashrc'));
});
test('POSIX repair mode escapes double-quoted shell metacharacters', () => {
const projected = projection.projectPathActionProjection({
mode: 'repair',
targetDir: '/tmp/qa\\"$HOME`tick',
platform: 'linux',
});
assert.equal(projected.shellActions.length, 1);
assert.equal(
projected.shellActions[0].command,
'export PATH="/tmp/qa\\\\\\"\\$HOME\\`tick:$PATH"',
);
});
test('POSIX persist mode escapes single quotes for rc-file echo commands', () => {
const projected = projection.projectPathActionProjection({
mode: 'persist',
targetDir: "/tmp/O'Neil/bin",
platform: 'linux',
});
assert.equal(projected.shellActions[0].command.includes("/tmp/O'\\''Neil/bin"), true);
assert.equal(projected.shellActions[1].command.includes("/tmp/O'\\''Neil/bin"), true);
});
test('maybeSuggestPathExport renders commands projected by path-action seam', () => {
const home = createTempHome();
try {
withIsolatedProcessState(() => {
const globalBin = path.join(home, '.npm-global', 'bin');
fs.mkdirSync(globalBin, { recursive: true });
fs.writeFileSync(path.join(home, '.zshrc'), 'export PATH="$HOME/.cargo/bin:$PATH"\n');
process.env.PATH = '';
const expected = projection.projectPathActionProjection({
mode: 'persist',
targetDir: globalBin,
platform: process.platform,
});
const logs = [];
const originalLog = console.log;
console.log = (...args) => logs.push(args.join(' '));
try {
install.maybeSuggestPathExport(globalBin, home);
} finally {
console.log = originalLog;
}
const joined = logs.join('\n');
for (const action of expected.shellActions) {
assert.ok(
joined.includes(action.command),
`expected installer output to include projected command: ${action.command}\nOutput:\n${joined}`,
);
}
});
} finally {
cleanup(home);
}
});
});