Refs: docs/reviews/2026-11-03-maturity-review/README.md 03-07 09-06 16-01 16-04~16-07 # Conflicts: # docs/manual/01-add-a-feature.md # docs/manual/reference/create-feature.md # docs/manual/reference/patterns.md # scripts/create-feature.ts # scripts/test-feature-scaffold.ts
100 lines
4.0 KiB
TypeScript
100 lines
4.0 KiB
TypeScript
import { spawnSync } from "node:child_process";
|
|
import { mkdir, rm, writeFile } from "node:fs/promises";
|
|
|
|
import { loadCiGateContract } from "./contracts/ci-gates.ts";
|
|
import {
|
|
runScaffoldDrillCommand,
|
|
scaffoldDrillCommands,
|
|
} from "./lib/feature-scaffold-drill.ts";
|
|
import {
|
|
createRemovalFixtureRoot,
|
|
prepareRemovalFixture,
|
|
REMOVAL_FIXTURE_COPY_TARGETS,
|
|
REMOVAL_FIXTURE_DOCUMENT_TARGETS,
|
|
renderRemovalJunit,
|
|
requireRemovalFixtureEnvironment,
|
|
runRemovalFixtureCheck,
|
|
sealRemovalFixtureRepository,
|
|
type RemovalCheck,
|
|
} from "./lib/removal-fixture.ts";
|
|
|
|
/**
|
|
* U7. A feature from `create:feature` passes the merge gates without an edit
|
|
* and breaks no other test. A copy of the repository, sample feature
|
|
* included, gets a default feature and a `--with-create --keyed` one, then
|
|
* runs the merge stage of its
|
|
* config/ci/gates.json: every command except those
|
|
* SCAFFOLD_DRILL_EXCLUDED_SCRIPTS names with a reason (the browser gates,
|
|
* test:system, the install check and the removal drills). 1103/12-02: this
|
|
* used to be a hand-kept list of 15 commands.
|
|
*
|
|
* 1103/16-02. The generated feature is then removed again with
|
|
* `test:sample-removal -- --feature=<id>`, the path the manual tells every
|
|
* product feature to take and that no gate ran.
|
|
*
|
|
* test:sample-removal repeats the generation after deleting the sample
|
|
* (decision 4), which proves the command needs nothing from it.
|
|
*/
|
|
const FEATURE_ID = "scaffold-feature";
|
|
/** 1103/09-06. The `--with-create --keyed` slice, in its own context. */
|
|
const WRITE_FEATURE_ID = "scaffold-write-feature";
|
|
const REPORT = "artifacts/tests/feature-scaffold.xml";
|
|
|
|
const pnpmCli = requireRemovalFixtureEnvironment("npm_execpath");
|
|
const fixtureRoot = await createRemovalFixtureRoot("feature-scaffold");
|
|
|
|
function fixtureCommit(root: string): string {
|
|
const head = spawnSync("git", ["rev-parse", "HEAD"], { cwd: root, encoding: "utf8" });
|
|
if (head.status !== 0) throw new Error(`feature scaffold fixture has no commit: ${head.stderr}`);
|
|
return head.stdout.trim();
|
|
}
|
|
|
|
function check(name: string, script: string, extra: readonly string[] = []): RemovalCheck {
|
|
return runRemovalFixtureCheck(name, fixtureRoot, pnpmCli, script, extra);
|
|
}
|
|
|
|
try {
|
|
// verify:documentation and the documentation tests read these.
|
|
await prepareRemovalFixture(fixtureRoot, [
|
|
...REMOVAL_FIXTURE_COPY_TARGETS,
|
|
...REMOVAL_FIXTURE_DOCUMENT_TARGETS,
|
|
]);
|
|
const created = check("create-feature", "create:feature", [FEATURE_ID]);
|
|
const createdWrite = check("create-feature-write", "create:feature", [
|
|
WRITE_FEATURE_ID,
|
|
"--with-create",
|
|
"--keyed",
|
|
]);
|
|
const checks: RemovalCheck[] = [created, createdWrite];
|
|
if (created.passed && createdWrite.passed) {
|
|
// Commits the copy with the feature, as a project would: git-based
|
|
// checks (git grep, git ls-files) then see the feature's files.
|
|
sealRemovalFixtureRepository(fixtureRoot);
|
|
// build:release-candidate records the build's commit and refuses one that
|
|
// is not a commit ID. CI sets VITE_COMMIT_SHA for the whole workflow; a
|
|
// local run gets the copy's own sealed commit instead of "local".
|
|
if (!process.env["VITE_COMMIT_SHA"]?.trim()) {
|
|
process.env["VITE_COMMIT_SHA"] = fixtureCommit(fixtureRoot);
|
|
}
|
|
for (const command of scaffoldDrillCommands(await loadCiGateContract(fixtureRoot))) {
|
|
checks.push(runScaffoldDrillCommand(command, fixtureRoot, pnpmCli));
|
|
}
|
|
checks.push(check("feature-removal", "test:sample-removal", ["--", `--feature=${FEATURE_ID}`]));
|
|
}
|
|
const failed = checks.filter((entry) => !entry.passed);
|
|
await mkdir("artifacts/tests", { recursive: true });
|
|
await writeFile(REPORT, renderRemovalJunit("feature-scaffold", checks));
|
|
if (failed.length > 0) {
|
|
process.stderr.write(
|
|
`feature scaffold failed:\n${failed
|
|
.map((entry) => ` ${entry.name}: ${entry.failure ?? "failed"}`)
|
|
.join("\n")}\n`,
|
|
);
|
|
process.exitCode = 1;
|
|
} else {
|
|
process.stdout.write(`feature scaffold: PASS (${checks.length} checks)\n`);
|
|
}
|
|
} finally {
|
|
await rm(fixtureRoot, { recursive: true, force: true });
|
|
}
|