test: add env mutation report

2026-06-06 05:51:15 +08:00 · 2026-06-04 19:59:11 +01:00
parent 85b4bd6c7b
commit 51f9082873
2 changed files with 582 additions and 0 deletions
--- a/test/scripts/test-env-mutation-report.test.ts
+++ b/test/scripts/test-env-mutation-report.test.ts
@@ -0,0 +1,143 @@
+import { spawnSync } from "node:child_process";
+import fs from "node:fs";
+import path from "node:path";
+import { describe, expect, it } from "vitest";
+import {
+  collectTestEnvMutationReport,
+  renderTestEnvMutationReport,
+  type TestEnvMutationReport,
+} from "../../scripts/test-env-mutation-report.js";
+import { createScriptTestHarness } from "./test-helpers.js";
+
+const { createTempDir } = createScriptTestHarness();
+
+function writeRepoFile(repoRoot: string, relativePath: string, value: string): void {
+  const filePath = path.join(repoRoot, relativePath);
+  fs.mkdirSync(path.dirname(filePath), { recursive: true });
+  fs.writeFileSync(filePath, value, "utf8");
+}
+
+function makeEnvMutationFixture(): string {
+  const repoRoot = createTempDir("openclaw-test-env-mutations-");
+  writeRepoFile(
+    repoRoot,
+    "src/runtime.ts",
+    `
+process.env.OPENCLAW_STATE_DIR = "ignored because this is not a test file";
+`,
+  );
+  writeRepoFile(
+    repoRoot,
+    "src/example.test.ts",
+    `
+process.env.OPENCLAW_STATE_DIR = "state";
+delete process.env["OPENCLAW_CONFIG_PATH"];
+vi.stubEnv("HOME", "home");
+vi.stubEnv("OPENCLAW_WORKSPACE_DIR", "workspace");
+process.env = { ...process.env, OPENCLAW_HOME: "home", OTHER_KEY: "ignored" };
+const dynamicEnvKey = "OPENCLAW_STATE_DIR";
+process.env[dynamicEnvKey] = "dynamic";
+delete process.env[dynamicEnvKey];
+const fixture = 'process.env.OPENCLAW_HOME = "not code"';
+process.env.NOT_OPENCLAW = "ignored";
+`,
+  );
+  writeRepoFile(
+    repoRoot,
+    "scripts/mcp-code-mode-gateway-e2e.ts",
+    `
+process.env.OPENCLAW_CONFIG_PATH = "script-harness";
+`,
+  );
+  writeRepoFile(
+    repoRoot,
+    "src/agents/auth-profiles/oauth-test-utils.ts",
+    `
+process.env.OPENCLAW_AGENT_DIR = "agent";
+`,
+  );
+  writeRepoFile(
+    repoRoot,
+    "src/test-utils/openclaw-test-state.ts",
+    `
+process.env.HOME = "allowed";
+delete process.env.OPENCLAW_STATE_DIR;
+`,
+  );
+  return repoRoot;
+}
+
+describe("collectTestEnvMutationReport", () => {
+  it("reports active OpenClaw env mutations while ignoring strings and non-test files", () => {
+    const report = collectTestEnvMutationReport({ repoRoot: makeEnvMutationFixture() });
+
+    expect(
+      report.activeFindings.map((finding) => ({
+        file: finding.file,
+        key: finding.key,
+        operation: finding.operation,
+      })),
+    ).toEqual([
+      {
+        file: "scripts/mcp-code-mode-gateway-e2e.ts",
+        key: "OPENCLAW_CONFIG_PATH",
+        operation: "assign",
+      },
+      {
+        file: "src/agents/auth-profiles/oauth-test-utils.ts",
+        key: "OPENCLAW_AGENT_DIR",
+        operation: "assign",
+      },
+      { file: "src/example.test.ts", key: "OPENCLAW_STATE_DIR", operation: "assign" },
+      { file: "src/example.test.ts", key: "OPENCLAW_CONFIG_PATH", operation: "delete" },
+      { file: "src/example.test.ts", key: "HOME", operation: "stubEnv" },
+      { file: "src/example.test.ts", key: "OPENCLAW_WORKSPACE_DIR", operation: "stubEnv" },
+      { file: "src/example.test.ts", key: "OPENCLAW_HOME", operation: "replace" },
+      { file: "src/example.test.ts", key: "<dynamic>", operation: "assign" },
+      { file: "src/example.test.ts", key: "<dynamic>", operation: "delete" },
+    ]);
+    expect(report.allowedFindings).toHaveLength(2);
+    expect(report.summary).toMatchObject({
+      activeFileCount: 3,
+      activeFindingCount: 9,
+      allowedFileCount: 1,
+      allowedFindingCount: 2,
+    });
+  });
+
+  it("renders a non-blocking text report for active findings", () => {
+    const report = collectTestEnvMutationReport({ repoRoot: makeEnvMutationFixture() });
+
+    const rendered = renderTestEnvMutationReport(report, { includeAllowed: true });
+
+    expect(rendered).toContain("OpenClaw test env mutation report");
+    expect(rendered).toContain("Findings: 9 active in 3 file(s), 2 allowed in 1 file(s)");
+    expect(rendered).toContain("- src/example.test.ts (7)");
+    expect(rendered).toContain("L2 OPENCLAW_STATE_DIR assign process.env");
+    expect(rendered).toContain("Allowed harness findings:");
+  });
+
+  it("prints JSON from the CLI and exits successfully", () => {
+    const repoRoot = makeEnvMutationFixture();
+    const result = spawnSync(
+      process.execPath,
+      [
+        "--import",
+        "tsx",
+        path.join(process.cwd(), "scripts/test-env-mutation-report.ts"),
+        "--",
+        "--repo-root",
+        repoRoot,
+        "--json",
+      ],
+      {
+        encoding: "utf8",
+      },
+    );
+
+    expect(result.status).toBe(0);
+    const report = JSON.parse(result.stdout) as TestEnvMutationReport;
+    expect(report.summary.activeFindingCount).toBe(9);
+    expect(report.summary.allowedFindingCount).toBe(2);
+  });
+});