diff --git a/scripts/check-ci-gating.ts b/scripts/check-ci-gating.ts index cde0df88..094b2558 100644 --- a/scripts/check-ci-gating.ts +++ b/scripts/check-ci-gating.ts @@ -5,6 +5,7 @@ import { loadCiGateContract } from "./contracts/ci-gates.ts"; import { loadProductCiOverlay } from "./contracts/product-ci-overlay.ts"; import { gatedTestPaths, + gatedTestTargets, listTestFiles, parseUngatedTestExclusions, ungatedTestFailures, @@ -38,7 +39,7 @@ try { failures.push( ...ungatedTestFailures({ testFiles: await listTestFiles(process.cwd()), - gatedPaths: gatedTestPaths( + gatedPaths: gatedTestTargets( packageScripts, [...contract.commands.map(({ script }) => script), ...productGateScripts], (file) => readFileSync(file, "utf8"), diff --git a/scripts/lib/ungated-tests.ts b/scripts/lib/ungated-tests.ts index cdaeff35..b4cd322a 100644 --- a/scripts/lib/ungated-tests.ts +++ b/scripts/lib/ungated-tests.ts @@ -16,6 +16,15 @@ import { reachablePackageScripts } from "./package-script-graph.ts"; export const UNGATED_TESTS_PATH = "config/ci/ungated-tests.json"; const TEST_FILE = /\.(?:test|spec)\.tsx?$/u; +// vitest.config.ts includes only the `*.test.ts` and `*.test.tsx` files below tests. +const VITEST_TEST_FILE = /\.test\.tsx?$/u; + +/** + * 0929/12-06. A gated path and the runner that reaches it. A Vitest path + * runs its `*.test.*` files only; a Playwright `testDir` runs what the + * Playwright default `testMatch` takes, `*.spec.*` and `*.test.*`. + */ +export type GatedTestTarget = Readonly<{ path: string; runner: "vitest" | "playwright" }>; const ungatedTestsSchema = z .object({ @@ -54,14 +63,26 @@ export function gatedTestPaths( entryScripts: readonly string[], readConfig: (file: string) => string, ): string[] { - const paths = new Set(); + return [...new Set(gatedTestTargets(scripts, entryScripts, readConfig).map(({ path: target }) => target))].sort(); +} + +export function gatedTestTargets( + scripts: Readonly>, + entryScripts: readonly string[], + readConfig: (file: string) => string, +): GatedTestTarget[] { + const targets = new Map(); + const add = (target: string, runner: GatedTestTarget["runner"]) => { + const normalized = target.replace(/\/$/u, ""); + targets.set(`${runner} ${normalized}`, { path: normalized, runner }); + }; const addVitestPaths = (tokens: readonly string[]) => { const vitestRun = tokens.findIndex( (token, index) => token === "run" && /(?:run-vitest\.ts|vitest)$/u.test(tokens[index - 1] ?? ""), ); if (vitestRun < 0) return; for (const token of tokens.slice(vitestRun + 1)) { - if (!token.startsWith("-")) paths.add(token.replace(/\/$/u, "")); + if (!token.startsWith("-")) add(token, "vitest"); } }; for (const script of reachablePackageScripts(scripts, entryScripts)) { @@ -79,20 +100,30 @@ export function gatedTestPaths( const configFlag = tokens.indexOf("--config"); const config = configFlag >= 0 ? tokens[configFlag + 1]! : "playwright.config.ts"; const testDir = /testDir:\s*["']\.?\/?([^"']+)["']/u.exec(readConfig(config))?.[1]; - if (testDir) paths.add(testDir.replace(/\/$/u, "")); + if (testDir) add(testDir, "playwright"); } } } - return [...paths].sort(); + return [...targets.values()].sort( + (left, right) => left.path.localeCompare(right.path) || left.runner.localeCompare(right.runner), + ); } export function ungatedTestFailures(input: Readonly<{ testFiles: readonly string[]; - gatedPaths: readonly string[]; + /** A bare string is a Vitest path. */ + gatedPaths: readonly (string | GatedTestTarget)[]; exclusions: readonly UngatedTestExclusion[]; }>): string[] { + const targets = input.gatedPaths.map((target): GatedTestTarget => + typeof target === "string" ? { path: target, runner: "vitest" } : target, + ); const gated = (file: string) => - input.gatedPaths.some((gatedPath) => file === gatedPath || file.startsWith(`${gatedPath}/`)); + targets.some( + ({ path: gatedPath, runner }) => + (file === gatedPath || file.startsWith(`${gatedPath}/`)) && + (runner === "playwright" || VITEST_TEST_FILE.test(file)), + ); const excluded = new Set(input.exclusions.map(({ path: file }) => file)); const failures = input.testFiles .filter((file) => !gated(file) && !excluded.has(file)) diff --git a/tests/unit/ungated-tests.test.ts b/tests/unit/ungated-tests.test.ts index 32a788fe..93ea3024 100644 --- a/tests/unit/ungated-tests.test.ts +++ b/tests/unit/ungated-tests.test.ts @@ -6,6 +6,7 @@ import { describe, expect, it } from "vitest"; import { loadCiGateContract } from "../../scripts/contracts/ci-gates.ts"; import { gatedTestPaths, + gatedTestTargets, listTestFiles, parseUngatedTestExclusions, ungatedTestFailures, @@ -23,7 +24,7 @@ async function repositoryInputs() { }; return { testFiles: await listTestFiles(process.cwd()), - gatedPaths: gatedTestPaths( + gatedPaths: gatedTestTargets( packageDocument.scripts, contract.commands.map(({ script }) => script), (file) => readFileSync(file, "utf8"), @@ -88,6 +89,24 @@ describe("ungated test files", () => { ]); }); + // 0929/12-06. A `*.spec.ts` under a Vitest path counted as gated, but + // vitest.config.ts includes only `*.test.{ts,tsx}`: nothing ran it. + it("gates a Vitest path's test files only, and a Playwright testDir's specs", async () => { + expect( + ungatedTestFailures({ testFiles: ["tests/unit/probe.spec.ts"], gatedPaths: ["tests/unit"], exclusions: [] }), + ).toEqual([ + "test file is not run by any CI gate command and is not in config/ci/ungated-tests.json: tests/unit/probe.spec.ts", + ]); + const inputs = await repositoryInputs(); + expect(inputs.gatedPaths).toContainEqual({ path: "tests/e2e", runner: "playwright" }); + expect(inputs.gatedPaths).toContainEqual({ path: "tests/unit", runner: "vitest" }); + expect( + ungatedTestFailures({ ...inputs, testFiles: ["tests/unit/probe.spec.ts", "tests/e2e/probe.spec.ts"] }), + ).toEqual([ + "test file is not run by any CI gate command and is not in config/ci/ungated-tests.json: tests/unit/probe.spec.ts", + ]); + }); + it("requires a reason for every exclusion", () => { expect(() => parseUngatedTestExclusions({