diff --git a/scripts/lib/ci-gate-failure.ts b/scripts/lib/ci-gate-failure.ts new file mode 100644 index 00000000..e795dec1 --- /dev/null +++ b/scripts/lib/ci-gate-failure.ts @@ -0,0 +1,25 @@ +/** + * 1112/08-13. What a failed `ci:gate` prints to stderr: the gate, the command + * that failed (or that none did), the log with the whole output, and the end + * of that output, where the cause usually is. + */ +export function formatGateFailure(input: Readonly<{ + gateId: string; + gateName: string; + logPath: string; + failedCommand?: string | undefined; + output: readonly string[]; + tailLines?: number; +}>): string { + const tail = input.output + .flatMap((chunk) => chunk.split(/\r?\n/u)) + .filter((line) => line.trim() !== "") + .slice(-(input.tailLines ?? 20)); + return [ + `${input.gateId} ${input.gateName}: FAIL`, + ` failed command: ${input.failedCommand ?? "none (a check outside the commands)"}`, + ` log: ${input.logPath}`, + " last lines of the log:", + ...tail.map((line) => ` ${line}`), + ].join("\n"); +} diff --git a/scripts/run-ci-gate.ts b/scripts/run-ci-gate.ts index d1167601..92957f43 100644 --- a/scripts/run-ci-gate.ts +++ b/scripts/run-ci-gate.ts @@ -11,6 +11,7 @@ import { import { classifyGateStepResult } from "./lib/ci-step-result.ts"; import { withCiGatePreflight } from "./contracts/ci-gates.ts"; import { validateCiArtifact } from "./lib/ci-artifact-validator.ts"; +import { formatGateFailure } from "./lib/ci-gate-failure.ts"; import { writeCiGateLogAtomic } from "./lib/ci-gate-log.ts"; const requestedGateId = process.argv @@ -111,6 +112,7 @@ for (const variable of gate.requiresEnvironment ?? []) { } } +let failedCommand: string | undefined; if (passed) { for (const commandId of gate.commandIds) { const step = contractIndex.commands.get(commandId); @@ -174,6 +176,7 @@ if (passed) { }); if (!appendOutput(`classification: ${classification.kind}`)) passed = false; if (!classification.expectationMet) { + failedCommand = commandLine; appendOutput( `expectation failed: expected ${step.expect}, exit=${result.status}, signal=${result.signal ?? "none"}`, ...(step.expect === "fail" @@ -241,7 +244,15 @@ if (passed) { } if (!passed) { - process.stderr.write(`${gateId} ${gate.name}: FAIL\n`); + process.stderr.write( + `${formatGateFailure({ + gateId, + gateName: gate.name, + logPath: logArtifact.path, + failedCommand, + output, + })}\n`, + ); process.exit(1); } process.stdout.write( diff --git a/tests/unit/ci-gate-failure.test.ts b/tests/unit/ci-gate-failure.test.ts new file mode 100644 index 00000000..f3db4bb7 --- /dev/null +++ b/tests/unit/ci-gate-failure.test.ts @@ -0,0 +1,110 @@ +import { spawnSync } from "node:child_process"; +import { mkdir, mkdtemp, readFile, rm, writeFile } from "node:fs/promises"; +import { tmpdir } from "node:os"; +import path from "node:path"; + +import { describe, expect, it } from "vitest"; + +import { loadCiGateContract } from "../../scripts/contracts/ci-gates.ts"; +import { formatGateFailure } from "../../scripts/lib/ci-gate-failure.ts"; +import { FIXTURE_PNPM_ENVIRONMENT } from "../../scripts/lib/fixture-node-modules.ts"; +import { childProcessTimeout } from "../helpers/child-process-timeout.ts"; + +/** + * 1112/08-13. A failed `ci:gate` printed one line, `FE-GATE-013 security: + * FAIL`: neither the command that failed nor the log that holds the cause + * (.claude/rules/gates-and-budgets.md: a failure names what it crossed and + * where to look). + */ +describe("formatGateFailure", () => { + const output = [ + "$ corepack pnpm verify:lockfile", + "lockfile ok", + "classification: PASS", + "$ corepack pnpm test:system", + "System test prerequisites: FAIL\n - this host does not allow unprivileged user namespaces\n", + "classification: COMMAND_FAILURE", + "expectation failed: expected pass, exit=1, signal=none", + ]; + + it("names the gate, the failed command and the log", () => { + const text = formatGateFailure({ + gateId: "FE-GATE-013", + gateName: "security", + logPath: "artifacts/quality/gates/FE-GATE-013.txt", + failedCommand: "$ corepack pnpm test:system", + output, + }); + + expect(text.split("\n")[0]).toBe("FE-GATE-013 security: FAIL"); + expect(text).toContain("failed command: $ corepack pnpm test:system"); + expect(text).toContain("log: artifacts/quality/gates/FE-GATE-013.txt"); + }); + + it("quotes the end of the log, where the cause is", () => { + const text = formatGateFailure({ + gateId: "FE-GATE-013", + gateName: "security", + logPath: "artifacts/quality/gates/FE-GATE-013.txt", + failedCommand: "$ corepack pnpm test:system", + output, + tailLines: 4, + }); + + expect(text).toContain("this host does not allow unprivileged user namespaces"); + expect(text).toContain("expectation failed: expected pass, exit=1"); + expect(text).not.toContain("lockfile ok"); + }); + + it("says when no command failed (a check before or after the commands)", () => { + const text = formatGateFailure({ + gateId: "FE-GATE-005", + gateName: "unit", + logPath: "artifacts/quality/gates/FE-GATE-005.txt", + output: ["missing required environment: CI_RUNNER_IMAGE"], + }); + + expect(text).toContain("failed command: none (a check outside the commands)"); + expect(text).toContain("missing required environment: CI_RUNNER_IMAGE"); + }); +}); + +// round9 confirm review. The runner itself hands the failed command to that +// text: a gate whose one command fails names it, its log and its last line. +// Same temp-root runner as tests/system/ci-runner/ci-evidence-freshness.test.ts, +// whose measured run this reuses. +describe("run-ci-gate on a failing command", { timeout: childProcessTimeout(871) }, () => { + it("names the command, the log and the cause", async () => { + const root = await mkdtemp(path.join(tmpdir(), "ci-gate-failure-output-")); + try { + await mkdir(path.join(root, "config/ci"), { recursive: true }); + const contract = JSON.parse( + JSON.stringify(await loadCiGateContract(process.cwd())), + ) as { commands: { id: string; script: string }[] }; + const command = contract.commands.find((entry) => entry.id === "test-runtime-schema"); + if (!command) throw new Error("expected the runtime-schema command"); + command.script = "test:fails-on-purpose"; + const packageDocument = JSON.parse(await readFile("package.json", "utf8")) as { + scripts: Record; + }; + packageDocument.scripts[command.script] = + "node -e \"console.error('the cause of this failure'); process.exit(3)\""; + await writeFile(path.join(root, "config/ci/gates.json"), `${JSON.stringify(contract)}\n`); + await writeFile(path.join(root, "package.json"), `${JSON.stringify(packageDocument)}\n`); + + const result = spawnSync( + process.execPath, + [path.resolve("scripts/run-ci-gate.ts"), "FE-GATE-004"], + { cwd: root, encoding: "utf8", env: { ...process.env, ...FIXTURE_PNPM_ENVIRONMENT, CI: "false" } }, + ); + + expect(result.status).toBe(1); + expect(result.stderr).toContain("FE-GATE-004 runtime-schema: FAIL"); + expect(result.stderr).toContain("failed command: $ corepack pnpm test:fails-on-purpose"); + expect(result.stderr).toContain("log: artifacts/quality/gates/FE-GATE-004.txt"); + expect(result.stderr).toContain("the cause of this failure"); + } finally { + await rm(root, { recursive: true, force: true }); + } + }); +});