Files
msd-core/tests/bug-1908-uninstall-manifest.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

135 lines
4.6 KiB
JavaScript

/**
* Regression test for bug #1908
*
* `--uninstall` did not remove `gsd-file-manifest.json` from the target
* directory, leaving a stale metadata file after uninstall.
*
* Fix: `uninstall()` must call
* fs.rmSync(path.join(targetDir, MANIFEST_NAME), { force: true })
* after cleaning up the rest of the GSD artefacts.
*/
'use strict';
process.env.GSD_TEST_MODE = '1';
const { describe, test, beforeEach, afterEach } = require('node:test');
const assert = require('node:assert/strict');
const fs = require('fs');
const path = require('path');
const os = require('os');
const { uninstall } = require('../bin/install.js');
const MANIFEST_NAME = 'gsd-file-manifest.json';
// ─── helpers ──────────────────────────────────────────────────────────────────
function createFakeInstall(prefix = 'gsd-uninstall-test-') {
const dir = fs.mkdtempSync(path.join(os.tmpdir(), prefix));
// Simulate the minimum directory/file layout produced by the installer:
// get-shit-done/ directory, agents/ directory, and the manifest file.
fs.mkdirSync(path.join(dir, 'get-shit-done', 'workflows'), { recursive: true });
fs.writeFileSync(path.join(dir, 'get-shit-done', 'workflows', 'execute-phase.md'), '# stub');
fs.mkdirSync(path.join(dir, 'agents'), { recursive: true });
fs.writeFileSync(path.join(dir, 'agents', 'gsd-executor.md'), '# stub');
const manifest = {
version: '1.34.0',
timestamp: new Date().toISOString(),
files: {
'get-shit-done/workflows/execute-phase.md': 'abc123',
'agents/gsd-executor.md': 'def456',
},
};
fs.writeFileSync(path.join(dir, MANIFEST_NAME), JSON.stringify(manifest, null, 2));
return dir;
}
function cleanup(dir) {
// eslint-disable-next-line local/no-raw-rmsync-in-tests -- local teardown helper predates helpers.cjs; renaming would collide with the imported cleanup
try { fs.rmSync(dir, { recursive: true, force: true }); } catch {}
}
// ─── tests ────────────────────────────────────────────────────────────────────
describe('uninstall — manifest cleanup (#1908)', () => {
let tmpDir;
beforeEach(() => {
tmpDir = createFakeInstall();
});
afterEach(() => {
cleanup(tmpDir);
});
test('gsd-file-manifest.json is removed after global uninstall', () => {
const manifestPath = path.join(tmpDir, MANIFEST_NAME);
// Pre-condition: manifest exists before uninstall
assert.ok(
fs.existsSync(manifestPath),
'Test setup failure: manifest file should exist before uninstall'
);
// Run uninstall against tmpDir (pass it via CLAUDE_CONFIG_DIR so getGlobalDir()
// resolves to our temp directory; pass isGlobal=true)
const savedEnv = process.env.CLAUDE_CONFIG_DIR;
process.env.CLAUDE_CONFIG_DIR = tmpDir;
try {
uninstall(true, 'claude');
} finally {
if (savedEnv === undefined) {
delete process.env.CLAUDE_CONFIG_DIR;
} else {
process.env.CLAUDE_CONFIG_DIR = savedEnv;
}
}
assert.ok(
!fs.existsSync(manifestPath),
[
`${MANIFEST_NAME} must be removed by uninstall() but still exists at`,
manifestPath,
].join(' ')
);
});
test('gsd-file-manifest.json is removed after local uninstall', () => {
const manifestPath = path.join(tmpDir, MANIFEST_NAME);
assert.ok(
fs.existsSync(manifestPath),
'Test setup failure: manifest file should exist before uninstall'
);
// For a local install, getGlobalDir is not called — targetDir = cwd + dirName.
// Simulate by creating .claude/ inside tmpDir and placing artefacts there.
const localDir = path.join(tmpDir, '.claude');
fs.mkdirSync(path.join(localDir, 'get-shit-done', 'workflows'), { recursive: true });
fs.writeFileSync(path.join(localDir, 'get-shit-done', 'workflows', 'execute-phase.md'), '# stub');
const localManifestPath = path.join(localDir, MANIFEST_NAME);
fs.writeFileSync(localManifestPath, JSON.stringify({ version: '1.34.0', files: {} }, null, 2));
const savedCwd = process.cwd();
process.chdir(tmpDir);
try {
uninstall(false, 'claude');
} finally {
process.chdir(savedCwd);
}
assert.ok(
!fs.existsSync(localManifestPath),
[
`${MANIFEST_NAME} must be removed by uninstall() (local) but still exists at`,
localManifestPath,
].join(' ')
);
});
});