문제 직전 커밋(짝 저장소 참조 테스트 범위 축소)이 보고서의 missingPaths를 읽지만, 테스트가 JSON을 읽을 때 쓰는 타입에 그 칸이 없어 check:types가 TS2339로 실패한다. vitest는 타입을 보지 않아 테스트는 통과했다. 고른 방법 - 보고서 타입에 missingPaths?: string[]를 더한다. 검증 - check:types 통과, documentation-readiness 테스트 19건 통과, eslint 통과. Refs: docs/reviews/2026-11-03-maturity-review/12-guardrails-ci.md 12-05
243 lines
12 KiB
TypeScript
243 lines
12 KiB
TypeScript
import { spawnSync } from "node:child_process";
|
|
import { cp, 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";
|
|
|
|
const INPUTS = ["README.md", "docs", "artifacts/tests/a11y-manual"];
|
|
|
|
/**
|
|
* Runs verify:documentation on a copy of its inputs, each `changes` entry
|
|
* applied to its document and every `removed` file deleted. Code facts (src,
|
|
* package.json, gates.json) are read from this repository, not the copy. The
|
|
* copy is a `frontend` folder; `siblings` are files written beside it, where a
|
|
* checkout of the paired repositories would be.
|
|
*/
|
|
async function verify(
|
|
changes: Readonly<Record<string, (text: string) => string>>,
|
|
removed: readonly string[] = [],
|
|
siblings: Readonly<Record<string, string>> = {},
|
|
) {
|
|
const parent = await mkdtemp(path.join(tmpdir(), "documentation-readiness-"));
|
|
const root = path.join(parent, "frontend");
|
|
try {
|
|
for (const [file, content] of Object.entries(siblings)) {
|
|
await mkdir(path.dirname(path.join(parent, file)), { recursive: true });
|
|
await writeFile(path.join(parent, file), content);
|
|
}
|
|
for (const input of INPUTS) await cp(input, path.join(root, input), { recursive: true });
|
|
for (const [document, mutate] of Object.entries(changes)) {
|
|
const target = path.join(root, document);
|
|
await writeFile(target, mutate(await readFile(target, "utf8")));
|
|
}
|
|
for (const file of removed) await rm(path.join(root, file));
|
|
const result = spawnSync(process.execPath, [path.resolve("scripts/verify-documentation-readiness.ts")], {
|
|
cwd: root,
|
|
encoding: "utf8",
|
|
});
|
|
const report = await readFile(path.join(root, "artifacts/quality/documentation-review.json"), "utf8")
|
|
.then((json) => JSON.parse(json) as {
|
|
documentReferences: { path: string; missingPaths?: string[]; unverifiedLinks?: string[] }[];
|
|
})
|
|
.catch(() => null);
|
|
return { ...result, report };
|
|
} finally {
|
|
await rm(parent, { recursive: true, force: true });
|
|
}
|
|
}
|
|
|
|
function verifyWithReadme(mutate: (readme: string) => string, document = "README.md") {
|
|
return verify({ [document]: mutate });
|
|
}
|
|
|
|
// 1101/14-06. A route missing from a scope document used to fail with only
|
|
// "canonical scoped-review evidence is incomplete", which points at the
|
|
// diagram review instead of the file to fix.
|
|
describe("verify:documentation failure output (1101/14-06)", () => {
|
|
it("passes the documents as they are", async () => {
|
|
const result = await verifyWithReadme((readme) => readme);
|
|
expect(result.status, result.stderr).toBe(0);
|
|
});
|
|
|
|
it("names the route ID that has no manual review record", async () => {
|
|
const result = await verify({}, ["artifacts/tests/a11y-manual/EXAMPLES_PLATFORM.md"]);
|
|
expect(result.status).toBe(1);
|
|
expect(result.stderr).toContain("artifacts/tests/a11y-manual/ has no record for route IDs: EXAMPLES_PLATFORM");
|
|
expect(result.stderr).toMatch(/FAIL_UNVERIFIED \(failed: route scope\)/u);
|
|
expect(result.stderr).not.toContain("scoped-review evidence");
|
|
});
|
|
|
|
it("names every failed check", async () => {
|
|
const result = await verify(
|
|
{ "README.md": (readme) => readme.replaceAll("`RELEASE_TARGET`", "") },
|
|
["artifacts/tests/a11y-manual/EXAMPLES_PLATFORM.md"],
|
|
);
|
|
expect(result.stderr).toContain("README.md does not name: RELEASE_TARGET");
|
|
expect(result.stderr).toMatch(/\(failed: route scope, runtime variables\)/u);
|
|
});
|
|
});
|
|
|
|
// 1101/14-05. README and the manual checklist listed every route ID, so each
|
|
// new feature edited two template-owned documents. The scope is the record
|
|
// files now, and the current contract documents (docs/README.md §1) may only
|
|
// name paths, package scripts and gate IDs that exist.
|
|
describe("verify:documentation current contract documents (1101/14-05)", () => {
|
|
// Written without the sample's route prefix: the sample removal drill runs
|
|
// this file and refuses any file that still names the removed sample.
|
|
const ROUTE_IDS = /`(?:APP_HOME|EXAMPLES_[A-Z]+|NOT_FOUND|[A-Z]+_RESOURCE_[A-Z]+)`/gu;
|
|
|
|
it("does not need README or the checklist to list route IDs", async () => {
|
|
const result = await verify({
|
|
"README.md": (readme) => readme.replaceAll(ROUTE_IDS, ""),
|
|
"docs/accessibility/manual-checklist.md": (checklist) => checklist.replaceAll(ROUTE_IDS, ""),
|
|
});
|
|
expect(result.status, result.stderr).toBe(0);
|
|
});
|
|
|
|
it.each([
|
|
["README.md", "scripts/verify-documentation-readiness.ts", "scripts/verify-documentation-readyness.ts"],
|
|
["docs/contracts/compatibility.md", "scripts/check-compatibility.ts", "scripts/check-compatibilty.ts"],
|
|
// reached through the `operations/` directory link
|
|
["docs/operations/release-cache-rollback.md", "scripts/lib/hosting-probe.ts", "scripts/lib/hosting-prob.ts"],
|
|
])("fails when %s names a path that does not exist", async (document, before, after) => {
|
|
const result = await verifyWithReadme((text) => text.replace(`\`${before}\``, `\`${after}\``), document);
|
|
expect(result.status).toBe(1);
|
|
expect(result.stderr).toContain(`${document} names paths that do not exist: ${after}`);
|
|
expect(result.stderr).toMatch(/\(failed: document references\)/u);
|
|
});
|
|
|
|
it("fails when docs/README.md links a document that does not exist", async () => {
|
|
const result = await verifyWithReadme(
|
|
(index) => index.replace("(architecture/layers.md)", "(architecture/layer.md)"),
|
|
"docs/README.md",
|
|
);
|
|
expect(result.status).toBe(1);
|
|
expect(result.stderr).toContain("docs/README.md names paths that do not exist: docs/architecture/layer.md");
|
|
});
|
|
|
|
it("fails when a document names a package script or a gate ID that does not exist", async () => {
|
|
const result = await verify({
|
|
"README.md": (readme) => readme.replace("`verify:documentation` fails", "`verify:documentaton` fails"),
|
|
"docs/README.md": (index) => index.replace("(FE-GATE-017)", "(FE-GATE-099)"),
|
|
});
|
|
expect(result.status).toBe(1);
|
|
expect(result.stderr).toContain("README.md names package scripts that do not exist: verify:documentaton");
|
|
expect(result.stderr).toContain("docs/README.md names gate IDs that config/ci/gates.json does not define: FE-GATE-099");
|
|
});
|
|
|
|
it("does not ask generated output to exist", async () => {
|
|
const result = await verifyWithReadme((readme) => `${readme}\nSee \`artifacts/quality/not-generated-yet.json\`.\n`);
|
|
expect(result.status, result.stderr).toBe(0);
|
|
});
|
|
|
|
it("accepts a path under history a copy deleted, and only that", async () => {
|
|
const naming = (readme: string) => `${readme}\nSee \`docs/retired-notes/plan.md\`.\n`;
|
|
const deleted = await verifyWithReadme((readme) =>
|
|
naming(readme).replace("| Path | Contents |\n| --- | --- |\n", "$&| `docs/retired-notes/` | deleted |\n"),
|
|
);
|
|
expect(deleted.status, deleted.stderr).toBe(0);
|
|
|
|
const missing = await verifyWithReadme(naming);
|
|
expect(missing.status).toBe(1);
|
|
expect(missing.stderr).toContain("README.md names paths that do not exist: docs/retired-notes/plan.md");
|
|
});
|
|
});
|
|
|
|
// 1103/12-05. Paths inside a command and links into the paired repositories
|
|
// were never looked up: a deleted V2 test stayed in a `vitest run` command,
|
|
// and a broken link to the backend template's contract passed.
|
|
describe("verify:documentation commands and sibling links (1103/12-05)", () => {
|
|
const CI_DOC = "docs/operations/ci-quality-gates.md";
|
|
const BACKEND = "clean-architecture-backend-template/docs/web/http-contract.md";
|
|
|
|
it.each([
|
|
["an inline command", "`corepack pnpm exec vitest run tests/integration/no-such-client.test.ts`"],
|
|
["a shell block", "```bash\nnode tests/integration/no-such-client.test.ts --flag\n```"],
|
|
])("fails when %s names a path that does not exist", async (_shape, line) => {
|
|
const result = await verify({ [CI_DOC]: (text) => `${text}\n${line}\n` });
|
|
expect(result.status).toBe(1);
|
|
expect(result.stderr).toContain(`${CI_DOC} names paths that do not exist: tests/integration/no-such-client.test.ts`);
|
|
});
|
|
|
|
it("looks up a command's existing arguments and leaves placeholders alone", async () => {
|
|
const result = await verify({
|
|
[CI_DOC]: (text) => `${text}\n\`corepack pnpm exec vitest run tests/unit/documentation-readiness.test.ts -t "x"\`\n` +
|
|
"```bash\ncorepack pnpm drill:runbook -- FE-RB-005 --release-root <release dir>\n```\n",
|
|
});
|
|
expect(result.status, result.stderr).toBe(0);
|
|
});
|
|
|
|
it("checks a link or a path into a paired repository checked out beside this one", async () => {
|
|
const naming = (target: string) => (text: string) =>
|
|
`${text}\n[contract](../../../${target}) and \`${target}\`\n`;
|
|
const present = await verify(
|
|
{ [CI_DOC]: naming(BACKEND) },
|
|
[],
|
|
{ [BACKEND]: "# contract\n" },
|
|
);
|
|
// Only this document is under test: other documents name paired-backend
|
|
// paths the stub checkout does not have.
|
|
expect(present.stderr).not.toContain(`${CI_DOC} names paths that do not exist`);
|
|
expect(
|
|
present.report?.documentReferences.find((entry) => entry.path === CI_DOC)?.missingPaths,
|
|
).toEqual([]);
|
|
|
|
const broken = await verify(
|
|
{ [CI_DOC]: naming("clean-architecture-backend-template/docs/web/no-such.md") },
|
|
[],
|
|
{ [BACKEND]: "# contract\n" },
|
|
);
|
|
expect(broken.status).toBe(1);
|
|
expect(broken.stderr).toContain(
|
|
`${CI_DOC} names paths that do not exist: ../clean-architecture-backend-template/docs/web/no-such.md`,
|
|
);
|
|
});
|
|
|
|
it("reports a link into a paired repository that is not checked out as unverified", async () => {
|
|
const result = await verify({
|
|
[CI_DOC]: (text) => `${text}\n[contract](../../../clean-architecture-backend-template/docs/web/no-such.md)\n`,
|
|
});
|
|
expect(result.status, result.stderr).toBe(0);
|
|
expect(result.stdout).toContain("not verified");
|
|
expect(result.report?.documentReferences.find((entry) => entry.path === CI_DOC)?.unverifiedLinks)
|
|
.toEqual(["../clean-architecture-backend-template/docs/web/no-such.md"]);
|
|
});
|
|
});
|
|
|
|
// 1101/14-03. The entry documents drew a top-level domain layer that does not
|
|
// exist, left out three of the nine src folders, and layers.md named a
|
|
// minority of the architecture rules while claiming it could not drift.
|
|
describe("verify:documentation source structure (1101/14-03)", () => {
|
|
it("fails when layers.md loses a rule name, as renaming a rule does", async () => {
|
|
const result = await verifyWithReadme(
|
|
(layers) => layers.replaceAll("`platform-kernel-is-product-neutral`", "`platform-kernel`"),
|
|
"docs/architecture/layers.md",
|
|
);
|
|
expect(result.status).toBe(1);
|
|
expect(result.stderr).toContain(
|
|
"docs/architecture/layers.md does not name .dependency-cruiser.json rules: platform-kernel-is-product-neutral",
|
|
);
|
|
expect(result.stderr).toMatch(/\(failed: source structure\)/u);
|
|
});
|
|
|
|
it("fails when a document names a top-level src folder that does not exist", async () => {
|
|
const result = await verifyWithReadme((readme) =>
|
|
readme.replace("presentation -> application -> contracts", "presentation -> application -> `src/domain`"),
|
|
);
|
|
expect(result.status).toBe(1);
|
|
expect(result.stderr).toContain("README.md names src folders that do not exist: domain");
|
|
});
|
|
|
|
it("fails when a document describes a folder differently from layers.md", async () => {
|
|
const result = await verifyWithReadme(
|
|
(overview) => overview.replace("- `src/platform` — product-neutral", "- `src/platform` — shared"),
|
|
"docs/architecture/overview.md",
|
|
);
|
|
expect(result.status).toBe(1);
|
|
expect(result.stderr).toContain(
|
|
"docs/architecture/overview.md does not describe src folders as the layers.md table does: platform",
|
|
);
|
|
});
|
|
});
|