* docs(test-standards): enforce no-source-grep rule with CI linter + update CONTRIBUTING.md
Adds scripts/lint-no-source-grep.cjs — a static linter that detects readFileSync
on .cjs source files in tests without an allow-test-rule annotation. Wires it
into CI as a new lint-tests job in test.yml and as npm run lint:tests.
Resolves all 9 existing violations across the test suite:
- Rewrites workspace routing tests (3) as behavioral runGsdTools calls that
verify each command is router-recognized (exit != "Unknown init workflow")
- Adds allow-test-rule annotations with explanatory comments to 7 legitimate
structural tests: architectural invariants (locking, orphan-worktree),
structural regression guards (milestone-regex-global), docs-parity
(config-field-docs), integration-test-input (copilot-install), and
structural-implementation-guards (bug-1891, discuss-mode)
Updates CONTRIBUTING.md Testing Standards section with:
- "Prohibited: Source-Grep Tests" section with the before/after pattern,
root cause analysis of why it breaks (commit 990c3e64), and CI reference
- allow-test-rule exemption table (6 recognized categories with when-to-use)
- "CI Test Quality Checks" table showing lint-tests job and local run command
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
* fix: resolve CodeRabbit findings on PR #2700
- CONTRIBUTING.md: "four recognized categories" → "six" (table has 6 rows)
- workspace.test.cjs: use positional args in routing tests (no --name flag)
- lint-no-source-grep.cjs: add source-dir guard to READ_WITH_INLINE_CJS_RE
(mirrors CJS_PATH_CONST_RE's protection against false positives on temp files)
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
* fix(lint): tighten allow-test-rule and add recursive test discovery
- ALLOW_ANNOTATION now requires at least one non-whitespace char after the
colon so bare '// allow-test-rule:' cannot bypass the lint gate
- findTestFiles() recurses into subdirectories so nested *.test.cjs files
are covered if the tests/ tree ever grows subdirs
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
---------
Co-authored-by: Claude Sonnet 4.6 <noreply@anthropic.com>
168 lines
7.4 KiB
JavaScript
168 lines
7.4 KiB
JavaScript
// allow-test-rule: structural-implementation-guard
|
|
// init.cjs cmdInitPlanPhase must expose text_mode in its returned flags object.
|
|
// The behavioral alternative (run plan-phase init and inspect JSON output) is
|
|
// fragile across runtime variations. Structural inspection guards the contract
|
|
// until a stable behavioral API test is in place.
|
|
|
|
/**
|
|
* Discuss Mode Config Tests
|
|
*
|
|
* Validates workflow.discuss_mode config, routing, and assumptions workflow integration.
|
|
*/
|
|
|
|
const { test, describe } = require('node:test');
|
|
const assert = require('node:assert/strict');
|
|
const fs = require('fs');
|
|
const path = require('path');
|
|
|
|
describe('workflow.discuss_mode config', () => {
|
|
test('config template includes discuss_mode default', () => {
|
|
const template = JSON.parse(
|
|
fs.readFileSync(path.join(__dirname, '..', 'get-shit-done', 'templates', 'config.json'), 'utf8')
|
|
);
|
|
assert.strictEqual(template.workflow.discuss_mode, 'discuss');
|
|
});
|
|
|
|
test('discuss-phase command references both workflow files', () => {
|
|
const command = fs.readFileSync(
|
|
path.join(__dirname, '..', 'commands', 'gsd', 'discuss-phase.md'), 'utf8'
|
|
);
|
|
assert.ok(command.includes('discuss-phase-assumptions.md'), 'should reference assumptions workflow');
|
|
assert.ok(command.includes('discuss-phase.md'), 'should reference discuss workflow');
|
|
assert.ok(command.includes('workflow.discuss_mode'), 'should reference config key');
|
|
});
|
|
|
|
test('discuss-phase command process block defers to workflow file (not inline instructions)', () => {
|
|
const command = fs.readFileSync(
|
|
path.join(__dirname, '..', 'commands', 'gsd', 'discuss-phase.md'), 'utf8'
|
|
);
|
|
// Extract the <process> block
|
|
const processMatch = command.match(/<process>([\s\S]*?)<\/process>/);
|
|
assert.ok(processMatch, 'should have a <process> block');
|
|
const processBlock = processMatch[1];
|
|
|
|
// The process block must explicitly tell the agent to read the workflow file
|
|
assert.ok(
|
|
processBlock.includes('Read and execute'),
|
|
'process block should direct agent to read and execute workflow file'
|
|
);
|
|
assert.ok(
|
|
processBlock.includes('MANDATORY'),
|
|
'process block should include MANDATORY instruction to read workflow files'
|
|
);
|
|
|
|
// The process block must NOT contain detailed step-by-step instructions
|
|
// that could substitute for the actual workflow file
|
|
assert.ok(
|
|
!processBlock.includes('Scout codebase'),
|
|
'process block should not contain detailed workflow steps (Scout codebase)'
|
|
);
|
|
assert.ok(
|
|
!processBlock.includes('Deep-dive each area'),
|
|
'process block should not contain detailed workflow steps (Deep-dive)'
|
|
);
|
|
assert.ok(
|
|
!processBlock.includes('Probing depth'),
|
|
'process block should not contain detailed workflow steps (Probing depth)'
|
|
);
|
|
});
|
|
|
|
test('discuss-phase command argument-hint includes --text', () => {
|
|
const command = fs.readFileSync(
|
|
path.join(__dirname, '..', 'commands', 'gsd', 'discuss-phase.md'), 'utf8'
|
|
);
|
|
assert.ok(command.includes('--text'), 'argument-hint should include --text');
|
|
});
|
|
|
|
test('assumptions workflow file exists and has required steps', () => {
|
|
const workflow = fs.readFileSync(
|
|
path.join(__dirname, '..', 'get-shit-done', 'workflows', 'discuss-phase-assumptions.md'), 'utf8'
|
|
);
|
|
const requiredSteps = [
|
|
'initialize', 'check_existing', 'load_prior_context',
|
|
'deep_codebase_analysis', 'present_assumptions', 'correct_assumptions',
|
|
'write_context', 'write_discussion_log', 'auto_advance'
|
|
];
|
|
for (const step of requiredSteps) {
|
|
assert.ok(workflow.includes(`<step name="${step}"`), `missing step: ${step}`);
|
|
}
|
|
});
|
|
|
|
test('assumptions workflow produces same CONTEXT.md sections', () => {
|
|
const workflow = fs.readFileSync(
|
|
path.join(__dirname, '..', 'get-shit-done', 'workflows', 'discuss-phase-assumptions.md'), 'utf8'
|
|
);
|
|
const sections = ['<domain>', '<decisions>', '<canonical_refs>', '<code_context>', '<specifics>', '<deferred>'];
|
|
for (const section of sections) {
|
|
assert.ok(workflow.includes(section), `missing CONTEXT.md section: ${section}`);
|
|
}
|
|
});
|
|
|
|
test('plan-phase gate references discuss_mode config', () => {
|
|
const planPhase = fs.readFileSync(
|
|
path.join(__dirname, '..', 'get-shit-done', 'workflows', 'plan-phase.md'), 'utf8'
|
|
);
|
|
assert.ok(planPhase.includes('workflow.discuss_mode'), 'should reference config key');
|
|
assert.ok(planPhase.includes('assumptions mode'), 'should mention assumptions mode');
|
|
});
|
|
|
|
test('assumptions workflow handles --auto flag', () => {
|
|
const workflow = fs.readFileSync(
|
|
path.join(__dirname, '..', 'get-shit-done', 'workflows', 'discuss-phase-assumptions.md'), 'utf8'
|
|
);
|
|
assert.ok(workflow.includes('--auto'), 'should handle --auto');
|
|
assert.ok(workflow.includes('auto-select'), 'should auto-select in --auto mode');
|
|
assert.ok(workflow.includes('auto_advance'), 'should support auto_advance');
|
|
});
|
|
|
|
test('assumptions workflow handles --text flag', () => {
|
|
const workflow = fs.readFileSync(
|
|
path.join(__dirname, '..', 'get-shit-done', 'workflows', 'discuss-phase-assumptions.md'), 'utf8'
|
|
);
|
|
assert.ok(workflow.includes('text_mode'), 'should reference text_mode config');
|
|
assert.ok(workflow.includes('--text'), 'should handle --text flag');
|
|
});
|
|
|
|
test('plan-phase workflow references text_mode', () => {
|
|
const planPhase = fs.readFileSync(
|
|
path.join(__dirname, '..', 'get-shit-done', 'workflows', 'plan-phase.md'), 'utf8'
|
|
);
|
|
assert.ok(planPhase.includes('text_mode'), 'plan-phase workflow should reference text_mode');
|
|
assert.ok(planPhase.includes('TEXT_MODE'), 'plan-phase workflow should use TEXT_MODE variable');
|
|
assert.ok(planPhase.includes('--text'), 'plan-phase workflow should handle --text flag');
|
|
});
|
|
|
|
test('plan-phase command argument-hint includes --text', () => {
|
|
const command = fs.readFileSync(
|
|
path.join(__dirname, '..', 'commands', 'gsd', 'plan-phase.md'), 'utf8'
|
|
);
|
|
assert.ok(command.includes('--text'), 'argument-hint should include --text flag');
|
|
});
|
|
|
|
test('plan-phase init exposes text_mode in workflow flags', () => {
|
|
const initSrc = fs.readFileSync(
|
|
path.join(__dirname, '..', 'get-shit-done', 'bin', 'lib', 'init.cjs'), 'utf8'
|
|
);
|
|
// The cmdInitPlanPhase result object must include text_mode
|
|
const planPhaseBlock = initSrc.slice(initSrc.indexOf('function cmdInitPlanPhase'));
|
|
assert.ok(planPhaseBlock.includes('text_mode: config.text_mode'), 'init plan-phase must expose text_mode');
|
|
});
|
|
|
|
test('progress workflow references discuss_mode', () => {
|
|
const progress = fs.readFileSync(
|
|
path.join(__dirname, '..', 'get-shit-done', 'workflows', 'progress.md'), 'utf8'
|
|
);
|
|
assert.ok(progress.includes('workflow.discuss_mode'), 'should read discuss_mode config');
|
|
assert.ok(progress.includes('Discuss mode'), 'should display discuss mode');
|
|
});
|
|
|
|
test('documentation file exists', () => {
|
|
const docPath = path.join(__dirname, '..', 'docs', 'workflow-discuss-mode.md');
|
|
assert.ok(fs.existsSync(docPath), 'docs/workflow-discuss-mode.md should exist');
|
|
const doc = fs.readFileSync(docPath, 'utf8');
|
|
assert.ok(doc.includes('assumptions'), 'doc should mention assumptions');
|
|
assert.ok(doc.includes('discuss'), 'doc should mention discuss');
|
|
assert.ok(doc.includes('config-set'), 'doc should show how to configure');
|
|
});
|
|
});
|