Files
openclaw/test/scripts/pr-review-artifact-validation.test.ts
2026-07-28 02:10:53 -04:00

590 lines
21 KiB
TypeScript

import { spawnSync } from "node:child_process";
import { mkdirSync, readdirSync, readFileSync, writeFileSync } from "node:fs";
import { join } from "node:path";
import { afterEach, describe, expect, it } from "vitest";
import { useAutoCleanupTempDirTracker } from "../helpers/temp-dir.js";
const tempDirs = useAutoCleanupTempDirTracker(afterEach);
const reviewScript = join(process.cwd(), "scripts/pr-lib/review.sh");
const reviewArtifactsScript = join(process.cwd(), "scripts/pr-lib/review-artifacts.mjs");
const mergeScript = join(process.cwd(), "scripts/pr-lib/merge.sh");
const describePosix = process.platform === "win32" ? describe.skip : describe;
const REVIEWED_PR = 42;
const REVIEWED_HEAD = "b".repeat(40);
const REVIEWED_IDENTITY_LINE = `Review artifact for PR #${REVIEWED_PR} at ${REVIEWED_HEAD}`;
const REVIEW_SHELL_COMMAND_SURFACE = [
"rg() {",
' if [ "${1-}" = "-F" ]; then',
" shift",
' command grep -F "$@"',
" else",
' command grep -E "$@"',
" fi",
"}",
].join("\n");
function validReview() {
return {
pr: { number: REVIEWED_PR, headSha: REVIEWED_HEAD },
recommendation: "NEEDS WORK",
findings: [] as Array<{
id: string;
title: string;
area: string;
fix: string;
severity: "BLOCKER" | "IMPORTANT" | "NIT";
}>,
nitSweep: {
performed: true,
status: "none",
summary: "No optional nits identified.",
},
behavioralSweep: {
performed: true,
status: "not_applicable",
summary: "No runtime behavior changed.",
silentDropRisk: "none",
branches: [] as unknown[],
},
issueValidation: {
performed: true,
source: "pr_body",
status: "unclear",
summary: "Review fixture.",
},
tests: {
ran: [],
gaps: [],
result: "pass",
},
docs: "not_applicable",
changelog: "not_required",
};
}
function validReadyReview() {
const review = validReview();
review.recommendation = "READY FOR /prepare-pr";
review.issueValidation.status = "valid";
return review;
}
function runValidation(
review: ReturnType<typeof validReview>,
options: {
files?: string[];
guardFailure?: boolean;
markdownIdentityLine?: string;
metaEnvPrNumber?: number;
mode?: "pr" | "main";
orList?: boolean;
} = {},
) {
const fixtureRoot = tempDirs.make("openclaw-pr-review-validation-");
const localDir = join(fixtureRoot, ".local");
mkdirSync(localDir);
writeFileSync(join(localDir, "review.json"), `${JSON.stringify(review)}\n`);
writeFileSync(
join(localDir, "review.md"),
[
options.markdownIdentityLine ?? REVIEWED_IDENTITY_LINE,
"A)",
"B)",
"C)",
"D)",
"E)",
"F)",
"G)",
"H)",
"I)",
"J)",
].join("\n"),
);
writeFileSync(
join(localDir, "pr-meta.env"),
`PR_URL=https://example.invalid/pr/42\nPR_NUMBER=${options.metaEnvPrNumber ?? REVIEWED_PR}\nPR_HEAD_SHA=${REVIEWED_HEAD}\n`,
);
writeFileSync(
join(localDir, "pr-meta.json"),
`${JSON.stringify({
number: REVIEWED_PR,
headRefOid: REVIEWED_HEAD,
files: (options.files ?? []).map((path) => ({ path })),
})}\n`,
);
return spawnSync(
"bash",
[
"-c",
[
"set -euo pipefail",
'source "$1"',
REVIEW_SHELL_COMMAND_SURFACE,
'fixture_root="$2"',
'enter_worktree() { cd "$fixture_root"; }',
'require_artifact() { [ -s "$1" ]; }',
'rg() { case " $* " in *" -F "*) grep "$@";; *) grep -E "$@";; esac; }',
options.guardFailure
? "review_guard() { REVIEW_MODE=pr; echo 'review head guard failed'; return 1; }"
: `review_guard() { REVIEW_MODE=${options.mode ?? "pr"}; }`,
"print_review_stdout_summary() { :; }",
options.orList ? "review_validate_artifacts 42 || exit 1" : "review_validate_artifacts 42",
].join("\n"),
"pr-review-artifact-validation",
reviewScript,
fixtureRoot,
],
{ encoding: "utf8" },
);
}
function runReviewShellFunction(fixtureRoot: string, invocation: string) {
return spawnSync(
"bash",
[
"-c",
[
"set -euo pipefail",
'source "$1"',
REVIEW_SHELL_COMMAND_SURFACE,
'fixture_root="$2"',
'enter_worktree() { cd "$fixture_root"; }',
'require_artifact() { [ -s "$1" ]; }',
'rg() { case " $* " in *" -F "*) grep "$@";; *) grep -E "$@";; esac; }',
"mark_pr_operation_side_effects_started() { :; }",
invocation,
].join("\n"),
"pr-review-shell",
reviewScript,
fixtureRoot,
],
{ encoding: "utf8" },
);
}
function runArtifactsInit(existing: { review?: unknown; markdown?: string } = {}) {
const fixtureRoot = tempDirs.make("openclaw-pr-review-artifacts-init-");
const localDir = join(fixtureRoot, ".local");
mkdirSync(localDir);
writeFileSync(join(localDir, "pr-meta.env"), `PR_NUMBER=${REVIEWED_PR}\n`);
writeFileSync(
join(localDir, "pr-meta.json"),
`${JSON.stringify({ number: REVIEWED_PR, headRefOid: REVIEWED_HEAD, files: [] })}\n`,
);
if (existing.review !== undefined) {
writeFileSync(join(localDir, "review.json"), `${JSON.stringify(existing.review)}\n`);
}
if (existing.markdown !== undefined) {
writeFileSync(join(localDir, "review.md"), existing.markdown);
}
const result = runReviewShellFunction(fixtureRoot, `review_artifacts_init ${REVIEWED_PR}`);
return { result, localDir };
}
function runMergeVerification(checks: "api-error" | "invalid-json" | "no-required" | "pending") {
const fixtureRoot = tempDirs.make("openclaw-pr-merge-verification-");
const localDir = join(fixtureRoot, ".local");
const head = "a".repeat(40);
mkdirSync(localDir);
writeFileSync(join(localDir, "prep.env"), `PREP_HEAD_SHA=${head}\n`);
const checksResponse =
checks === "api-error"
? "echo 'GitHub API unavailable' >&2; return 1"
: checks === "no-required"
? "echo \"no required checks reported on the 'review-branch' branch\" >&2; return 1"
: checks === "pending"
? `printf '%s\\n' '[{"name":"CI","bucket":"pending","state":"IN_PROGRESS"}]'; return 8`
: "printf '%s\\n' 'not valid JSON'";
return spawnSync(
"bash",
[
"-c",
[
"set -euo pipefail",
'source "$1"',
'fixture_root="$2"',
'enter_worktree() { cd "$fixture_root"; }',
'require_artifact() { [ -s "$1" ]; }',
"verify_prep_branch_matches_prepared_head() { :; }",
`pr_meta_json() { printf '%s\\n' '{"isDraft":false,"headRefOid":"${head}"}'; }`,
"mark_pr_operation_side_effects_started() { :; }",
"git() { :; }",
`gh() { case "$*" in *"--json name,bucket,state"*) ${checksResponse};; *) return 0;; esac; }`,
"merge_verify 42",
].join("\n"),
"pr-merge-verification",
mergeScript,
fixtureRoot,
],
{ encoding: "utf8" },
);
}
describePosix("scripts/pr review artifact validation", () => {
it("supplies direct review.sh consumers with the ripgrep command surface", () => {
const fixtureRoot = tempDirs.make("openclaw-pr-review-rg-surface-");
const target = join(fixtureRoot, "target.txt");
writeFileSync(target, `prefix ${REVIEWED_HEAD} suffix\n`);
const result = runReviewShellFunction(
fixtureRoot,
[
'test "$(type -t rg)" = "function"',
`printf '%s\\n' '${REVIEWED_HEAD}' | rg -q '^[0-9a-f]{40}$'`,
`rg -F -q '${REVIEWED_HEAD}' '${target}'`,
].join("\n"),
);
expect(result.status, `${result.stdout}\n${result.stderr}`).toBe(0);
});
it("accepts a valid review artifact", () => {
const result = runValidation(validReview());
expect(result.status, `${result.stdout}\n${result.stderr}`).toBe(0);
expect(result.stdout).toContain("review artifacts validated");
});
it("rejects a review authored for a different PR", () => {
const review = validReadyReview();
review.pr.number = 113928;
const result = runValidation(review);
expect(result.status).toBe(1);
expect(result.stdout).toContain(
`Review artifact identity mismatch in .local/review.json: authored for PR #113928 at ${REVIEWED_HEAD}, but .local/pr-meta.json describes PR #${REVIEWED_PR} at ${REVIEWED_HEAD}`,
);
});
it("rejects a review stamped with a superseded head", () => {
const review = validReadyReview();
review.pr.headSha = "c".repeat(40);
const result = runValidation(review);
expect(result.status).toBe(1);
expect(result.stdout).toContain("Review artifact identity mismatch in .local/review.json");
});
it("rejects a self-consistent artifact set describing another PR", () => {
const result = runValidation(validReadyReview(), { metaEnvPrNumber: 113928 });
expect(result.status).toBe(1);
expect(result.stdout).toContain(
`Review artifact identity mismatch: .local/pr-meta.json describes PR #${REVIEWED_PR} at ${REVIEWED_HEAD}, which does not match .local/pr-meta.env.`,
);
});
it("rejects a review markdown authored for a different PR", () => {
const result = runValidation(validReadyReview(), {
markdownIdentityLine: `Review artifact for PR #113928 at ${REVIEWED_HEAD}`,
});
expect(result.status).toBe(1);
expect(result.stdout).toContain(
`Review artifact identity mismatch in .local/review.md: first line must be "${REVIEWED_IDENTITY_LINE}"`,
);
});
it("rejects a review with no PR identity stamp", () => {
const review = validReadyReview() as Partial<ReturnType<typeof validReadyReview>>;
review.pr = undefined;
const result = runValidation(review as ReturnType<typeof validReadyReview>);
expect(result.status).toBe(1);
expect(result.stdout).toContain("Invalid PR identity in .local/review.json");
});
it("moves foreign review artifacts aside and stamps a fresh template", () => {
const foreign = validReadyReview();
foreign.pr.number = 113928;
const { result, localDir } = runArtifactsInit({
review: foreign,
markdown: "A) Ship another PR\n",
});
expect(result.status, `${result.stdout}\n${result.stderr}`).toBe(0);
expect(result.stdout).toContain("moved aside .local/review.json");
const archives = readdirSync(join(localDir, "superseded"));
expect(archives).toHaveLength(1);
const archive = join(localDir, "superseded", archives[0]!);
expect(readdirSync(archive).sort()).toEqual(["review.json", "review.md"]);
expect(JSON.parse(readFileSync(join(archive, "review.json"), "utf8")).pr.number).toBe(113928);
expect(readFileSync(join(archive, "review.md"), "utf8")).toBe("A) Ship another PR\n");
const rewritten = JSON.parse(readFileSync(join(localDir, "review.json"), "utf8"));
expect(rewritten.pr).toEqual({ number: REVIEWED_PR, headSha: REVIEWED_HEAD });
expect(rewritten.recommendation).toContain("NEEDS WORK");
const markdown = readFileSync(join(localDir, "review.md"), "utf8");
expect(markdown.split("\n")[0]).toBe(REVIEWED_IDENTITY_LINE);
expect(markdown).toContain("A) TL;DR recommendation");
});
it("re-stamps markdown left over from another PR even when the JSON stamp matches", () => {
const { result, localDir } = runArtifactsInit({
review: validReadyReview(),
markdown: `Review artifact for PR #113928 at ${REVIEWED_HEAD}\n\nA) Ship another PR\n`,
});
expect(result.status, `${result.stdout}\n${result.stderr}`).toBe(0);
expect(result.stdout).toContain("moved aside .local/review.md");
expect(readFileSync(join(localDir, "review.md"), "utf8").split("\n")[0]).toBe(
REVIEWED_IDENTITY_LINE,
);
});
it("preserves in-progress artifacts already stamped for this head", () => {
const inProgress = validReadyReview();
inProgress.issueValidation.summary = "Half-written review worth keeping.";
const { result, localDir } = runArtifactsInit({
review: inProgress,
markdown: `${REVIEWED_IDENTITY_LINE}\n\nA) Half-written review worth keeping.\n`,
});
expect(result.status, `${result.stdout}\n${result.stderr}`).toBe(0);
expect(result.stdout).toContain(
`review artifacts already stamped for PR #${REVIEWED_PR} at ${REVIEWED_HEAD}`,
);
expect(readFileSync(join(localDir, "review.md"), "utf8")).toBe(
`${REVIEWED_IDENTITY_LINE}\n\nA) Half-written review worth keeping.\n`,
);
expect(
JSON.parse(readFileSync(join(localDir, "review.json"), "utf8")).issueValidation.summary,
).toBe("Half-written review worth keeping.");
});
it("rejects a review guard whose PR metadata describes another PR", () => {
const fixtureRoot = tempDirs.make("openclaw-pr-review-guard-");
const localDir = join(fixtureRoot, ".local");
mkdirSync(localDir);
writeFileSync(join(localDir, "review-mode.env"), "REVIEW_MODE=pr\n");
writeFileSync(join(localDir, "pr-meta.env"), "PR_NUMBER=113928\n");
const result = runReviewShellFunction(fixtureRoot, `review_guard ${REVIEWED_PR}`);
expect(result.status).toBe(1);
expect(result.stdout).toContain(
`Review guard failed: .local/pr-meta.env describes PR #113928, not #${REVIEWED_PR}`,
);
});
it("rejects validation from main-baseline mode", () => {
const result = runValidation(validReview(), { mode: "main" });
expect(result.status).toBe(1);
expect(result.stdout).toContain(
"Review artifact validation requires the reviewed PR head, not main-baseline mode.",
);
});
it("preserves head-guard failures when preparation calls validation in an OR-list", () => {
const result = runValidation(validReview(), { guardFailure: true, orList: true });
expect(result.status).toBe(1);
expect(result.stdout).toContain("review head guard failed");
expect(result.stdout).not.toContain("review artifacts validated");
});
it.each(["BLOCKER", "IMPORTANT"] as const)(
"rejects a ready review containing a %s finding",
(severity) => {
const review = validReadyReview();
review.findings.push({
id: "review-finding",
title: "Actionable review finding",
area: "runtime",
fix: "Resolve the finding before preparing the PR.",
severity,
});
const result = runValidation(review);
expect(result.status).toBe(1);
expect(result.stdout).toContain(
"READY FOR /prepare-pr cannot include BLOCKER or IMPORTANT findings",
);
},
);
it("keeps non-ready findings and failed proof valid for review triage", () => {
const review = validReview();
review.findings.push({
id: "review-finding",
title: "Actionable review finding",
area: "runtime",
fix: "Resolve the finding before preparing the PR.",
severity: "IMPORTANT",
});
review.tests.result = "fail";
const result = runValidation(review);
expect(result.status, `${result.stdout}\n${result.stderr}`).toBe(0);
});
it("rejects a ready review with failing proof", () => {
const review = validReadyReview();
review.tests.result = "fail";
const result = runValidation(review);
expect(result.status).toBe(1);
expect(result.stdout).toContain("READY FOR /prepare-pr cannot include failing tests");
});
it("permits documentation-only ready reviews without runtime tests", () => {
const review = validReadyReview();
review.tests.result = "not_run";
const result = runValidation(review, { files: ["docs/reference/example.md"] });
expect(result.status, `${result.stdout}\n${result.stderr}`).toBe(0);
});
it.each([
"packages/normalization-core/src/string-normalization.ts",
"packages/gateway-protocol/src/schema/approvals.ts",
"ui/src/app.ts",
])("requires behavioral review for core runtime path %s", (path) => {
const result = runValidation(validReview(), { files: [path] });
expect(result.status).toBe(1);
expect(result.stdout).toContain(
"runtime file changes require behavioralSweep.status=pass|needs_work",
);
expect(result.stdout).toContain("runtime file changes require at least one branch entry");
});
it("requires passing runtime proof for a ready review", () => {
const review = validReadyReview();
review.behavioralSweep.status = "pass";
review.behavioralSweep.branches.push({
path: "ui/src/app.ts",
decision: "verified",
outcome: "Behavior remains correct.",
});
review.tests.result = "not_run";
const result = runValidation(review, { files: ["ui/src/app.ts"] });
expect(result.status).toBe(1);
expect(result.stdout).toContain(
"READY FOR /prepare-pr on runtime changes requires passing tests",
);
});
it("rejects merge verification when GitHub cannot verify required checks", () => {
const result = runMergeVerification("api-error");
expect(result.status).toBe(1);
expect(result.stderr).toContain("unable to verify the required GitHub checks");
expect(result.stderr).toContain("GitHub API unavailable");
expect(result.stdout).not.toContain("merge-verify passed");
expect(result.stdout).not.toContain("No required checks configured");
});
it("preserves GitHub CLI behavior when a branch has no required checks", () => {
const result = runMergeVerification("no-required");
expect(result.status, `${result.stdout}\n${result.stderr}`).toBe(0);
expect(result.stdout).toContain("No required checks configured for this PR.");
expect(result.stdout).toContain("merge-verify passed for PR #42");
});
it("preserves GitHub CLI pending-check evidence from exit status eight", () => {
const result = runMergeVerification("pending");
expect(result.status).toBe(1);
expect(result.stdout).toContain("Required checks are still pending.");
expect(result.stderr).not.toContain("unable to verify the required GitHub checks");
expect(result.stdout).not.toContain("merge-verify passed");
});
it("rejects merge verification when GitHub returns malformed check evidence", () => {
const result = runMergeVerification("invalid-json");
expect(result.status).toBe(1);
expect(result.stderr).toContain("GitHub returned invalid required-check evidence");
expect(result.stdout).not.toContain("merge-verify passed");
});
it("reports the required branch entry shape without a raw jq error", () => {
const review = validReview();
review.behavioralSweep.branches = ["src/example.ts"];
const result = runValidation(review);
expect(result.status).toBe(1);
expect(result.stdout).toContain(
"Invalid behavioral sweep branch entry in .local/review.json: each entry must be an object with string path/decision/outcome",
);
expect(`${result.stdout}\n${result.stderr}`).not.toContain(
'Cannot index string with string ("path")',
);
});
it("lists allowed values for an invalid enum", () => {
const review = validReview();
review.behavioralSweep.status = "performed";
const result = runValidation(review);
expect(result.status).toBe(1);
expect(result.stdout).toContain(
'Invalid behavioral sweep status in .local/review.json: "performed" (allowed: pass|needs_work|not_applicable)',
);
});
it("reports every artifact violation before exiting", () => {
const review = validReview();
review.behavioralSweep.status = "performed";
review.behavioralSweep.branches = "src/example.ts" as unknown as unknown[];
review.docs = "todo";
const result = runValidation(review);
expect(result.status).toBe(1);
expect(result.stdout).toContain(
'Invalid behavioral sweep status in .local/review.json: "performed" (allowed: pass|needs_work|not_applicable)',
);
expect(result.stdout).toContain(
"Invalid behavioral sweep in .local/review.json: behavioralSweep.branches must be an array",
);
expect(result.stdout).toContain(
'Invalid docs status in .local/review.json: "todo" (allowed: up_to_date|missing|not_applicable)',
);
expect(result.stdout).toContain("3 artifact violations");
});
it("derives template enum hints from the validation table", () => {
const result = spawnSync(
process.execPath,
[reviewArtifactsScript, "template", String(REVIEWED_PR), REVIEWED_HEAD],
{ encoding: "utf8" },
);
const template = JSON.parse(result.stdout) as ReturnType<typeof validReview>;
expect(result.status, `${result.stdout}\n${result.stderr}`).toBe(0);
expect(template.pr).toEqual({ number: REVIEWED_PR, headSha: REVIEWED_HEAD });
expect(template.recommendation).toBe(
"NEEDS WORK (allowed: READY FOR /prepare-pr|NEEDS WORK|NEEDS DISCUSSION|NOT USEFUL (CLOSE))",
);
expect(template.nitSweep.status).toBe("none (allowed: none|has_nits)");
expect(template.behavioralSweep.status).toBe(
"not_applicable (allowed: pass|needs_work|not_applicable)",
);
expect(template.behavioralSweep.silentDropRisk).toBe("none (allowed: none|present|unknown)");
expect(template.issueValidation.source).toBe("pr_body (allowed: linked_issue|pr_body|both)");
expect(template.issueValidation.status).toBe(
"unclear (allowed: valid|unclear|invalid|already_fixed_on_main)",
);
expect(template.tests.result).toBe("pass (allowed: pass|fail|not_run)");
expect(template.docs).toBe("not_applicable (allowed: up_to_date|missing|not_applicable)");
expect(template.changelog).toBe("not_required (allowed: required|not_required)");
});
});