Files
msd-core/tests/issue-498-update-context.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

197 lines
9.0 KiB
JavaScript

'use strict';
process.env.GSD_TEST_MODE = '1';
// Issue #498 (candidate 3): resolveUpdateContext ports update.md's ~280-line
// get_installed_version bash into a pure, injected-fs function. It returns the
// same 4-field contract the workflow emits: { installedVersion, scope, runtime,
// gsdDir }. The fs is injected (exists/readFile) so the precedence cascade is
// finally testable without a live multi-runtime install.
const { test, describe } = require('node:test');
const assert = require('node:assert/strict');
const path = require('node:path');
const nodeFs = require('node:fs');
const os = require('node:os');
const { execFileSync } = require('node:child_process');
const ROOT = path.join(__dirname, '..');
const GSD_TOOLS = path.join(ROOT, 'get-shit-done', 'bin', 'gsd-tools.cjs');
const { cleanup } = require('./helpers.cjs');
const { resolveUpdateContext } = require(
path.join(ROOT, 'get-shit-done', 'bin', 'lib', 'update-context.cjs'),
);
// Normalize a path to a platform-agnostic key: resolve to absolute, then
// lowercase forward-slash form. This makes the fake fs match the resolver's
// path.join/path.resolve lookups on Windows (backslash + drive letter) as well
// as POSIX, so these unit tests are not OS-coupled.
function normKey(p) { return path.resolve(p).replace(/\\/g, '/').toLowerCase(); }
// Build an injected fs from a map of absolute path -> contents. Marker files
// (VERSION, workflows/update.md) just need to "exist".
function fakeFs(files) {
const set = new Map();
for (const [k, v] of Object.entries(files)) set.set(normKey(k), v);
return {
exists: (p) => set.has(normKey(p)),
readFile: (p) => { const k = normKey(p); return set.has(k) ? set.get(k) : null; },
};
}
// Compare resolved-dir results without coupling to OS path style.
function sameDir(a, b) { return normKey(a) === normKey(b); }
const HOME = '/home/u';
const CWD = '/work/proj';
function ver(dir) { return `${dir}/get-shit-done/VERSION`; }
function marker(dir) { return `${dir}/get-shit-done/workflows/update.md`; }
describe('resolveUpdateContext: scope cascade', () => {
test('GLOBAL claude install under $HOME/.claude', () => {
const fs = fakeFs({ [ver(`${HOME}/.claude`)]: '1.40.0\n', [marker(`${HOME}/.claude`)]: 'x' });
const r = resolveUpdateContext({ home: HOME, cwd: CWD, env: {}, fs });
assert.equal(r.installedVersion, '1.40.0');
assert.equal(r.scope, 'GLOBAL');
assert.equal(r.runtime, 'claude');
assert.ok(sameDir(r.gsdDir, `${HOME}/.claude`), `gsdDir was ${r.gsdDir}`);
});
test('LOCAL install under ./.claude takes priority over global', () => {
const fs = fakeFs({
[ver(`${CWD}/.claude`)]: '1.39.0\n', [marker(`${CWD}/.claude`)]: 'x',
[ver(`${HOME}/.claude`)]: '1.40.0\n', [marker(`${HOME}/.claude`)]: 'x',
});
const r = resolveUpdateContext({ home: HOME, cwd: CWD, env: {}, fs });
assert.equal(r.scope, 'LOCAL');
assert.equal(r.installedVersion, '1.39.0');
assert.ok(sameDir(r.gsdDir, `${CWD}/.claude`), `gsdDir was ${r.gsdDir}`);
});
test('cwd === home does NOT misdetect as LOCAL (dedup)', () => {
const fs = fakeFs({ [ver(`${HOME}/.claude`)]: '1.40.0\n', [marker(`${HOME}/.claude`)]: 'x' });
const r = resolveUpdateContext({ home: HOME, cwd: HOME, env: {}, fs });
assert.equal(r.scope, 'GLOBAL');
});
test('runtime detected but VERSION missing -> 0.0.0, keep scope/runtime', () => {
const fs = fakeFs({ [marker(`${HOME}/.gemini`)]: 'x' });
const r = resolveUpdateContext({ home: HOME, cwd: CWD, env: {}, fs });
assert.equal(r.installedVersion, '0.0.0');
assert.equal(r.scope, 'GLOBAL');
assert.equal(r.runtime, 'gemini');
});
test('no install anywhere -> UNKNOWN / claude / empty gsdDir', () => {
const r = resolveUpdateContext({ home: HOME, cwd: CWD, env: {}, fs: fakeFs({}) });
assert.deepEqual(r, { installedVersion: '0.0.0', scope: 'UNKNOWN', runtime: 'claude', gsdDir: '' });
});
});
describe('resolveUpdateContext: runtime probing + env overrides', () => {
test('opencode global under $HOME/.config/opencode', () => {
const dir = `${HOME}/.config/opencode`;
const fs = fakeFs({ [ver(dir)]: '1.40.0\n', [marker(dir)]: 'x' });
const r = resolveUpdateContext({ home: HOME, cwd: CWD, env: {}, fs });
assert.equal(r.runtime, 'opencode');
assert.ok(sameDir(r.gsdDir, dir), `gsdDir was ${r.gsdDir}`);
});
test('CLAUDE_CONFIG_DIR env override locates a custom global dir', () => {
const custom = '/opt/claude-home';
const fs = fakeFs({ [ver(custom)]: '1.40.0\n', [marker(custom)]: 'x' });
const r = resolveUpdateContext({ home: HOME, cwd: CWD, env: { CLAUDE_CONFIG_DIR: custom }, fs });
assert.equal(r.scope, 'GLOBAL');
assert.equal(r.runtime, 'claude');
assert.ok(sameDir(r.gsdDir, custom), `gsdDir was ${r.gsdDir}`);
});
test('preferredConfigDir fast-path: trusts a validated custom dir as GLOBAL', () => {
const custom = '/opt/gsd-x';
const fs = fakeFs({ [ver(custom)]: '1.41.0\n', [marker(custom)]: 'x' });
const r = resolveUpdateContext({
home: HOME, cwd: CWD, env: {}, fs,
preferredConfigDir: custom, preferredRuntime: 'kilo',
});
assert.equal(r.scope, 'GLOBAL');
assert.equal(r.runtime, 'kilo');
assert.ok(sameDir(r.gsdDir, custom), `gsdDir was ${r.gsdDir}`);
assert.equal(r.installedVersion, '1.41.0');
});
});
describe('gsd-tools update-context (CLI): emits the JSON contract', () => {
test('--config-dir fixture resolves to the documented 4-field JSON', () => {
const tmp = nodeFs.mkdtempSync(path.join(os.tmpdir(), 'gsd-uc-'));
try {
nodeFs.mkdirSync(path.join(tmp, 'get-shit-done', 'workflows'), { recursive: true });
nodeFs.writeFileSync(path.join(tmp, 'get-shit-done', 'VERSION'), '1.42.0\n');
nodeFs.writeFileSync(path.join(tmp, 'get-shit-done', 'workflows', 'update.md'), 'x');
const out = execFileSync(
process.execPath,
[GSD_TOOLS, 'update-context', '--config-dir', tmp, '--runtime', 'kilo', '--json'],
{ encoding: 'utf8', env: { ...process.env, GSD_TEST_MODE: '1' } },
);
const ctx = JSON.parse(out);
assert.deepEqual(Object.keys(ctx).sort(), ['gsdDir', 'installedVersion', 'runtime', 'scope']);
assert.equal(ctx.installedVersion, '1.42.0');
assert.equal(ctx.scope, 'GLOBAL');
assert.equal(ctx.runtime, 'kilo');
} finally {
cleanup(tmp);
}
});
});
describe('resolveUpdateContext: parity with the old inline bash (adversarial-review)', () => {
test('preferredConfigDir with a leading ~/ is expanded before the fast path', () => {
// The old inline bash ran `expand_home "$PREFERRED_CONFIG_DIR"` first, so a
// custom --config-dir like ~/custom-gsd must resolve, not fall to UNKNOWN.
const fs = fakeFs({
[ver(`${HOME}/custom-gsd`)]: '1.41.0\n',
[marker(`${HOME}/custom-gsd`)]: 'x',
});
const r = resolveUpdateContext({
home: HOME, cwd: CWD, env: {}, fs, preferredConfigDir: '~/custom-gsd',
});
assert.equal(r.installedVersion, '1.41.0');
assert.equal(r.scope, 'GLOBAL');
assert.ok(sameDir(r.gsdDir, `${HOME}/custom-gsd`), `gsdDir was ${r.gsdDir}`);
});
test('a VERSION-only dir (no update.md marker) is NOT trusted as a real version', () => {
// The old cascade required BOTH VERSION and the update.md marker before
// trusting the version; a partial dir falls to 0.0.0 but keeps scope.
const fs = fakeFs({ [ver(`${HOME}/.claude`)]: '1.40.0\n' }); // marker absent
const r = resolveUpdateContext({ home: HOME, cwd: CWD, env: {}, fs });
assert.equal(r.installedVersion, '0.0.0', 'VERSION-only dir must not be trusted');
assert.equal(r.scope, 'GLOBAL');
assert.equal(r.runtime, 'claude');
assert.ok(sameDir(r.gsdDir, `${HOME}/.claude`), `gsdDir was ${r.gsdDir}`);
});
test('fast path also requires the marker: VERSION-only preferredConfigDir -> 0.0.0', () => {
// The "trust = VERSION + marker" rule is consistent across every path, not
// just the cascade. A custom --config-dir with VERSION but no marker is a
// partial install: keep the dir/scope, report 0.0.0.
const custom = '/opt/gsd-partial';
const fs = fakeFs({ [ver(custom)]: '1.41.0\n' }); // marker absent
const r = resolveUpdateContext({
home: HOME, cwd: CWD, env: {}, fs, preferredConfigDir: custom, preferredRuntime: 'kilo',
});
assert.equal(r.installedVersion, '0.0.0', 'VERSION-only fast path must not be trusted');
assert.equal(r.scope, 'GLOBAL');
assert.ok(sameDir(r.gsdDir, custom), `gsdDir was ${r.gsdDir}`);
});
test('partial install with cwd===home does NOT misdetect as LOCAL (fallback dedup)', () => {
// Same same-path dedup the trusted path uses must apply to the 0.0.0
// fallback: a VERSION-only ~/.claude probed from cwd===home is GLOBAL.
const fs = fakeFs({ [ver(`${HOME}/.claude`)]: '1.40.0\n' }); // marker absent
const r = resolveUpdateContext({ home: HOME, cwd: HOME, env: {}, fs });
assert.equal(r.installedVersion, '0.0.0');
assert.equal(r.scope, 'GLOBAL', 'cwd===home partial must be GLOBAL, not LOCAL');
assert.ok(sameDir(r.gsdDir, `${HOME}/.claude`), `gsdDir was ${r.gsdDir}`);
});
});