Files
clean-architecture-frontend…/tests/unit/deployment-admission.test.ts
T
DongHyeonka 7b34756355 fix(release): 공개 대상 승인이 예시·테스트용 예약 이름을 거절한다 (1101/13-02)
문제
staging·production 프로필은 `https://api.example.com/`,
`https://telemetry.example.com/v1/events`를 싣고 텔레메트리를 켠다.
공개 대상 승인(FE-GATE-027)은 https와 비공개 호스트만 보므로 프로필을
고치지 않은 production 빌드가 `production ADMITTED`로 통과한다. 모든 API
호출이 실패하고 이벤트는 프로젝트가 소유하지 않은 도메인으로 간다.
CI 계약은 immutable_build의 env를 APP_PROFILE·RELEASE_TARGET로 고정해
RUNTIME_*를 넘길 수 없는데, README 변수 표는 이를 적지 않고 운영 예시는
`api.example.com`을 그대로 쓴다.

고른 방법
- publicEndpointViolations에 예약 이름 거절을 더한다. RFC 2606·6761의
  `example.com`·`example.net`·`example.org`와 그 하위, `.example`,
  `.invalid`, `.test`. 비공개 호스트와 겹치면 비공개 사유 하나만 낸다.
- README 운영 예시의 URL을 `<your-api-origin>/` 같은 빈칸으로 바꾼다.
- README 변수 표와 본문에 CI에서 endpoint를 바꾸는 방법은 프로필 파일을
  커밋하는 것 하나라고 적는다.
- 테스트 fixture의 공개 endpoint를 예약되지 않은 이름으로 바꾸고, 프로필을
  고치지 않은 빌드는 두 위반, endpoint를 준 빌드는 승인되는 것을 고정한다.

버린 대안
- 프로필 기본값을 비워 스키마가 빌드를 막게 하기: 더 확실하지만 프로필이
  예시로 읽히지 않고 네 프로필을 같이 바꿔야 한다. 리뷰 대안 비교에서 승인
  규칙 한 곳이 더 작다고 봤다.
- 리뷰 13-02 (3)의 괄호("13-01 배포 슬롯에 RUNTIME_* 허용 목록")는 하지
  않았다. RUNTIME_*는 빌드 때 쓰이는 값이고, 슬롯은 승격 뒤 배포 job이라
  거기서 넘겨도 이미 만든 후보에 닿지 않는다.

위험·한계
- 템플릿을 그대로 쓰는 프로젝트(이 repo 포함)가 APP_PROFILE=production으로
  immutable_build를 돌리면 FE-GATE-027이 새로 실패한다(의도).
- `*.test` 같은 이름을 실제 운영 endpoint로 쓰는 프로젝트는 없다고 본다.

검증
- RED: node scripts/run-vitest.ts run tests/unit/deployment-admission.test.ts
  2 failed / 22 passed. "refuses names reserved for examples and tests"
  (`expected [] to deeply equal [...]`), "refuses a public build from the
  unedited profile on both endpoints"(`staging: expected [] to deeply equal
  [ 'API_BASE_URL', 'TELEMETRY_ENDPOINT' ]`)
- GREEN: 같은 파일 24 passed. feature-override-diagnostics,
  documentation-readiness 포함 29 passed
- 실험 E-A 재실행: APP_PROFILE=production VITE_BUILD_ID=rel-prod-a
  RELEASE_ID=rel-a 빌드 뒤 RELEASE_TARGET=production 승인 rc=1,
  API_BASE_URL·TELEMETRY_ENDPOINT 두 위반으로 거절
- tsc(app, test) 0, eslint 바뀐 파일 0, verify-documentation-readiness
  PASS_SCOPED

Refs: docs/reviews/2026-11-01-maturity-review/13-build-release-supply-chain.md 13-02
2026-11-03 00:56:00 +09:00

384 lines
14 KiB
TypeScript

import { spawnSync } from "node:child_process";
import { mkdir, mkdtemp, readFile, readdir, rm, writeFile } from "node:fs/promises";
import { tmpdir } from "node:os";
import path from "node:path";
import { describe, expect, it } from "vitest";
import {
DEPLOYMENT_TARGETS,
findAdmissionViolations,
isDeploymentTarget,
type AdmissionInput,
} from "../../src/contracts/deployment-admission.ts";
import { ENV_REGISTRY, getBuildConfig } from "../../src/contracts/env.ts";
import { runtimeConfigV2ArtifactSchema } from "../../src/contracts/release-artifacts.ts";
import { generateRuntimeConfig } from "../../scripts/generate-runtime-config.ts";
const PRODUCTION_ARTIFACT: AdmissionInput = Object.freeze({
APP_ENV: "production",
API_BASE_URL: "https://api.my-product.kr/",
REQUEST_TIMEOUT_MS: 10_000,
MAX_RETRY_ATTEMPTS: 2,
TELEMETRY_ENABLED: false,
AUTH_MODE: "external",
CONFIG_SCHEMA_VERSION: "2.0",
RELEASE_MANIFEST_URL: "/release-manifest.json",
BUILD_ID: "20260815.42",
RELEASE_ID: "r-2026.08.15-1",
CAPABILITY_OVERRIDES: Object.freeze({
REALTIME: "DEFAULT",
WEB_WORKER: "DEFAULT",
SERVICE_WORKER: "DEFAULT",
OFFLINE_COMMANDS: "DEFAULT",
}),
}) as AdmissionInput;
const LOCAL_ARTIFACT: AdmissionInput = Object.freeze({
...PRODUCTION_ARTIFACT,
APP_ENV: "local",
API_BASE_URL: "http://localhost:8080/",
AUTH_MODE: "demo",
BUILD_ID: "local-build",
RELEASE_ID: "local-release",
}) as AdmissionInput;
describe("deployment admission", () => {
it("admits an artifact only to the environment it declares", () => {
expect(findAdmissionViolations("production", PRODUCTION_ARTIFACT)).toEqual([]);
expect(findAdmissionViolations("local", LOCAL_ARTIFACT)).toEqual([]);
});
it("refuses the exact local build that release coherence used to approve", () => {
// The review's strongest reproduction: FE-GATE-015 passed on a build whose
// runtime document was APP_ENV=local / AUTH_MODE=demo / loopback API. Each
// of those is now an independent refusal, so fixing one does not admit it.
const violations = findAdmissionViolations("production", LOCAL_ARTIFACT);
const fields = violations.map((violation) => violation.field);
expect(fields).toContain("APP_ENV");
expect(fields).toContain("AUTH_MODE");
expect(fields).toContain("API_BASE_URL");
expect(fields).toContain("BUILD_ID");
expect(fields).toContain("RELEASE_ID");
});
it("refuses endpoints a browser on the public internet cannot reach", () => {
for (const host of [
"http://api.example.com/",
"https://localhost/",
"https://127.0.0.1/",
"https://10.0.0.5/",
"https://192.168.1.10/",
"https://172.16.4.4/",
"https://169.254.169.254/",
"https://[::1]/",
]) {
const violations = findAdmissionViolations("production", {
...PRODUCTION_ARTIFACT,
API_BASE_URL: host,
} as AdmissionInput);
expect(violations.map((violation) => violation.field), host).toContain(
"API_BASE_URL",
);
}
});
it("refuses IPv6, mapped, CGNAT, 0/8 and internal-name hosts (Q-6.7-10)", () => {
for (const host of [
"https://[::ffff:127.0.0.1]/",
"https://[::ffff:8.8.8.8]/",
"https://[fd00::1]/",
"https://[fc12:3456::1]/",
"https://[fe80::1]/",
"https://[febf::1]/",
"https://[0:0:0:0:0:0:0:1]/",
"https://100.64.0.1/",
"https://100.127.255.254/",
"https://0.1.2.3/",
"https://api.internal/",
"https://printer.local/",
"https://localhost./",
"https://api.internal./",
]) {
const violations = findAdmissionViolations("production", {
...PRODUCTION_ARTIFACT,
API_BASE_URL: host,
} as AdmissionInput);
expect(violations.map((violation) => violation.field), host).toContain(
"API_BASE_URL",
);
}
});
it("permits a routable public host", () => {
for (const host of [
"https://api.172.16.my-product.kr/",
"https://100.128.0.1/",
"https://100.63.255.255/",
"https://[2001:db8::1]/",
"https://[fec0::1]/",
"https://internal.my-product.kr/",
"https://local.my-product.kr/",
"https://myexample.com/",
"https://example.com.my-product.kr/",
"https://tested.kr/",
]) {
expect(
findAdmissionViolations("production", {
...PRODUCTION_ARTIFACT,
API_BASE_URL: host,
} as AdmissionInput),
host,
).toEqual([]);
}
});
// 1101/13-02. RFC 2606 and RFC 6761 reserve these names for examples and
// tests, so an endpoint on one is a template value that was never replaced.
it("refuses names reserved for examples and tests", () => {
for (const host of [
"https://example.com/",
"https://api.example.com/",
"https://telemetry.staging.example.net/",
"https://example.org./",
"https://api.example/",
"https://api.invalid/",
"https://desktop.test/",
"https://API.EXAMPLE.COM/",
]) {
const violations = findAdmissionViolations("production", {
...PRODUCTION_ARTIFACT,
API_BASE_URL: host,
} as AdmissionInput);
expect(violations, host).toEqual([
{ field: "API_BASE_URL", reason: expect.stringContaining("reserved") },
]);
}
});
it("refuses a placeholder identity on a public target", () => {
for (const buildId of ["local-build", "local", "dev", "unknown", ""]) {
const violations = findAdmissionViolations("production", {
...PRODUCTION_ARTIFACT,
BUILD_ID: buildId,
} as AdmissionInput);
expect(violations.map((violation) => violation.field), buildId).toContain(
"BUILD_ID",
);
}
});
it("treats an unknown target as not a target at all", () => {
for (const value of ["prod", "PRODUCTION", "", undefined, null, 1]) {
expect(isDeploymentTarget(value), String(value)).toBe(false);
}
for (const target of DEPLOYMENT_TARGETS) {
expect(isDeploymentTarget(target)).toBe(true);
}
});
});
const IDENTITY = Object.freeze({
VITE_BUILD_ID: "20260815.42",
RELEASE_ID: "r-2026.08.15-1",
});
// What a project commits to its profile; RUNTIME_* stands in for the edit here.
const PROJECT_ENDPOINTS = Object.freeze({
...IDENTITY,
RUNTIME_API_BASE_URL: "https://api.my-product.kr/",
RUNTIME_TELEMETRY_ENDPOINT: "https://telemetry.my-product.kr/v1/events",
});
describe("runtime config profiles", () => {
it("ships one valid profile per deployment target", async () => {
const files = (await readdir("config/runtime")).sort();
expect(files).toEqual(
[...DEPLOYMENT_TARGETS].map((target) => `${target}.json`).sort(),
);
for (const target of DEPLOYMENT_TARGETS) {
const source: unknown = JSON.parse(
await readFile(path.join("config/runtime", `${target}.json`), "utf8"),
);
const parsed = runtimeConfigV2ArtifactSchema.safeParse({
...(source as Record<string, unknown>),
BUILD_ID: "20260815.42",
RELEASE_ID: "r-1",
});
expect(parsed.success, `${target}: ${JSON.stringify(parsed.error?.issues)}`).toBe(
true,
);
expect((source as Record<string, unknown>)["APP_ENV"]).toBe(target);
}
});
// 1101/13-02. The public profiles ship example endpoints. A project that
// starts from the template and builds without editing them must be refused.
it("refuses a public build from the unedited profile on both endpoints", async () => {
for (const target of ["staging", "production"] as const) {
const config = await generateRuntimeConfig(target, IDENTITY);
expect(
findAdmissionViolations(target, config as unknown as AdmissionInput).map(
(violation) => violation.field,
),
target,
).toEqual(["API_BASE_URL", "TELEMETRY_ENDPOINT"]);
}
});
it("admits a public build once the project supplies its endpoints", async () => {
for (const target of ["staging", "production"] as const) {
const config = await generateRuntimeConfig(target, PROJECT_ENDPOINTS);
expect(
findAdmissionViolations(target, config as unknown as AdmissionInput),
).toEqual([]);
}
});
it("refuses a deployment override that would make the document unservable", async () => {
await expect(
generateRuntimeConfig("production", {
VITE_BUILD_ID: "20260815.42",
RELEASE_ID: "r-1",
RUNTIME_API_BASE_URL: "http://api.example.com/",
}),
).rejects.toThrow(/runtime config is invalid/u);
});
it("refuses a staging or production build without VITE_BUILD_ID (F-6)", async () => {
for (const target of ["staging", "production"] as const) {
await expect(
generateRuntimeConfig(target, { RELEASE_ID: "r-1" }),
).rejects.toThrow(/VITE_BUILD_ID/u);
await expect(
generateRuntimeConfig(target, { VITE_BUILD_ID: "", RELEASE_ID: "r-1" }),
).rejects.toThrow(/VITE_BUILD_ID/u);
}
});
it("declares the build defaults that getBuildConfig applies (F-6)", () => {
const applied = getBuildConfig({});
expect({
VITE_BUILD_ID: ENV_REGISTRY.VITE_BUILD_ID.defaultValue,
VITE_COMMIT_SHA: ENV_REGISTRY.VITE_COMMIT_SHA.defaultValue,
VITE_ROUTER_BASE_PATH: ENV_REGISTRY.VITE_ROUTER_BASE_PATH.defaultValue,
VITE_RUNTIME_CONFIG_URL: ENV_REGISTRY.VITE_RUNTIME_CONFIG_URL.defaultValue,
}).toEqual({
VITE_BUILD_ID: applied.buildId,
VITE_COMMIT_SHA: applied.commitSha,
VITE_ROUTER_BASE_PATH: applied.routerBasePath,
VITE_RUNTIME_CONFIG_URL: applied.runtimeConfigUrl,
});
});
it("keeps a developer build from carrying a released identity by default", async () => {
const config = await generateRuntimeConfig("local", {});
expect(config["BUILD_ID"]).toBe("local-build");
expect(
findAdmissionViolations("production", config as unknown as AdmissionInput)
.length,
).toBeGreaterThan(0);
});
// F-5 (13-15). `corepack pnpm dev` serves public/config.json while every
// build writes the local profile instead, so the two copies must not drift.
it("keeps public/config.json equal to what a local build writes", async () => {
const served: unknown = JSON.parse(await readFile("public/config.json", "utf8"));
expect(served).toEqual(await generateRuntimeConfig("local", {}));
});
// 13-01: the build profile and the admission target are two repository
// variables. A staging profile left in place for a production release has to
// stop the release, whatever the built document happens to say.
it.each([
["staging", 1],
["production", 0],
] as const)("admits a production artifact under APP_PROFILE=%s only when it names the target", async (profile, status) => {
const root = await mkdtemp(path.join(tmpdir(), "release-admission-profile-"));
try {
const config = await generateRuntimeConfig("production", PROJECT_ENDPOINTS);
await mkdir(path.join(root, "dist"), { recursive: true });
await writeFile(path.join(root, "dist/config.json"), JSON.stringify(config));
const result = spawnSync(
process.execPath,
[path.resolve("scripts/check-release-admission.ts")],
{
cwd: root,
encoding: "utf8",
env: { ...process.env, APP_PROFILE: profile, RELEASE_TARGET: "production" },
},
);
expect(result.status, result.stderr).toBe(status);
if (status === 1) expect(result.stderr).toMatch(/APP_PROFILE=staging/u);
} finally {
await rm(root, { recursive: true, force: true });
}
});
});
// 1101/13-05. The emergency switches (CAPABILITY_OVERRIDES, FEATURE_OVERRIDES)
// are changed in the deployed config.json without a rebuild. A typo there stops
// every boot, so the edited copy is checked against the deployed one first.
describe("checking an edited copy of the deployed runtime config", () => {
async function check(
edit: (deployed: Record<string, unknown>) => Record<string, unknown>,
args: readonly string[] = ["--config", "edited.json", "--original", "deployed.json"],
) {
const root = await mkdtemp(path.join(tmpdir(), "release-admission-copy-"));
try {
const deployed = await generateRuntimeConfig("production", PROJECT_ENDPOINTS);
await writeFile(path.join(root, "deployed.json"), JSON.stringify(deployed));
await writeFile(path.join(root, "edited.json"), JSON.stringify(edit(deployed)));
const result = spawnSync(
process.execPath,
[path.resolve("scripts/check-release-admission.ts"), ...args],
{
cwd: root,
encoding: "utf8",
env: { ...process.env, APP_PROFILE: "production", RELEASE_TARGET: "production" },
},
);
const records = await readdir(path.join(root, "artifacts/release")).catch(() => []);
return { status: result.status, stderr: result.stderr, stdout: result.stdout, records };
} finally {
await rm(root, { recursive: true, force: true });
}
}
const withServiceWorker = (deployed: Record<string, unknown>, value: string) => ({
...deployed,
CAPABILITY_OVERRIDES: {
...(deployed["CAPABILITY_OVERRIDES"] as Record<string, unknown>),
SERVICE_WORKER: value,
},
});
it("admits a copy that only flips an emergency switch, without writing the build's record", async () => {
const result = await check((deployed) => withServiceWorker(deployed, "DISABLED"));
expect(result.status, result.stderr).toBe(0);
expect(result.stdout).toContain("edited.json");
expect(result.records).toEqual([]);
});
it("refuses a typo in a switch value", async () => {
const result = await check((deployed) => withServiceWorker(deployed, "DISABLE"));
expect(result.status).toBe(1);
expect(result.stderr).toMatch(/edited\.json is not a valid runtime config/u);
});
// A valid value, so only the comparison with the deployed copy can refuse it.
it.each([
["BUILD_ID", "20260815.43"],
["RELEASE_ID", "r-2026.08.15-2"],
["API_BASE_URL", "https://other.my-product.kr/"],
])("refuses a copy that changes %s, which only a build may change", async (field, value) => {
const result = await check((deployed) => ({ ...deployed, [field]: value }));
expect(result.status).toBe(1);
expect(result.stderr).toContain(`edited.json changes ${field}`);
});
it("refuses --config without the deployed original to compare with", async () => {
const result = await check((deployed) => deployed, ["--config", "edited.json"]);
expect(result.status).toBe(1);
expect(result.stderr).toContain("--original");
});
});