Files
msd-core/tests/bug-3784-gsd-settings-model-profile-ui-omits-adaptive.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

199 lines
8.4 KiB
JavaScript

'use strict';
// allow-test-rule: source-text-is-the-product
// The deployed settings.md IS the product — testing its text content tests the deployed contract.
/**
* Regression test for bug #3784
*
* /gsd-settings model profile UI omits `adaptive`. The AskUserQuestion block
* for model_profile in settings.md lists only four options (Quality, Balanced,
* Budget, Inherit) but the settings schema registers five valid profiles:
* quality, balanced, budget, adaptive, inherit. The `adaptive` profile is
* reachable by name via `gsd:config --profile adaptive` but cannot be selected
* interactively through `/gsd:settings`.
*
* Root cause: the options array in the model-profile AskUserQuestion block was
* written before the `adaptive` profile was introduced and was never updated.
* Because AskUserQuestion enforces a hard 4-option cap, the fix uses a two-
* question split: Q1 asks "Standard tier or Adaptive?" (2 options); if the
* user picks Standard, Q2 asks which of the three standard profiles to use
* (Quality, Balanced, Budget). This keeps every call within the 4-option cap
* while making all five profiles reachable.
*
* Fixes: #3784
*/
const { describe, test, before } = require('node:test');
const assert = require('node:assert/strict');
const fs = require('fs');
const path = require('path');
const SETTINGS_PATH = path.join(__dirname, '..', 'gsd-core', 'workflows', 'settings.md');
/**
* Extract all AskUserQuestion option labels from a text block.
* Returns them lowercased for case-insensitive comparison.
*/
function extractOptionLabels(block) {
const labelPattern = /label:\s*"([^"]+)"/g;
const labels = [];
let match;
while ((match = labelPattern.exec(block)) !== null) {
labels.push(match[1].toLowerCase());
}
return labels;
}
describe('bug #3784: settings.md model profile UI exposes all 5 profiles', () => {
let content;
let presentBlock;
before(() => {
content = fs.readFileSync(SETTINGS_PATH, 'utf-8');
const presentMatch = content.match(/<step name="present_settings">[\s\S]*?<\/step>/);
assert.ok(presentMatch, 'settings.md must have a present_settings step');
presentBlock = presentMatch[0];
});
// ── Core contract: all five valid profiles reachable via the settings UI ──
test('present_settings step includes Adaptive as a selectable option (#3784)', () => {
// This is the primary assertion for bug #3784 — adaptive was missing.
const labels = extractOptionLabels(presentBlock);
assert.ok(
labels.some(l => l === 'adaptive' || l.startsWith('adaptive')),
[
'Bug #3784: present_settings step must include an "Adaptive" label in',
'its model profile AskUserQuestion options so users can select it',
`interactively. Got labels: [${labels.join(', ')}]`,
].join(' ')
);
});
test('present_settings step includes Quality as a selectable option', () => {
const labels = extractOptionLabels(presentBlock);
assert.ok(
labels.some(l => l === 'quality' || l.startsWith('quality')),
`present_settings step must include a "Quality" option. Got: [${labels.join(', ')}]`
);
});
test('present_settings step includes Balanced as a selectable option', () => {
const labels = extractOptionLabels(presentBlock);
assert.ok(
labels.some(l => l === 'balanced' || l.startsWith('balanced')),
`present_settings step must include a "Balanced" option. Got: [${labels.join(', ')}]`
);
});
test('present_settings step includes Budget as a selectable option', () => {
const labels = extractOptionLabels(presentBlock);
assert.ok(
labels.some(l => l === 'budget' || l.startsWith('budget')),
`present_settings step must include a "Budget" option. Got: [${labels.join(', ')}]`
);
});
test('present_settings step includes Inherit as a selectable option', () => {
const labels = extractOptionLabels(presentBlock);
assert.ok(
labels.some(l => l === 'inherit' || l.startsWith('inherit')),
`present_settings step must include an "Inherit" option. Got: [${labels.join(', ')}]`
);
});
// ── update_config step writes adaptive as a valid value ──
test('update_config step lists adaptive as a valid model_profile value', () => {
const updateMatch = content.match(/<step name="update_config">[\s\S]*?<\/step>/);
assert.ok(updateMatch, 'settings.md must have an update_config step');
const block = updateMatch[0];
assert.ok(
block.includes('adaptive'),
'update_config step must list "adaptive" as a valid model_profile value'
);
});
// ── confirm step displays adaptive as a possible profile value ──
test('confirm step table shows adaptive as a possible model profile value', () => {
const confirmMatch = content.match(/<step name="confirm">[\s\S]*?<\/step>/);
assert.ok(confirmMatch, 'settings.md must have a confirm step');
const block = confirmMatch[0];
assert.ok(
block.includes('adaptive'),
'confirm step must include "adaptive" in the Model Profile row placeholder'
);
});
// ── adaptive described with role-based routing semantics ──
test('settings.md describes adaptive profile with role-based routing semantics', () => {
// Adaptive uses heavy/light role tiers per routingTier.
// The UI description must convey role-based cost optimization and the heavy/light tier
// split — not just mention "Adaptive" somewhere (that word appears 6+ times in the file).
const lower = content.toLowerCase();
assert.ok(
lower.includes('role-based cost optimization') && lower.includes('heavy roles'),
'settings.md must describe the adaptive profile with "role-based cost optimization" and "heavy roles" wording so the description is meaningful across all supported runtimes'
);
});
// ── 4-option cap enforcement ──
test('each question object in present_settings AskUserQuestion blocks has at most 4 options (AskUserQuestion runtime cap)', () => {
// The AskUserQuestion runtime enforces a hard 4-option cap per individual question object
// (each { question:..., options:[...] } entry). This test guards against a naïve revert
// that puts all 5 profiles into a single question object instead of using the Q1/Q2 split.
const ASK_USER_QUESTION_OPTION_CAP = 4; // hard limit enforced by the AskUserQuestion runtime
// Extract each individual options array by finding 'options: [' and walking to the
// matching balanced ']', then count label: entries within that span.
const optionsKeyRe = /\boptions\s*:\s*\[/g;
let match;
let questionIndex = 0;
while ((match = optionsKeyRe.exec(presentBlock)) !== null) {
questionIndex++;
// Walk forward from the opening '[' to find the balanced close ']'.
let depth = 0;
const start = match.index + match[0].length - 1; // points at '['
let end = start;
for (let k = start; k < presentBlock.length; k++) {
if (presentBlock[k] === '[') { depth++; }
else if (presentBlock[k] === ']') {
depth--;
if (depth === 0) { end = k; break; }
}
}
const optionsBody = presentBlock.slice(start, end + 1);
const labelMatches = optionsBody.match(/label:\s*"[^"]+"/g) || [];
const optionCount = labelMatches.length;
assert.ok(
optionCount <= ASK_USER_QUESTION_OPTION_CAP,
`Question object ${questionIndex} in present_settings has ${optionCount} options — exceeds the runtime cap of ${ASK_USER_QUESTION_OPTION_CAP}. Split into multiple questions (as #3784 did for model_profile).`
);
}
// Sanity check: there must be at least one options array found.
assert.ok(questionIndex > 0, 'present_settings must contain at least one AskUserQuestion options array');
});
// ── Brace-balance regression (bd53925f fixed duplicate '{' from 35fc1d21) ──
test('present_settings step has balanced braces — regression: brace-balance after #3784 split', () => {
// commit bd53925f fixed a duplicate '{' introduced by 35fc1d21 when the model-profile
// AskUserQuestion was split into Q1+Q2. This test guards against a recurrence.
let depth = 0;
const maxDepth = 0;
for (const ch of presentBlock) {
if (ch === '{') { depth++; }
if (ch === '}') { depth--; }
}
assert.strictEqual(
depth,
0,
`present_settings step has unbalanced braces: net depth after full scan is ${depth} (positive = extra '{', negative = extra '}'). Regression guard for bd53925f / #3784.`
);
});
});