Files
msd-core/tests/bug-2439-set-profile-gsd-sdk-preflight.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

87 lines
4.1 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.
/**
* Regression test for bug #2439
*
* /gsd-set-profile crashed with `command not found: gsd-sdk` when the
* gsd-sdk binary was not installed or not in PATH. The command body
* invoked `gsd-sdk query config-set-model-profile` directly with no
* pre-flight check, so missing gsd-sdk produced an opaque shell error.
*
* Fix mirrors bug #2334: guard the invocation with `command -v gsd-sdk`
* and emit an install hint when absent.
*/
'use strict';
const { test, describe } = require('node:test');
const assert = require('node:assert/strict');
const fs = require('fs');
const path = require('path');
// #2790: set-profile.md was consolidated into config.md as the --profile flag.
// The gsd-sdk pre-flight check logic moved to config.md body.
const COMMAND_PATH = path.join(__dirname, '..', 'commands', 'gsd', 'config.md');
describe('bug #2439: /gsd-set-profile gsd-sdk pre-flight check', () => {
test('command file exists (config.md — absorbed set-profile in #2790)', () => {
assert.ok(fs.existsSync(COMMAND_PATH), 'commands/gsd/config.md should exist (absorbed set-profile)');
});
test('config.md --profile flag references gsd-sdk config-set-model-profile', () => {
const content = fs.readFileSync(COMMAND_PATH, 'utf-8');
assert.ok(
content.includes('gsd-sdk query config-set-model-profile') || content.includes('config-set-model-profile'),
'config.md must reference gsd-sdk query config-set-model-profile for --profile flag'
);
});
test('pre-flight guard for #2439 is explicitly documented in config.md --profile path', () => {
// The original #2439 bug: gsd-sdk was invoked with no pre-flight check, producing
// an opaque "command not found: gsd-sdk" error.
//
// Structural assertion (no raw .includes() on the whole file): isolate the
// <context> block, locate the --profile branch, then verify it documents both
// (a) the pre-flight check (`command -v gsd-sdk`) and (b) the install hint
// BEFORE the gsd-sdk invocation. Otherwise the regression returns silently.
const content = fs.readFileSync(COMMAND_PATH, 'utf-8');
const ctxMatch = content.match(/<context>([\s\S]*?)<\/context>/);
assert.ok(ctxMatch, 'config.md must contain a <context> block describing flag routing');
const ctx = ctxMatch[1];
// Find the --profile bullet (everything from the --profile mention up to the
// next top-level `- ` bullet that does not start with `--profile`).
const profileBranchMatch = ctx.match(/- If it starts with `--profile`[\s\S]*?(?=\n- (?!\s)[A-Z])/);
assert.ok(profileBranchMatch, 'config.md <context> must contain a --profile branch');
const profileBranch = profileBranchMatch[0];
// (a) pre-flight check token
assert.ok(
/command -v gsd-sdk/.test(profileBranch),
'config.md --profile branch must document `command -v gsd-sdk` pre-flight check (#2439)'
);
// (b) install hint near the guard, not after the invocation
assert.ok(
/install/i.test(profileBranch),
'config.md --profile branch must surface an install hint when gsd-sdk is absent (#2439)'
);
// (c) #2439 reference so future maintainers can trace the contract
assert.ok(
/#2439/.test(profileBranch),
'config.md --profile branch must cite #2439 so the regression contract is discoverable'
);
// (d) ordering: the pre-flight guard text must appear BEFORE the actual
// `gsd-sdk query config-set-model-profile` invocation in the same branch.
const guardIdx = profileBranch.indexOf('command -v gsd-sdk');
const invokeIdx = profileBranch.indexOf('gsd-sdk query config-set-model-profile');
assert.notEqual(guardIdx, -1, 'guard token missing');
assert.notEqual(invokeIdx, -1, 'invocation token missing');
assert.ok(guardIdx < invokeIdx, 'pre-flight guard must appear before the gsd-sdk invocation (#2439 contract)');
});
});