Fold 51 issue-named CLI black-box + scripts-tooling regression files into their canonical module suites (runtime-launcher-parity, worktree-safety, install-*, managed-hooks, read-guard, capability-registry, etc.), plus a NEW slash-command-namespace.test.cjs grouping the 4 slash/colon-namespace-leak invariant suites that had no canonical owner. Verbatim block-scoped describe wrappers; 427 subtests conserved 1:1. Host-env pre-check (per B2): no CLI-receiving host sets a redirecting GSD_WORKSTREAM/GSD_PROJECT value. One folded suite (bug-3668 runtime resolver) creates an extension-less PATH gsd-tools stub + bash -c; co-locating it with the host's chmodSync tripped local/no-unguarded-nonportable-exec, so it's now Windows-guarded (skip on win32) matching the host suite's own bash -c guard. Regenerates regression-name allowlist (222->182), ratchets file-count allowlist (graphify 7->6, docs entry removed), makes 26 relocated allow-test-rule exemptions issue-ref-compliant (ADR-456; prunes stale ids). Repoints 13 tests/ references across CONTEXT.md, COMMANDS.md/FEATURES.md (EN + ja/ko/pt/zh) and ADR-0002. lint:ci green. Part of epic #1969. Closes #1975. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
948 lines
36 KiB
JavaScript
948 lines
36 KiB
JavaScript
// allow-test-rule: source-text-is-the-product
|
|
// Reads .md/.json/.yml product files whose deployed text IS what the
|
|
// runtime loads — testing text content tests the deployed contract.
|
|
|
|
/**
|
|
* GSD Tools Tests — Codebase Drift Detection (#2003)
|
|
*
|
|
* Unit tests for bin/lib/drift.cjs plus CLI surface via verify codebase-drift.
|
|
* Exercises the four drift categories (new dir, barrel, migration, route),
|
|
* threshold gating, warn vs. auto-remap, last_mapped_commit round-trip,
|
|
* config validation, mapper --paths passthrough, and graceful failure paths.
|
|
*/
|
|
|
|
'use strict';
|
|
|
|
const { test, describe, beforeEach, afterEach } = require('node:test');
|
|
const assert = require('node:assert/strict');
|
|
const fs = require('node:fs');
|
|
const path = require('node:path');
|
|
const { execFileSync } = require('node:child_process');
|
|
const {
|
|
createTempProject,
|
|
createTempGitProject,
|
|
cleanup,
|
|
runGsdTools,
|
|
} = require('./helpers.cjs');
|
|
|
|
const DRIFT_PATH = path.join(
|
|
__dirname,
|
|
'..',
|
|
'gsd-core',
|
|
'bin',
|
|
'lib',
|
|
'drift.cjs',
|
|
);
|
|
const CONFIG_SCHEMA_PATH = path.join(
|
|
__dirname,
|
|
'..',
|
|
'gsd-core',
|
|
'bin',
|
|
'lib',
|
|
'config-schema.cjs',
|
|
);
|
|
|
|
const {
|
|
detectDrift,
|
|
classifyFile,
|
|
readMappedCommit,
|
|
writeMappedCommit,
|
|
chooseAffectedPaths,
|
|
sanitizePaths,
|
|
DRIFT_CATEGORIES,
|
|
} = require(DRIFT_PATH);
|
|
|
|
// Small wrapper around execFileSync so tests don't sprinkle shell=true calls.
|
|
function git(cwd, ...args) {
|
|
return execFileSync('git', args, { cwd, encoding: 'utf8', stdio: ['pipe', 'pipe', 'pipe'] }).trim();
|
|
}
|
|
|
|
// ─── Unit: classifyFile ──────────────────────────────────────────────────────
|
|
|
|
describe('classifyFile', () => {
|
|
test('classifies packages barrel export', () => {
|
|
assert.strictEqual(classifyFile('packages/foo/src/index.ts'), 'barrel');
|
|
});
|
|
|
|
test('classifies apps barrel export', () => {
|
|
assert.strictEqual(classifyFile('apps/web/src/index.tsx'), 'barrel');
|
|
});
|
|
|
|
test('classifies supabase migration', () => {
|
|
assert.strictEqual(
|
|
classifyFile('supabase/migrations/20240101_init.sql'),
|
|
'migration',
|
|
);
|
|
});
|
|
|
|
test('classifies prisma migration folder', () => {
|
|
assert.strictEqual(
|
|
classifyFile('prisma/migrations/20240101_init/migration.sql'),
|
|
'migration',
|
|
);
|
|
});
|
|
|
|
test('classifies drizzle meta migration', () => {
|
|
assert.strictEqual(classifyFile('drizzle/meta/_journal.json'), 'migration');
|
|
});
|
|
|
|
test('classifies route module', () => {
|
|
assert.strictEqual(
|
|
classifyFile('apps/web/src/routes/journal.ts'),
|
|
'route',
|
|
);
|
|
assert.strictEqual(
|
|
classifyFile('src/api/users.ts'),
|
|
'route',
|
|
);
|
|
});
|
|
|
|
test('returns null for ordinary source file', () => {
|
|
assert.strictEqual(classifyFile('src/lib/util.ts'), null);
|
|
});
|
|
});
|
|
|
|
// ─── Unit: detectDrift categories ────────────────────────────────────────────
|
|
|
|
describe('detectDrift — categories', () => {
|
|
const baseStructure = [
|
|
'# Codebase Structure',
|
|
'',
|
|
'- `src/lib/` — helpers',
|
|
'- `bin/` — CLIs',
|
|
'',
|
|
].join('\n');
|
|
|
|
test('identifies new directory outside mapped paths', () => {
|
|
const result = detectDrift({
|
|
addedFiles: ['newpkg/src/thing.ts'],
|
|
modifiedFiles: [],
|
|
deletedFiles: [],
|
|
structureMd: baseStructure,
|
|
});
|
|
const newDirs = result.elements.filter((e) => e.category === 'new_dir');
|
|
assert.ok(newDirs.length >= 1, 'should find at least one new directory');
|
|
assert.ok(
|
|
newDirs.some((e) => e.path.startsWith('newpkg')),
|
|
'should flag newpkg as new',
|
|
);
|
|
});
|
|
|
|
test('does not flag files in already-mapped paths', () => {
|
|
const result = detectDrift({
|
|
addedFiles: ['src/lib/newhelper.ts'],
|
|
modifiedFiles: [],
|
|
deletedFiles: [],
|
|
structureMd: baseStructure,
|
|
});
|
|
const newDirs = result.elements.filter((e) => e.category === 'new_dir');
|
|
assert.strictEqual(
|
|
newDirs.length,
|
|
0,
|
|
'src/lib is mapped — no new_dir drift',
|
|
);
|
|
});
|
|
|
|
test('identifies new barrel export', () => {
|
|
const result = detectDrift({
|
|
addedFiles: ['packages/widgets/src/index.ts'],
|
|
modifiedFiles: [],
|
|
deletedFiles: [],
|
|
structureMd: baseStructure,
|
|
});
|
|
assert.ok(result.elements.some((e) => e.category === 'barrel'));
|
|
});
|
|
|
|
test('identifies new migration', () => {
|
|
const result = detectDrift({
|
|
addedFiles: ['supabase/migrations/20240501_add_accounts.sql'],
|
|
modifiedFiles: [],
|
|
deletedFiles: [],
|
|
structureMd: baseStructure,
|
|
});
|
|
assert.ok(result.elements.some((e) => e.category === 'migration'));
|
|
});
|
|
|
|
test('identifies new route module', () => {
|
|
const result = detectDrift({
|
|
addedFiles: ['apps/accounting/src/routes/journal.ts'],
|
|
modifiedFiles: [],
|
|
deletedFiles: [],
|
|
structureMd: baseStructure,
|
|
});
|
|
assert.ok(result.elements.some((e) => e.category === 'route'));
|
|
});
|
|
|
|
test('prioritizes higher-specificity category per file', () => {
|
|
const result = detectDrift({
|
|
addedFiles: ['supabase/migrations/20240101_init.sql'],
|
|
modifiedFiles: [],
|
|
deletedFiles: [],
|
|
structureMd: baseStructure,
|
|
});
|
|
const perFile = result.elements.filter(
|
|
(e) => e.path === 'supabase/migrations/20240101_init.sql',
|
|
);
|
|
assert.strictEqual(perFile.length, 1, 'file counted once');
|
|
assert.strictEqual(perFile[0].category, 'migration');
|
|
});
|
|
});
|
|
|
|
// ─── Unit: threshold gating ──────────────────────────────────────────────────
|
|
|
|
describe('detectDrift — threshold gating', () => {
|
|
test('2 elements under default threshold → no action', () => {
|
|
const result = detectDrift({
|
|
addedFiles: [
|
|
'packages/a/src/index.ts',
|
|
'packages/b/src/index.ts',
|
|
],
|
|
modifiedFiles: [],
|
|
deletedFiles: [],
|
|
structureMd: '# only src/ mapped',
|
|
threshold: 3,
|
|
});
|
|
assert.strictEqual(result.elements.length >= 2, true);
|
|
assert.strictEqual(result.actionRequired, false);
|
|
});
|
|
|
|
test('3 elements at threshold → action required', () => {
|
|
const result = detectDrift({
|
|
addedFiles: [
|
|
'packages/a/src/index.ts',
|
|
'packages/b/src/index.ts',
|
|
'packages/c/src/index.ts',
|
|
],
|
|
modifiedFiles: [],
|
|
deletedFiles: [],
|
|
structureMd: '# only src/ mapped',
|
|
threshold: 3,
|
|
});
|
|
assert.strictEqual(result.actionRequired, true);
|
|
});
|
|
|
|
test('4 elements exceeds threshold → action required', () => {
|
|
const result = detectDrift({
|
|
addedFiles: [
|
|
'packages/a/src/index.ts',
|
|
'packages/b/src/index.ts',
|
|
'packages/c/src/index.ts',
|
|
'supabase/migrations/1.sql',
|
|
],
|
|
modifiedFiles: [],
|
|
deletedFiles: [],
|
|
structureMd: '# only src/ mapped',
|
|
threshold: 3,
|
|
});
|
|
assert.strictEqual(result.actionRequired, true);
|
|
});
|
|
|
|
test('respects custom threshold value', () => {
|
|
const result = detectDrift({
|
|
addedFiles: ['packages/a/src/index.ts', 'packages/b/src/index.ts'],
|
|
modifiedFiles: [],
|
|
deletedFiles: [],
|
|
structureMd: '# only src/ mapped',
|
|
threshold: 2,
|
|
});
|
|
assert.strictEqual(result.actionRequired, true);
|
|
});
|
|
});
|
|
|
|
// ─── Unit: action routing ────────────────────────────────────────────────────
|
|
|
|
describe('detectDrift — action routing', () => {
|
|
const over = {
|
|
addedFiles: [
|
|
'packages/a/src/index.ts',
|
|
'packages/b/src/index.ts',
|
|
'packages/c/src/index.ts',
|
|
],
|
|
modifiedFiles: [],
|
|
deletedFiles: [],
|
|
structureMd: '# only src/ mapped',
|
|
threshold: 3,
|
|
};
|
|
|
|
test('warn action yields warn directive and no mapper spawn request', () => {
|
|
const result = detectDrift({ ...over, action: 'warn' });
|
|
assert.strictEqual(result.directive, 'warn');
|
|
assert.strictEqual(result.spawnMapper, false);
|
|
assert.ok(result.message.includes('drift'), 'message mentions drift');
|
|
});
|
|
|
|
test('auto-remap action yields spawn directive with affected paths', () => {
|
|
const result = detectDrift({ ...over, action: 'auto-remap' });
|
|
assert.strictEqual(result.directive, 'auto-remap');
|
|
assert.strictEqual(result.spawnMapper, true);
|
|
assert.ok(Array.isArray(result.affectedPaths));
|
|
assert.ok(result.affectedPaths.length > 0);
|
|
for (const p of result.affectedPaths) {
|
|
assert.ok(!p.startsWith('/'), 'no absolute paths');
|
|
assert.ok(!p.includes('..'), 'no traversal');
|
|
}
|
|
});
|
|
|
|
test('below-threshold inputs produce no directive', () => {
|
|
const result = detectDrift({
|
|
addedFiles: ['packages/a/src/index.ts'],
|
|
modifiedFiles: [],
|
|
deletedFiles: [],
|
|
structureMd: '# only src/ mapped',
|
|
threshold: 3,
|
|
action: 'auto-remap',
|
|
});
|
|
assert.strictEqual(result.actionRequired, false);
|
|
assert.strictEqual(result.spawnMapper, false);
|
|
assert.strictEqual(result.directive, 'none');
|
|
});
|
|
});
|
|
|
|
// ─── Unit: affected-paths scoping ────────────────────────────────────────────
|
|
|
|
describe('chooseAffectedPaths', () => {
|
|
test('collapses files into top-level prefixes', () => {
|
|
const paths = chooseAffectedPaths([
|
|
'apps/accounting/src/routes/a.ts',
|
|
'apps/accounting/src/routes/b.ts',
|
|
'packages/ui/src/index.ts',
|
|
]);
|
|
assert.ok(paths.includes('apps/accounting'));
|
|
assert.ok(paths.includes('packages/ui'));
|
|
});
|
|
|
|
test('deduplicates and sorts', () => {
|
|
const paths = chooseAffectedPaths([
|
|
'zzz/a.ts',
|
|
'aaa/b.ts',
|
|
'zzz/c.ts',
|
|
]);
|
|
assert.deepStrictEqual(paths, ['aaa', 'zzz']);
|
|
});
|
|
|
|
test('returns [] for empty input', () => {
|
|
assert.deepStrictEqual(chooseAffectedPaths([]), []);
|
|
});
|
|
});
|
|
|
|
// ─── Unit: sanitizePaths ─────────────────────────────────────────────────────
|
|
|
|
describe('sanitizePaths', () => {
|
|
test('rejects traversal', () => {
|
|
assert.deepStrictEqual(sanitizePaths(['../evil']), []);
|
|
assert.deepStrictEqual(sanitizePaths(['foo/../evil']), []);
|
|
});
|
|
|
|
test('rejects absolute paths', () => {
|
|
assert.deepStrictEqual(sanitizePaths(['/etc/passwd']), []);
|
|
});
|
|
|
|
test('rejects shell metacharacters', () => {
|
|
assert.deepStrictEqual(sanitizePaths(['foo;rm -rf /']), []);
|
|
assert.deepStrictEqual(sanitizePaths(['foo`id`']), []);
|
|
assert.deepStrictEqual(sanitizePaths(['foo$(id)']), []);
|
|
});
|
|
|
|
test('accepts normal repo-relative paths', () => {
|
|
assert.deepStrictEqual(
|
|
sanitizePaths(['apps/web', 'packages/ui']),
|
|
['apps/web', 'packages/ui'],
|
|
);
|
|
});
|
|
});
|
|
|
|
// ─── Unit: last_mapped_commit frontmatter round-trip ─────────────────────────
|
|
|
|
describe('last_mapped_commit frontmatter', () => {
|
|
let tmp;
|
|
beforeEach(() => {
|
|
tmp = createTempProject('gsd-drift-');
|
|
fs.mkdirSync(path.join(tmp, '.planning', 'codebase'), { recursive: true });
|
|
});
|
|
afterEach(() => cleanup(tmp));
|
|
|
|
test('writeMappedCommit creates frontmatter on fresh file', () => {
|
|
const file = path.join(tmp, '.planning', 'codebase', 'STRUCTURE.md');
|
|
fs.writeFileSync(file, '# Codebase Structure\n\nBody\n');
|
|
writeMappedCommit(file, 'deadbeef00000000000000000000000000000000', '2026-04-22');
|
|
const content = fs.readFileSync(file, 'utf8');
|
|
assert.ok(content.startsWith('---\n'));
|
|
assert.ok(content.includes('last_mapped_commit: deadbeef00000000000000000000000000000000'));
|
|
assert.ok(content.includes('# Codebase Structure'));
|
|
});
|
|
|
|
test('writeMappedCommit updates existing frontmatter', () => {
|
|
const file = path.join(tmp, '.planning', 'codebase', 'STRUCTURE.md');
|
|
fs.writeFileSync(
|
|
file,
|
|
'---\nlast_mapped_commit: aaaa\nother: keep-me\n---\n# body\n',
|
|
);
|
|
writeMappedCommit(file, 'bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb', '2026-04-22');
|
|
const content = fs.readFileSync(file, 'utf8');
|
|
assert.ok(content.includes('last_mapped_commit: bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb'));
|
|
assert.ok(content.includes('other: keep-me'), 'preserves other keys');
|
|
assert.ok(content.includes('# body'));
|
|
});
|
|
|
|
test('readMappedCommit round-trips via write', () => {
|
|
const file = path.join(tmp, '.planning', 'codebase', 'STRUCTURE.md');
|
|
fs.writeFileSync(file, '# body\n');
|
|
writeMappedCommit(file, 'cafebabe00000000000000000000000000000000', '2026-04-22');
|
|
assert.strictEqual(
|
|
readMappedCommit(file),
|
|
'cafebabe00000000000000000000000000000000',
|
|
);
|
|
});
|
|
|
|
test('readMappedCommit returns null when file missing', () => {
|
|
assert.strictEqual(readMappedCommit('/nonexistent/path.md'), null);
|
|
});
|
|
|
|
test('readMappedCommit returns null when frontmatter absent', () => {
|
|
const file = path.join(tmp, '.planning', 'codebase', 'STRUCTURE.md');
|
|
fs.writeFileSync(file, '# No frontmatter\n');
|
|
assert.strictEqual(readMappedCommit(file), null);
|
|
});
|
|
|
|
test('writeMappedCommit creates the file when it does not exist (symmetry with readMappedCommit)', () => {
|
|
const file = path.join(tmp, '.planning', 'codebase', 'NEW-DOC.md');
|
|
assert.strictEqual(fs.existsSync(file), false, 'precondition: file absent');
|
|
// Must not throw — readMappedCommit returns null for missing files,
|
|
// writeMappedCommit must defensively create them.
|
|
writeMappedCommit(file, 'feedface00000000000000000000000000000000', '2026-04-22');
|
|
assert.strictEqual(fs.existsSync(file), true, 'file created');
|
|
assert.strictEqual(
|
|
readMappedCommit(file),
|
|
'feedface00000000000000000000000000000000',
|
|
);
|
|
});
|
|
});
|
|
|
|
// ─── Unit: negative / defensive ──────────────────────────────────────────────
|
|
|
|
describe('detectDrift — defensive paths', () => {
|
|
test('missing structureMd → skipped result, no throw', () => {
|
|
const result = detectDrift({
|
|
addedFiles: ['foo/bar.ts'],
|
|
modifiedFiles: [],
|
|
deletedFiles: [],
|
|
structureMd: null,
|
|
});
|
|
assert.strictEqual(result.skipped, true);
|
|
assert.strictEqual(result.actionRequired, false);
|
|
assert.ok(result.reason);
|
|
});
|
|
|
|
test('empty inputs → no drift', () => {
|
|
const result = detectDrift({
|
|
addedFiles: [],
|
|
modifiedFiles: [],
|
|
deletedFiles: [],
|
|
structureMd: '# structure',
|
|
});
|
|
assert.strictEqual(result.elements.length, 0);
|
|
assert.strictEqual(result.actionRequired, false);
|
|
});
|
|
|
|
test('categories constant is exposed and stable', () => {
|
|
assert.ok(Array.isArray(DRIFT_CATEGORIES));
|
|
assert.deepStrictEqual(
|
|
[...DRIFT_CATEGORIES].sort(),
|
|
['barrel', 'migration', 'new_dir', 'route'],
|
|
);
|
|
});
|
|
});
|
|
|
|
// ─── Unit: non-blocking guarantee ────────────────────────────────────────────
|
|
|
|
describe('detectDrift — non-blocking guarantee', () => {
|
|
test('never throws on malformed input', () => {
|
|
assert.doesNotThrow(() => detectDrift({}));
|
|
assert.doesNotThrow(() => detectDrift({ addedFiles: null }));
|
|
assert.doesNotThrow(() => detectDrift({ addedFiles: ['x'], structureMd: undefined }));
|
|
});
|
|
|
|
test('malformed input returns a skipped result (never crashes the phase)', () => {
|
|
const r = detectDrift({});
|
|
assert.strictEqual(r.skipped, true);
|
|
assert.strictEqual(r.actionRequired, false);
|
|
});
|
|
});
|
|
|
|
// ─── Config validation: drift keys owned by the drift capability ──────────────
|
|
//
|
|
// After ADR-857 phase-6 migration, workflow.drift_threshold and workflow.drift_action
|
|
// are no longer in the central config schema manifest (VALID_CONFIG_KEYS). They are
|
|
// federated config keys owned exclusively by the `drift` capability in the registry.
|
|
// VALID_CONFIG_KEYS covers central-only keys; capability-owned keys resolve through
|
|
// the federated config overlay (loadConfig still returns them at their defaults).
|
|
|
|
const CAPABILITY_REGISTRY_PATH = path.join(
|
|
__dirname,
|
|
'..',
|
|
'gsd-core',
|
|
'bin',
|
|
'lib',
|
|
'capability-registry.cjs',
|
|
);
|
|
|
|
describe('config-schema — drift keys', () => {
|
|
test('workflow.drift_threshold owned by drift capability (not central)', () => {
|
|
const { isCentralConfigKey } = require(CONFIG_SCHEMA_PATH);
|
|
const registry = require(CAPABILITY_REGISTRY_PATH);
|
|
// Must be owned by the drift capability
|
|
assert.strictEqual(registry.configKeys['workflow.drift_threshold'], 'drift',
|
|
'workflow.drift_threshold must be owned by the drift capability');
|
|
// Must NOT be in central schema (migration complete)
|
|
assert.strictEqual(isCentralConfigKey('workflow.drift_threshold'), false,
|
|
'workflow.drift_threshold must not be a central config key after capability migration');
|
|
});
|
|
|
|
test('workflow.drift_action owned by drift capability (not central)', () => {
|
|
const { isCentralConfigKey } = require(CONFIG_SCHEMA_PATH);
|
|
const registry = require(CAPABILITY_REGISTRY_PATH);
|
|
// Must be owned by the drift capability
|
|
assert.strictEqual(registry.configKeys['workflow.drift_action'], 'drift',
|
|
'workflow.drift_action must be owned by the drift capability');
|
|
// Must NOT be in central schema (migration complete)
|
|
assert.strictEqual(isCentralConfigKey('workflow.drift_action'), false,
|
|
'workflow.drift_action must not be a central config key after capability migration');
|
|
});
|
|
});
|
|
|
|
describe('config-set drift validation via CLI', () => {
|
|
let tmp;
|
|
beforeEach(() => {
|
|
tmp = createTempGitProject('gsd-drift-cfg-');
|
|
});
|
|
afterEach(() => cleanup(tmp));
|
|
|
|
test('accepts warn', () => {
|
|
const r = runGsdTools(['config-set', 'workflow.drift_action', 'warn'], tmp);
|
|
assert.strictEqual(r.success, true, r.error);
|
|
});
|
|
|
|
test('accepts auto-remap', () => {
|
|
const r = runGsdTools(['config-set', 'workflow.drift_action', 'auto-remap'], tmp);
|
|
assert.strictEqual(r.success, true, r.error);
|
|
});
|
|
|
|
test('rejects bogus drift_action value', () => {
|
|
const r = runGsdTools(['config-set', 'workflow.drift_action', 'sometimes'], tmp);
|
|
assert.strictEqual(r.success, false);
|
|
});
|
|
|
|
test('drift_threshold accepts integer', () => {
|
|
const r = runGsdTools(['config-set', 'workflow.drift_threshold', '5'], tmp);
|
|
assert.strictEqual(r.success, true, r.error);
|
|
});
|
|
|
|
test('drift_threshold rejects non-numeric', () => {
|
|
const r = runGsdTools(['config-set', 'workflow.drift_threshold', 'many'], tmp);
|
|
assert.strictEqual(r.success, false);
|
|
});
|
|
});
|
|
|
|
// ─── Docs parity for CONFIGURATION.md ────────────────────────────────────────
|
|
|
|
describe('docs parity', () => {
|
|
test('workflow.drift_threshold mentioned in docs/CONFIGURATION.md', () => {
|
|
const md = fs.readFileSync(
|
|
path.join(__dirname, '..', 'docs', 'CONFIGURATION.md'),
|
|
'utf8',
|
|
);
|
|
assert.ok(md.includes('`workflow.drift_threshold`'));
|
|
});
|
|
|
|
test('workflow.drift_action mentioned in docs/CONFIGURATION.md', () => {
|
|
const md = fs.readFileSync(
|
|
path.join(__dirname, '..', 'docs', 'CONFIGURATION.md'),
|
|
'utf8',
|
|
);
|
|
assert.ok(md.includes('`workflow.drift_action`'));
|
|
});
|
|
});
|
|
|
|
// ─── Mapper --paths flag documented ──────────────────────────────────────────
|
|
|
|
describe('gsd-codebase-mapper --paths flag', () => {
|
|
test('agent doc mentions --paths', () => {
|
|
const doc = fs.readFileSync(
|
|
path.join(__dirname, '..', 'agents', 'gsd-codebase-mapper.md'),
|
|
'utf8',
|
|
);
|
|
assert.ok(/--paths/.test(doc));
|
|
});
|
|
|
|
test('AGENTS.md mentions --paths for mapper', () => {
|
|
const doc = fs.readFileSync(
|
|
path.join(__dirname, '..', 'docs', 'AGENTS.md'),
|
|
'utf8',
|
|
);
|
|
assert.ok(/--paths/.test(doc));
|
|
});
|
|
|
|
test('map-codebase workflow documents --paths passthrough', () => {
|
|
const doc = fs.readFileSync(
|
|
path.join(
|
|
__dirname,
|
|
'..',
|
|
'gsd-core',
|
|
'workflows',
|
|
'map-codebase.md',
|
|
),
|
|
'utf8',
|
|
);
|
|
assert.ok(/--paths/.test(doc));
|
|
});
|
|
});
|
|
|
|
// ─── Execute-phase workflow integration ──────────────────────────────────────
|
|
//
|
|
// After ADR-857 phase-6 migration, codebase_drift_gate is no longer an inline
|
|
// step in execute-phase.md. Instead, it is declared as a gate in the `drift`
|
|
// capability at the `execute:wave:post` hook point. The execute-phase.md
|
|
// dispatches capability gates via `gsd_run loop render-hooks execute:wave:post`,
|
|
// which fires the drift gates automatically.
|
|
|
|
describe('execute-phase integrates codebase_drift_gate', () => {
|
|
test('workflow references a codebase drift step', () => {
|
|
// After capability migration: the drift gate fires via execute:wave:post
|
|
// render-hooks dispatch. Verify two things:
|
|
// 1. execute-phase.md has the execute:wave:post render-hooks call site.
|
|
// 2. The drift capability declares a codebase-drift gate at execute:wave:post.
|
|
const doc = fs.readFileSync(
|
|
path.join(
|
|
__dirname,
|
|
'..',
|
|
'gsd-core',
|
|
'workflows',
|
|
'execute-phase.md',
|
|
),
|
|
'utf8',
|
|
);
|
|
// execute-phase.md must dispatch execute:wave:post hooks (the call site that fires drift gates)
|
|
assert.ok(
|
|
/loop render-hooks execute:wave:post/.test(doc),
|
|
'execute-phase.md must dispatch execute:wave:post hooks (drift capability gate call site)',
|
|
);
|
|
// The drift capability must declare a codebase-drift gate at execute:wave:post
|
|
const registry = require(CAPABILITY_REGISTRY_PATH);
|
|
const driftCap = registry.capabilities['drift'];
|
|
assert.ok(driftCap, 'drift capability must be registered');
|
|
const codebaseDriftGate = (driftCap.gates || []).find(
|
|
(g) => g.check && /codebase.drift/i.test(g.check.query),
|
|
);
|
|
assert.ok(
|
|
codebaseDriftGate,
|
|
'drift capability must declare a codebase-drift gate at execute:wave:post',
|
|
);
|
|
assert.strictEqual(codebaseDriftGate.point, 'execute:wave:post');
|
|
assert.strictEqual(codebaseDriftGate.blocking, false,
|
|
'codebase-drift gate must be non-blocking by contract');
|
|
});
|
|
|
|
test('workflow documents non-blocking guarantee for drift', () => {
|
|
const doc = fs.readFileSync(
|
|
path.join(
|
|
__dirname,
|
|
'..',
|
|
'gsd-core',
|
|
'workflows',
|
|
'execute-phase.md',
|
|
),
|
|
'utf8',
|
|
);
|
|
assert.ok(/non[- ]blocking/i.test(doc) || /continue on (error|failure)/i.test(doc));
|
|
});
|
|
});
|
|
|
|
// ─── CLI: verify codebase-drift subcommand ───────────────────────────────────
|
|
|
|
describe('verify codebase-drift CLI', () => {
|
|
let tmp;
|
|
beforeEach(() => {
|
|
tmp = createTempGitProject('gsd-drift-cli-');
|
|
fs.mkdirSync(path.join(tmp, '.planning', 'codebase'), { recursive: true });
|
|
});
|
|
afterEach(() => cleanup(tmp));
|
|
|
|
test('returns skipped JSON when STRUCTURE.md missing', () => {
|
|
const r = runGsdTools(['verify', 'codebase-drift'], tmp);
|
|
assert.strictEqual(r.success, true, r.error);
|
|
const data = JSON.parse(r.output);
|
|
assert.strictEqual(data.skipped, true);
|
|
assert.strictEqual(data.action_required, false);
|
|
});
|
|
|
|
test('returns no-drift result when STRUCTURE.md is fresh', () => {
|
|
const structure = path.join(tmp, '.planning', 'codebase', 'STRUCTURE.md');
|
|
fs.writeFileSync(structure, '# Codebase Structure\n\n- `src/`\n');
|
|
const head = git(tmp, 'rev-parse', 'HEAD');
|
|
writeMappedCommit(structure, head, '2026-04-22');
|
|
const r = runGsdTools(['verify', 'codebase-drift'], tmp);
|
|
assert.strictEqual(r.success, true, r.error);
|
|
const data = JSON.parse(r.output);
|
|
assert.strictEqual(data.action_required, false);
|
|
});
|
|
|
|
test('detects drift when new files added after last_mapped_commit', () => {
|
|
const structure = path.join(tmp, '.planning', 'codebase', 'STRUCTURE.md');
|
|
fs.writeFileSync(structure, '# Codebase Structure\n\n- `src/`\n');
|
|
const head = git(tmp, 'rev-parse', 'HEAD');
|
|
writeMappedCommit(structure, head, '2026-04-22');
|
|
git(tmp, 'add', '-A');
|
|
git(tmp, 'commit', '-m', 'map codebase');
|
|
for (const pkg of ['alpha', 'beta', 'gamma']) {
|
|
const dir = path.join(tmp, 'packages', pkg, 'src');
|
|
fs.mkdirSync(dir, { recursive: true });
|
|
fs.writeFileSync(path.join(dir, 'index.ts'), 'export {};\n');
|
|
}
|
|
git(tmp, 'add', '-A');
|
|
git(tmp, 'commit', '-m', 'add packages');
|
|
const r = runGsdTools(['verify', 'codebase-drift'], tmp);
|
|
assert.strictEqual(r.success, true, r.error);
|
|
const data = JSON.parse(r.output);
|
|
assert.strictEqual(data.action_required, true);
|
|
assert.strictEqual(data.directive, 'warn');
|
|
assert.ok(data.elements.length >= 3);
|
|
});
|
|
|
|
test('never exits non-zero when git repo is missing (non-blocking)', () => {
|
|
const nonGit = createTempProject('gsd-drift-nongit-');
|
|
try {
|
|
const r = runGsdTools(['verify', 'codebase-drift'], nonGit);
|
|
assert.strictEqual(r.success, true, 'must exit 0 even without git');
|
|
const data = JSON.parse(r.output);
|
|
assert.strictEqual(data.skipped, true);
|
|
} finally {
|
|
cleanup(nonGit);
|
|
}
|
|
});
|
|
});
|
|
|
|
// ─── Regression #1493 — workflow.drift_action / drift_threshold read from nested config shape ───
|
|
//
|
|
// loadConfig() returns a flattened object; config?.workflow was always undefined,
|
|
// making drift_action permanently 'warn' and drift_threshold always 3 regardless
|
|
// of .planning/config.json contents. Fix reads the raw nested JSON directly.
|
|
|
|
describe('verify codebase-drift — workflow config read from nested shape (#1493)', () => {
|
|
let tmp;
|
|
beforeEach(() => {
|
|
tmp = createTempGitProject('gsd-drift-1493-');
|
|
fs.mkdirSync(path.join(tmp, '.planning', 'codebase'), { recursive: true });
|
|
});
|
|
afterEach(() => cleanup(tmp));
|
|
|
|
test('workflow.drift_action=auto-remap in config.json is honored (not always warn) (#1493)', () => {
|
|
// Write config with nested workflow shape — the flat loadConfig() path would
|
|
// have silently dropped this, leaving action === 'warn'.
|
|
fs.writeFileSync(
|
|
path.join(tmp, '.planning', 'config.json'),
|
|
JSON.stringify({ workflow: { drift_action: 'auto-remap', drift_threshold: 1 } }, null, 2),
|
|
);
|
|
|
|
// Map codebase to current HEAD so anything committed next is "new" drift.
|
|
const structure = path.join(tmp, '.planning', 'codebase', 'STRUCTURE.md');
|
|
fs.writeFileSync(structure, '# Codebase Structure\n\n- `src/`\n');
|
|
writeMappedCommit(structure, git(tmp, 'rev-parse', 'HEAD'), '2026-04-22');
|
|
git(tmp, 'add', '-A');
|
|
git(tmp, 'commit', '-m', 'map codebase');
|
|
|
|
// Add one structural barrel file — enough to exceed drift_threshold of 1.
|
|
const dir = path.join(tmp, 'packages', 'ui', 'src');
|
|
fs.mkdirSync(dir, { recursive: true });
|
|
fs.writeFileSync(path.join(dir, 'index.ts'), 'export {};\n');
|
|
git(tmp, 'add', '-A');
|
|
git(tmp, 'commit', '-m', 'add package barrel');
|
|
|
|
const r = runGsdTools(['verify', 'codebase-drift'], tmp);
|
|
assert.strictEqual(r.success, true, r.error);
|
|
const data = JSON.parse(r.output);
|
|
assert.strictEqual(
|
|
data.action, 'auto-remap',
|
|
'workflow.drift_action=auto-remap must flow through from nested config; "warn" means the flat-shape bug is still active',
|
|
);
|
|
});
|
|
|
|
test('workflow.drift_threshold in config.json gates triggering (#1493)', () => {
|
|
// Threshold of 100 — 1 structural file should not trigger action_required.
|
|
fs.writeFileSync(
|
|
path.join(tmp, '.planning', 'config.json'),
|
|
JSON.stringify({ workflow: { drift_action: 'auto-remap', drift_threshold: 100 } }, null, 2),
|
|
);
|
|
|
|
const structure = path.join(tmp, '.planning', 'codebase', 'STRUCTURE.md');
|
|
fs.writeFileSync(structure, '# Codebase Structure\n\n- `src/`\n');
|
|
writeMappedCommit(structure, git(tmp, 'rev-parse', 'HEAD'), '2026-04-22');
|
|
git(tmp, 'add', '-A');
|
|
git(tmp, 'commit', '-m', 'map codebase');
|
|
|
|
const dir = path.join(tmp, 'packages', 'ui', 'src');
|
|
fs.mkdirSync(dir, { recursive: true });
|
|
fs.writeFileSync(path.join(dir, 'index.ts'), 'export {};\n');
|
|
git(tmp, 'add', '-A');
|
|
git(tmp, 'commit', '-m', 'add one package barrel');
|
|
|
|
const r = runGsdTools(['verify', 'codebase-drift'], tmp);
|
|
assert.strictEqual(r.success, true, r.error);
|
|
const data = JSON.parse(r.output);
|
|
assert.strictEqual(data.threshold, 100,
|
|
'workflow.drift_threshold=100 must be read from nested config; 3 means the flat-shape bug is still active');
|
|
assert.strictEqual(data.action_required, false,
|
|
'1 structural file must not exceed threshold of 100');
|
|
});
|
|
});
|
|
|
|
|
|
// ────────────────────────────────────────────────────────────────────────
|
|
// Folded from tests/bug-619-codebase-drift-gate-shim.test.cjs — consolidation epic #1969 (B6 #1975)
|
|
// ────────────────────────────────────────────────────────────────────────
|
|
{
|
|
const { describe: __foldDescribe } = require('node:test');
|
|
__foldDescribe("folded:bug-619-codebase-drift-gate-shim (consolidation epic #1969 B6 #1975)", () => {
|
|
// allow-test-rule: source-text-is-the-product (see #619)
|
|
// codebase-drift-gate.md is the shipped orchestration step contract. Bug #619:
|
|
// the initial drift check ran the bare PATH binary `gsd-tools verify codebase-drift`.
|
|
// On a shim-only install (gsd-tools.cjs present, `gsd-tools` not on PATH) that exits
|
|
// 127, `2>/dev/null` hides it, and the `|| echo` fallback marks the gate skipped —
|
|
// so post-execution drift detection silently never runs. The fix resolves gsd-tools
|
|
// through the runtime shim launcher (gsd_run), defining the canonical preamble once in
|
|
// this always-run block so the file stays compliant with the single-preamble parity
|
|
// invariant (the conditional auto-remap block reuses the launcher via shared shell scope).
|
|
//
|
|
// This file locks the source contract AND behaviorally proves the shim resolves: it runs
|
|
// the exact shipped drift-check block against a shim-only topology and asserts the shim
|
|
// actually executes, where the old bare-binary form would have skipped.
|
|
|
|
'use strict';
|
|
|
|
const { test, describe } = require('node:test');
|
|
const assert = require('node:assert/strict');
|
|
const fs = require('node:fs');
|
|
const os = require('node:os');
|
|
const path = require('node:path');
|
|
const { execFileSync } = require('node:child_process');
|
|
const { cleanup } = require('./helpers.cjs');
|
|
|
|
const GATE_MD = path.join(
|
|
__dirname, '..', 'gsd-core', 'workflows', 'execute-phase', 'steps', 'codebase-drift-gate.md',
|
|
);
|
|
const SNIPPET_FILE = path.join(__dirname, '..', 'gsd-core', 'workflows', '_runtime-launcher.snippet.sh');
|
|
|
|
function readGate() {
|
|
return fs.readFileSync(GATE_MD, 'utf8');
|
|
}
|
|
|
|
// Extract the Nth (0-based) ```bash fenced block body from the file.
|
|
function bashBlock(content, n) {
|
|
const blocks = [];
|
|
const re = /```bash\r?\n([\s\S]*?)```/g;
|
|
let m;
|
|
while ((m = re.exec(content)) !== null) blocks.push(m[1]);
|
|
assert.ok(blocks.length > n, `expected at least ${n + 1} bash blocks, found ${blocks.length}`);
|
|
return blocks[n];
|
|
}
|
|
|
|
describe('bug #619 — codebase-drift-gate resolves gsd-tools via the runtime shim, not the bare PATH binary', () => {
|
|
test('codebase-drift-gate.md is readable', () => {
|
|
assert.ok(readGate().length > 0, 'codebase-drift-gate.md must not be empty');
|
|
});
|
|
|
|
// ── Source contract (the .md is the product) ──────────────────────────────
|
|
|
|
test('the drift check resolves gsd-tools via the shim launcher (gsd_run), not the bare binary (#619)', () => {
|
|
const content = readGate();
|
|
assert.match(
|
|
content,
|
|
/DRIFT=\$\(gsd_run verify codebase-drift 2>\/dev\/null \|\| echo '\{"skipped":true,"reason":"sdk-failed"\}'\)/,
|
|
'drift check must call `gsd_run verify codebase-drift` with the non-blocking skip fallback',
|
|
);
|
|
assert.doesNotMatch(
|
|
content,
|
|
/\bgsd-tools verify codebase-drift\b/,
|
|
'the bare `gsd-tools verify codebase-drift` PATH-binary call (the #619 bug) must be gone',
|
|
);
|
|
});
|
|
|
|
test('non-blocking contract preserved: the skip JSON fallback is intact (#619)', () => {
|
|
const content = readGate();
|
|
assert.match(
|
|
content,
|
|
/\|\| echo '\{"skipped":true,"reason":"sdk-failed"\}'/,
|
|
'an internal drift-command failure must still fall through to the skip JSON',
|
|
);
|
|
});
|
|
|
|
test('exactly one canonical launcher preamble, in the drift-check block, before any launcher call (#619)', () => {
|
|
const content = readGate();
|
|
const snippet = fs.readFileSync(SNIPPET_FILE, 'utf8').replace(/\r?\n$/, '');
|
|
|
|
// Count canonical preamble occurrences across the whole file (parity: exactly one).
|
|
let count = 0;
|
|
let pos = 0;
|
|
for (;;) {
|
|
const idx = content.indexOf(snippet, pos);
|
|
if (idx === -1) break;
|
|
count++;
|
|
pos = idx + snippet.length;
|
|
}
|
|
assert.equal(count, 1, `expected exactly one canonical preamble; found ${count}`);
|
|
|
|
// The preamble must live in the first (drift-check) bash block, before the DRIFT call.
|
|
const block0 = bashBlock(content, 0);
|
|
assert.ok(block0.includes(snippet), 'the canonical preamble must be in the drift-check block');
|
|
assert.ok(
|
|
block0.indexOf(snippet) < block0.indexOf('gsd_run verify codebase-drift'),
|
|
'the preamble must precede the gsd_run drift call in the same block',
|
|
);
|
|
|
|
// The auto-remap block reuses gsd_run but must NOT carry its own preamble.
|
|
const content2 = content.slice(content.indexOf('AGENT_SKILLS_MAPPER'));
|
|
assert.ok(!content2.includes(snippet), 'the auto-remap block must not re-declare the preamble (single-preamble parity)');
|
|
});
|
|
|
|
// ── Behavioral proof: the shim resolves on a shim-only topology ───────────
|
|
|
|
test('shipped drift-check block runs the shim (gsd-tools.cjs), not skip, on a shim-only install (#619)', () => {
|
|
const tmp = fs.mkdtempSync(path.join(os.tmpdir(), 'gsd-619-'));
|
|
try {
|
|
// Shim-only topology: gsd-tools.cjs present under RUNTIME_DIR; no `gsd-tools` on PATH.
|
|
const binDir = path.join(tmp, 'gsd-core', 'bin');
|
|
fs.mkdirSync(binDir, { recursive: true });
|
|
fs.writeFileSync(
|
|
path.join(binDir, 'gsd-tools.cjs'),
|
|
'if (process.argv[2] === "verify" && process.argv[3] === "codebase-drift") {\n' +
|
|
' process.stdout.write(JSON.stringify({ action_required: false, sentinel: "SHIM_RAN" }));\n' +
|
|
'}\n',
|
|
);
|
|
|
|
const block = bashBlock(readGate(), 0) + '\nprintf "%s" "$DRIFT"\n';
|
|
const out = execFileSync('bash', ['-c', block], {
|
|
env: { ...process.env, RUNTIME_DIR: tmp },
|
|
encoding: 'utf8',
|
|
});
|
|
|
|
assert.match(out, /SHIM_RAN/, 'the drift check must execute the resolved shim, proving gsd_run resolution');
|
|
assert.doesNotMatch(out, /sdk-failed/, 'the gate must NOT silently skip when the shim is present (#619)');
|
|
} finally {
|
|
cleanup(tmp);
|
|
}
|
|
});
|
|
|
|
test('red-proof: the old bare `gsd-tools` form would skip when gsd-tools is not on PATH', () => {
|
|
// Documents the #619 bug: the pre-fix bare-binary call, with no `gsd-tools` on PATH,
|
|
// hits the 127 → `|| echo` skip path even though the shim (gsd-tools.cjs) exists.
|
|
const oldForm =
|
|
'DRIFT=$(gsd-tools verify codebase-drift 2>/dev/null || echo \'{"skipped":true,"reason":"sdk-failed"}\'); printf "%s" "$DRIFT"';
|
|
const out = execFileSync('bash', ['-c', 'export PATH=/nonexistent-empty-path; ' + oldForm], {
|
|
env: { ...process.env },
|
|
encoding: 'utf8',
|
|
});
|
|
assert.match(out, /sdk-failed/, 'sanity: the bare-binary form skips without gsd-tools on PATH — the bug the fix removes');
|
|
});
|
|
});
|
|
});
|
|
}
|