openclaw/test/scripts/test-perf-budget.test.ts

// Test Perf Budget tests cover test perf budget script behavior.
import fs from "node:fs";
import os from "node:os";
import path from "node:path";
import { describe, expect, it } from "vitest";
import { testing } from "../../scripts/test-perf-budget.mjs";

function withReport(payload: unknown, run: (reportPath: string) => void) {
  const reportPath = path.join(os.tmpdir(), `openclaw-test-perf-budget-${Date.now()}.json`);
  fs.writeFileSync(
    reportPath,
    typeof payload === "string" ? payload : `${JSON.stringify(payload)}\n`,
  );
  try {
    run(reportPath);
  } finally {
    fs.rmSync(reportPath, { force: true });
  }
}

describe("test perf budget script", () => {
  it("requires a budget source unless report-only mode is explicit", () => {
    expect(() => testing.parseArgs([], {})).toThrow(
      "provide --max-wall-ms, --baseline-wall-ms, or set --report-only",
    );
    expect(testing.parseArgs(["--report-only"], {})).toMatchObject({
      baselineWallMs: null,
      maxWallMs: null,
      reportOnly: true,
    });
    expect(
      testing.parseArgs([], {
        OPENCLAW_TEST_PERF_REPORT_ONLY: "yes",
      }),
    ).toMatchObject({
      baselineWallMs: null,
      maxWallMs: null,
      reportOnly: true,
    });
    expect(testing.parseArgs(["--baseline-wall-ms", "1000"], {})).toMatchObject({
      baselineWallMs: 1000,
      maxRegressionPct: 10,
      maxWallMs: null,
      reportOnly: false,
    });
  });

  it("parses numeric budget env vars strictly before running Vitest", () => {
    expect(
      testing.parseArgs([], {
        OPENCLAW_TEST_PERF_BASELINE_WALL_MS: "1000",
        OPENCLAW_TEST_PERF_MAX_REGRESSION_PCT: "12.5",
        OPENCLAW_TEST_PERF_MAX_WALL_MS: "1500",
      }),
    ).toMatchObject({
      baselineWallMs: 1000,
      maxRegressionPct: 12.5,
      maxWallMs: 1500,
    });

    expect(() =>
      testing.parseArgs([], {
        OPENCLAW_TEST_PERF_MAX_WALL_MS: "1000ms",
      }),
    ).toThrow("OPENCLAW_TEST_PERF_MAX_WALL_MS must be a non-negative number");
  });

  it("rejects malformed CLI budget values before running Vitest", () => {
    expect(testing.parseArgs(["--max-wall-ms", "1e3"], {})).toMatchObject({
      maxWallMs: 1000,
    });

    expect(() => testing.parseArgs(["--max-wall-ms", "1e3ms"], {})).toThrow(
      "--max-wall-ms must be a non-negative number",
    );
    expect(() => testing.parseArgs(["--max-regression-pct"], {})).toThrow(
      "--max-regression-pct requires a value",
    );
    expect(() => testing.parseArgs(["--max-wall-ms", "--baseline-wall-ms", "1000"], {})).toThrow(
      "--max-wall-ms requires a value",
    );
  });

  it("requires timed file evidence in the Vitest JSON report", () => {
    withReport(
      {
        testResults: [{ endTime: 1400, name: "test/scripts/demo.test.ts", startTime: 1000 }],
      },
      (reportPath) => {
        expect(testing.collectPerfReportStats(reportPath)).toEqual({
          fileCount: 1,
          totalFileDurationMs: 400,
        });
      },
    );

    withReport({ testResults: [] }, (reportPath) => {
      expect(() => testing.collectPerfReportStats(reportPath)).toThrow(
        "Vitest JSON report contained no timed file results",
      );
    });
    withReport({ testResults: [{ name: "missing-timing" }] }, (reportPath) => {
      expect(() => testing.collectPerfReportStats(reportPath)).toThrow(
        "Vitest JSON report contained no timed file results",
      );
    });
    withReport("{", (reportPath) => {
      expect(() => testing.collectPerfReportStats(reportPath)).toThrow(
        "failed to read Vitest JSON report",
      );
    });
  });
});