Files
msd-core/tests/bug-3541-installer-migration-prompt-user-resolution.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

240 lines
9.2 KiB
JavaScript
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
/**
* Regression test for #3541: first-time-baseline installer migration
* `prompt-user` actions threw hard with no resolution path, making
* `/gsd-update` unrecoverable when leftover `gsd-*` files were classified
* as `stale-gsd-looking`.
*
* Fix shape (per triage brief):
* A. Classify-and-default for safe categories - stale SDK build
* artifacts default to "remove"; user-facing skills/gsd-asterisk/SKILL.md
* defaults to "keep". Each resolution is logged.
* B. Improved error message when an unresolved prompt-user action
* remains: lists choices, suggests the resolution path, groups
* blocked paths by reason.
*
* Behavioural test — exercises the actual installer migration code paths
* via the public `runInstallerMigrations` + new resolver entry points.
* No source-grep (per CONTEXT.md L98–101 / RULESET.TESTS).
*/
'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('node:fs');
const path = require('node:path');
const crypto = require('node:crypto');
const {
runInstallerMigrations,
} = require('../gsd-core/bin/lib/installer-migrations.cjs');
const {
assertInstallerMigrationsUnblocked,
resolveInstallerMigrationPromptsForNonTty,
} = require('../gsd-core/bin/lib/installer-migration-report.cjs');
const { createTempDir, cleanup } = require('./helpers.cjs');
function sha256(content) {
return crypto.createHash('sha256').update(content).digest('hex');
}
function writeFile(root, relPath, content) {
const fullPath = path.join(root, relPath);
fs.mkdirSync(path.dirname(fullPath), { recursive: true });
fs.writeFileSync(fullPath, content, 'utf8');
}
function writeManifest(root, files) {
fs.writeFileSync(
path.join(root, 'gsd-file-manifest.json'),
JSON.stringify({
version: '1.41.2',
timestamp: '2026-05-10T00:00:00.000Z',
mode: 'full',
files,
}, null, 2),
'utf8'
);
}
describe('#3541: installer migration prompt-user non-TTY resolution', { concurrency: false }, () => {
let configDir;
beforeEach(() => {
configDir = createTempDir('gsd-3541-');
});
afterEach(() => {
cleanup(configDir);
});
test('Test A: non-TTY default resolution removes stale SDK artifacts and keeps user skills', () => {
// Stale SDK build artifact: replicates the 1.41.2 → 1.42.2 upgrade where
// 24 stale `gsd-core/sdk/{dist,src}/gsd-*` files leaked into the
// baseline because the new manifest no longer classifies them as managed.
writeFile(configDir, 'gsd-core/sdk/dist/gsd-old-bundle.js', 'stale sdk bundle\n');
// User-facing skill: replicates `skills/gsd-roadmap/SKILL.md` from the
// same incident — user-owned content that must be preserved.
writeFile(configDir, 'skills/gsd-roadmap/SKILL.md', '# Roadmap skill\nuser content\n');
// Plant an empty manifest so both files classify as `stale-gsd-looking`
// (they look like GSD artifacts but are not manifest-managed).
writeManifest(configDir, {});
const result = runInstallerMigrations({
configDir,
runtime: 'claude',
scope: 'global',
baselineScan: true,
});
// Confirm the migration framework classified both as prompt-user
// blockers — this is the precondition the fix resolves.
const blockedPaths = (result.blocked || []).map((a) => a.relPath).sort();
assert.deepEqual(
blockedPaths,
['gsd-core/sdk/dist/gsd-old-bundle.js', 'skills/gsd-roadmap/SKILL.md'],
'precondition: both stale-looking files should be flagged for explicit user choice'
);
// Now run the non-TTY resolver. It must classify-and-default each
// blocked action and return a structured log of resolutions.
const resolved = resolveInstallerMigrationPromptsForNonTty(result, { isTty: false });
assert.ok(Array.isArray(resolved.resolutions), 'resolver returns a resolutions log');
assert.equal(
resolved.resolutions.length,
2,
'one resolution entry per blocked action'
);
const byPath = new Map(resolved.resolutions.map((r) => [r.relPath, r]));
const sdkResolution = byPath.get('gsd-core/sdk/dist/gsd-old-bundle.js');
const skillResolution = byPath.get('skills/gsd-roadmap/SKILL.md');
assert.ok(sdkResolution, 'SDK artifact resolution logged');
assert.equal(sdkResolution.choice, 'remove', 'stale SDK build artifact defaults to remove');
assert.equal(sdkResolution.category, 'stale-sdk-build-artifact');
assert.ok(skillResolution, 'user skill resolution logged');
assert.equal(skillResolution.choice, 'keep', 'user-facing skill defaults to keep');
assert.equal(skillResolution.category, 'user-facing-skill');
// After resolution there must be no blocked actions remaining; the
// assertion gatekeeper must not throw.
assert.equal(
(resolved.result.blocked || []).length,
0,
'all prompt-user actions resolved'
);
assert.doesNotThrow(() => assertInstallerMigrationsUnblocked(resolved.result));
});
test('Test B: error message groups paths by reason and suggests a resolution path', () => {
// Build a synthetic result with two blocked prompt-user actions of
// distinct reasons. The improved error message must (1) list the
// documented choices, (2) suggest the non-interactive resolution
// path, (3) group blocked paths by reason rather than emit each path
// individually.
const blocked = [
{
type: 'prompt-user',
relPath: 'gsd-core/sdk/dist/gsd-a.js',
reason: 'GSD-looking file is not proven manifest-managed and needs explicit user choice',
classification: 'stale-gsd-looking',
prompt: 'Choose whether to remove this stale-looking GSD artifact or keep it as user-owned.',
choices: ['keep', 'remove'],
},
{
type: 'prompt-user',
relPath: 'gsd-core/sdk/dist/gsd-b.js',
reason: 'GSD-looking file is not proven manifest-managed and needs explicit user choice',
classification: 'stale-gsd-looking',
prompt: 'Choose whether to remove this stale-looking GSD artifact or keep it as user-owned.',
choices: ['keep', 'remove'],
},
];
let captured = null;
try {
assertInstallerMigrationsUnblocked({ blocked });
assert.fail('expected assertInstallerMigrationsUnblocked to throw');
} catch (err) {
captured = err;
}
assert.ok(captured instanceof Error);
const message = captured.message;
// (a) Documented choices listed.
assert.match(message, /keep/, 'error message lists `keep` choice');
assert.match(message, /remove/, 'error message lists `remove` choice');
// (b) Suggests the resolution path. The fix introduces an
// environment variable as the documented non-interactive resolution
// surface — the message must point users at it.
assert.match(
message,
/GSD_INSTALLER_MIGRATION_RESOLVE/,
'error message suggests the non-interactive resolution env var'
);
// (c) Paths grouped by reason — two paths sharing the same reason
// appear under one summary count, not as two separate path lines.
// The message must include a `2 files` (or similar) grouped summary
// and must NOT list each individual relPath in the top-level message.
assert.match(
message,
/2 (files?|paths?|artifacts?)/,
'error message groups blocked paths into a count summary'
);
// Structured surface: the thrown error must carry a `blockedByReason`
// map so callers can render their own report without re-parsing.
assert.ok(captured.blockedByReason, 'error carries blockedByReason data');
const reasons = Object.keys(captured.blockedByReason);
assert.equal(reasons.length, 1, 'two same-reason paths grouped under one key');
assert.equal(captured.blockedByReason[reasons[0]].length, 2);
});
test('Test C: non-TTY env override resolves otherwise-unclassified prompt-user actions', () => {
const result = {
blocked: [
{
type: 'prompt-user',
relPath: 'skills/gsd-custom/SKILL.toml',
reason: 'custom skill metadata requires user decision',
choices: ['keep', 'remove'],
},
],
plan: {
actions: [],
blocked: [
{
type: 'prompt-user',
relPath: 'skills/gsd-custom/SKILL.toml',
reason: 'custom skill metadata requires user decision',
choices: ['keep', 'remove'],
},
],
},
};
const resolved = resolveInstallerMigrationPromptsForNonTty(result, {
isTty: false,
env: { GSD_INSTALLER_MIGRATION_RESOLVE: 'keep' },
});
assert.equal(resolved.resolutions.length, 1, 'env override resolves prompt-user action');
assert.equal(resolved.resolutions[0].choice, 'keep');
assert.equal(resolved.resolutions[0].source, 'GSD_INSTALLER_MIGRATION_RESOLVE');
assert.equal(resolved.resolutions[0].category, 'operator-override');
assert.equal((resolved.result.blocked || []).length, 0);
assert.equal((resolved.result.plan.blocked || []).length, 0);
assert.equal((resolved.result.plan.actions || []).length, 1);
assert.equal(resolved.result.plan.actions[0].type, 'baseline-preserve-user');
});
});