diff --git a/scripts/lib/removal-fixture.ts b/scripts/lib/removal-fixture.ts index ed3d2741..efbbf9b3 100644 --- a/scripts/lib/removal-fixture.ts +++ b/scripts/lib/removal-fixture.ts @@ -46,6 +46,41 @@ export const REMOVAL_FIXTURE_COPY_TARGETS = Object.freeze([ * provider suite down with it — twenty-odd failures with one cause. */ +/** + * The repository's documents. A drill that adds or removes a feature copies + * them as well (REMOVAL_FIXTURE_COPY_TARGETS plus these), because the change + * must leave the documents valid (1103/14-04). The capability drills do not: + * the documents describe the capability they delete, and what those drills + * prove is that the code still builds and tests without it. + */ +export const REMOVAL_FIXTURE_DOCUMENT_TARGETS = Object.freeze([ + "README.md", + "CHANGELOG.md", + "docs", +] as const); + +/** + * 1103/02-06. Tests that read REMOVAL_FIXTURE_DOCUMENT_TARGETS. A fixture + * copied without the documents cannot run them: every capability drill + * (FE-GATE-020) failed its `test` check on ENOENT for README.md and + * CHANGELOG.md, whatever the removal did. prepareRemovalFixture deletes them + * from such a fixture, and the repository's own test:unit keeps running them. + * This is the only list; the sample drill used to keep the exclusion to itself. + */ +export const REMOVAL_FIXTURE_DOCUMENT_TESTS = Object.freeze([ + "tests/unit/changelog-review-ids.test.ts", + "tests/unit/documentation-readiness.test.ts", +] as const); + +/** The tests a fixture copied from `copyTargets` cannot run. */ +export function removalFixtureExcludedTests( + copyTargets: readonly string[], +): readonly string[] { + return REMOVAL_FIXTURE_DOCUMENT_TARGETS.every((target) => copyTargets.includes(target)) + ? [] + : REMOVAL_FIXTURE_DOCUMENT_TESTS; +} + /** * Regenerated result trees under `artifacts/`: traces, coverage HTML, recorded * videos and Storybook bundles. They are tens of megabytes and mean nothing to @@ -114,6 +149,9 @@ export async function prepareRemovalFixture( for (const target of copyTargets) { await cp(target, path.join(root, target), { recursive: true }); } + for (const test of removalFixtureExcludedTests(copyTargets)) { + await rm(path.join(root, test), { force: true }); + } await copyReleaseEvidenceTree(process.cwd(), root); runFixtureGit(root, ["init", "--quiet", "--initial-branch=fixture"]); await linkFixtureNodeModules(root); diff --git a/scripts/test-feature-scaffold.ts b/scripts/test-feature-scaffold.ts index 61654558..6348a516 100644 --- a/scripts/test-feature-scaffold.ts +++ b/scripts/test-feature-scaffold.ts @@ -4,6 +4,7 @@ import { createRemovalFixtureRoot, prepareRemovalFixture, REMOVAL_FIXTURE_COPY_TARGETS, + REMOVAL_FIXTURE_DOCUMENT_TARGETS, renderRemovalJunit, requireRemovalFixtureEnvironment, runRemovalFixtureCheck, @@ -32,9 +33,7 @@ try { // verify:documentation and the documentation tests read these. await prepareRemovalFixture(fixtureRoot, [ ...REMOVAL_FIXTURE_COPY_TARGETS, - "README.md", - "CHANGELOG.md", - "docs", + ...REMOVAL_FIXTURE_DOCUMENT_TARGETS, ]); const created = check("create-feature", "create:feature", [FEATURE_ID]); const checks: RemovalCheck[] = [created]; diff --git a/scripts/test-sample-removal.ts b/scripts/test-sample-removal.ts index 81bec4c0..dab5ac93 100644 --- a/scripts/test-sample-removal.ts +++ b/scripts/test-sample-removal.ts @@ -207,10 +207,6 @@ try { "tests/unit/__snapshots__/ci-workflow-generation.test.ts.snap", "tests/unit/removal-fixture.test.ts", "tests/unit/http-scenario-evidence.test.ts", - // They check README.md and CHANGELOG.md, which the fixture does not copy - // (REMOVAL_FIXTURE_COPY_TARGETS); removing a feature does not change them. - "tests/unit/changelog-review-ids.test.ts", - "tests/unit/documentation-readiness.test.ts", ]) { await rm(path.join(fixtureRoot, excludedFixtureTest), { force: true }); } diff --git a/tests/unit/removal-fixture.test.ts b/tests/unit/removal-fixture.test.ts index b117687b..b34457c0 100644 --- a/tests/unit/removal-fixture.test.ts +++ b/tests/unit/removal-fixture.test.ts @@ -8,6 +8,10 @@ import { loadCiGateContract } from "../../scripts/contracts/ci-gates.ts"; import { assertNoRuntimeImports, pruneRemovalFixtureCiContract, + REMOVAL_FIXTURE_COPY_TARGETS, + REMOVAL_FIXTURE_DOCUMENT_TARGETS, + REMOVAL_FIXTURE_DOCUMENT_TESTS, + removalFixtureExcludedTests, removeRuntimeDependentTests, renderRemovalJunit, runtimeImportGraph, @@ -132,6 +136,42 @@ it("rejects pruning that leaves a reduced gate without commands", async () => { })).rejects.toThrow(/commandIds|too small|at least 1/i); }); +// 1103/02-06. Three FE-GATE-020 drills copied the repository without its +// documents and still ran the tests that read them, so each failed its `test` +// check on ENOENT whatever it removed. Only the sample drill excluded them. +describe("document tests in a removal fixture", () => { + it("leaves the document tests out exactly when the documents are not copied", () => { + expect(removalFixtureExcludedTests(REMOVAL_FIXTURE_COPY_TARGETS)) + .toEqual(REMOVAL_FIXTURE_DOCUMENT_TESTS); + expect(removalFixtureExcludedTests([ + ...REMOVAL_FIXTURE_COPY_TARGETS, + ...REMOVAL_FIXTURE_DOCUMENT_TARGETS, + ])).toEqual([]); + }); + + it("names tests that exist and read the documents", async () => { + for (const test of REMOVAL_FIXTURE_DOCUMENT_TESTS) { + await expect(readFile(test, "utf8")).resolves.toMatch(/README\.md|CHANGELOG\.md/u); + } + }); + + it("is the only exclusion list: every drill prepares its fixture through it", async () => { + for (const drill of [ + "scripts/test-sample-removal.ts", + "scripts/test-feature-scaffold.ts", + "scripts/test-browser-file-storage-runtime-removal.ts", + "scripts/test-realtime-runtime-removal.ts", + "scripts/test-optional-recipe-removal.ts", + ]) { + const source = await readFile(drill, "utf8"); + expect(source, drill).toContain("prepareRemovalFixture("); + for (const test of REMOVAL_FIXTURE_DOCUMENT_TESTS) { + expect(source, drill).not.toContain(test); + } + } + }); +}); + describe("release evidence fixture copy", () => { it("keeps the release evidence and leaves the regenerated trees behind", async () => { const { copyReleaseEvidenceTree, RELEASE_EVIDENCE_REGENERATED_TREES } =