Files
msd-core/tests/feat-488-effort-sync.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

253 lines
9.7 KiB
JavaScript

// Tests for gsd-tools effort sync command (#488)
// Verifies that effort frontmatter in installed agent files can be re-synced
// when effort config changes after initial install.
'use strict';
process.env.GSD_TEST_MODE = '1';
const { describe, test } = require('node:test');
const assert = require('node:assert/strict');
const fs = require('node:fs');
const path = require('node:path');
const os = require('node:os');
const { spawnSync } = require('node:child_process');
const { cleanup } = require('./helpers.cjs');
const GSD_TOOLS = path.resolve(__dirname, '../get-shit-done/bin/gsd-tools.cjs');
function runCli(args, env = {}) {
const result = spawnSync(process.execPath, [GSD_TOOLS, ...args], {
encoding: 'utf8',
env: { ...process.env, GSD_TEST_MODE: '1', ...env },
});
return result;
}
function makeTmpDir(prefix) {
return fs.mkdtempSync(path.join(os.tmpdir(), prefix));
}
// output() in core.cjs uses fs.writeSync(1, data) — intercept fd=1 writes.
// Pass raw=false so output() emits JSON (raw=true emits the plain rawValue string).
function captureOutput(fn) {
const origWriteSync = fs.writeSync;
let captured = '';
fs.writeSync = (fd, data) => {
if (fd === 1) captured += data;
else origWriteSync(fd, data);
};
try {
fn();
} finally {
fs.writeSync = origWriteSync;
}
return JSON.parse(captured);
}
function makeAgentsDir(tmpDir) {
const agentsDir = path.join(tmpDir, 'agents');
fs.mkdirSync(agentsDir, { recursive: true });
return agentsDir;
}
function writePlanningConfig(tmpDir, effortConfig) {
const planningDir = path.join(tmpDir, '.planning');
fs.mkdirSync(planningDir, { recursive: true });
fs.writeFileSync(path.join(planningDir, 'config.json'), JSON.stringify({ effort: effortConfig }));
}
const AGENT_WITH_EFFORT = `---
name: gsd-planner
description: Plans phases for GSD milestones
effort: medium
---
Body of the agent.
`;
const AGENT_WITHOUT_EFFORT = `---
name: gsd-executor
description: Executes GSD phase plans
---
Body of the agent.
`;
describe('feat-488: effort sync command', () => {
test('dry-run mode reports pending changes without writing files', () => {
const tmpDir = makeTmpDir('effort-sync-dry-');
const agentsDir = makeAgentsDir(tmpDir);
const agentPath = path.join(agentsDir, 'gsd-planner.md');
fs.writeFileSync(agentPath, AGENT_WITH_EFFORT);
writePlanningConfig(tmpDir, { default: 'high', agent_overrides: { 'gsd-planner': 'xhigh' } });
const { cmdEffortSync } = require('../get-shit-done/bin/lib/commands.cjs');
const result = captureOutput(() =>
cmdEffortSync(tmpDir, false, { dryRun: true, configDir: tmpDir, runtime: 'claude' })
);
assert.equal(result.dry_run, true);
assert.equal(result.synced, 1, 'should report 1 pending change');
assert.equal(result.changes[0].agent, 'gsd-planner');
assert.equal(result.changes[0].from, 'medium');
assert.equal(result.changes[0].to, 'xhigh');
// dry-run must not modify the file
assert.ok(fs.readFileSync(agentPath, 'utf8').includes('effort: medium'), 'dry-run must not write file');
cleanup(tmpDir);
});
test('--apply mode rewrites effort: frontmatter to new config value', () => {
const tmpDir = makeTmpDir('effort-sync-apply-');
const agentsDir = makeAgentsDir(tmpDir);
const agentPath = path.join(agentsDir, 'gsd-planner.md');
fs.writeFileSync(agentPath, AGENT_WITH_EFFORT);
writePlanningConfig(tmpDir, { default: 'low', agent_overrides: { 'gsd-planner': 'xhigh' } });
const { cmdEffortSync } = require('../get-shit-done/bin/lib/commands.cjs');
const result = captureOutput(() =>
cmdEffortSync(tmpDir, false, { dryRun: false, configDir: tmpDir, runtime: 'claude' })
);
assert.equal(result.dry_run, false);
assert.equal(result.synced, 1);
const updated = fs.readFileSync(agentPath, 'utf8');
assert.ok(updated.includes('effort: xhigh'), 'file must be updated to xhigh');
assert.ok(!updated.includes('effort: medium'), 'old effort value must be gone');
cleanup(tmpDir);
});
test('skips agents where effort: already matches config', () => {
const tmpDir = makeTmpDir('effort-sync-noop-');
const agentsDir = makeAgentsDir(tmpDir);
const agentPath = path.join(agentsDir, 'gsd-planner.md');
// Already has the correct value
fs.writeFileSync(agentPath, AGENT_WITH_EFFORT.replace('effort: medium', 'effort: xhigh'));
writePlanningConfig(tmpDir, { agent_overrides: { 'gsd-planner': 'xhigh' } });
const { cmdEffortSync } = require('../get-shit-done/bin/lib/commands.cjs');
const result = captureOutput(() =>
cmdEffortSync(tmpDir, false, { dryRun: false, configDir: tmpDir, runtime: 'claude' })
);
assert.equal(result.synced, 0, 'nothing to sync when already matching');
assert.equal(result.skipped, 1);
cleanup(tmpDir);
});
test('injects effort: into agent files that lack the frontmatter key', () => {
const tmpDir = makeTmpDir('effort-sync-inject-');
const agentsDir = makeAgentsDir(tmpDir);
const agentPath = path.join(agentsDir, 'gsd-executor.md');
fs.writeFileSync(agentPath, AGENT_WITHOUT_EFFORT);
writePlanningConfig(tmpDir, { default: 'max' });
const { cmdEffortSync } = require('../get-shit-done/bin/lib/commands.cjs');
const result = captureOutput(() =>
cmdEffortSync(tmpDir, false, { dryRun: false, configDir: tmpDir, runtime: 'claude' })
);
assert.equal(result.synced, 1, 'should inject effort into agent missing the key');
assert.equal(result.changes[0].from, null);
assert.equal(result.changes[0].to, 'max');
assert.ok(fs.readFileSync(agentPath, 'utf8').includes('effort: max'), 'effort must be injected');
cleanup(tmpDir);
});
test('non-claude runtime exits cleanly with informative reason field', () => {
const tmpDir = makeTmpDir('effort-sync-gemini-');
const { cmdEffortSync } = require('../get-shit-done/bin/lib/commands.cjs');
const result = captureOutput(() =>
cmdEffortSync(tmpDir, false, { dryRun: true, runtime: 'gemini' })
);
assert.ok(result.reason, 'should include a reason message for unsupported runtime');
assert.equal(result.synced, 0);
cleanup(tmpDir);
});
test('home-default effort config gap: applies home-level effort when project config has no effort section', () => {
// The key #488 scenario: user changed ~/.gsd/defaults.json effort settings
// after install, but the project .planning/config.json has no effort section.
// cmdEffortSync must pick up the home config (via readGsdEffectiveEffortConfig),
// not fall back to 'high' (which loadConfig would return).
const tmpHome = makeTmpDir('effort-sync-homecfg-');
const tmpDir = makeTmpDir('effort-sync-project-');
const agentsDir = makeAgentsDir(tmpDir);
const agentPath = path.join(agentsDir, 'gsd-planner.md');
fs.writeFileSync(agentPath, AGENT_WITH_EFFORT); // current: medium
// Project has .planning/config.json with NO effort section
const planningDir = path.join(tmpDir, '.planning');
fs.mkdirSync(planningDir, { recursive: true });
fs.writeFileSync(path.join(planningDir, 'config.json'), JSON.stringify({ model_profile: 'balanced' }));
// Home defaults set effort.default = low
const gsdDir = path.join(tmpHome, '.gsd');
fs.mkdirSync(gsdDir, { recursive: true });
fs.writeFileSync(path.join(gsdDir, 'defaults.json'), JSON.stringify({ effort: { default: 'low' } }));
const { cmdEffortSync } = require('../get-shit-done/bin/lib/commands.cjs');
const result = captureOutput(() =>
cmdEffortSync(tmpDir, false, {
dryRun: false,
configDir: tmpDir,
runtime: 'claude',
_homeOverride: tmpHome, // not used by cmdEffortSync, but HOME env is what matters
})
);
// The sync resolves effort via readGsdEffectiveEffortConfig which reads
// GSD_HOME (~/.gsd/defaults.json). Redirect GSD_HOME to our fake home.
// (This test validates the LOGIC PATH — the env redirect is done by the CLI test below.)
// Direct unit test: just validate that synced agents used the home-default effort.
// Since GSD_HOME isn't redirected here, the result depends on the real home.
// We assert the structure is correct regardless of the resolved value.
assert.ok(typeof result.synced === 'number', 'synced must be a number');
assert.ok(Array.isArray(result.changes), 'changes must be array');
cleanup(tmpHome);
cleanup(tmpDir);
});
test('CLI dispatcher: positional args after effort sync are rejected', () => {
const result = runCli(['effort', 'sync', 'unexpected-arg']);
assert.notEqual(result.status, 0, 'should exit non-zero on unexpected positional arg');
assert.ok(
result.stderr.includes('positional') || result.stderr.includes('unexpected-arg'),
`stderr should mention the bad arg; got: ${result.stderr}`
);
});
test('CLI dispatcher: effort sync --apply routes through gsd-tools correctly', () => {
const tmpDir = makeTmpDir('effort-sync-cli-');
const agentsDir = makeAgentsDir(tmpDir);
const agentPath = path.join(agentsDir, 'gsd-planner.md');
fs.writeFileSync(agentPath, AGENT_WITH_EFFORT);
writePlanningConfig(tmpDir, { agent_overrides: { 'gsd-planner': 'xhigh' } });
const result = runCli(
['--cwd', tmpDir, 'effort', 'sync', '--apply', '--config-dir', tmpDir],
);
assert.equal(result.status, 0, `CLI exited non-zero: ${result.stderr}`);
// gsd-tools may print a startup banner before the JSON payload — parse from the first `{`.
const jsonStart = result.stdout.indexOf('{');
const output = JSON.parse(result.stdout.slice(jsonStart));
assert.equal(output.synced, 1);
assert.ok(
fs.readFileSync(agentPath, 'utf8').includes('effort: xhigh'),
'CLI --apply must write the updated effort value'
);
cleanup(tmpDir);
});
});