Files
msd-core/tests/code-review-pipeline-regression.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

350 lines
14 KiB
JavaScript

// allow-test-rule: source-text-is-the-product
// The workflow and agent .md files ARE the product: their text is loaded and
// executed/interpreted at runtime by the agent host. Testing that specific
// strings exist within these files tests the deployed contract, not an
// implementation detail. No runtime API exists to enumerate the label accept-
// list or filter-set definitions — the text IS the specification.
//
// Bug 1 (compute_file_scope) — The inline Node.js script embedded in the
// workflow .md is the parser. The test implements the identical parse logic as
// a pure JS function (mirroring lines 172-184 of code-review.md exactly) and
// asserts on its structured output. A separate docs-parity assertion checks
// that the workflow .md contains the hyphen-aware boundary regex and the
// em-dash/parenthetical stripping — both of which are the deployed contract.
//
// Bug 2 (present_results) — Tested both behaviourally (pure JS helper that
// mimics the grep|cut pipeline) and via docs-parity on the workflow .md text.
//
// Bugs 3 and reviewer contract — docs-parity only on agents/*.md: the filter-
// set definition and label-equivalence contract exist only as text in those
// files; there is no runtime enumeration API.
'use strict';
const { describe, test } = require('node:test');
const assert = require('node:assert/strict');
const fs = require('node:fs');
const path = require('node:path');
const ROOT = path.resolve(__dirname, '..');
const WORKFLOW_PATH = path.join(ROOT, 'gsd-core', 'workflows', 'code-review.md');
const FIXER_PATH = path.join(ROOT, 'agents', 'gsd-code-fixer.md');
const REVIEWER_PATH = path.join(ROOT, 'agents', 'gsd-code-reviewer.md');
// ---------------------------------------------------------------------------
// Pure-function implementation of the compute_file_scope Node script body.
// This mirrors the logic in code-review.md lines 172-184 exactly.
// If those lines change, this function must be updated in tandem (and the
// docs-parity assertions below will catch a mismatch at the regex level).
// ---------------------------------------------------------------------------
function parseKeyFiles(yaml) {
const files = [];
let inSection = null;
for (const line of yaml.split('\n')) {
if (/^\s+created:/.test(line)) { inSection = 'created'; continue; }
if (/^\s+modified:/.test(line)) { inSection = 'modified'; continue; }
// Hyphen-aware boundary: reset inSection for ANY key: line (including key-decisions:, etc.)
if (/^\s*[\w-]+:/.test(line) && !/^\s*-/.test(line)) { inSection = null; continue; }
if (inSection && /^\s+-\s+(.+)/.test(line)) {
let raw = line.match(/^\s+-\s+(.+)/)[1].trim();
raw = raw.replace(/^['"]|['"]$/g, '');
// Order matters: parens BEFORE em-dash because em-dashes can appear inside parens
raw = raw.replace(/\s+\([^)]*\)\s*$/, '');
raw = raw.split(/\s+—\s/)[0].trim();
if (/\//.test(raw) && /\.[A-Za-z0-9]+$/.test(raw)) {
files.push(raw);
}
}
}
return files;
}
// ---------------------------------------------------------------------------
// Pure-function implementation of the present_results severity-label parser.
// Mirrors the grep -E "^\s*(critical|blocker):" | head -1 | cut -d: -f2 | xargs
// pipeline from code-review.md.
// ---------------------------------------------------------------------------
function parseFrontmatterCritical(frontmatter) {
const lines = frontmatter.split('\n');
const match = lines.find((l) => /^\s*(critical|blocker):/.test(l));
if (!match) return { critical: 0 };
const value = match.split(':').slice(1).join(':').trim();
return { critical: parseInt(value, 10) || 0 };
}
// ---------------------------------------------------------------------------
// BUG 1 — SUMMARY parser: compute_file_scope must not bleed prose from
// hyphenated sections (key-decisions:, patterns-established:, etc.) into the
// file list, and must strip em-dash descriptions and parentheticals.
// ---------------------------------------------------------------------------
describe('Bug 1 — compute_file_scope SUMMARY parser', () => {
test('extracts only key-files.created and key-files.modified entries', () => {
const yaml = [
'key-files:',
' created:',
' - app/foo.tsx',
' modified:',
' - lib/bar.ts',
'key-decisions:',
' - We chose RSC for performance reasons',
'patterns-established:',
' - Always validate at the boundary',
'requirements-completed:',
' - REQ-01 done',
].join('\n');
const files = parseKeyFiles(yaml);
assert.deepStrictEqual(files.sort(), ['app/foo.tsx', 'lib/bar.ts'].sort());
});
test('strips em-dash narrative from bullet: "app/foo.tsx — RSC catalogue with filters"', () => {
const yaml = [
'key-files:',
' created:',
' - app/foo.tsx — RSC catalogue with topic/mode/date filters',
].join('\n');
const files = parseKeyFiles(yaml);
assert.deepStrictEqual(files, ['app/foo.tsx']);
});
test('strips parenthetical from bullet: "tests/bar.test.ts (122 lines — 17 assertions)"', () => {
const yaml = [
'key-files:',
' created:',
' - tests/bar.test.ts (122 lines — 17 assertions)',
].join('\n');
const files = parseKeyFiles(yaml);
assert.deepStrictEqual(files, ['tests/bar.test.ts']);
});
test('hyphenated sections in any order produce identical results', () => {
const yamlA = [
'key-decisions:',
' - Some decision',
'key-files:',
' created:',
' - src/index.ts',
'patterns-established:',
' - Some pattern',
].join('\n');
const yamlB = [
'patterns-established:',
' - Some pattern',
'key-files:',
' created:',
' - src/index.ts',
'key-decisions:',
' - Some decision',
].join('\n');
assert.deepStrictEqual(parseKeyFiles(yamlA), parseKeyFiles(yamlB));
assert.deepStrictEqual(parseKeyFiles(yamlA), ['src/index.ts']);
});
test('prose-only bullets from key-decisions are never included in file list', () => {
const yaml = [
'key-decisions:',
' - We chose RSC for performance reasons',
' - Deferred auth to Phase 3',
'key-files:',
' created:',
' - app/page.tsx',
].join('\n');
const files = parseKeyFiles(yaml);
assert.deepStrictEqual(files, ['app/page.tsx']);
});
// Docs-parity: the workflow .md must contain the hyphen-aware boundary regex
// so what we tested above is actually what is deployed.
test('code-review.md contains hyphen-aware boundary regex [\\w-]+', () => {
const src = fs.readFileSync(WORKFLOW_PATH, 'utf8');
// Locate the Node script block in the compute_file_scope step
const scriptStart = src.indexOf('const files = [];');
assert.ok(scriptStart !== -1, 'compute_file_scope script must contain "const files = [];"');
const scriptEnd = src.indexOf('if (files.length)', scriptStart);
const scriptSection = src.slice(scriptStart, scriptEnd);
// Must use [\\w-]+ (hyphen-aware) not \\w+ only
const hasHyphenAwareRegex = scriptSection.includes('[\\\\w-]') || scriptSection.includes('[\\w-]');
assert.ok(
hasHyphenAwareRegex,
'compute_file_scope boundary regex must be hyphen-aware ([\\w-]+), found section:\n' + scriptSection
);
});
// Docs-parity: the workflow .md must contain the em-dash and parenthetical stripping.
test('code-review.md contains em-dash split and parenthetical strip in script body', () => {
const src = fs.readFileSync(WORKFLOW_PATH, 'utf8');
const scriptStart = src.indexOf('const files = [];');
const scriptEnd = src.indexOf('if (files.length)', scriptStart);
const scriptSection = src.slice(scriptStart, scriptEnd);
assert.ok(
scriptSection.includes('replace(/\\s+\\([^)]*\\)\\s*$/, \'\')'),
'Script must strip parentheticals with replace(/\\s+\\([^)]*\\)\\s*$/, \'\')'
);
assert.ok(
scriptSection.includes('split(/\\s+—\\s'),
'Script must split on em-dash to strip narrative'
);
});
});
// ---------------------------------------------------------------------------
// BUG 2 — severity-label parser: present_results must accept both `critical:`
// and `blocker:` as Critical-tier frontmatter keys.
// ---------------------------------------------------------------------------
describe('Bug 2 — present_results severity-label parser', () => {
test('frontmatter with blocker: 8 is parsed as critical: 8', () => {
const frontmatter = [
'phase: 03-courses',
'reviewed: 2025-01-01T00:00:00Z',
'findings:',
' blocker: 8',
' warning: 2',
' info: 0',
' total: 10',
'status: issues_found',
].join('\n');
const result = parseFrontmatterCritical(frontmatter);
assert.strictEqual(result.critical, 8);
});
test('frontmatter with critical: 5 is parsed as critical: 5', () => {
const frontmatter = [
'phase: 03-courses',
'reviewed: 2025-01-01T00:00:00Z',
'findings:',
' critical: 5',
' warning: 1',
' info: 0',
' total: 6',
'status: issues_found',
].join('\n');
const result = parseFrontmatterCritical(frontmatter);
assert.strictEqual(result.critical, 5);
});
test('frontmatter with neither critical nor blocker returns 0', () => {
const frontmatter = [
'phase: 03-courses',
'findings:',
' warning: 3',
' info: 1',
' total: 4',
'status: issues_found',
].join('\n');
const result = parseFrontmatterCritical(frontmatter);
assert.strictEqual(result.critical, 0);
});
// Docs-parity: the workflow .md must contain the updated grep pattern.
test('code-review.md present_results grep accepts both critical and blocker labels', () => {
const src = fs.readFileSync(WORKFLOW_PATH, 'utf8');
assert.ok(
src.includes('grep -E "^[[:space:]]*(critical|blocker):"'),
'code-review.md present_results must grep for both critical: and blocker: labels'
);
});
// Docs-parity: the workflow .md must contain the updated grep for BL- headings.
test('code-review.md present_results grep includes BL- headings alongside CR- and WR-', () => {
const src = fs.readFileSync(WORKFLOW_PATH, 'utf8');
assert.ok(
src.includes('### BL-') && src.includes('### CR-') && src.includes('### WR-'),
'code-review.md present_results must grep for BL- alongside CR- and WR- headings'
);
});
});
// ---------------------------------------------------------------------------
// BUG 3 — fixer agent ID alphabet and filter sets must include BL-* alongside CR-*.
// ---------------------------------------------------------------------------
describe('Bug 3 — gsd-code-fixer BL-* inclusion in filter sets', () => {
test('finding_parser documents BL-\\d+ as Critical-tier-equivalent', () => {
const src = fs.readFileSync(FIXER_PATH, 'utf8');
const parserStart = src.indexOf('<finding_parser>');
const parserEnd = src.indexOf('</finding_parser>');
assert.ok(parserStart !== -1, 'gsd-code-fixer.md must have a <finding_parser> block');
const parserSection = src.slice(parserStart, parserEnd);
assert.ok(
parserSection.includes('BL-'),
'finding_parser block must document BL-* as a Critical-tier-equivalent ID prefix'
);
});
test('parse_findings step documents severity as "Critical (CR-* or BL-*)"', () => {
const src = fs.readFileSync(FIXER_PATH, 'utf8');
const stepStart = src.indexOf('<step name="parse_findings">');
const stepEnd = src.indexOf('</step>', stepStart);
assert.ok(stepStart !== -1, 'gsd-code-fixer.md must have a parse_findings step');
const stepSection = src.slice(stepStart, stepEnd);
assert.ok(
stepSection.includes('CR-* or BL-*') || stepSection.includes('CR-* and BL-*'),
'parse_findings step must describe Critical severity as "CR-* or BL-*"'
);
});
test('critical_warning filter set includes BL-* alongside CR-* and WR-*', () => {
const src = fs.readFileSync(FIXER_PATH, 'utf8');
const stepStart = src.indexOf('<step name="parse_findings">');
const stepEnd = src.indexOf('</step>', stepStart);
const stepSection = src.slice(stepStart, stepEnd);
const critWarningIdx = stepSection.indexOf('critical_warning');
assert.ok(critWarningIdx !== -1, 'parse_findings must define critical_warning filter');
const lineStart = stepSection.lastIndexOf('\n', critWarningIdx);
const lineEnd = stepSection.indexOf('\n', critWarningIdx);
const filterLine = stepSection.slice(lineStart, lineEnd);
assert.ok(
filterLine.includes('BL-'),
'critical_warning filter line must include BL-*: ' + filterLine.trim()
);
});
test('sort order description mentions both CR-* and BL-* for Critical tier', () => {
const src = fs.readFileSync(FIXER_PATH, 'utf8');
const stepStart = src.indexOf('<step name="parse_findings">');
const stepEnd = src.indexOf('</step>', stepStart);
const stepSection = src.slice(stepStart, stepEnd);
assert.ok(
stepSection.includes('BL-'),
'parse_findings sort-order description must mention BL-* as Critical-tier alongside CR-*'
);
});
});
// ---------------------------------------------------------------------------
// REVIEWER CONTRACT — gsd-code-reviewer.md must acknowledge BL-/blocker: as
// an accepted alternative to CR-/critical: (tier-equivalent).
// ---------------------------------------------------------------------------
describe('Reviewer contract — gsd-code-reviewer.md label-equivalence', () => {
test('write_review step documents blocker: as accepted alternative to critical:', () => {
const src = fs.readFileSync(REVIEWER_PATH, 'utf8');
const stepStart = src.indexOf('<step name="write_review">');
const stepEnd = src.indexOf('</step>', stepStart);
assert.ok(stepStart !== -1, 'gsd-code-reviewer.md must have a write_review step');
const stepSection = src.slice(stepStart, stepEnd);
assert.ok(
stepSection.includes('blocker'),
'write_review step must acknowledge blocker: as a tier-equivalent alternative to critical:'
);
});
test('write_review step acknowledges BL- finding ID prefix as Critical-tier-equivalent', () => {
const src = fs.readFileSync(REVIEWER_PATH, 'utf8');
const stepStart = src.indexOf('<step name="write_review">');
const stepEnd = src.indexOf('</step>', stepStart);
const stepSection = src.slice(stepStart, stepEnd);
assert.ok(
stepSection.includes('BL-'),
'write_review step must acknowledge BL- as a Critical-tier-equivalent finding ID prefix'
);
});
});