fix(scripts): add docker e2e scheduler help

vincentkoc · vincentkoc · commit 81f62a689b52 · 2026-05-26T08:07:36.000+02:00
diff --git a/scripts/test-docker-all.mjs b/scripts/test-docker-all.mjs
@@ -41,13 +41,51 @@ const DEFAULT_GITHUB_WORKFLOW = "openclaw-live-and-e2e-checks-reusable.yml";
 const IS_MAIN = process.argv[1]
   ? path.resolve(process.argv[1]) === fileURLToPath(import.meta.url)
   : false;
-const cliArgs = new Set(IS_MAIN ? process.argv.slice(2) : []);
-if (IS_MAIN) {
-  for (const arg of cliArgs) {
-    if (arg !== "--plan-json") {
-      throw new Error(`unknown argument: ${arg}`);
+
+export function dockerAllUsage() {
+  return [
+    "Usage: node scripts/test-docker-all.mjs [--plan-json]",
+    "",
+    "Options:",
+    "  --plan-json    Print the resolved Docker E2E plan as JSON and exit.",
+    "  -h, --help     Show this help.",
+    "",
+    "Lane selection and scheduler settings are configured with OPENCLAW_DOCKER_ALL_* env vars.",
+  ].join("\n");
+}
+
+export function parseDockerAllCliArgs(argv) {
+  const options = {
+    help: false,
+    planJson: false,
+  };
+  for (const arg of argv) {
+    if (arg === "--plan-json") {
+      options.planJson = true;
+    } else if (arg === "--help" || arg === "-h") {
+      options.help = true;
+    } else {
+      throw new Error(`unknown argument: ${arg}\n\n${dockerAllUsage()}`);
     }
   }
+  return options;
+}
+
+let cliOptions = {
+  help: false,
+  planJson: false,
+};
+if (IS_MAIN) {
+  try {
+    cliOptions = parseDockerAllCliArgs(process.argv.slice(2));
+  } catch (error) {
+    console.error(error instanceof Error ? error.message : String(error));
+    process.exit(1);
+  }
+  if (cliOptions.help) {
+    console.log(dockerAllUsage());
+    process.exit(0);
+  }
 }
 
 function parsePositiveInt(raw, fallback, label) {
@@ -1107,7 +1145,7 @@ async function main() {
   const timingsEnabled = parseBool(process.env.OPENCLAW_DOCKER_ALL_TIMINGS, true);
   const buildEnabled = parseBool(process.env.OPENCLAW_DOCKER_ALL_BUILD, true);
   const planJson =
-    cliArgs.has("--plan-json") || parseBool(process.env.OPENCLAW_DOCKER_ALL_PLAN_JSON, false);
+    cliOptions.planJson || parseBool(process.env.OPENCLAW_DOCKER_ALL_PLAN_JSON, false);
   const planReleaseAll = parseBool(process.env.OPENCLAW_DOCKER_ALL_PLAN_RELEASE_ALL, false);
   const profile = parseProfile(process.env.OPENCLAW_DOCKER_ALL_PROFILE);
   const releaseProfile = normalizeReleaseProfile(
diff --git a/test/scripts/docker-all-scheduler.test.ts b/test/scripts/docker-all-scheduler.test.ts
@@ -1,8 +1,10 @@
+import { spawnSync } from "node:child_process";
 import { describe, expect, it } from "vitest";
 import { DEFAULT_RESOURCE_LIMITS } from "../../scripts/lib/docker-e2e-plan.mjs";
 import {
   canStartSchedulerLane,
   describeDockerSchedulerLimits,
+  parseDockerAllCliArgs,
 } from "../../scripts/test-docker-all.mjs";
 
 const limits = {
@@ -30,6 +32,46 @@ function activePool({
 }
 
 describe("scripts/test-docker-all scheduler", () => {
+  it("parses the supported CLI options", () => {
+    expect(parseDockerAllCliArgs([])).toEqual({
+      help: false,
+      planJson: false,
+    });
+    expect(parseDockerAllCliArgs(["--plan-json"])).toEqual({
+      help: false,
+      planJson: true,
+    });
+    expect(parseDockerAllCliArgs(["--help"])).toEqual({
+      help: true,
+      planJson: false,
+    });
+  });
+
+  it("prints CLI help without a stack trace", () => {
+    const result = spawnSync(process.execPath, ["scripts/test-docker-all.mjs", "--help"], {
+      cwd: process.cwd(),
+      encoding: "utf8",
+    });
+
+    expect(result.status).toBe(0);
+    expect(result.stderr).toBe("");
+    expect(result.stdout).toContain("Usage: node scripts/test-docker-all.mjs [--plan-json]");
+    expect(result.stdout).toContain("OPENCLAW_DOCKER_ALL_* env vars");
+  });
+
+  it("rejects unknown CLI options without a stack trace", () => {
+    const result = spawnSync(process.execPath, ["scripts/test-docker-all.mjs", "--bogus"], {
+      cwd: process.cwd(),
+      encoding: "utf8",
+    });
+
+    expect(result.status).toBe(1);
+    expect(result.stdout).toBe("");
+    expect(result.stderr).toContain("unknown argument: --bogus");
+    expect(result.stderr).toContain("Usage: node scripts/test-docker-all.mjs [--plan-json]");
+    expect(result.stderr).not.toContain("at ");
+  });
+
   it("allows an overweight lane to start alone under low parallelism", () => {
     expect(
       canStartSchedulerLane(
