import { spawnSync } from "node:child_process"; import type { CiGateContract } from "../contracts/ci-gates.ts"; import { classifyGateStepResult, type GateStepExpectation } from "./ci-step-result.ts"; import { FIXTURE_PNPM_ENVIRONMENT } from "./fixture-node-modules.ts"; import type { RemovalCheck } from "./removal-fixture.ts"; /** * 1103/12-02. test:feature-scaffold proves that a feature from * `create:feature` passes the merge gates. It ran a hand-kept list of 15 * commands while the merge stage has 88, so a template change that broke a * generated feature in any other merge command passed FE-GATE-020. * * The drill now runs the merge stage of the copy's config/ci/gates.json, in * stage order, each command once. A command added to the merge stage runs here * unless this list names it, with the reason it cannot run in the drill. */ const BROWSER = "needs Playwright browsers. FE-GATE-020 runs in a merge job without them " + "(merge_test installs none). The generated routes in the browser " + "gates are reviewed as 1103/12-01 and 12-03."; const DRILL = "a removal drill copies the repository again. The drill runs the generated " + "feature's own removal instead (feature-removal)."; export const SCAFFOLD_DRILL_EXCLUDED_SCRIPTS: Readonly> = Object.freeze({ "verify:lockfile": "runs pnpm install, which writes into the node_modules the copy links from " + "the repository (scripts/lib/fixture-node-modules.ts).", "test:e2e": BROWSER, "test:browser-capabilities": BROWSER, "verify:browser-capability-evidence": `reads the test:browser-capabilities results; ${BROWSER}`, "test:storybook": BROWSER, "test:visual": BROWSER, "check:test-evidence:browser": `reads the browser gates' results; ${BROWSER}`, "test:a11y": BROWSER, "test:system": "needs the CI runner's bubblewrap, systemd and cgroup v2 " + "(scripts/check-system-test-prerequisites.ts). It tests the provider " + "sandbox, which a feature does not reach.", "test:sample-removal": DRILL, "test:feature-scaffold": "is this drill.", "test:optional-recipe-removal": DRILL, "test:browser-file-storage-removal": DRILL, "test:realtime-removal": DRILL, }); export type ScaffoldDrillCommand = Readonly<{ /** `:`, the check's name in the drill report. */ name: string; script: string; args: readonly string[]; expectation: GateStepExpectation; }>; type ContractShape = Pick; export function scaffoldDrillCommands( contract: ContractShape, excluded: Readonly> = SCAFFOLD_DRILL_EXCLUDED_SCRIPTS, ): readonly ScaffoldDrillCommand[] { const merge = contract.stages.find(({ id }) => id === "merge"); if (!merge) throw new TypeError("the CI contract has no merge stage"); const commands = new Map(contract.commands.map((command) => [command.id, command])); const mergeScripts = new Set(); const seen = new Set(); const selected: ScaffoldDrillCommand[] = []; for (const gateId of merge.gateIds) { const gate = contract.gates.find(({ id }) => id === gateId); if (!gate) throw new TypeError(`the merge stage names an undefined gate: ${gateId}`); for (const commandId of gate.commandIds) { const command = commands.get(commandId); if (!command) throw new TypeError(`${gateId} names an undefined command: ${commandId}`); mergeScripts.add(command.script); if (seen.has(commandId) || Object.hasOwn(excluded, command.script)) continue; seen.add(commandId); selected.push(Object.freeze({ name: `${gateId}:${commandId}`, script: command.script, args: Object.freeze([...(command.args ?? [])]), expectation: command.expect === "pass" ? Object.freeze({ kind: "pass" as const }) : Object.freeze({ kind: "fail" as const, expectedExitCode: command.expectedExitCode ?? 1, expectedDiagnosticId: command.expectedDiagnosticId ?? "", }), })); } } // An exclusion for a command that moved out of the merge stage would hide // nothing today and silently drop it if it came back. A command the contract // no longer has at all (a removal drill pruned its capability) is not stale. const contractScripts = new Set(contract.commands.map(({ script }) => script)); const stale = Object.keys(excluded).filter( (script) => contractScripts.has(script) && !mergeScripts.has(script), ); if (stale.length > 0) { throw new TypeError( `the scaffold drill excludes scripts the contract runs outside the merge stage: ${stale.join(", ")}`, ); } return Object.freeze(selected); } /** * Runs one merge command in the fixture. A negative fixture command passes * only with its registered exit code and diagnostic, as in run-ci-gate.ts. */ export function runScaffoldDrillCommand( command: ScaffoldDrillCommand, root: string, pnpmCli: string, ): RemovalCheck { const capture = command.expectation.kind === "fail"; const result = spawnSync(process.execPath, [pnpmCli, command.script, ...command.args], { cwd: root, encoding: "utf8", stdio: capture ? "pipe" : "inherit", maxBuffer: 64 * 1024 * 1024, env: { ...process.env, ...FIXTURE_PNPM_ENVIRONMENT }, }); if (capture) { process.stdout.write(result.stdout ?? ""); process.stderr.write(result.stderr ?? ""); } const classification = classifyGateStepResult(command.expectation, { status: result.status, signal: result.signal, stdout: result.stdout ?? "", stderr: result.stderr ?? "", ...(result.error ? { error: { code: (result.error as NodeJS.ErrnoException).code } } : {}), }); if (classification.expectationMet) return { name: command.name, passed: true }; const invocation = `corepack pnpm ${[command.script, ...command.args].join(" ")}`; return { name: command.name, passed: false, failure: command.expectation.kind === "fail" ? `${invocation}: ${classification.kind}, expected exit ${command.expectation.expectedExitCode} with ${JSON.stringify(command.expectation.expectedDiagnosticId)}, got exit ${result.status ?? result.signal}` : `${invocation} exited ${result.status ?? result.signal ?? "on a spawn error"}`, }; }