* feat(#2982): extend no-source-grep lint to catch var-binding readFileSync.includes() The base lint (scripts/lint-no-source-grep.cjs) only catches readFileSync(...).<text-method>() chained directly. The much more common var-binding form escapes it: const src = fs.readFileSync(p, 'utf8'); // 50 lines later if (src.includes('foo')) {} // ← still grep, lint missed it Scan of the test suite found ~141 files using this pattern. Implementation built TDD per #2982 with structured-IR assertions: scripts/lint-no-source-grep-extras.cjs - detectVarBindingViolations(src) — pure detector, two passes: pass 1 collects vars bound from readFileSync, pass 2 finds any <var>.<includes|startsWith|endsWith|match|search>( on those vars. - detectWrappedAssertOkMatch(src) — flags assert.ok(<expr>.match(...)) which escapes the assert.match rule. - VIOLATION enum exposes stable codes for tests to assert on. scripts/lint-no-source-grep.cjs - Wires the new detectors into the existing per-file check; one additional violation row per file with the first 3 sample tokens. tests/bug-2982-lint-var-binding.test.cjs - 13 tests, all assertions on typed VIOLATION enum / structured records. Covers all 5 text-match methods, multi-var, no-bind, string literal (must NOT trigger), wrapped assert.ok(.match), and assert.match (must NOT double-flag). Migration backlog (#2974 expanded scope): - 42 files annotated `// allow-test-rule: source-text-is-the-product` (legitimate — they read .md/.json/.yml files whose deployed text IS the product) - 3 files annotated `// allow-test-rule: pending-migration-to-typed-ir [#2974]` (read .cjs/.js source — clear migration debt) - 95 files annotated `pending-migration-to-typed-ir [#2974]` with `Per-file review may reclassify as source-text-is-the-product during migration` (mixed — manual review under #2974) After this lands the lint reports 0 violations on main; new violations in PRs surface immediately. Closes #2982 Refs #2974 * test(#2982): fix truncated test name per CR The label ended with a bare '(' from a copy-paste mishap. Now reads 'does NOT flag .matchAll(...) — matchAll is not match, so assert.ok(.matchAll(...)) is not flagged'. * chore(#2982): add changeset fragment for PR #2985 * chore(#2982): add changeset fragment for PR #2985
819 lines
34 KiB
JavaScript
819 lines
34 KiB
JavaScript
// allow-test-rule: pending-migration-to-typed-ir [#2974]
|
|
// Tracked in #2974 for migration to typed-IR assertions per CONTRIBUTING.md
|
|
// "Prohibited: Raw Text Matching on Test Outputs". Per-file review may
|
|
// reclassify some entries as source-text-is-the-product during migration.
|
|
|
|
/**
|
|
* GSD Tools Tests - Validate Health Command
|
|
*
|
|
* Comprehensive tests for validate-health covering all 8 health checks
|
|
* and the repair path.
|
|
*/
|
|
|
|
const { test, describe, beforeEach, afterEach } = require('node:test');
|
|
const assert = require('node:assert/strict');
|
|
const fs = require('fs');
|
|
const path = require('path');
|
|
const { runGsdTools, createTempProject, cleanup } = require('./helpers.cjs');
|
|
|
|
// ─── Helpers for setting up minimal valid projects ────────────────────────────
|
|
|
|
function writeMinimalRoadmap(tmpDir, phases = ['1']) {
|
|
const lines = phases.map(n => `### Phase ${n}: Phase ${n} Description`).join('\n');
|
|
fs.writeFileSync(
|
|
path.join(tmpDir, '.planning', 'ROADMAP.md'),
|
|
`# Roadmap\n\n${lines}\n`
|
|
);
|
|
}
|
|
|
|
function writeMinimalProjectMd(tmpDir, sections = ['## What This Is', '## Core Value', '## Requirements']) {
|
|
const content = sections.map(s => `${s}\n\nContent here.\n`).join('\n');
|
|
fs.writeFileSync(
|
|
path.join(tmpDir, '.planning', 'PROJECT.md'),
|
|
`# Project\n\n${content}`
|
|
);
|
|
}
|
|
|
|
function writeMinimalStateMd(tmpDir, content) {
|
|
const defaultContent = content || `# Session State\n\n## Current Position\n\nPhase: 1\n`;
|
|
fs.writeFileSync(
|
|
path.join(tmpDir, '.planning', 'STATE.md'),
|
|
defaultContent
|
|
);
|
|
}
|
|
|
|
function writeValidConfigJson(tmpDir) {
|
|
fs.writeFileSync(
|
|
path.join(tmpDir, '.planning', 'config.json'),
|
|
JSON.stringify({ model_profile: 'balanced', commit_docs: true }, null, 2)
|
|
);
|
|
}
|
|
|
|
// ─────────────────────────────────────────────────────────────────────────────
|
|
// validate health command — all 8 checks
|
|
// ─────────────────────────────────────────────────────────────────────────────
|
|
|
|
describe('validate health command', () => {
|
|
let tmpDir;
|
|
|
|
beforeEach(() => {
|
|
tmpDir = createTempProject();
|
|
});
|
|
|
|
afterEach(() => {
|
|
cleanup(tmpDir);
|
|
});
|
|
|
|
// ─── Check 1: .planning/ exists ───────────────────────────────────────────
|
|
|
|
test("returns 'broken' when .planning directory is missing", () => {
|
|
// createTempProject creates .planning/phases — remove it entirely
|
|
fs.rmSync(path.join(tmpDir, '.planning'), { recursive: true, force: true });
|
|
|
|
const result = runGsdTools('validate health', tmpDir);
|
|
assert.ok(result.success, `Command failed: ${result.error}`);
|
|
|
|
const output = JSON.parse(result.output);
|
|
assert.strictEqual(output.status, 'broken', 'should be broken');
|
|
assert.ok(
|
|
output.errors.some(e => e.code === 'E001'),
|
|
`Expected E001 in errors: ${JSON.stringify(output.errors)}`
|
|
);
|
|
});
|
|
|
|
// ─── Check 2: PROJECT.md exists and has required sections ─────────────────
|
|
|
|
test('warns when PROJECT.md is missing', () => {
|
|
// No PROJECT.md in .planning
|
|
writeMinimalRoadmap(tmpDir, ['1']);
|
|
writeMinimalStateMd(tmpDir);
|
|
writeValidConfigJson(tmpDir);
|
|
// Create valid phase dir so no W007
|
|
fs.mkdirSync(path.join(tmpDir, '.planning', 'phases', '01-a'), { recursive: true });
|
|
|
|
const result = runGsdTools('validate health', tmpDir);
|
|
assert.ok(result.success, `Command failed: ${result.error}`);
|
|
|
|
const output = JSON.parse(result.output);
|
|
assert.ok(
|
|
output.errors.some(e => e.code === 'E002'),
|
|
`Expected E002 in errors: ${JSON.stringify(output.errors)}`
|
|
);
|
|
});
|
|
|
|
test('warns when PROJECT.md missing required sections', () => {
|
|
// PROJECT.md missing "## Core Value" section
|
|
fs.writeFileSync(
|
|
path.join(tmpDir, '.planning', 'PROJECT.md'),
|
|
'# Project\n\n## What This Is\n\nFoo\n\n## Requirements\n\nBar\n'
|
|
);
|
|
writeMinimalRoadmap(tmpDir, ['1']);
|
|
writeMinimalStateMd(tmpDir);
|
|
writeValidConfigJson(tmpDir);
|
|
fs.mkdirSync(path.join(tmpDir, '.planning', 'phases', '01-a'), { recursive: true });
|
|
|
|
const result = runGsdTools('validate health', tmpDir);
|
|
assert.ok(result.success, `Command failed: ${result.error}`);
|
|
|
|
const output = JSON.parse(result.output);
|
|
const w001s = output.warnings.filter(w => w.code === 'W001');
|
|
assert.ok(w001s.length > 0, `Expected W001 warnings: ${JSON.stringify(output.warnings)}`);
|
|
assert.ok(
|
|
w001s.some(w => w.message.includes('## Core Value')),
|
|
`Expected W001 mentioning "## Core Value": ${JSON.stringify(w001s)}`
|
|
);
|
|
});
|
|
|
|
test('passes when PROJECT.md has all required sections', () => {
|
|
writeMinimalProjectMd(tmpDir);
|
|
writeMinimalRoadmap(tmpDir, ['1']);
|
|
writeMinimalStateMd(tmpDir);
|
|
writeValidConfigJson(tmpDir);
|
|
fs.mkdirSync(path.join(tmpDir, '.planning', 'phases', '01-a'), { recursive: true });
|
|
|
|
const result = runGsdTools('validate health', tmpDir);
|
|
assert.ok(result.success, `Command failed: ${result.error}`);
|
|
|
|
const output = JSON.parse(result.output);
|
|
assert.ok(
|
|
!output.errors.some(e => e.code === 'E002'),
|
|
`Should not have E002: ${JSON.stringify(output.errors)}`
|
|
);
|
|
assert.ok(
|
|
!output.warnings.some(w => w.code === 'W001'),
|
|
`Should not have W001: ${JSON.stringify(output.warnings)}`
|
|
);
|
|
});
|
|
|
|
// ─── Check 3: ROADMAP.md exists ───────────────────────────────────────────
|
|
|
|
test('errors when ROADMAP.md is missing', () => {
|
|
writeMinimalProjectMd(tmpDir);
|
|
writeMinimalStateMd(tmpDir);
|
|
writeValidConfigJson(tmpDir);
|
|
// No ROADMAP.md
|
|
|
|
const result = runGsdTools('validate health', tmpDir);
|
|
assert.ok(result.success, `Command failed: ${result.error}`);
|
|
|
|
const output = JSON.parse(result.output);
|
|
assert.ok(
|
|
output.errors.some(e => e.code === 'E003'),
|
|
`Expected E003 in errors: ${JSON.stringify(output.errors)}`
|
|
);
|
|
});
|
|
|
|
// ─── Check 4: STATE.md exists and references valid phases ─────────────────
|
|
|
|
test('errors when STATE.md is missing with repairable true', () => {
|
|
writeMinimalProjectMd(tmpDir);
|
|
writeMinimalRoadmap(tmpDir, ['1']);
|
|
writeValidConfigJson(tmpDir);
|
|
fs.mkdirSync(path.join(tmpDir, '.planning', 'phases', '01-a'), { recursive: true });
|
|
// No STATE.md
|
|
|
|
const result = runGsdTools('validate health', tmpDir);
|
|
assert.ok(result.success, `Command failed: ${result.error}`);
|
|
|
|
const output = JSON.parse(result.output);
|
|
const e004 = output.errors.find(e => e.code === 'E004');
|
|
assert.ok(e004, `Expected E004 in errors: ${JSON.stringify(output.errors)}`);
|
|
assert.strictEqual(e004.repairable, true, 'E004 should be repairable');
|
|
});
|
|
|
|
test('warns when STATE.md references nonexistent phase', () => {
|
|
writeMinimalProjectMd(tmpDir);
|
|
writeMinimalRoadmap(tmpDir, ['1']);
|
|
writeValidConfigJson(tmpDir);
|
|
// STATE.md mentions Phase 99 but only 01-a dir exists
|
|
fs.writeFileSync(
|
|
path.join(tmpDir, '.planning', 'STATE.md'),
|
|
'# Session State\n\nPhase 99 is the current phase.\n'
|
|
);
|
|
fs.mkdirSync(path.join(tmpDir, '.planning', 'phases', '01-a'), { recursive: true });
|
|
|
|
const result = runGsdTools('validate health', tmpDir);
|
|
assert.ok(result.success, `Command failed: ${result.error}`);
|
|
|
|
const output = JSON.parse(result.output);
|
|
const w002 = output.warnings.find(w => w.code === 'W002');
|
|
assert.ok(w002, `Expected W002 in warnings: ${JSON.stringify(output.warnings)}`);
|
|
assert.strictEqual(w002.repairable, false, 'W002 should not be auto-repairable');
|
|
});
|
|
|
|
// ─── Check 5: config.json valid JSON + valid schema ───────────────────────
|
|
|
|
test('warns when config.json is missing with repairable true', () => {
|
|
writeMinimalProjectMd(tmpDir);
|
|
writeMinimalRoadmap(tmpDir, ['1']);
|
|
writeMinimalStateMd(tmpDir);
|
|
fs.mkdirSync(path.join(tmpDir, '.planning', 'phases', '01-a'), { recursive: true });
|
|
// No config.json
|
|
|
|
const result = runGsdTools('validate health', tmpDir);
|
|
assert.ok(result.success, `Command failed: ${result.error}`);
|
|
|
|
const output = JSON.parse(result.output);
|
|
const w003 = output.warnings.find(w => w.code === 'W003');
|
|
assert.ok(w003, `Expected W003 in warnings: ${JSON.stringify(output.warnings)}`);
|
|
assert.strictEqual(w003.repairable, true, 'W003 should be repairable');
|
|
});
|
|
|
|
test('errors when config.json has invalid JSON', () => {
|
|
writeMinimalProjectMd(tmpDir);
|
|
writeMinimalRoadmap(tmpDir, ['1']);
|
|
writeMinimalStateMd(tmpDir);
|
|
fs.writeFileSync(
|
|
path.join(tmpDir, '.planning', 'config.json'),
|
|
'{broken json'
|
|
);
|
|
fs.mkdirSync(path.join(tmpDir, '.planning', 'phases', '01-a'), { recursive: true });
|
|
|
|
const result = runGsdTools('validate health', tmpDir);
|
|
assert.ok(result.success, `Command failed: ${result.error}`);
|
|
|
|
const output = JSON.parse(result.output);
|
|
assert.ok(
|
|
output.errors.some(e => e.code === 'E005'),
|
|
`Expected E005 in errors: ${JSON.stringify(output.errors)}`
|
|
);
|
|
});
|
|
|
|
test('warns when config.json has invalid model_profile', () => {
|
|
writeMinimalProjectMd(tmpDir);
|
|
writeMinimalRoadmap(tmpDir, ['1']);
|
|
writeMinimalStateMd(tmpDir);
|
|
fs.writeFileSync(
|
|
path.join(tmpDir, '.planning', 'config.json'),
|
|
JSON.stringify({ model_profile: 'invalid' })
|
|
);
|
|
fs.mkdirSync(path.join(tmpDir, '.planning', 'phases', '01-a'), { recursive: true });
|
|
|
|
const result = runGsdTools('validate health', tmpDir);
|
|
assert.ok(result.success, `Command failed: ${result.error}`);
|
|
|
|
const output = JSON.parse(result.output);
|
|
assert.ok(
|
|
output.warnings.some(w => w.code === 'W004'),
|
|
`Expected W004 in warnings: ${JSON.stringify(output.warnings)}`
|
|
);
|
|
});
|
|
|
|
test('accepts inherit model_profile as valid', () => {
|
|
writeMinimalProjectMd(tmpDir);
|
|
writeMinimalRoadmap(tmpDir, ['1']);
|
|
writeMinimalStateMd(tmpDir);
|
|
fs.writeFileSync(
|
|
path.join(tmpDir, '.planning', 'config.json'),
|
|
JSON.stringify({
|
|
model_profile: 'inherit',
|
|
workflow: {
|
|
research: true,
|
|
plan_check: true,
|
|
verifier: true,
|
|
nyquist_validation: true,
|
|
},
|
|
})
|
|
);
|
|
fs.mkdirSync(path.join(tmpDir, '.planning', 'phases', '01-a'), { recursive: true });
|
|
|
|
const result = runGsdTools('validate health', tmpDir);
|
|
assert.ok(result.success, `Command failed: ${result.error}`);
|
|
|
|
const output = JSON.parse(result.output);
|
|
assert.ok(
|
|
!output.warnings.some(w => w.code === 'W004'),
|
|
`Should not warn for inherit model_profile: ${JSON.stringify(output.warnings)}`
|
|
);
|
|
});
|
|
|
|
// ─── Check 6: Phase directory naming (NN-name format) ─────────────────────
|
|
|
|
test('warns about incorrectly named phase directories', () => {
|
|
writeMinimalProjectMd(tmpDir);
|
|
// Roadmap with no phases to avoid W006
|
|
fs.writeFileSync(
|
|
path.join(tmpDir, '.planning', 'ROADMAP.md'),
|
|
'# Roadmap\n\nNo phases yet.\n'
|
|
);
|
|
writeMinimalStateMd(tmpDir, '# Session State\n\nNo phase references.\n');
|
|
writeValidConfigJson(tmpDir);
|
|
// Create a badly named dir
|
|
fs.mkdirSync(path.join(tmpDir, '.planning', 'phases', 'bad_name'), { recursive: true });
|
|
|
|
const result = runGsdTools('validate health', tmpDir);
|
|
assert.ok(result.success, `Command failed: ${result.error}`);
|
|
|
|
const output = JSON.parse(result.output);
|
|
assert.ok(
|
|
output.warnings.some(w => w.code === 'W005'),
|
|
`Expected W005 in warnings: ${JSON.stringify(output.warnings)}`
|
|
);
|
|
});
|
|
|
|
// ─── Check 7: Orphaned plans (PLAN without SUMMARY) ───────────────────────
|
|
|
|
test('reports orphaned plans (PLAN without SUMMARY) as info', () => {
|
|
writeMinimalProjectMd(tmpDir);
|
|
writeMinimalRoadmap(tmpDir, ['1']);
|
|
writeMinimalStateMd(tmpDir);
|
|
writeValidConfigJson(tmpDir);
|
|
// Create 01-test phase dir with a PLAN but no matching SUMMARY
|
|
const phaseDir = path.join(tmpDir, '.planning', 'phases', '01-test');
|
|
fs.mkdirSync(phaseDir, { recursive: true });
|
|
fs.writeFileSync(path.join(phaseDir, '01-01-PLAN.md'), '# Plan\n');
|
|
// No 01-01-SUMMARY.md
|
|
|
|
const result = runGsdTools('validate health', tmpDir);
|
|
assert.ok(result.success, `Command failed: ${result.error}`);
|
|
|
|
const output = JSON.parse(result.output);
|
|
assert.ok(
|
|
output.info.some(i => i.code === 'I001'),
|
|
`Expected I001 in info: ${JSON.stringify(output.info)}`
|
|
);
|
|
});
|
|
|
|
// ─── Check 8: Consistency (roadmap/disk sync) ─────────────────────────────
|
|
|
|
test('warns about phase in ROADMAP but not on disk', () => {
|
|
writeMinimalProjectMd(tmpDir);
|
|
// ROADMAP mentions Phase 5 but no 05-xxx dir
|
|
fs.writeFileSync(
|
|
path.join(tmpDir, '.planning', 'ROADMAP.md'),
|
|
'# Roadmap\n\n### Phase 5: Future Phase\n'
|
|
);
|
|
writeMinimalStateMd(tmpDir, '# Session State\n\nNo phase refs.\n');
|
|
writeValidConfigJson(tmpDir);
|
|
// No phase dirs
|
|
|
|
const result = runGsdTools('validate health', tmpDir);
|
|
assert.ok(result.success, `Command failed: ${result.error}`);
|
|
|
|
const output = JSON.parse(result.output);
|
|
assert.ok(
|
|
output.warnings.some(w => w.code === 'W006'),
|
|
`Expected W006 in warnings: ${JSON.stringify(output.warnings)}`
|
|
);
|
|
});
|
|
|
|
test('warns about phase on disk but not in ROADMAP', () => {
|
|
writeMinimalProjectMd(tmpDir);
|
|
// ROADMAP has no phases
|
|
fs.writeFileSync(
|
|
path.join(tmpDir, '.planning', 'ROADMAP.md'),
|
|
'# Roadmap\n\nNo phases listed.\n'
|
|
);
|
|
writeMinimalStateMd(tmpDir, '# Session State\n\nNo phase refs.\n');
|
|
writeValidConfigJson(tmpDir);
|
|
// Orphan phase dir not in ROADMAP
|
|
fs.mkdirSync(path.join(tmpDir, '.planning', 'phases', '99-orphan'), { recursive: true });
|
|
|
|
const result = runGsdTools('validate health', tmpDir);
|
|
assert.ok(result.success, `Command failed: ${result.error}`);
|
|
|
|
const output = JSON.parse(result.output);
|
|
assert.ok(
|
|
output.warnings.some(w => w.code === 'W007'),
|
|
`Expected W007 in warnings: ${JSON.stringify(output.warnings)}`
|
|
);
|
|
});
|
|
|
|
// ─── Check 5b: Nyquist validation key presence (W008) ─────────────────────
|
|
|
|
test('detects W008 when workflow.nyquist_validation absent from config', () => {
|
|
writeMinimalProjectMd(tmpDir);
|
|
writeMinimalRoadmap(tmpDir, ['1']);
|
|
writeMinimalStateMd(tmpDir, '# Session State\n\nPhase 1 in progress.\n');
|
|
// Config with workflow section but WITHOUT nyquist_validation key
|
|
fs.writeFileSync(
|
|
path.join(tmpDir, '.planning', 'config.json'),
|
|
JSON.stringify({ model_profile: 'balanced', workflow: { research: true } }, null, 2)
|
|
);
|
|
fs.mkdirSync(path.join(tmpDir, '.planning', 'phases', '01-a'), { recursive: true });
|
|
|
|
const result = runGsdTools('validate health', tmpDir);
|
|
assert.ok(result.success, `Command failed: ${result.error}`);
|
|
|
|
const output = JSON.parse(result.output);
|
|
assert.ok(
|
|
output.warnings.some(w => w.code === 'W008'),
|
|
`Expected W008 in warnings: ${JSON.stringify(output.warnings)}`
|
|
);
|
|
});
|
|
|
|
test('does not emit W008 when nyquist_validation is explicitly set', () => {
|
|
writeMinimalProjectMd(tmpDir);
|
|
writeMinimalRoadmap(tmpDir, ['1']);
|
|
writeMinimalStateMd(tmpDir, '# Session State\n\nPhase 1 in progress.\n');
|
|
// Config with workflow.nyquist_validation explicitly set
|
|
fs.writeFileSync(
|
|
path.join(tmpDir, '.planning', 'config.json'),
|
|
JSON.stringify({ model_profile: 'balanced', workflow: { research: true, nyquist_validation: true } }, null, 2)
|
|
);
|
|
fs.mkdirSync(path.join(tmpDir, '.planning', 'phases', '01-a'), { recursive: true });
|
|
|
|
const result = runGsdTools('validate health', tmpDir);
|
|
assert.ok(result.success, `Command failed: ${result.error}`);
|
|
|
|
const output = JSON.parse(result.output);
|
|
assert.ok(
|
|
!output.warnings.some(w => w.code === 'W008'),
|
|
`Should not have W008: ${JSON.stringify(output.warnings)}`
|
|
);
|
|
});
|
|
|
|
// ─── Check 8b: W006 false-positives for not-yet-started phases (#2009) ──────
|
|
|
|
test('does not emit W006 for phases listed in ROADMAP summary as unchecked (not started)', () => {
|
|
// A ROADMAP with Phase 1 started (has disk dir) and Phase 2 listed but
|
|
// unchecked (- [ ]) — phase 2 has no directory because it hasn't started.
|
|
// W006 must NOT fire for phase 2.
|
|
writeMinimalProjectMd(tmpDir);
|
|
fs.writeFileSync(
|
|
path.join(tmpDir, '.planning', 'ROADMAP.md'),
|
|
[
|
|
'# Roadmap',
|
|
'',
|
|
'## v1.0.0',
|
|
'',
|
|
'- [x] **Phase 1: Setup** - First phase',
|
|
'- [ ] **Phase 2: Build** - Not yet started',
|
|
'',
|
|
'### Phase 1: Setup',
|
|
'',
|
|
'### Phase 2: Build',
|
|
'',
|
|
].join('\n')
|
|
);
|
|
writeMinimalStateMd(tmpDir, '# Session State\n\nPhase 1 in progress.\n');
|
|
writeValidConfigJson(tmpDir);
|
|
// Only phase 1 dir exists; phase 2 dir does not (not started yet)
|
|
fs.mkdirSync(path.join(tmpDir, '.planning', 'phases', '01-setup'), { recursive: true });
|
|
|
|
const result = runGsdTools('validate health', tmpDir);
|
|
assert.ok(result.success, `Command failed: ${result.error}`);
|
|
|
|
const output = JSON.parse(result.output);
|
|
const w006s = output.warnings.filter(w => w.code === 'W006');
|
|
assert.ok(
|
|
w006s.length === 0,
|
|
'W006 must not fire for phases with an unchecked summary checkbox (not yet started), got: ' +
|
|
JSON.stringify(w006s)
|
|
);
|
|
});
|
|
|
|
test('still emits W006 for a phase that was started (checked) but has no directory', () => {
|
|
// Phase 1 is marked complete ([x]) in ROADMAP summary but has no directory
|
|
// on disk — that IS a genuine inconsistency and should still trigger W006.
|
|
writeMinimalProjectMd(tmpDir);
|
|
fs.writeFileSync(
|
|
path.join(tmpDir, '.planning', 'ROADMAP.md'),
|
|
[
|
|
'# Roadmap',
|
|
'',
|
|
'- [x] **Phase 1: Setup** - Completed',
|
|
'',
|
|
'### Phase 1: Setup',
|
|
'',
|
|
].join('\n')
|
|
);
|
|
writeMinimalStateMd(tmpDir, '# Session State\n\nPhase 1 done.\n');
|
|
writeValidConfigJson(tmpDir);
|
|
// No phase 1 directory — even though roadmap says it's complete
|
|
|
|
const result = runGsdTools('validate health', tmpDir);
|
|
assert.ok(result.success, `Command failed: ${result.error}`);
|
|
|
|
const output = JSON.parse(result.output);
|
|
assert.ok(
|
|
output.warnings.some(w => w.code === 'W006'),
|
|
'W006 must still fire when a completed phase has no directory, warnings: ' +
|
|
JSON.stringify(output.warnings)
|
|
);
|
|
});
|
|
|
|
// ─── Check 7b: Nyquist VALIDATION.md consistency (W009) ──────────────────
|
|
|
|
test('detects W009 when RESEARCH.md has Validation Architecture but no VALIDATION.md', () => {
|
|
writeMinimalProjectMd(tmpDir);
|
|
writeMinimalRoadmap(tmpDir, ['1']);
|
|
writeMinimalStateMd(tmpDir, '# Session State\n\nPhase 1 in progress.\n');
|
|
writeValidConfigJson(tmpDir);
|
|
// Create phase dir with RESEARCH.md containing Validation Architecture
|
|
const phaseDir = path.join(tmpDir, '.planning', 'phases', '01-setup');
|
|
fs.mkdirSync(phaseDir, { recursive: true });
|
|
fs.writeFileSync(
|
|
path.join(phaseDir, '01-RESEARCH.md'),
|
|
'# Research\n\n## Validation Architecture\n\nSome validation content.\n'
|
|
);
|
|
// No VALIDATION.md
|
|
|
|
const result = runGsdTools('validate health', tmpDir);
|
|
assert.ok(result.success, `Command failed: ${result.error}`);
|
|
|
|
const output = JSON.parse(result.output);
|
|
assert.ok(
|
|
output.warnings.some(w => w.code === 'W009'),
|
|
`Expected W009 in warnings: ${JSON.stringify(output.warnings)}`
|
|
);
|
|
});
|
|
|
|
test('does not emit W009 when VALIDATION.md exists alongside RESEARCH.md', () => {
|
|
writeMinimalProjectMd(tmpDir);
|
|
writeMinimalRoadmap(tmpDir, ['1']);
|
|
writeMinimalStateMd(tmpDir, '# Session State\n\nPhase 1 in progress.\n');
|
|
writeValidConfigJson(tmpDir);
|
|
// Create phase dir with both RESEARCH.md and VALIDATION.md
|
|
const phaseDir = path.join(tmpDir, '.planning', 'phases', '01-setup');
|
|
fs.mkdirSync(phaseDir, { recursive: true });
|
|
fs.writeFileSync(
|
|
path.join(phaseDir, '01-RESEARCH.md'),
|
|
'# Research\n\n## Validation Architecture\n\nSome validation content.\n'
|
|
);
|
|
fs.writeFileSync(
|
|
path.join(phaseDir, '01-VALIDATION.md'),
|
|
'# Validation\n\nValidation content.\n'
|
|
);
|
|
|
|
const result = runGsdTools('validate health', tmpDir);
|
|
assert.ok(result.success, `Command failed: ${result.error}`);
|
|
|
|
const output = JSON.parse(result.output);
|
|
assert.ok(
|
|
!output.warnings.some(w => w.code === 'W009'),
|
|
`Should not have W009: ${JSON.stringify(output.warnings)}`
|
|
);
|
|
});
|
|
|
|
// ─── Overall status ────────────────────────────────────────────────────────
|
|
|
|
test("returns 'healthy' when all checks pass", () => {
|
|
writeMinimalProjectMd(tmpDir);
|
|
writeMinimalRoadmap(tmpDir, ['1']);
|
|
writeMinimalStateMd(tmpDir, '# Session State\n\nPhase 1 in progress.\n');
|
|
writeValidConfigJson(tmpDir);
|
|
// Create valid phase dir matching ROADMAP
|
|
const phaseDir = path.join(tmpDir, '.planning', 'phases', '01-a');
|
|
fs.mkdirSync(phaseDir, { recursive: true });
|
|
// Add PLAN+SUMMARY so no I001
|
|
fs.writeFileSync(path.join(phaseDir, '01-01-PLAN.md'), '# Plan\n');
|
|
fs.writeFileSync(path.join(phaseDir, '01-01-SUMMARY.md'), '# Summary\n');
|
|
|
|
const result = runGsdTools('validate health', tmpDir);
|
|
assert.ok(result.success, `Command failed: ${result.error}`);
|
|
|
|
const output = JSON.parse(result.output);
|
|
assert.strictEqual(output.status, 'healthy', `Expected healthy, got ${output.status}. Errors: ${JSON.stringify(output.errors)}, Warnings: ${JSON.stringify(output.warnings)}`);
|
|
assert.deepStrictEqual(output.errors, [], 'should have no errors');
|
|
assert.deepStrictEqual(output.warnings, [], 'should have no warnings');
|
|
});
|
|
|
|
test("returns 'degraded' when only warnings exist", () => {
|
|
writeMinimalProjectMd(tmpDir);
|
|
writeMinimalRoadmap(tmpDir, ['1']);
|
|
writeMinimalStateMd(tmpDir);
|
|
// No config.json → W003 (warning, not error)
|
|
fs.mkdirSync(path.join(tmpDir, '.planning', 'phases', '01-a'), { recursive: true });
|
|
|
|
const result = runGsdTools('validate health', tmpDir);
|
|
assert.ok(result.success, `Command failed: ${result.error}`);
|
|
|
|
const output = JSON.parse(result.output);
|
|
assert.strictEqual(output.status, 'degraded', `Expected degraded, got ${output.status}`);
|
|
assert.strictEqual(output.errors.length, 0, 'should have no errors');
|
|
assert.ok(output.warnings.length > 0, 'should have warnings');
|
|
});
|
|
});
|
|
|
|
// ─────────────────────────────────────────────────────────────────────────────
|
|
// validate health --repair command
|
|
// ─────────────────────────────────────────────────────────────────────────────
|
|
|
|
describe('validate health --repair command', () => {
|
|
let tmpDir;
|
|
|
|
beforeEach(() => {
|
|
tmpDir = createTempProject();
|
|
// Set up base project with ROADMAP and PROJECT.md so repairs are triggered
|
|
// (E001, E003 are not repairable so we always need .planning/ and ROADMAP.md)
|
|
writeMinimalProjectMd(tmpDir);
|
|
writeMinimalRoadmap(tmpDir, ['1']);
|
|
fs.mkdirSync(path.join(tmpDir, '.planning', 'phases', '01-a'), { recursive: true });
|
|
});
|
|
|
|
afterEach(() => {
|
|
cleanup(tmpDir);
|
|
});
|
|
|
|
test('creates config.json with defaults when missing', () => {
|
|
// STATE.md present so no STATE repair; no config.json
|
|
writeMinimalStateMd(tmpDir, '# Session State\n\nPhase 1 in progress.\n');
|
|
// Ensure no config.json
|
|
const configPath = path.join(tmpDir, '.planning', 'config.json');
|
|
if (fs.existsSync(configPath)) fs.unlinkSync(configPath);
|
|
|
|
const result = runGsdTools('validate health --repair', tmpDir);
|
|
assert.ok(result.success, `Command failed: ${result.error}`);
|
|
|
|
const output = JSON.parse(result.output);
|
|
assert.ok(
|
|
Array.isArray(output.repairs_performed),
|
|
`Expected repairs_performed array: ${JSON.stringify(output)}`
|
|
);
|
|
const createAction = output.repairs_performed.find(r => r.action === 'createConfig');
|
|
assert.ok(createAction, `Expected createConfig action: ${JSON.stringify(output.repairs_performed)}`);
|
|
assert.strictEqual(createAction.success, true, 'createConfig should succeed');
|
|
|
|
// Verify config.json now exists on disk with valid JSON and balanced profile
|
|
assert.ok(fs.existsSync(configPath), 'config.json should now exist on disk');
|
|
const diskConfig = JSON.parse(fs.readFileSync(configPath, 'utf-8'));
|
|
assert.strictEqual(diskConfig.model_profile, 'balanced', 'default model_profile should be balanced');
|
|
// Verify nested workflow structure matches config.cjs canonical format
|
|
assert.ok(diskConfig.workflow, 'config should have nested workflow object');
|
|
assert.strictEqual(diskConfig.workflow.research, true, 'workflow.research should default to true');
|
|
assert.strictEqual(diskConfig.workflow.plan_check, true, 'workflow.plan_check should default to true');
|
|
assert.strictEqual(diskConfig.workflow.verifier, true, 'workflow.verifier should default to true');
|
|
assert.strictEqual(diskConfig.workflow.nyquist_validation, true, 'workflow.nyquist_validation should default to true');
|
|
// Verify branch templates are present
|
|
assert.strictEqual(diskConfig.phase_branch_template, 'gsd/phase-{phase}-{slug}');
|
|
assert.strictEqual(diskConfig.milestone_branch_template, 'gsd/{milestone}-{slug}');
|
|
});
|
|
|
|
test('resets config.json when JSON is invalid', () => {
|
|
writeMinimalStateMd(tmpDir, '# Session State\n\nPhase 1 in progress.\n');
|
|
const configPath = path.join(tmpDir, '.planning', 'config.json');
|
|
fs.writeFileSync(configPath, '{broken json');
|
|
|
|
const result = runGsdTools('validate health --repair', tmpDir);
|
|
assert.ok(result.success, `Command failed: ${result.error}`);
|
|
|
|
const output = JSON.parse(result.output);
|
|
assert.ok(
|
|
Array.isArray(output.repairs_performed),
|
|
`Expected repairs_performed: ${JSON.stringify(output)}`
|
|
);
|
|
const resetAction = output.repairs_performed.find(r => r.action === 'resetConfig');
|
|
assert.ok(resetAction, `Expected resetConfig action: ${JSON.stringify(output.repairs_performed)}`);
|
|
|
|
// Verify config.json is now valid JSON with correct nested structure
|
|
const diskConfig = JSON.parse(fs.readFileSync(configPath, 'utf-8'));
|
|
assert.ok(typeof diskConfig === 'object', 'config.json should be valid JSON after repair');
|
|
assert.ok(diskConfig.workflow, 'reset config should have nested workflow object');
|
|
assert.strictEqual(diskConfig.workflow.research, true, 'workflow.research should be true after reset');
|
|
});
|
|
|
|
test('regenerates STATE.md when missing', () => {
|
|
writeValidConfigJson(tmpDir);
|
|
// No STATE.md
|
|
const statePath = path.join(tmpDir, '.planning', 'STATE.md');
|
|
if (fs.existsSync(statePath)) fs.unlinkSync(statePath);
|
|
|
|
const result = runGsdTools('validate health --repair', tmpDir);
|
|
assert.ok(result.success, `Command failed: ${result.error}`);
|
|
|
|
const output = JSON.parse(result.output);
|
|
assert.ok(
|
|
Array.isArray(output.repairs_performed),
|
|
`Expected repairs_performed: ${JSON.stringify(output)}`
|
|
);
|
|
const regenerateAction = output.repairs_performed.find(r => r.action === 'regenerateState');
|
|
assert.ok(regenerateAction, `Expected regenerateState action: ${JSON.stringify(output.repairs_performed)}`);
|
|
assert.strictEqual(regenerateAction.success, true, 'regenerateState should succeed');
|
|
|
|
// Verify STATE.md now exists and contains "# Session State"
|
|
assert.ok(fs.existsSync(statePath), 'STATE.md should now exist on disk');
|
|
const stateContent = fs.readFileSync(statePath, 'utf-8');
|
|
assert.ok(stateContent.includes('# Session State'), 'regenerated STATE.md should contain "# Session State"');
|
|
});
|
|
|
|
test('does not rewrite existing STATE.md for invalid phase references', () => {
|
|
writeValidConfigJson(tmpDir);
|
|
const statePath = path.join(tmpDir, '.planning', 'STATE.md');
|
|
const originalContent = '# Session State\n\nPhase 99 is current.\n';
|
|
fs.writeFileSync(
|
|
statePath,
|
|
originalContent
|
|
);
|
|
|
|
const result = runGsdTools('validate health --repair', tmpDir);
|
|
assert.ok(result.success, `Command failed: ${result.error}`);
|
|
|
|
const output = JSON.parse(result.output);
|
|
assert.ok(
|
|
!Array.isArray(output.repairs_performed) || !output.repairs_performed.some(r => r.action === 'regenerateState'),
|
|
`Did not expect regenerateState for W002: ${JSON.stringify(output)}`
|
|
);
|
|
|
|
const stateContent = fs.readFileSync(statePath, 'utf-8');
|
|
assert.strictEqual(stateContent, originalContent, 'existing STATE.md should be preserved');
|
|
|
|
const planningDir = path.join(tmpDir, '.planning');
|
|
const planningFiles = fs.readdirSync(planningDir);
|
|
const backupFile = planningFiles.find(f => f.startsWith('STATE.md.bak-'));
|
|
assert.strictEqual(backupFile, undefined, `Did not expect backup file for non-destructive repair. Found: ${planningFiles.join(', ')}`);
|
|
});
|
|
|
|
test('adds nyquist_validation key to config.json via addNyquistKey repair', () => {
|
|
writeMinimalStateMd(tmpDir, '# Session State\n\nPhase 1 in progress.\n');
|
|
// Config with workflow section but missing nyquist_validation
|
|
const configPath = path.join(tmpDir, '.planning', 'config.json');
|
|
fs.writeFileSync(
|
|
configPath,
|
|
JSON.stringify({ model_profile: 'balanced', workflow: { research: true } }, null, 2)
|
|
);
|
|
|
|
const result = runGsdTools('validate health --repair', tmpDir);
|
|
assert.ok(result.success, `Command failed: ${result.error}`);
|
|
|
|
const output = JSON.parse(result.output);
|
|
assert.ok(
|
|
Array.isArray(output.repairs_performed),
|
|
`Expected repairs_performed array: ${JSON.stringify(output)}`
|
|
);
|
|
const addKeyAction = output.repairs_performed.find(r => r.action === 'addNyquistKey');
|
|
assert.ok(addKeyAction, `Expected addNyquistKey action: ${JSON.stringify(output.repairs_performed)}`);
|
|
assert.strictEqual(addKeyAction.success, true, 'addNyquistKey should succeed');
|
|
|
|
// Read config.json and verify workflow.nyquist_validation is true
|
|
const diskConfig = JSON.parse(fs.readFileSync(configPath, 'utf-8'));
|
|
assert.strictEqual(diskConfig.workflow.nyquist_validation, true, 'nyquist_validation should be true');
|
|
});
|
|
|
|
test('reports repairable_count correctly', () => {
|
|
// No config.json (W003, repairable=true) and no STATE.md (E004, repairable=true)
|
|
const configPath = path.join(tmpDir, '.planning', 'config.json');
|
|
if (fs.existsSync(configPath)) fs.unlinkSync(configPath);
|
|
const statePath = path.join(tmpDir, '.planning', 'STATE.md');
|
|
if (fs.existsSync(statePath)) fs.unlinkSync(statePath);
|
|
|
|
// Run WITHOUT --repair to just check repairable_count
|
|
const result = runGsdTools('validate health', tmpDir);
|
|
assert.ok(result.success, `Command failed: ${result.error}`);
|
|
|
|
const output = JSON.parse(result.output);
|
|
assert.ok(
|
|
output.repairable_count >= 2,
|
|
`Expected repairable_count >= 2, got ${output.repairable_count}. Full output: ${JSON.stringify(output)}`
|
|
);
|
|
});
|
|
|
|
test('phase mismatch warnings do not count as repairable issues', () => {
|
|
writeValidConfigJson(tmpDir);
|
|
fs.writeFileSync(
|
|
path.join(tmpDir, '.planning', 'STATE.md'),
|
|
'# Session State\n\nPhase 99 is the current phase.\n'
|
|
);
|
|
|
|
const result = runGsdTools('validate health', tmpDir);
|
|
assert.ok(result.success, `Command failed: ${result.error}`);
|
|
|
|
const output = JSON.parse(result.output);
|
|
assert.strictEqual(output.repairable_count, 0, `Expected no repairable issues for W002: ${JSON.stringify(output)}`);
|
|
});
|
|
});
|
|
|
|
// ─────────────────────────────────────────────────────────────────────────────
|
|
// Graceful degradation when phasesDir is missing (#1973)
|
|
// ─────────────────────────────────────────────────────────────────────────────
|
|
|
|
describe('validate health — missing phasesDir', () => {
|
|
let tmpDir;
|
|
|
|
beforeEach(() => {
|
|
tmpDir = createTempProject();
|
|
});
|
|
|
|
afterEach(() => {
|
|
cleanup(tmpDir);
|
|
});
|
|
|
|
test('completes without throwing and emits zero phase-directory warnings when phasesDir does not exist', () => {
|
|
// Setup: valid PROJECT, ROADMAP, STATE, config but NO phases directory
|
|
writeMinimalProjectMd(tmpDir);
|
|
writeMinimalRoadmap(tmpDir, ['1', '2']);
|
|
writeMinimalStateMd(tmpDir);
|
|
writeValidConfigJson(tmpDir);
|
|
|
|
// Remove the phases directory if it exists
|
|
const phasesDir = path.join(tmpDir, '.planning', 'phases');
|
|
if (fs.existsSync(phasesDir)) {
|
|
fs.rmSync(phasesDir, { recursive: true, force: true });
|
|
}
|
|
|
|
// Should complete without throwing
|
|
const result = runGsdTools('validate health', tmpDir);
|
|
assert.ok(result.success, `Command should succeed when phasesDir is missing: ${result.error}`);
|
|
|
|
const output = JSON.parse(result.output);
|
|
|
|
// Assert no phase-directory warnings fired
|
|
const phaseDirCodes = ['W005', 'W006', 'W007', 'W009', 'I001'];
|
|
const issues = output.issues || [];
|
|
for (const code of phaseDirCodes) {
|
|
const matches = issues.filter(i => i.code === code);
|
|
assert.strictEqual(matches.length, 0, `Expected no ${code} issues when phasesDir is missing, got: ${JSON.stringify(matches)}`);
|
|
}
|
|
});
|
|
});
|