a9a7a328e6
Mechanical rename produced by scripts/msd-rename.cjs: gsd/Gsd/GSD -> msd/Msd/MSD across contents and paths, upstream package/repo coordinates -> @golem15/msd-core and golem15com/msd-core. Deep links into upstream history, sibling upstream packages, the GSD-2 import feature, CHANGELOG.md and .changeset/ are kept as-is. Hand edits on top: MSD block-letter banner and logos, LICENSE copyright line, package/plugin identity, regenerated lockfile, install-tree fixtures, derived registries and benchmark baseline; migration checksum baseline re-locked (MSD keeps its own install state, so no install had applied the old sums); sort-order and regex-escaped expectations in tests adjusted.
448 lines
19 KiB
JavaScript
448 lines
19 KiB
JavaScript
'use strict';
|
|
|
|
// 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.
|
|
|
|
/**
|
|
* Tests for /msd-edit-phase (#2617)
|
|
*
|
|
* Covers:
|
|
* - Command file and workflow file existence
|
|
* - Single-field edit instructions
|
|
* - Full-phase regeneration from clarified intent
|
|
* - Invalid depends_on blocks with clear error
|
|
* - Guarded edit of in_progress phase without --force
|
|
* - --force override of status guard
|
|
* - Invalid phase number produces clear error
|
|
* - Diff + confirmation before writing
|
|
* - Phase number and position are preserved
|
|
*/
|
|
|
|
const { describe, test } = require('node:test');
|
|
const assert = require('node:assert/strict');
|
|
const fs = require('node:fs');
|
|
const path = require('node:path');
|
|
const { splitTableRow } = require('../msd-core/bin/lib/markdown-table.cjs');
|
|
|
|
const ROOT = path.resolve(__dirname, '..');
|
|
|
|
// #2790: edit-phase.md was consolidated into phase.md as the --edit flag.
|
|
// The COMMAND_PATH here now points to the consolidated command.
|
|
const COMMAND_PATH = path.join(ROOT, 'commands', 'msd', 'phase.md');
|
|
const WORKFLOW_PATH = path.join(ROOT, 'msd-core', 'workflows', 'edit-phase.md');
|
|
|
|
// ─── File existence ──────────────────────────────────────────────────────────
|
|
|
|
describe('edit-phase: file existence', () => {
|
|
test('commands/msd/phase.md exists (absorbed edit-phase in #2790)', () => {
|
|
assert.ok(fs.existsSync(COMMAND_PATH), 'commands/msd/phase.md should exist (consolidates edit-phase)');
|
|
});
|
|
|
|
test('msd-core/workflows/edit-phase.md exists', () => {
|
|
assert.ok(fs.existsSync(WORKFLOW_PATH), 'msd-core/workflows/edit-phase.md should exist');
|
|
});
|
|
});
|
|
|
|
// ─── Command file structure ───────────────────────────────────────────────────
|
|
|
|
describe('edit-phase: command file structure', () => {
|
|
test('consolidated phase.md has correct name frontmatter (#2790)', () => {
|
|
const content = fs.readFileSync(COMMAND_PATH, 'utf-8');
|
|
assert.ok(/^name:\s*msd:phase/m.test(content), 'name should be msd:phase (consolidated)');
|
|
});
|
|
|
|
test('command file has description frontmatter', () => {
|
|
const content = fs.readFileSync(COMMAND_PATH, 'utf-8');
|
|
assert.ok(/^description:/m.test(content), 'should have description frontmatter');
|
|
});
|
|
|
|
test('command file references edit-phase workflow', () => {
|
|
const content = fs.readFileSync(COMMAND_PATH, 'utf-8');
|
|
assert.ok(
|
|
content.includes('edit-phase.md'),
|
|
'command file should reference edit-phase workflow'
|
|
);
|
|
});
|
|
|
|
test('command file documents --force flag (passed through --edit)', () => {
|
|
const content = fs.readFileSync(COMMAND_PATH, 'utf-8');
|
|
assert.ok(content.includes('--edit') || content.includes('--force'), 'command file should document --edit flag (which supports --force)');
|
|
});
|
|
});
|
|
|
|
// ─── Workflow: single-field edit ─────────────────────────────────────────────
|
|
|
|
describe('edit-phase workflow: single-field edit', () => {
|
|
test('workflow instructs presenting current field values before editing', () => {
|
|
const content = fs.readFileSync(WORKFLOW_PATH, 'utf-8');
|
|
const showsCurrentValues = (
|
|
/current\s+value/i.test(content) ||
|
|
/present.*current/i.test(content) ||
|
|
/display.*current/i.test(content) ||
|
|
/current_value/i.test(content)
|
|
);
|
|
assert.ok(showsCurrentValues, 'workflow must present current field values before editing');
|
|
});
|
|
|
|
test('workflow supports editing specific fields individually', () => {
|
|
const content = fs.readFileSync(WORKFLOW_PATH, 'utf-8');
|
|
const supportsIndividualFields = (
|
|
/specific\s+field/i.test(content) ||
|
|
/individual\s+field/i.test(content) ||
|
|
/edit.*field/i.test(content)
|
|
);
|
|
assert.ok(supportsIndividualFields, 'workflow must support editing individual fields');
|
|
});
|
|
|
|
test('workflow covers title, goal, depends_on, requirements, success_criteria fields', () => {
|
|
const content = fs.readFileSync(WORKFLOW_PATH, 'utf-8');
|
|
assert.ok(/\btitle\b/i.test(content), 'workflow should mention title field');
|
|
assert.ok(/\bgoal\b/i.test(content), 'workflow should mention goal field');
|
|
assert.ok(/depends_on/i.test(content), 'workflow should mention depends_on field');
|
|
assert.ok(/requirements/i.test(content), 'workflow should mention requirements field');
|
|
assert.ok(/success_criteria/i.test(content), 'workflow should mention success_criteria field');
|
|
});
|
|
});
|
|
|
|
// ─── Workflow: full-phase regeneration ───────────────────────────────────────
|
|
|
|
describe('edit-phase workflow: full-phase regeneration', () => {
|
|
test('workflow supports regenerating all fields from clarified intent', () => {
|
|
const content = fs.readFileSync(WORKFLOW_PATH, 'utf-8');
|
|
const supportsRegen = (
|
|
/regenerate/i.test(content) ||
|
|
/rewrite.*all/i.test(content) ||
|
|
/all.*from.*clarified/i.test(content) ||
|
|
/clarified.*intent/i.test(content)
|
|
);
|
|
assert.ok(supportsRegen, 'workflow must support full regeneration from clarified intent');
|
|
});
|
|
|
|
test('workflow prompts user for clarified intent during full regeneration', () => {
|
|
const content = fs.readFileSync(WORKFLOW_PATH, 'utf-8');
|
|
const promptsClarifiedIntent = (
|
|
/clarified?\s+intent/i.test(content) ||
|
|
/revised\s+intent/i.test(content) ||
|
|
/describe.*revised/i.test(content)
|
|
);
|
|
assert.ok(
|
|
promptsClarifiedIntent,
|
|
'workflow must prompt user for clarified intent during full regeneration'
|
|
);
|
|
});
|
|
});
|
|
|
|
// ─── Workflow: invalid depends_on ────────────────────────────────────────────
|
|
|
|
describe('edit-phase workflow: depends_on validation', () => {
|
|
test('workflow validates depends_on references against existing phases', () => {
|
|
const content = fs.readFileSync(WORKFLOW_PATH, 'utf-8');
|
|
const validatesDepends = (
|
|
/validate.*depends/i.test(content) ||
|
|
/depends.*valid/i.test(content) ||
|
|
/invalid.*depends/i.test(content) ||
|
|
/depends_on.*valid/i.test(content)
|
|
);
|
|
assert.ok(validatesDepends, 'workflow must validate depends_on references');
|
|
});
|
|
|
|
test('workflow blocks write when depends_on references invalid phase', () => {
|
|
const content = fs.readFileSync(WORKFLOW_PATH, 'utf-8');
|
|
const blocksInvalidRef = (
|
|
/invalid.*phase/i.test(content) &&
|
|
/exit|block|error/i.test(content)
|
|
);
|
|
assert.ok(blocksInvalidRef, 'workflow must block write for invalid depends_on references');
|
|
});
|
|
|
|
test('workflow validates that depends_on does not reference the phase itself', () => {
|
|
const content = fs.readFileSync(WORKFLOW_PATH, 'utf-8');
|
|
const preventsCircular = (
|
|
/not reference itself/i.test(content) ||
|
|
/circular/i.test(content) ||
|
|
/self-reference/i.test(content) ||
|
|
/itself/i.test(content)
|
|
);
|
|
assert.ok(preventsCircular, 'workflow must prevent self-referencing depends_on');
|
|
});
|
|
});
|
|
|
|
// ─── Workflow: status guard ───────────────────────────────────────────────────
|
|
|
|
describe('edit-phase workflow: in-progress/completed status guard', () => {
|
|
test('workflow checks phase status before allowing edit', () => {
|
|
const content = fs.readFileSync(WORKFLOW_PATH, 'utf-8');
|
|
const checksStatus = (
|
|
/disk_status/i.test(content) ||
|
|
/phase.*status/i.test(content) ||
|
|
/status.*check/i.test(content)
|
|
);
|
|
assert.ok(checksStatus, 'workflow must check phase status before allowing edit');
|
|
});
|
|
|
|
test('workflow refuses to edit in_progress phases without --force', () => {
|
|
const content = fs.readFileSync(WORKFLOW_PATH, 'utf-8');
|
|
const refusesInProgress = (
|
|
/in.progress/i.test(content) &&
|
|
/--force/i.test(content)
|
|
);
|
|
assert.ok(refusesInProgress, 'workflow must refuse in_progress edits without --force');
|
|
});
|
|
|
|
test('workflow refuses to edit completed phases without --force', () => {
|
|
const content = fs.readFileSync(WORKFLOW_PATH, 'utf-8');
|
|
const refusesCompleted = (
|
|
/completed/i.test(content) &&
|
|
/--force/i.test(content)
|
|
);
|
|
assert.ok(refusesCompleted, 'workflow must refuse completed phase edits without --force');
|
|
});
|
|
|
|
test('workflow allows edit with --force flag override', () => {
|
|
const content = fs.readFileSync(WORKFLOW_PATH, 'utf-8');
|
|
const forcePath = content.match(/--force[\s\S]{0,300}/i);
|
|
assert.ok(forcePath, 'workflow must handle --force flag');
|
|
const forceSection = forcePath[0];
|
|
const allowsForce = (
|
|
/proceed|continue|allow|override/i.test(forceSection) ||
|
|
/force.*was.*passed/i.test(content) ||
|
|
/force.*passed/i.test(content)
|
|
);
|
|
assert.ok(allowsForce, 'workflow must allow editing when --force is passed');
|
|
});
|
|
});
|
|
|
|
// ─── Workflow: invalid phase number ──────────────────────────────────────────
|
|
|
|
describe('edit-phase workflow: invalid phase number', () => {
|
|
test('workflow produces clear error when phase number does not exist', () => {
|
|
const content = fs.readFileSync(WORKFLOW_PATH, 'utf-8');
|
|
const handlesNotFound = (
|
|
/not.*found/i.test(content) ||
|
|
/phase.*not.*found/i.test(content) ||
|
|
/does not exist/i.test(content)
|
|
);
|
|
assert.ok(handlesNotFound, 'workflow must error clearly when phase number does not exist');
|
|
});
|
|
|
|
test('workflow errors on missing phase number argument', () => {
|
|
const content = fs.readFileSync(WORKFLOW_PATH, 'utf-8');
|
|
const handlesNoArg = (
|
|
/no.*argument/i.test(content) ||
|
|
/required/i.test(content) ||
|
|
/phase number required/i.test(content)
|
|
);
|
|
assert.ok(handlesNoArg, 'workflow must error when phase number argument is missing');
|
|
});
|
|
});
|
|
|
|
// ─── Workflow: diff + confirmation ───────────────────────────────────────────
|
|
|
|
describe('edit-phase workflow: diff and confirmation', () => {
|
|
test('workflow shows diff of changes before writing', () => {
|
|
const content = fs.readFileSync(WORKFLOW_PATH, 'utf-8');
|
|
const showsDiff = (
|
|
/diff/i.test(content) ||
|
|
/proposed.*change/i.test(content) ||
|
|
/show.*change/i.test(content)
|
|
);
|
|
assert.ok(showsDiff, 'workflow must show a diff of changes before writing');
|
|
});
|
|
|
|
test('workflow asks for confirmation before writing', () => {
|
|
const content = fs.readFileSync(WORKFLOW_PATH, 'utf-8');
|
|
const asksConfirmation = (
|
|
/confirm/i.test(content) ||
|
|
/apply.*change/i.test(content) ||
|
|
/y\/n/i.test(content) ||
|
|
/yes.*no/i.test(content)
|
|
);
|
|
assert.ok(asksConfirmation, 'workflow must ask for confirmation before writing');
|
|
});
|
|
|
|
test('workflow exits without writing if user declines', () => {
|
|
const content = fs.readFileSync(WORKFLOW_PATH, 'utf-8');
|
|
const handlesDecline = (
|
|
/says.*n/i.test(content) ||
|
|
/user says.*n/i.test(content) ||
|
|
/if.*user.*n/i.test(content) ||
|
|
/exit.*without.*writing/i.test(content) ||
|
|
/without writing/i.test(content)
|
|
);
|
|
assert.ok(handlesDecline, 'workflow must exit without writing if user declines confirmation');
|
|
});
|
|
});
|
|
|
|
// ─── Workflow: phase number and position preservation ────────────────────────
|
|
|
|
describe('edit-phase workflow: phase number and position preservation', () => {
|
|
test('workflow preserves phase number when writing back', () => {
|
|
const content = fs.readFileSync(WORKFLOW_PATH, 'utf-8');
|
|
const preservesNumber = (
|
|
/number.*preserved/i.test(content) ||
|
|
/preserve.*number/i.test(content) ||
|
|
/position.*preserved/i.test(content) ||
|
|
/number and position/i.test(content)
|
|
);
|
|
assert.ok(preservesNumber, 'workflow must preserve phase number and position');
|
|
});
|
|
|
|
test('anti_patterns block renumbering', () => {
|
|
const content = fs.readFileSync(WORKFLOW_PATH, 'utf-8');
|
|
// eslint-disable-next-line local/no-unbounded-quantifier -- parses this repo's own workflow .md content, fixed-size author-controlled content
|
|
const antiPatterns = content.match(/<anti_patterns>([\s\S]*?)<\/anti_patterns>/i);
|
|
assert.ok(antiPatterns, 'workflow should have anti_patterns section');
|
|
assert.ok(
|
|
/renumber|number.*preserved|preserve.*number/i.test(antiPatterns[1]),
|
|
'anti_patterns must prohibit renumbering'
|
|
);
|
|
});
|
|
|
|
test('workflow writes phase back in place (replaces section, not full file)', () => {
|
|
const content = fs.readFileSync(WORKFLOW_PATH, 'utf-8');
|
|
const inPlace = (
|
|
/in.*place/i.test(content) ||
|
|
/replace.*section/i.test(content) ||
|
|
/section.*replace/i.test(content) ||
|
|
/replace.*old.*section/i.test(content)
|
|
);
|
|
assert.ok(inPlace, 'workflow must write phase back in place (section replacement)');
|
|
});
|
|
});
|
|
|
|
// ─── Workflow: milestone scope guard (#3262) ─────────────────────────────────
|
|
|
|
describe('edit-phase workflow: milestone scope guard (#3262)', () => {
|
|
test('workflow captures the milestone scope before writing the updated phase', () => {
|
|
const content = fs.readFileSync(WORKFLOW_PATH, 'utf-8');
|
|
// eslint-disable-next-line local/no-unbounded-quantifier -- parses this repo's own workflow .md content, fixed-size author-controlled content
|
|
const writeStep = content.match(/<step name="write_updated_phase">([\s\S]*?)<\/step>/);
|
|
assert.ok(writeStep, 'write_updated_phase step must exist');
|
|
assert.match(
|
|
writeStep[1],
|
|
/milestone-scope/,
|
|
'write_updated_phase must run the roadmap milestone-scope probe before writing'
|
|
);
|
|
assert.match(writeStep[1], /SCOPE_BEFORE/i, 'the pre-write capture must be named for the post-write comparison');
|
|
});
|
|
|
|
test('workflow re-derives the milestone scope after the write and rolls back on mismatch', () => {
|
|
const content = fs.readFileSync(WORKFLOW_PATH, 'utf-8');
|
|
// eslint-disable-next-line local/no-unbounded-quantifier -- parses this repo's own workflow .md content, fixed-size author-controlled content
|
|
const writeStep = content.match(/<step name="write_updated_phase">([\s\S]*?)<\/step>/);
|
|
assert.ok(writeStep, 'write_updated_phase step must exist');
|
|
assert.match(writeStep[1], /SCOPE_AFTER/i, 'the post-write re-derivation must be present');
|
|
assert.match(writeStep[1], /scope|phases/i, 'the comparison must cover the scope and the phase set');
|
|
assert.match(
|
|
writeStep[1],
|
|
/rollback|restore|revert|rolled back/i,
|
|
'a scope or phase-set mismatch must trigger rollback'
|
|
);
|
|
assert.match(
|
|
writeStep[1],
|
|
/milestone scope changed|scope changed/i,
|
|
'the rollback path must surface an explicit error'
|
|
);
|
|
});
|
|
|
|
test('milestone scope guard success criterion is checked (#3262)', () => {
|
|
const content = fs.readFileSync(WORKFLOW_PATH, 'utf-8');
|
|
// eslint-disable-next-line local/no-unbounded-quantifier -- parses this repo's own workflow .md content, fixed-size author-controlled content
|
|
const criteria = content.match(/<success_criteria>([\s\S]*?)<\/success_criteria>/);
|
|
assert.ok(criteria, 'workflow should have a success_criteria section');
|
|
assert.match(
|
|
criteria[1],
|
|
/milestone scope/i,
|
|
'success criteria must include the milestone-scope verification'
|
|
);
|
|
});
|
|
});
|
|
|
|
// ─── Workflow: STATE.md update ────────────────────────────────────────────────
|
|
|
|
describe('edit-phase workflow: STATE.md roadmap evolution', () => {
|
|
test('workflow updates STATE.md Roadmap Evolution after edit', () => {
|
|
const content = fs.readFileSync(WORKFLOW_PATH, 'utf-8');
|
|
const updatesState = (
|
|
/state\.add-roadmap-evolution/i.test(content) ||
|
|
/Roadmap Evolution/i.test(content)
|
|
);
|
|
assert.ok(updatesState, 'workflow must update STATE.md Roadmap Evolution after edit');
|
|
});
|
|
});
|
|
|
|
// ─── Docs registration ────────────────────────────────────────────────────────
|
|
|
|
describe('edit-phase: documentation registration', () => {
|
|
test('INVENTORY.md routes edit-phase workflow through consolidated /msd-phase --edit (#2790)', () => {
|
|
// #2790 absorbed /msd-edit-phase into /msd-phase as the --edit flag. The
|
|
// workflow file (edit-phase.md) survives, but its "Invoked by" column must
|
|
// point at the consolidated command surface, not the deleted standalone.
|
|
const inventory = fs.readFileSync(
|
|
path.join(ROOT, 'docs', 'INVENTORY.md'),
|
|
'utf-8'
|
|
);
|
|
// Locate the edit-phase.md row in the Workflows table and assert the
|
|
// "Invoked by" column documents /msd-phase --edit (not the deleted form).
|
|
const row = inventory
|
|
.split(/\r?\n/)
|
|
.map((line) => (line.trim().startsWith('|') ? splitTableRow(line) : null))
|
|
.find((cells) => cells && cells[0] === '`edit-phase.md`');
|
|
assert.ok(row, 'docs/INVENTORY.md must contain an edit-phase.md workflow row');
|
|
const invokedBy = row[2];
|
|
assert.ok(
|
|
/\/msd-phase\s+--edit/.test(invokedBy),
|
|
`edit-phase.md row must list "/msd-phase --edit" as caller; got: "${invokedBy}"`
|
|
);
|
|
assert.ok(
|
|
!/\/msd-edit-phase\b/.test(invokedBy),
|
|
`edit-phase.md row must not still cite the deleted /msd-edit-phase command; got: "${invokedBy}"`
|
|
);
|
|
});
|
|
|
|
test('INVENTORY.md contains edit-phase.md workflow', () => {
|
|
const inventory = fs.readFileSync(
|
|
path.join(ROOT, 'docs', 'INVENTORY.md'),
|
|
'utf-8'
|
|
);
|
|
assert.ok(
|
|
inventory.includes('edit-phase.md'),
|
|
'docs/INVENTORY.md must contain edit-phase.md workflow row'
|
|
);
|
|
});
|
|
|
|
test('INVENTORY-MANIFEST.json contains /msd-phase in commands (#2790: edit-phase absorbed into phase.md)', () => {
|
|
// #2790: /msd-edit-phase was absorbed into /msd-phase as the --edit flag.
|
|
// The manifest now records /msd-phase instead of /msd-edit-phase.
|
|
const manifest = JSON.parse(
|
|
fs.readFileSync(path.join(ROOT, 'docs', 'INVENTORY-MANIFEST.json'), 'utf-8')
|
|
);
|
|
assert.ok(
|
|
manifest.families.commands.includes('/msd-phase'),
|
|
'INVENTORY-MANIFEST.json must list /msd-phase in commands (absorbed /msd-edit-phase via #2790)'
|
|
);
|
|
});
|
|
|
|
test('INVENTORY-MANIFEST.json contains edit-phase.md in workflows', () => {
|
|
const manifest = JSON.parse(
|
|
fs.readFileSync(path.join(ROOT, 'docs', 'INVENTORY-MANIFEST.json'), 'utf-8')
|
|
);
|
|
assert.ok(
|
|
manifest.families.workflows.includes('edit-phase.md'),
|
|
'INVENTORY-MANIFEST.json must list edit-phase.md in workflows'
|
|
);
|
|
});
|
|
|
|
test('docs/COMMANDS.md documents /msd-phase (absorbed /msd-edit-phase via --edit flag, #2790)', () => {
|
|
const commands = fs.readFileSync(
|
|
path.join(ROOT, 'docs', 'COMMANDS.md'),
|
|
'utf-8'
|
|
);
|
|
assert.ok(
|
|
commands.includes('/msd-phase'),
|
|
'docs/COMMANDS.md must document /msd-phase (which absorbed /msd-edit-phase via --edit flag in #2790)'
|
|
);
|
|
});
|
|
});
|