Files
msd-core/tests/bug-410-install-defaults-test-mode-guard.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

118 lines
4.0 KiB
JavaScript

'use strict';
/**
* Bug #410: finishInstall writes ~/.gsd/defaults.json for non-Claude runtimes
* without a GSD_TEST_MODE guard, polluting the real developer home directory
* during test runs.
*
* The opencode permission-config write a few lines above already carries the
* GSD_TEST_MODE guard (added for #130) — this test covers the un-fixed sibling
* (the resolve_model_ids: "omit" write).
*/
const { test, describe } = require('node:test');
const { cleanup } = require('./helpers.cjs');
const assert = require('node:assert/strict');
const path = require('node:path');
const os = require('node:os');
const fs = require('node:fs');
const ROOT = path.join(__dirname, '..');
// Point HOME at a temp dir so the defaults.json write can't reach the real
// ~/.gsd/ even if the guard is missing.
// On Windows, os.homedir() reads USERPROFILE (not HOME). Set both so
// finishInstall's path.join(os.homedir(), '.gsd') resolves into FAKE_HOME
// on every platform. Node docs: https://nodejs.org/docs/latest-v22.x/api/os.html#oshomedir
const FAKE_HOME = fs.mkdtempSync(path.join(os.tmpdir(), 'gsd-410-test-'));
process.env.HOME = FAKE_HOME;
process.env.USERPROFILE = FAKE_HOME;
// The path that finishInstall would write to for a non-Claude runtime.
const GSD_DIR = path.join(FAKE_HOME, '.gsd');
const DEFAULTS_PATH = path.join(GSD_DIR, 'defaults.json');
// Set GSD_TEST_MODE before requiring install.js so any module-level guards
// also see the flag.
process.env.GSD_TEST_MODE = '1';
const installModule = require(path.join(ROOT, 'bin', 'install.js'));
// A synthetic settingsPath that won't exist — finishInstall should cope.
const SETTINGS_PATH = path.join(FAKE_HOME, `gsd-test-settings-${process.pid}.json`);
function callFinishInstallForRuntime(runtime) {
const original = console.log;
console.log = () => {};
try {
installModule.finishInstall(
SETTINGS_PATH,
{}, // empty settings
null, // statuslineCommand
false, // shouldInstallStatusline
runtime,
true, // isGlobal
null, // configDir
);
} finally {
console.log = original;
}
}
describe('Bug #410: finishInstall non-Claude runtime + GSD_TEST_MODE side-effect guard', () => {
test('defaults.json is NOT written for opencode runtime under GSD_TEST_MODE', () => {
assert.equal(
fs.existsSync(DEFAULTS_PATH),
false,
'defaults.json should not exist before finishInstall call',
);
callFinishInstallForRuntime('opencode');
assert.equal(
fs.existsSync(DEFAULTS_PATH),
false,
`defaults.json must NOT be created under GSD_TEST_MODE; found at ${DEFAULTS_PATH}`,
);
});
test('defaults.json is NOT written for gemini runtime under GSD_TEST_MODE', () => {
// Reset in case previous test left artifacts (it shouldn't).
assert.equal(
fs.existsSync(DEFAULTS_PATH),
false,
'defaults.json should not exist before gemini test',
);
callFinishInstallForRuntime('gemini');
assert.equal(
fs.existsSync(DEFAULTS_PATH),
false,
`defaults.json must NOT be created under GSD_TEST_MODE for gemini; found at ${DEFAULTS_PATH}`,
);
});
test('defaults.json IS written for opencode runtime when GSD_TEST_MODE is unset', () => {
// Temporarily unset GSD_TEST_MODE to verify the user-facing path still works.
const saved = process.env.GSD_TEST_MODE;
delete process.env.GSD_TEST_MODE;
try {
callFinishInstallForRuntime('opencode');
assert.equal(
fs.existsSync(DEFAULTS_PATH),
true,
`defaults.json must be written for non-Claude runtime when GSD_TEST_MODE is unset`,
);
// Verify the written content is correct.
const contents = JSON.parse(fs.readFileSync(DEFAULTS_PATH, 'utf8'));
assert.equal(contents.resolve_model_ids, 'omit', 'resolve_model_ids must be "omit"');
} finally {
// Restore GSD_TEST_MODE and clean up the written file.
process.env.GSD_TEST_MODE = saved;
cleanup(DEFAULTS_PATH);
try { fs.rmdirSync(GSD_DIR); } catch { /* not empty or already gone */ }
}
});
});