Files
msd-core/tests/check-update-config-dir.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

156 lines
6.1 KiB
JavaScript

// allow-test-rule: structural-regression-guard
// Reads hook .js or bin/install.js source to assert structural invariants
// (search array order, function wiring, path constants) that cannot be
// verified by observing runtime outputs alone. Per CONTRIBUTING.md exception matrix.
/**
* Regression test for #1860: detectConfigDir in gsd-check-update.js should
* prioritize .claude over .config/opencode so that Claude Code sessions
* don't report false "update available" warnings when an older OpenCode
* install exists alongside a newer Claude Code install.
*/
'use strict';
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 { execFileSync } = require('child_process');
const { cleanup } = require('./helpers.cjs');
const CHECK_UPDATE_PATH = path.join(__dirname, '..', 'hooks', 'gsd-check-update.js');
// ─── Static source-order assertion ──────────────────────────────────────────
describe('detectConfigDir search order (#1860)', () => {
test('.claude appears before .config/opencode in the search array', () => {
const content = fs.readFileSync(CHECK_UPDATE_PATH, 'utf8');
// Extract the search order array from the for..of loop in detectConfigDir
const arrayMatch = content.match(/for\s*\(const dir of\s*\[([^\]]+)\]/);
assert.ok(arrayMatch, 'should find the for..of search array in detectConfigDir');
const arrayLiteral = arrayMatch[1];
const entries = arrayLiteral.match(/'([^']+)'/g).map(s => s.replace(/'/g, ''));
const claudeIndex = entries.indexOf('.claude');
const openCodeIndex = entries.indexOf('.config/opencode');
assert.ok(claudeIndex !== -1, '.claude must be in the search array');
assert.ok(openCodeIndex !== -1, '.config/opencode must be in the search array');
assert.ok(
claudeIndex < openCodeIndex,
[
'.claude must appear BEFORE .config/opencode in the search array.',
`Got order: ${entries.join(', ')}`,
`.claude is at index ${claudeIndex}, .config/opencode is at index ${openCodeIndex}.`,
].join(' ')
);
});
});
// ─── Integration: hook picks the .claude version when both dirs exist ────────
describe('detectConfigDir runtime behavior (#1860)', () => {
let tmpHome;
beforeEach(() => {
tmpHome = fs.mkdtempSync(path.join(os.tmpdir(), 'gsd-test-home-'));
});
afterEach(() => {
cleanup(tmpHome);
});
test('returns .claude config dir when both .claude and .config/opencode exist', () => {
// Simulate OpenCode install with OLDER version
const openCodeVersionDir = path.join(tmpHome, '.config', 'opencode', 'get-shit-done');
fs.mkdirSync(openCodeVersionDir, { recursive: true });
fs.writeFileSync(path.join(openCodeVersionDir, 'VERSION'), '1.0.0\n');
// Simulate Claude Code install with NEWER version
const claudeVersionDir = path.join(tmpHome, '.claude', 'get-shit-done');
fs.mkdirSync(claudeVersionDir, { recursive: true });
fs.writeFileSync(path.join(claudeVersionDir, 'VERSION'), '1.32.0\n');
// Run the hook script with our fake HOME. It will error when trying to spawn
// the background child (npm view will fail in test env) but that's OK — we
// only care about which VERSION file path it computes. We extract that by
// injecting a quick wrapper that calls detectConfigDir and logs the result
// before the rest of the script runs.
//
// Strategy: extract detectConfigDir source from the hook and evaluate it
// in a small test harness that uses our fake HOME.
const hookSource = fs.readFileSync(CHECK_UPDATE_PATH, 'utf8');
// Extract detectConfigDir function body (from 'function detectConfigDir' to the closing brace)
const fnMatch = hookSource.match(/(function detectConfigDir\(baseDir\)\s*\{[\s\S]*?\n\})/);
assert.ok(fnMatch, 'should be able to extract detectConfigDir function from hook source');
const fnSource = fnMatch[1];
// Build a test harness script that calls detectConfigDir with our fake home
const testScript = [
"'use strict';",
"const fs = require('fs');",
"const path = require('path');",
fnSource,
`const result = detectConfigDir(${JSON.stringify(tmpHome)});`,
"process.stdout.write(result);",
].join('\n');
const result = execFileSync(process.execPath, ['-e', testScript], {
encoding: 'utf8',
});
const expectedDir = path.join(tmpHome, '.claude');
assert.strictEqual(
result.trim(),
expectedDir,
[
'detectConfigDir should return .claude when both .claude and .config/opencode have VERSION files.',
`Expected: ${expectedDir}`,
`Got: ${result.trim()}`,
].join('\n')
);
});
test('falls back to .config/opencode when .claude does not exist', () => {
// Only OpenCode installed
const openCodeVersionDir = path.join(tmpHome, '.config', 'opencode', 'get-shit-done');
fs.mkdirSync(openCodeVersionDir, { recursive: true });
fs.writeFileSync(path.join(openCodeVersionDir, 'VERSION'), '1.0.0\n');
const hookSource = fs.readFileSync(CHECK_UPDATE_PATH, 'utf8');
const fnMatch = hookSource.match(/(function detectConfigDir\(baseDir\)\s*\{[\s\S]*?\n\})/);
assert.ok(fnMatch, 'should be able to extract detectConfigDir function from hook source');
const fnSource = fnMatch[1];
const testScript = [
"'use strict';",
"const fs = require('fs');",
"const path = require('path');",
fnSource,
`const result = detectConfigDir(${JSON.stringify(tmpHome)});`,
"process.stdout.write(result);",
].join('\n');
const result = execFileSync(process.execPath, ['-e', testScript], {
encoding: 'utf8',
});
const expectedDir = path.join(tmpHome, '.config', 'opencode');
assert.strictEqual(
result.trim(),
expectedDir,
[
'detectConfigDir should fall back to .config/opencode when .claude does not exist.',
`Expected: ${expectedDir}`,
`Got: ${result.trim()}`,
].join('\n')
);
});
});