fix(ci): coverage 증거 검사가 summary의 branchesTrue를 받는다
FE-GATE-005의 증거 검사(scripts/lib/ci-artifact-validator.ts)는 coverage-summary.json 항목마다 lines·statements·functions·branches만 허용하는 .strict() schema를 쓴다. istanbul-lib-coverage 3.2.2는 summary에 branchesTrue를 넣으므로, 시험이 모두 통과해도 증거 단계에서 게이트가 "Unrecognized key: branchesTrue"로 실패한다. 같은 파일을 읽는 risk-coverage 검사는 이 키를 허용해 두 검사기가 갈라져 있었다. 템플릿 bca5fc27을 그대로 가져온다(git apply, 충돌 없음). 키 목록을 scripts/lib/coverage-summary-metrics.ts 한 곳에 두고 두 검사기가 같이 쓴다. 평가하는 네 지표와 보고기가 더할 수 있는 선택 지표(branchesTrue)를 나누고, 선택 지표도 counter 형식은 그대로 검사한다. 위험·한계: 다른 모르는 키는 여전히 거절한다(의도). 검증: 템플릿 커밋의 tests/unit/coverage-summary-artifact.test.ts를 같이 가져왔다. 결과는 이 브랜치 전체 게이트 실행에 적는다.
This commit is contained in:
@@ -9,6 +9,10 @@ import type {
|
||||
CiGateArtifactSchema,
|
||||
} from "../contracts/ci-gates.ts";
|
||||
import { ciContractReportSchema } from "./ci-contract-report.ts";
|
||||
import {
|
||||
COVERAGE_SUMMARY_METRICS,
|
||||
COVERAGE_SUMMARY_OPTIONAL_METRICS,
|
||||
} from "./coverage-summary-metrics.ts";
|
||||
import {
|
||||
architectureDependencyReportArtifactSchema,
|
||||
automatedA11yArtifactSchema,
|
||||
@@ -76,16 +80,17 @@ const coverageCounterSchema = z
|
||||
context.addIssue({ code: "custom", path: ["pct"], message: "coverage pct is not exact" });
|
||||
}
|
||||
});
|
||||
// 1103/12-09. The key list is shared with the risk coverage gate, which reads
|
||||
// the same file; this schema used to refuse the `branchesTrue` the reporter
|
||||
// always writes.
|
||||
const coverageSummarySchema = z
|
||||
.record(
|
||||
z.string(),
|
||||
z
|
||||
.object({
|
||||
lines: coverageCounterSchema,
|
||||
statements: coverageCounterSchema,
|
||||
functions: coverageCounterSchema,
|
||||
branches: coverageCounterSchema,
|
||||
})
|
||||
.object(Object.fromEntries([
|
||||
...COVERAGE_SUMMARY_METRICS.map((metric) => [metric, coverageCounterSchema]),
|
||||
...COVERAGE_SUMMARY_OPTIONAL_METRICS.map((metric) => [metric, coverageCounterSchema.optional()]),
|
||||
]))
|
||||
.strict(),
|
||||
)
|
||||
.refine((value) => "total" in value, "coverage summary lacks total");
|
||||
|
||||
@@ -0,0 +1,24 @@
|
||||
/**
|
||||
* The keys of one entry in Vitest's `coverage-summary.json`. Two readers check
|
||||
* that file: the CI evidence validator (ci-artifact-validator.ts) and the risk
|
||||
* coverage gate (risk-coverage.ts). They kept separate lists, and the
|
||||
* validator refused `branchesTrue` while the gate accepted it, so FE-GATE-005
|
||||
* failed at its evidence step after every test had passed (1103/12-09).
|
||||
*/
|
||||
|
||||
/** The four metrics both readers evaluate. */
|
||||
export const COVERAGE_SUMMARY_METRICS = Object.freeze([
|
||||
"lines",
|
||||
"statements",
|
||||
"functions",
|
||||
"branches",
|
||||
] as const);
|
||||
|
||||
/**
|
||||
* Keys the reporter may add. istanbul-lib-coverage 3.2.2 puts `branchesTrue`
|
||||
* in every blank summary, so the total always carries it. Each is still
|
||||
* checked as a counter; neither reader evaluates it.
|
||||
*/
|
||||
export const COVERAGE_SUMMARY_OPTIONAL_METRICS = Object.freeze([
|
||||
"branchesTrue",
|
||||
] as const);
|
||||
@@ -8,14 +8,12 @@ import {
|
||||
import path from "node:path";
|
||||
import babelParser from "@babel/eslint-parser";
|
||||
|
||||
import {
|
||||
COVERAGE_SUMMARY_METRICS as coverageMetrics,
|
||||
COVERAGE_SUMMARY_OPTIONAL_METRICS,
|
||||
} from "./coverage-summary-metrics.ts";
|
||||
import { normalizeRepositoryRelativePath } from "./repository-file-inventory.ts";
|
||||
|
||||
const coverageMetrics = [
|
||||
"lines",
|
||||
"statements",
|
||||
"functions",
|
||||
"branches",
|
||||
] as const;
|
||||
const teamIdPattern = /^[a-z][a-z0-9]*(?:-[a-z0-9]+)*$/u;
|
||||
const maximumWaiverDurationMs = 90 * 24 * 60 * 60 * 1_000;
|
||||
|
||||
@@ -643,16 +641,20 @@ function parseCoverageCounter(value: unknown, label: string): CoverageCounter {
|
||||
|
||||
function parseCoverageMetrics(value: unknown, label: string): CoverageMetrics {
|
||||
if (!isRecord(value)) throw new TypeError(`${label} must be an object`);
|
||||
const optionalMetrics: readonly string[] = COVERAGE_SUMMARY_OPTIONAL_METRICS;
|
||||
const unknownMetrics = Object.keys(value).filter(
|
||||
(metric) => metric !== "branchesTrue" && !coverageMetrics.includes(metric as CoverageMetric),
|
||||
(metric) =>
|
||||
!optionalMetrics.includes(metric) && !coverageMetrics.includes(metric as CoverageMetric),
|
||||
);
|
||||
if (unknownMetrics.length > 0) {
|
||||
throw new TypeError(
|
||||
`${label} has unknown coverage metric keys: ${unknownMetrics.sort().join(", ")}`,
|
||||
);
|
||||
}
|
||||
if (value.branchesTrue !== undefined) {
|
||||
parseCoverageCounter(value.branchesTrue, `${label}.branchesTrue`);
|
||||
for (const metric of optionalMetrics) {
|
||||
if (value[metric] !== undefined) {
|
||||
parseCoverageCounter(value[metric], `${label}.${metric}`);
|
||||
}
|
||||
}
|
||||
const parsed = {} as Record<CoverageMetric, CoverageCounter>;
|
||||
for (const metric of coverageMetrics) {
|
||||
|
||||
@@ -0,0 +1,66 @@
|
||||
import { mkdir, mkdtemp, rm, writeFile } from "node:fs/promises";
|
||||
import { tmpdir } from "node:os";
|
||||
import path from "node:path";
|
||||
|
||||
import { afterEach, describe, expect, it } from "vitest";
|
||||
|
||||
import { loadCiGateContract } from "../../scripts/contracts/ci-gates.ts";
|
||||
import { validateCiArtifact } from "../../scripts/lib/ci-artifact-validator.ts";
|
||||
|
||||
const SUMMARY_PATH = "artifacts/tests/coverage/coverage-summary.json";
|
||||
const roots: string[] = [];
|
||||
|
||||
afterEach(async () => {
|
||||
await Promise.all(roots.splice(0).map((root) => rm(root, { recursive: true, force: true })));
|
||||
});
|
||||
|
||||
const counter = (total: number, covered = total) => ({
|
||||
total,
|
||||
covered,
|
||||
skipped: 0,
|
||||
pct: total === 0 ? 100 : Math.floor((covered / total) * 10_000) / 100,
|
||||
});
|
||||
const metrics = {
|
||||
lines: counter(4),
|
||||
statements: counter(4),
|
||||
functions: counter(1),
|
||||
branches: counter(2),
|
||||
};
|
||||
|
||||
async function validateSummary(summary: unknown): Promise<void> {
|
||||
const contract = await loadCiGateContract(process.cwd());
|
||||
const artifact = contract.artifacts.find((entry) => entry.path === SUMMARY_PATH);
|
||||
const schema = contract.artifactSchemas.find((entry) => entry.id === artifact?.schemaId);
|
||||
if (!artifact || !schema) throw new Error(`the CI contract no longer declares ${SUMMARY_PATH}`);
|
||||
const root = await mkdtemp(path.join(tmpdir(), "coverage-summary-artifact-"));
|
||||
roots.push(root);
|
||||
await mkdir(path.join(root, path.dirname(SUMMARY_PATH)), { recursive: true });
|
||||
await writeFile(path.join(root, SUMMARY_PATH), `${JSON.stringify(summary)}\n`);
|
||||
await validateCiArtifact({ root, artifact, schema });
|
||||
}
|
||||
|
||||
// 1103/12-09. istanbul-lib-coverage 3.2.2 puts `branchesTrue` in every blank
|
||||
// summary, so the json-summary total always carries it. The CI evidence check
|
||||
// refused the key that the risk-coverage gate reading the same file accepts,
|
||||
// and FE-GATE-005 failed after every test had passed.
|
||||
describe("coverage summary evidence (1103/12-09)", () => {
|
||||
it("accepts the summary the coverage reporter writes, with branchesTrue", async () => {
|
||||
await expect(validateSummary({
|
||||
total: { ...metrics, branchesTrue: counter(0) },
|
||||
"src/a.ts": metrics,
|
||||
})).resolves.toBeUndefined();
|
||||
});
|
||||
|
||||
it("accepts a summary without branchesTrue", async () => {
|
||||
await expect(validateSummary({ total: metrics, "src/a.ts": metrics }))
|
||||
.resolves.toBeUndefined();
|
||||
});
|
||||
|
||||
it("still validates branchesTrue as a counter and refuses other keys", async () => {
|
||||
await expect(validateSummary({
|
||||
total: { ...metrics, branchesTrue: { ...counter(0), pct: 0 } },
|
||||
})).rejects.toThrow(/pct/u);
|
||||
await expect(validateSummary({ total: { ...metrics, branchesFalse: counter(0) } }))
|
||||
.rejects.toThrow(/branchesFalse/u);
|
||||
});
|
||||
});
|
||||
Reference in New Issue
Block a user