Files
msd-core/tests/phase-command-router.test.cjs
Tom Boucher 463cffd894 chore(#604): rename get-shit-done/ runtime directory to gsd-core/ (#615)
* chore(#604): rename get-shit-done/ runtime directory to gsd-core/

Renames the installed runtime directory `get-shit-done/` to `gsd-core/` so the
on-disk name matches the package (`@opengsd/gsd-core`), repo, and binary
(`gsd-tools`). The npm package name and binary are unchanged; npx/npm consumers
are unaffected.

Mechanical (bulk, ~90% of the diff):
- `git mv get-shit-done gsd-core`
- Swept path/identifier references across the repo via
  `perl -pe 's/get-shit-done(?!-\w)/gsd-core/g'`. The negative lookahead
  preserves the five legitimate slug variants that are NOT the directory:
  get-shit-done-{OLD,cc,classic,cli,redux} (old package/repo names).
- Build/manifest wiring: package.json (bin, files, coverage globs),
  tsconfig.build.json (outDir), ~86 .gitignore build-output entries,
  stryker.config.mjs, scan-ignore files, install.js path strings.
- Frozen (not rewritten): CHANGELOG.md history; translated docs
  (README.<locale>.md and docs/{ja-JP,ko-KR,pt-BR,zh-CN}/).

New logic (review here):
- src/installer-migrations/003-rename-get-shit-done-to-gsd-core.cts: a proper
  ADR-0008 installer migration. On upgrade it walks the legacy
  `~/.claude/get-shit-done/` tree, classifies each file via the prior install
  manifest, and emits remove-managed / backup-and-remove for managed files
  while PRESERVING unknown user-added files. Symlink-safe (skips a symlinked
  root and symlinked entries; bounds-checks every path under configDir). The
  framework rolls back on install failure. Emptied dirs may remain (framework
  has no recursive dir-removal primitive) — documented.
- scripts/lint-legacy-dir-name.cjs: CI regression guard forbidding the bare
  `get-shit-done` directory token (split token to avoid self-match; case-
  insensitive; `(?!-\w)` lookahead allows the slug variants; allowlists
  CHANGELOG, translated docs, and `gsd-allow-legacy-name` marker lines).
  Wired into the lint-tests CI job.
- Restored scripts/lint-package-identity-drift.cjs detection regexes (the
  mechanical sweep had wrongly rewritten the old-name patterns it exists to
  detect) and marked them as intentional legacy references.
- TDD tests for the migration and the guard; do.md slash-command guard regex
  tightened so a `/gsd-core/bin` path segment is not mistaken for a command;
  changeset + docs/installer-migrations.md row added.

Breaking: the installed runtime path moves `~/.claude/get-shit-done/` ->
`~/.claude/gsd-core/`. Migration 003 removes the stale legacy dir's managed
files (preserving user files) on upgrade. Users with custom hooks/configs
hardcoding the old path must update them.

Closes #604

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>

* fix(#604): unsweep pending changesets + allowlist injection-example docs

CI fixes for the rename PR:
- Do not sweep pending .changeset/*.md (ephemeral release-note fragments,
  like CHANGELOG); reverted those body edits so 5 pre-existing malformed
  fragments (missing type/pr) no longer enter the PR diff and trip docs-lint.
  Allowlisted .changeset/ in the legacy-name guard accordingly.
- Allowlisted TEST-EXAMPLES.md and docs/explanation/security-model.md in
  prompt-injection-scan.sh: they contain intentional injection examples /
  security-model prose; the path-reference rewrites are kept.

CodeQL alerts on this PR are pre-existing (alert lines unchanged by this PR;
none in the new migration/guard) and are out of scope for the rename.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>

* fix(#604): resolve CodeQL alerts surfaced on this PR

The rename diff touched files carrying pre-existing CodeQL findings; per the
no-pre-existing-dismissal rule, fixing every surfaced alert rather than waving
them off. All behavior-preserving:

- scripts/ci-test-scope.cjs: build the config-path match from string
  .includes() instead of a RegExp over an arg-derived value (js/regex-injection).
- src/profile-output.cts: escape backslashes before pipe-escaping desc/safeName
  so the table-cell escape is complete (js/incomplete-sanitization).
- tests/{bug-2643,bug-2808,docs-parity-live-registry}: two-pass HTML-comment
  strip so a bare/unclosed `<!--` cannot survive (js/incomplete-multi-character-sanitization).
- tests/inline-plan-threshold: drop the no-op `\s`->`\s` identity replace,
  keep the meaningful POSIX-class conversion (js/identity-replacement).

Verified: build:lib green; the touched test files + ci-test-scope + profile-output
suites pass; lint:legacy-name clean.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>

* fix(#604): correctly resolve remaining CodeQL alerts (regex-injection + sanitization)

The prior commit's fixes for two alerts were ineffective:
- ci-test-scope.cjs js/regex-injection: the alert is the CLI-arg-derived `file`
  reaching static regex `.test(file)` calls (not the config rule). Removed ALL
  regex over file/t — startsWith/includes/=== string checks + an isWindowsHint
  helper — so there is no regex sink for the tainted value.
- js/incomplete-multi-character-sanitization (3 test files): a single
  `.replace(/<!--...-->/g,'')` can let `<!--` re-form. Replaced with a fixpoint
  loop (replace until stable) plus a final bare-opener strip.

Verified: no regex over file/t remains; ci-test-scope + the 3 test suites pass;
lint:legacy-name clean.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>

* fix(#604): make ci-test-scope + comment-strippers regex-free to clear CodeQL

CodeQL flags the regex PATTERNS syntactically (regex-injection on the
--files arg split; incomplete-multi-character-sanitization on the <!--...-->
replace), so loop fixes do not satisfy it. Made these paths regex-free:
- ci-test-scope.cjs splitFiles: char-by-char separator tokenizer (no /[,\\s]+/).
- 3 test files: indexOf/slice HTML-comment stripper (no .replace(/<!--/)).
Behavior preserved; ci-test-scope + the 3 suites pass; guard clean.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>

* fix(#604): unblock security base64 scan on the large rename diff

The security job hit its 10m timeout: base64-scan.sh choked on the binary
test fixture tests/feat-3594-parser-property-style.test.cjs (embedded NUL/
non-UTF8 bytes -> thousands of bogus blobs + "ignored null byte" warnings),
and the ~800-file rename diff is slow to scan regardless.

- scripts/base64-scan.sh: skip binary-by-content files (grep -Iq .) — they
  can't carry base64-obfuscated *text* and feeding NUL bytes through the
  per-line scanner is pathologically slow. collect_files already filtered
  binary *extensions*; this catches binary *content* in text extensions.
- .github/workflows/security-scan.yml: raise the security job timeout 10m->30m
  to accommodate very large diffs (the scan itself is unchanged).

Verified locally: scan skips the fixture, 0 "ignored null byte" warnings,
0 findings, exit 0.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>

* fix(#604): sweep get-shit-done refs introduced by merging next

The branch was updated with next (#614/#384/#618 etc.), which reference the
get-shit-done/ dir (still named that on next). Swept the stale references in
the merged files to gsd-core so the rename stays consistent and lint:legacy-name
passes:
- commands/gsd/discuss-phase.md (runtime-launcher shim paths)
- src/core.cts (getAgentsDir layout comments)
- tests/bug-384-agents-runtime-aware.test.cjs (require path to runtime lib)

Verified: guard 0 violations; build green.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>

* fix(#604): exclude gsd-core/ path segments from bug-3683 command cross-ref invariant

The #614 runtime-launcher shim added to discuss-phase.md references
`${_GSD_RUNTIME_ROOT}/gsd-core/bin/...`. bug-3683's REF_PATTERN excluded path-y
refs only via lookbehind, but `}` precedes `/gsd-core/` in the shim, so it
mis-read the directory path as a dangling `/gsd-core` command ref (same class as
the #604 bug-2954 fix). Added a trailing `(?![\w-]*\/)` so `/gsd-<x>/...` path
segments are not treated as slash-command references.

Verified locally on BOTH platforms before pushing:
- mac (node 26) full suite: 0 failures
- gsd-test-runner (linux, node22 image) full suite: 0 failures
- bug-3683 + bug-2954 pass.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>

* fix(#604): lazily resolve findProjectRoot in gsd-tools (harden flaky CI)

CI intermittently failed state.test's gsd-tools subprocess with
"findProjectRoot is not a function" (flip-flopping across legs; not reproducible
on mac full suite, gsd-test linux full suite, test:unit, or state.test x8).
findProjectRoot is a re-export from core.cjs (sourced from project-root.cjs);
binding it via destructure at module-load can be undefined under a load-ordering
edge. Resolve it lazily at call time via a small wrapper so the lookup happens
after core.cjs is fully initialized.

Verified green on BOTH platforms before pushing:
- mac (node 26) full suite: 0 failures
- gsd-test-runner (linux, node22) full suite: 0 failures
- state.test.cjs: 106/106; gsd-tools loads cleanly.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>

* fix(#604): allowlist verification-patterns.md placeholder examples in secret scan

The rename git-mv'd references/verification-patterns.md into gsd-core/, pulling
it into the secret-scan diff. It documents stub/placeholder RED-FLAG env-var
examples (illustrative Stripe test-key / database-URL / API-key placeholders) —
not real credentials. Added it to .secretscanignore with the strict annotation,
mirroring the existing gsd-core/workflows/plan-phase.md exception.

Verified locally: secret-scan-lint --strict OK; secret-scan --diff origin/next
exits 0 with 0 findings.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>

---------

Co-authored-by: Claude Opus 4.8 <noreply@anthropic.com>
2026-06-02 18:35:29 -04:00

421 lines
14 KiB
JavaScript

'use strict';
/**
* Behavioral tests for the phase-command-router adapter (#3788).
*
* Shape:
* 1. Adapter translation — CLI args → hub dispatch shape
* 2. Result translation — hub result → stdout / error callback
* 3. Unsupported subcommands — scaffold produces the documented redirect
* 4. Unknown subcommand — unmapped subcommands produce a well-formed error
* 5. Integration — real hub + real CJS phase handler invocation
*
* Testing rules in force (CONTRIBUTING.md § Testing Standards):
* - No readFileSync of source files.
* - No mocking of the hub itself — tests use the real CommandRoutingHub
* with stub cjsRegistry / sdkLoader entries.
* - All assertions on return values and captured call arguments.
*/
const { describe, test, before, after } = require('node:test');
const assert = require('node:assert/strict');
const { routePhaseCommand } = require('../gsd-core/bin/lib/phase-command-router.cjs');
// Force CJS path throughout: set GSD_WORKSTREAM so tryLoadSdk() is bypassed.
// This makes unit-level assertions deterministic regardless of SDK build state.
let _prevWorkstream;
before(() => {
_prevWorkstream = process.env.GSD_WORKSTREAM;
process.env.GSD_WORKSTREAM = 'test-unit';
});
after(() => {
if (_prevWorkstream === undefined) delete process.env.GSD_WORKSTREAM;
else process.env.GSD_WORKSTREAM = _prevWorkstream;
});
// ─── Helper: build a minimal phase stub ──────────────────────────────────────
function makePhase(overrides = {}) {
return {
cmdPhaseMvpMode: () => {},
cmdPhaseNextDecimal: () => {},
cmdPhaseAdd: () => {},
cmdPhaseAddBatch: () => {},
cmdPhaseInsert: () => {},
cmdPhaseRemove: () => {},
cmdPhaseComplete: () => {},
...overrides,
};
}
// ─── 1. Adapter translation — CLI args → handler calls ───────────────────────
describe('phase-command-router — CLI arg translation (CJS path)', () => {
test('routes phase mvp-mode: passes cwd, args.slice(2), raw to handler', () => {
const calls = [];
const phase = makePhase({
cmdPhaseMvpMode: (cwd, slicedArgs, raw) => calls.push({ cwd, slicedArgs, raw }),
});
routePhaseCommand({ phase, args: ['phase', 'mvp-mode', '--enable'], cwd: '/proj', raw: false, error: (m) => { throw new Error(m); } });
assert.equal(calls.length, 1);
assert.equal(calls[0].cwd, '/proj');
assert.deepEqual(calls[0].slicedArgs, ['--enable']);
assert.equal(calls[0].raw, false);
});
test('routes phase next-decimal: passes cwd, args[2], raw to handler', () => {
const calls = [];
const phase = makePhase({
cmdPhaseNextDecimal: (cwd, label, raw) => calls.push({ cwd, label, raw }),
});
routePhaseCommand({ phase, args: ['phase', 'next-decimal', '5'], cwd: '/p', raw: true, error: (m) => { throw new Error(m); } });
assert.equal(calls[0].label, '5');
assert.equal(calls[0].raw, true);
});
test('routes phase add: strips --raw, passes joined description and no customId', () => {
const calls = [];
const phase = makePhase({
cmdPhaseAdd: (cwd, desc, raw, customId) => calls.push({ cwd, desc, raw, customId }),
});
routePhaseCommand({ phase, args: ['phase', 'add', 'My', 'phase', '--raw'], cwd: '/p', raw: true, error: (m) => { throw new Error(m); } });
assert.equal(calls[0].desc, 'My phase');
assert.equal(calls[0].customId, null);
});
test('routes phase add: captures --id value', () => {
const calls = [];
const phase = makePhase({
cmdPhaseAdd: (cwd, desc, raw, customId) => calls.push({ customId }),
});
routePhaseCommand({ phase, args: ['phase', 'add', '--id', '05', 'Desc'], cwd: '/p', raw: false, error: (m) => { throw new Error(m); } });
assert.equal(calls[0].customId, '05');
});
test('routes phase add-batch: --descriptions JSON array parses correctly', () => {
const calls = [];
const phase = makePhase({
cmdPhaseAddBatch: (cwd, descriptions, raw) => calls.push({ descriptions }),
});
routePhaseCommand({
phase,
args: ['phase', 'add-batch', '--descriptions', '["Phase A","Phase B"]'],
cwd: '/p',
raw: false,
error: (m) => { throw new Error(m); },
});
assert.deepEqual(calls[0].descriptions, ['Phase A', 'Phase B']);
});
test('routes phase add-batch: positional args used when --descriptions absent', () => {
const calls = [];
const phase = makePhase({
cmdPhaseAddBatch: (cwd, descriptions, raw) => calls.push({ descriptions }),
});
routePhaseCommand({
phase,
args: ['phase', 'add-batch', 'A', 'B', '--raw'],
cwd: '/p',
raw: true,
error: (m) => { throw new Error(m); },
});
assert.deepEqual(calls[0].descriptions, ['A', 'B']);
});
test('routes phase insert: passes cwd, phaseNum, trailing joined, raw', () => {
const calls = [];
const phase = makePhase({
cmdPhaseInsert: (cwd, phaseNum, desc, raw) => calls.push({ cwd, phaseNum, desc, raw }),
});
routePhaseCommand({ phase, args: ['phase', 'insert', '02', 'New', 'phase'], cwd: '/p', raw: false, error: (m) => { throw new Error(m); } });
assert.equal(calls[0].phaseNum, '02');
assert.equal(calls[0].desc, 'New phase');
});
test('routes phase remove: passes cwd, phaseNum, force:false, raw', () => {
const calls = [];
const phase = makePhase({
cmdPhaseRemove: (cwd, phaseNum, opts, raw) => calls.push({ cwd, phaseNum, opts, raw }),
});
routePhaseCommand({ phase, args: ['phase', 'remove', '03'], cwd: '/p', raw: false, error: (m) => { throw new Error(m); } });
assert.equal(calls[0].phaseNum, '03');
assert.deepEqual(calls[0].opts, { force: false });
});
test('routes phase remove: --force flag sets opts.force:true', () => {
const calls = [];
const phase = makePhase({
cmdPhaseRemove: (cwd, phaseNum, opts, raw) => calls.push({ opts }),
});
routePhaseCommand({ phase, args: ['phase', 'remove', '--force', '03'], cwd: '/p', raw: false, error: (m) => { throw new Error(m); } });
assert.deepEqual(calls[0].opts, { force: true });
});
test('routes phase complete: passes cwd, args[2], raw', () => {
const calls = [];
const phase = makePhase({
cmdPhaseComplete: (cwd, phaseNum, raw) => calls.push({ cwd, phaseNum, raw }),
});
routePhaseCommand({ phase, args: ['phase', 'complete', '04'], cwd: '/p', raw: false, error: (m) => { throw new Error(m); } });
assert.equal(calls[0].phaseNum, '04');
});
});
// ─── 2. Result translation — error callback on failure ───────────────────────
describe('phase-command-router — result translation (error path)', () => {
test('phase add with --id missing value calls error()', () => {
let msg = null;
const phase = makePhase();
routePhaseCommand({
phase,
args: ['phase', 'add', '--id'],
cwd: '/p',
raw: false,
error: (m) => { msg = m; },
});
assert.ok(msg !== null, 'error callback must be called');
assert.ok(msg.includes('--id requires a value'));
});
test('phase add with unknown flag calls error()', () => {
let msg = null;
const phase = makePhase();
routePhaseCommand({
phase,
args: ['phase', 'add', '--unknown-flag'],
cwd: '/p',
raw: false,
error: (m) => { msg = m; },
});
assert.ok(msg !== null);
assert.ok(msg.includes('phase add does not support'));
});
test('phase add-batch with non-JSON --descriptions calls error()', () => {
let msg = null;
const phase = makePhase();
routePhaseCommand({
phase,
args: ['phase', 'add-batch', '--descriptions', 'not-json'],
cwd: '/p',
raw: false,
error: (m) => { msg = m; },
});
assert.ok(msg !== null);
assert.ok(msg.includes('JSON array'));
});
test('phase insert with --dry-run calls error()', () => {
let msg = null;
const phase = makePhase();
routePhaseCommand({
phase,
args: ['phase', 'insert', '02', '--dry-run'],
cwd: '/p',
raw: false,
error: (m) => { msg = m; },
});
assert.ok(msg !== null);
assert.ok(msg.includes('does not support --dry-run'));
});
test('phase remove with unsupported flag calls error()', () => {
let msg = null;
const phase = makePhase();
routePhaseCommand({
phase,
args: ['phase', 'remove', '--quiet', '03'],
cwd: '/p',
raw: false,
error: (m) => { msg = m; },
});
assert.ok(msg !== null);
assert.ok(msg.includes('phase remove does not support'));
});
test('phase remove without a phase number calls error()', () => {
let msg = null;
const phase = makePhase();
routePhaseCommand({
phase,
args: ['phase', 'remove'],
cwd: '/p',
raw: false,
error: (m) => { msg = m; },
});
assert.ok(msg !== null);
assert.ok(msg.includes('exactly one phase number'));
});
});
// ─── 3. Unsupported subcommands ────────────────────────────────────────────────
describe('phase-command-router — unsupported subcommands', () => {
test('phase list-plans resolves as unknown subcommand', () => {
let msg = null;
routePhaseCommand({
phase: makePhase(),
args: ['phase', 'list-plans'],
cwd: '/p',
raw: false,
error: (m) => { msg = m; },
});
assert.ok(msg !== null);
assert.ok(msg.includes('Unknown phase subcommand'));
assert.ok(msg.includes('Available:'), `expected "Available:" in: ${msg}`);
});
test('phase list-artifacts resolves as unknown subcommand', () => {
let msg = null;
routePhaseCommand({
phase: makePhase(),
args: ['phase', 'list-artifacts'],
cwd: '/p',
raw: false,
error: (m) => { msg = m; },
});
assert.ok(msg !== null);
assert.ok(msg.includes('Unknown phase subcommand'));
assert.ok(msg.includes('Available:'), `expected "Available:" in: ${msg}`);
});
test('phase scaffold calls error() with redirect message', () => {
let msg = null;
routePhaseCommand({
phase: makePhase(),
args: ['phase', 'scaffold'],
cwd: '/p',
raw: false,
error: (m) => { msg = m; },
});
assert.ok(msg !== null);
assert.ok(msg.includes('scaffold'));
});
});
// ─── 4. Unknown subcommand ────────────────────────────────────────────────────
describe('phase-command-router — unknown subcommand', () => {
test('unknown phase subcommand calls error() listing available ones', () => {
let msg = null;
routePhaseCommand({
phase: makePhase(),
args: ['phase', 'frobnicate'],
cwd: '/p',
raw: false,
error: (m) => { msg = m; },
});
assert.ok(msg !== null);
assert.ok(msg.includes('Unknown phase subcommand'));
assert.ok(msg.includes('Available:'), `expected "Available:" in: ${msg}`);
});
test('unknown subcommand message lists canonical manifest commands like add and complete', () => {
// mvp-mode is NOT in the available list (not in PHASE_SUBCOMMANDS manifest),
// matching the pre-#3788 behaviour of routeCjsCommandFamily.
// The list does include the manifest-backed commands: add, complete, etc.
let msg = null;
routePhaseCommand({
phase: makePhase(),
args: ['phase', 'bogus'],
cwd: '/p',
raw: false,
error: (m) => { msg = m; },
});
assert.ok(msg.includes('add'), `expected add in available list: ${msg}`);
assert.ok(msg.includes('complete'), `expected complete in available list: ${msg}`);
assert.ok(!msg.includes('list-plans'), `list-plans must not appear in available list: ${msg}`);
});
});
// ─── 5. Integration — real hub + real CJS phase handler ──────────────────────
//
// This test exercises the full dispatch chain end-to-end:
// routePhaseCommand → createHub (cjs mode) → dispatch → cjsRegistry handler
// → phase stub → assert the call was received.
//
// No mocking of the hub. The phase stub is a real dependency collaborator.
describe('phase-command-router — integration: real hub + CJS phase handler', () => {
test('dispatches phase complete through real hub to real CJS handler chain', () => {
const calls = [];
const phase = makePhase({
cmdPhaseComplete: (cwd, phaseNum, raw) => calls.push({ cwd, phaseNum, raw }),
});
// No error should occur; handler should be called exactly once.
let errorMsg = null;
routePhaseCommand({
phase,
args: ['phase', 'complete', '07'],
cwd: '/integration',
raw: false,
error: (m) => { errorMsg = m; },
});
assert.equal(errorMsg, null, `unexpected error: ${errorMsg}`);
assert.equal(calls.length, 1);
assert.equal(calls[0].cwd, '/integration');
assert.equal(calls[0].phaseNum, '07');
assert.equal(calls[0].raw, false);
});
test('dispatches phase add-batch through real hub with --descriptions', () => {
const calls = [];
const phase = makePhase({
cmdPhaseAddBatch: (cwd, descriptions, raw) => calls.push({ descriptions }),
});
let errorMsg = null;
routePhaseCommand({
phase,
args: ['phase', 'add-batch', '--descriptions', '["Alpha","Beta"]'],
cwd: '/integration',
raw: false,
error: (m) => { errorMsg = m; },
});
assert.equal(errorMsg, null, `unexpected error: ${errorMsg}`);
assert.deepEqual(calls[0].descriptions, ['Alpha', 'Beta']);
});
});