* test(#2974): migrate 8 test files to typed-IR assertions Replaces raw stdout/stderr substring matching with structured-field assertions per CONTRIBUTING.md "Prohibited: Raw Text Matching on Test Outputs". Adds shared infrastructure for typed error emission so this pattern is the easy path going forward. Shared infrastructure: - core.cjs: ERROR_REASON frozen enum + setJsonErrorMode/getJsonErrorMode - gsd-tools.cjs: --json-errors CLI flag, parsed before subcommand dispatch - config.cjs: typed reasons at all 7 error sites - graphify.cjs: GRAPHIFY_REASON enum + reason/timeout_ms in execGraphify result - bin/install.js: pure buildSdkFailFastReport() IR builder + renderer - hooks/gsd-session-state.sh, gsd-phase-boundary.sh: emit Claude Code hookSpecificOutput JSON envelope with typed state_present/config_mode/ planning_modified/file_path fields (no-op when hooks.community is off) Test migrations (all pass, 171 tests across the 8 files): - bug-2649-sdk-fail-fast: assert on ir.reason / ir.context / ir.fix_command - bug-2687-config-read-warning-parity: assert.equal stderr === '' - bug-2796-arg-parsing-regression: assert on result.json.updated/.phase - bug-2838-summary-rescue: parse rescue footer, assert mtime invariant - bug-2943-config-get-context-window: parse JSON, assert ERROR_REASON.CONFIG_KEY_NOT_FOUND - graphify: assert reason === GRAPHIFY_REASON.ENOENT/TIMEOUT - hooks-opt-in: parse hookSpecificOutput, assert typed fields - security-scan: reclassified as source-text-is-the-product (scan label output and CI workflow YAML ARE the deployed contract) Verification: lint-no-source-grep clean (0 violations), full suite 6741/6741 pass. Closes #2974 * test(#2974): address CR feedback — typed code field, robust idempotency Two CodeRabbit findings on #3016 addressed: 1. tests/hooks-opt-in.test.cjs:355 (Minor, inline) — parsed.reason.includes('Conventional Commits') was still substring matching after the typed-IR migration. Fixed at the source: the gsd-validate-commit hook now emits a typed `code` field ('CONVENTIONAL_COMMITS_VIOLATION', 'COMMIT_SUBJECT_TOO_LONG') alongside the human-readable `reason`. Test asserts strictEqual on the code; the prose copy is no longer part of the test contract. 2. tests/bug-2838-summary-rescue-gitignored-planning.test.cjs:224-250 (Outside-diff) — mtimeMs alone can stay unchanged on coarse-grained filesystems (HFS+, FAT) when two rewrites land within the same timestamp tick, falsely passing the idempotency assertion. Replaced with a full snapshot (mtimeMs, ctimeMs, size, ino, sha256 of contents) compared via assert.deepStrictEqual — the hash catches any rewrite the timestamp would miss. Verification: 30/30 pass on the two affected files; lint-no-source-grep clean (0 violations across 368 test files).
143 lines
5.5 KiB
JavaScript
143 lines
5.5 KiB
JavaScript
/**
|
|
* Regression test for bug #2943
|
|
*
|
|
* `gsd-tools.cjs config-get context_window` (and the SDK equivalent) threw
|
|
* "Key not found: context_window" when the key was absent from config.json,
|
|
* even though context_window has a documented schema default of 200000.
|
|
*
|
|
* Fix: `cmdConfigGet` in bin/lib/config.cjs now consults a SCHEMA_DEFAULTS map
|
|
* before emitting "Key not found", so schema-defaulted keys always return the
|
|
* default value (exit 0) when not explicitly set in the project config.
|
|
*/
|
|
|
|
'use strict';
|
|
|
|
// Migrated to typed-IR (#2974): the previous shape grepped stderr/stdout for
|
|
// "Key not found"; now the test passes `--json-errors` to gsd-tools and
|
|
// asserts on the structured `reason` code (a frozen-enum value from
|
|
// `core.cjs::ERROR_REASON`). Exit code is also a typed signal — together
|
|
// they fully discriminate the failure class.
|
|
|
|
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 os = require('node:os');
|
|
const { execFileSync } = require('node:child_process');
|
|
|
|
const GSD_TOOLS = path.join(__dirname, '..', 'get-shit-done', 'bin', 'gsd-tools.cjs');
|
|
const { ERROR_REASON } = require(path.join(__dirname, '..', 'get-shit-done', 'bin', 'lib', 'core.cjs'));
|
|
|
|
describe('bug-2943: config-get returns schema default for context_window', () => {
|
|
let tmpDir;
|
|
let planningDir;
|
|
|
|
beforeEach(() => {
|
|
tmpDir = fs.mkdtempSync(path.join(os.tmpdir(), 'gsd-test-2943-'));
|
|
planningDir = path.join(tmpDir, '.planning');
|
|
fs.mkdirSync(planningDir, { recursive: true });
|
|
});
|
|
|
|
afterEach(() => {
|
|
fs.rmSync(tmpDir, { recursive: true, force: true });
|
|
});
|
|
|
|
/**
|
|
* Run config-get with optional extra args. Returns { exitCode, stdout, stderr }.
|
|
* Uses --raw so we get the plain scalar value, not JSON-wrapped.
|
|
*/
|
|
function runConfigGet(keyPath, extraArgs = []) {
|
|
const args = [GSD_TOOLS, 'config-get', keyPath, '--raw', '--cwd', tmpDir, ...extraArgs];
|
|
let stdout = '';
|
|
let stderr = '';
|
|
let exitCode = 0;
|
|
try {
|
|
stdout = execFileSync(process.execPath, args, {
|
|
encoding: 'utf-8',
|
|
stdio: ['pipe', 'pipe', 'pipe'],
|
|
timeout: 5000,
|
|
});
|
|
} catch (err) {
|
|
exitCode = err.status ?? 1;
|
|
stdout = err.stdout?.toString() ?? '';
|
|
stderr = err.stderr?.toString() ?? '';
|
|
}
|
|
return { exitCode, stdout: stdout.trim(), stderr: stderr.trim() };
|
|
}
|
|
|
|
test('returns "200000" (exit 0) when context_window absent from config.json', () => {
|
|
// Fixture A: config with unrelated keys, no context_window
|
|
fs.writeFileSync(
|
|
path.join(planningDir, 'config.json'),
|
|
JSON.stringify({ workflow: { auto_advance: false } })
|
|
);
|
|
|
|
const result = runConfigGet('context_window');
|
|
|
|
assert.strictEqual(result.exitCode, 0, 'should exit 0 (schema default applied)');
|
|
assert.strictEqual(result.stdout, '200000', 'should return schema default of 200000');
|
|
});
|
|
|
|
test('returns configured value when context_window is explicitly set', () => {
|
|
// Fixture B: config has context_window: 1000000
|
|
fs.writeFileSync(
|
|
path.join(planningDir, 'config.json'),
|
|
JSON.stringify({ context_window: 1000000 })
|
|
);
|
|
|
|
const result = runConfigGet('context_window');
|
|
|
|
assert.strictEqual(result.exitCode, 0, 'should exit 0 for found key');
|
|
assert.strictEqual(result.stdout, '1000000', 'should return configured value not schema default');
|
|
});
|
|
|
|
test('--default flag overrides schema default', () => {
|
|
// config has context_window but we pass --default with a different value —
|
|
// when key IS present, real value wins over any default
|
|
fs.writeFileSync(
|
|
path.join(planningDir, 'config.json'),
|
|
JSON.stringify({ workflow: { auto_advance: false } })
|
|
);
|
|
|
|
const result = runConfigGet('context_window', ['--default', '123456']);
|
|
|
|
assert.strictEqual(result.exitCode, 0, 'should exit 0 when --default provided');
|
|
assert.strictEqual(result.stdout, '123456', 'should return the --default value, not schema default');
|
|
});
|
|
|
|
test('errors with reason=CONFIG_KEY_NOT_FOUND (exit 1) for an unknown absent key — no regression', () => {
|
|
// An unrecognised key with no schema default still errors as before.
|
|
// Migrated #2974: assert on the structured reason code from --json-errors,
|
|
// not on substring presence in stderr/stdout text.
|
|
fs.writeFileSync(
|
|
path.join(planningDir, 'config.json'),
|
|
JSON.stringify({ workflow: { auto_advance: false } })
|
|
);
|
|
|
|
const result = runConfigGet('totally_unknown_key_xyz', ['--json-errors']);
|
|
|
|
assert.strictEqual(result.exitCode, 1, 'should exit 1 for unknown absent key');
|
|
let parsed;
|
|
try {
|
|
parsed = JSON.parse(result.stderr);
|
|
} catch (err) {
|
|
assert.fail(`expected JSON-shaped stderr from --json-errors; got: ${JSON.stringify(result.stderr)}`);
|
|
}
|
|
assert.strictEqual(parsed.ok, false);
|
|
assert.strictEqual(parsed.reason, ERROR_REASON.CONFIG_KEY_NOT_FOUND,
|
|
`expected reason=${ERROR_REASON.CONFIG_KEY_NOT_FOUND}, got=${parsed.reason}`);
|
|
});
|
|
|
|
test('--default flag still works for arbitrary absent keys', () => {
|
|
fs.writeFileSync(
|
|
path.join(planningDir, 'config.json'),
|
|
JSON.stringify({})
|
|
);
|
|
|
|
const result = runConfigGet('some.missing.key', ['--default', '200000']);
|
|
|
|
assert.strictEqual(result.exitCode, 0, 'should exit 0 when --default supplied');
|
|
assert.strictEqual(result.stdout, '200000', 'should return the explicit --default value');
|
|
});
|
|
});
|