Files
get-shit-done/tests/execute-phase-worktree-artifacts.test.cjs
Tom Boucher 918f987a19 feat(#2982): extend no-source-grep lint to catch var-binding readFileSync.includes() (#2985)
* 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
2026-05-01 19:50:10 -04:00

133 lines
5.5 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.
/**
* Execute-phase worktree shared artifact ownership tests
*
* Guards against bug #1571: worktree executor agents independently writing
* STATE.md and ROADMAP.md, causing last-merge-wins overwrites.
*
* Fix: In parallel worktree mode, remove STATE.md/ROADMAP.md update requirements
* from the executor agent success_criteria. The orchestrator owns those writes
* after each wave via single-writer post-wave commands.
*/
const { test, describe } = require('node:test');
const assert = require('node:assert/strict');
const fs = require('fs');
const path = require('path');
const WORKFLOW_PATH = path.join(__dirname, '..', 'get-shit-done', 'workflows', 'execute-phase.md');
describe('execute-phase worktree: shared artifact ownership (#1571)', () => {
test('workflow file exists', () => {
assert.ok(fs.existsSync(WORKFLOW_PATH), 'workflows/execute-phase.md should exist');
});
test('worktree executor agent success_criteria does NOT include STATE.md update', () => {
const content = fs.readFileSync(WORKFLOW_PATH, 'utf-8');
// Extract the worktree Task() block (between "Worktree mode" and "Sequential mode")
const worktreeMatch = content.match(
/\*\*Worktree mode\*\*[\s\S]*?<success_criteria>([\s\S]*?)<\/success_criteria>/
);
assert.ok(worktreeMatch, 'should find success_criteria inside the worktree mode Task block');
const criteria = worktreeMatch[1];
assert.ok(
!criteria.includes('STATE.md'),
'worktree executor success_criteria must NOT reference STATE.md (orchestrator owns this write)'
);
});
test('worktree executor agent success_criteria does NOT include ROADMAP.md update', () => {
const content = fs.readFileSync(WORKFLOW_PATH, 'utf-8');
// Extract the worktree Task() block
const worktreeMatch = content.match(
/\*\*Worktree mode\*\*[\s\S]*?<success_criteria>([\s\S]*?)<\/success_criteria>/
);
assert.ok(worktreeMatch, 'should find success_criteria inside the worktree mode Task block');
const criteria = worktreeMatch[1];
assert.ok(
!criteria.includes('ROADMAP.md'),
'worktree executor success_criteria must NOT reference ROADMAP.md (orchestrator owns this write)'
);
});
test('worktree executor agent success_criteria includes SUMMARY.md creation', () => {
const content = fs.readFileSync(WORKFLOW_PATH, 'utf-8');
// SUMMARY.md is plan-local and safe for worktree agents to create
const worktreeMatch = content.match(
/\*\*Worktree mode\*\*[\s\S]*?<success_criteria>([\s\S]*?)<\/success_criteria>/
);
assert.ok(worktreeMatch, 'should find success_criteria inside the worktree mode Task block');
const criteria = worktreeMatch[1];
assert.ok(
criteria.includes('SUMMARY.md'),
'worktree executor success_criteria should still require SUMMARY.md creation'
);
});
test('post-wave orchestrator runs roadmap update-plan-progress for each completed plan', () => {
const content = fs.readFileSync(WORKFLOW_PATH, 'utf-8');
assert.ok(
content.includes('roadmap update-plan-progress'),
'post-wave section should contain orchestrator-owned roadmap update-plan-progress command'
);
// Confirm it is in a post-wave context, not only inside an agent prompt
const postWaveIdx = content.indexOf('roadmap update-plan-progress');
const worktreeAgentStart = content.indexOf('isolation="worktree"');
const worktreeAgentEnd = content.indexOf('**Sequential mode**');
assert.ok(
postWaveIdx < worktreeAgentStart || postWaveIdx > worktreeAgentEnd,
'roadmap update-plan-progress must appear outside the worktree agent prompt (orchestrator-owned)'
);
});
test('ghost state update-position command removed from post-wave section (#1627)', () => {
const content = fs.readFileSync(WORKFLOW_PATH, 'utf-8');
assert.ok(
!content.includes('state update-position'),
'state update-position was a ghost reference (command never existed in CLI dispatcher) — should be removed'
);
});
test('sequential mode executor agent success_criteria still includes STATE.md update', () => {
const content = fs.readFileSync(WORKFLOW_PATH, 'utf-8');
// Extract the sequential mode Task() block
const seqMatch = content.match(
/\*\*Sequential mode\*\*[\s\S]*?<success_criteria>([\s\S]*?)<\/success_criteria>/
);
assert.ok(seqMatch, 'should find success_criteria inside the sequential mode Task block');
const criteria = seqMatch[1];
assert.ok(
criteria.includes('STATE.md'),
'sequential executor success_criteria should still require STATE.md update (no conflict risk)'
);
});
test('sequential mode executor agent success_criteria still includes ROADMAP.md update', () => {
const content = fs.readFileSync(WORKFLOW_PATH, 'utf-8');
// Extract the sequential mode Task() block
const seqMatch = content.match(
/\*\*Sequential mode\*\*[\s\S]*?<success_criteria>([\s\S]*?)<\/success_criteria>/
);
assert.ok(seqMatch, 'should find success_criteria inside the sequential mode Task block');
const criteria = seqMatch[1];
assert.ok(
criteria.includes('ROADMAP.md'),
'sequential executor success_criteria should still require ROADMAP.md update (no conflict risk)'
);
});
});