mirror of
https://github.com/openclaw/openclaw.git
synced 2026-10-03 17:53:39 +00:00
eaaa6da895
* perf(ui): remove redundant login failure projections * perf(ci): balance release E2E and reuse npm downloads * refactor(ci): keep timing run provenance separate * fix(ci): preserve reporter types and trim login refresh state * refactor(ui): render login recovery commands directly * fix(ci): isolate release npm seed publication queue * fix(release): bound candidate metadata enumeration
273 lines
10 KiB
TypeScript
273 lines
10 KiB
TypeScript
import fs from "node:fs/promises";
|
|
import path from "node:path";
|
|
import { withTempHome } from "openclaw/plugin-sdk/test-env";
|
|
import { describe, expect, it } from "vitest";
|
|
import { runBuiltCli } from "./cli-json-stdout.test-support.js";
|
|
|
|
describe("cli json stdout contract", () => {
|
|
it.each([
|
|
{
|
|
name: "implicit JSON",
|
|
args: ["cron", "edit", "job-1", "--enable", "--disable"],
|
|
},
|
|
{
|
|
name: "explicit JSON",
|
|
args: ["cron", "edit", "job-1", "--enable", "--disable", "--json"],
|
|
},
|
|
{
|
|
name: "automation alias implicit JSON",
|
|
args: ["automations", "edit", "job-1", "--enable", "--disable"],
|
|
},
|
|
{
|
|
name: "ordinary local validation failure",
|
|
args: ["cron", "edit", "job-1", "--command-cwd", "", "--json"],
|
|
message: "--command-cwd must not be blank",
|
|
},
|
|
{
|
|
name: "Gateway failure implicit JSON",
|
|
args: ["cron", "edit", "job-1", "--enable", "--port", "29793", "--token", "fixture-token"],
|
|
gatewayRequest: true,
|
|
},
|
|
{
|
|
name: "Gateway failure explicit JSON",
|
|
args: [
|
|
"cron",
|
|
"edit",
|
|
"job-1",
|
|
"--enable",
|
|
"--port",
|
|
"29793",
|
|
"--token",
|
|
"fixture-token",
|
|
"--json",
|
|
],
|
|
gatewayRequest: true,
|
|
},
|
|
{
|
|
name: "forced Commander JSON",
|
|
args: ["cron", "edit", "job-1", "--enable", "--disable", "--json"],
|
|
commander: true,
|
|
},
|
|
{
|
|
name: "dual-TTY implicit JSON",
|
|
args: ["cron", "edit", "job-1", "--enable", "--disable"],
|
|
tty: true,
|
|
},
|
|
{
|
|
name: "dual-TTY automation alias implicit JSON",
|
|
args: ["automations", "edit", "job-1", "--enable", "--disable"],
|
|
tty: true,
|
|
},
|
|
{
|
|
name: "dual-TTY implicit JSON command sibling",
|
|
args: ["cron", "runs", "--id", "job-1", "--limit", "invalid"],
|
|
message: "Invalid --limit (must be a positive integer).",
|
|
tty: true,
|
|
},
|
|
{
|
|
name: "dual-TTY raw-output command sibling",
|
|
args: ["cron", "scratch", "job-1", "--set", "updated", "--unset"],
|
|
message: "choose only one of --set, --file, or --unset",
|
|
tty: true,
|
|
},
|
|
{
|
|
name: "dual-TTY explicit JSON",
|
|
args: ["cron", "edit", "job-1", "--enable", "--disable", "--json"],
|
|
tty: true,
|
|
},
|
|
{
|
|
name: "human-output sibling",
|
|
args: ["cron", "list", "--agent", ""],
|
|
message: "--agent must not be blank",
|
|
human: true,
|
|
},
|
|
{
|
|
name: "dual-TTY human-output sibling",
|
|
args: ["cron", "list", "--agent", ""],
|
|
message: "--agent must not be blank",
|
|
human: true,
|
|
tty: true,
|
|
},
|
|
])("renders cron edit failures through the shared owner for $name", async (testCase) => {
|
|
await withTempHome(
|
|
async (tempHome) => {
|
|
const configPath = path.join(tempHome, "missing-openclaw.json");
|
|
const stateDir = path.join(tempHome, "isolated-state");
|
|
const gatewayError = "AUTOQA_INJECTED_GATEWAY_FAILURE";
|
|
const preload = Buffer.from(
|
|
[
|
|
'import net from "node:net";',
|
|
`net.Socket.prototype.connect = function () { throw new Error(${JSON.stringify(gatewayError)}); };`,
|
|
...("tty" in testCase
|
|
? [
|
|
'Object.defineProperty(process.stdout, "isTTY", { value: true, configurable: true });',
|
|
'Object.defineProperty(process.stderr, "isTTY", { value: true, configurable: true });',
|
|
]
|
|
: []),
|
|
].join("\n"),
|
|
).toString("base64");
|
|
const result = runBuiltCli(tempHome, testCase.args, {
|
|
NODE_OPTIONS: `--import=data:text/javascript;base64,${preload}`,
|
|
OPENCLAW_CONFIG_PATH: configPath,
|
|
OPENCLAW_DISABLE_BUNDLED_PLUGINS: "1",
|
|
OPENCLAW_STATE_DIR: stateDir,
|
|
...("commander" in testCase ? { OPENCLAW_DISABLE_ROUTE_FIRST: "1" } : {}),
|
|
...("tty" in testCase ? { FORCE_COLOR: "1" } : {}),
|
|
});
|
|
const message =
|
|
"gatewayRequest" in testCase
|
|
? gatewayError
|
|
: (testCase.message ?? "Choose --enable or --disable, not both");
|
|
|
|
expect(result.status, result.stderr).toBe(1);
|
|
if ("human" in testCase) {
|
|
if ("tty" in testCase) {
|
|
expect(result.stdout).toContain("OpenClaw");
|
|
} else {
|
|
expect(result.stdout).toBe("");
|
|
}
|
|
} else {
|
|
expect(result.stdout, result.stderr).not.toMatch(/[\u001B\u0007]/u);
|
|
expect(JSON.parse(result.stdout)).toEqual({
|
|
ok: false,
|
|
error: { type: "cli_error", message },
|
|
});
|
|
}
|
|
expect(result.stderr).toContain(message);
|
|
if ("gatewayRequest" in testCase) {
|
|
expect(result.stderr).toContain(gatewayError);
|
|
} else {
|
|
expect(result.stderr).not.toContain(gatewayError);
|
|
await expect(fs.stat(stateDir)).rejects.toMatchObject({ code: "ENOENT" });
|
|
}
|
|
if ("tty" in testCase && !("human" in testCase)) {
|
|
expect(result.stderr).toContain("\u001B[?25h");
|
|
}
|
|
await expect(fs.stat(configPath)).rejects.toMatchObject({ code: "ENOENT" });
|
|
},
|
|
{ prefix: "openclaw-cron-edit-json-failure-e2e-" },
|
|
);
|
|
});
|
|
|
|
it("renders a missing TaskFlow as one canonical JSON document without stderr", async () => {
|
|
await withTempHome(
|
|
async (tempHome) => {
|
|
const result = runBuiltCli(tempHome, ["tasks", "flow", "show", "missing-flow", "--json"]);
|
|
|
|
expect(result.status, result.stderr).toBe(1);
|
|
expect(result.stdout, result.stderr).not.toBe("");
|
|
expect(JSON.parse(result.stdout)).toEqual({
|
|
ok: false,
|
|
error: {
|
|
type: "cli_error",
|
|
message:
|
|
"TaskFlow not found: missing-flow. Run openclaw tasks flow list to see recent flow ids.",
|
|
},
|
|
});
|
|
expect(result.stderr).toBe("");
|
|
},
|
|
{ prefix: "openclaw-task-flow-json-failure-e2e-" },
|
|
);
|
|
});
|
|
|
|
it.each([
|
|
{
|
|
name: "audit limit in human mode",
|
|
args: ["tasks", "audit", "--limit", "5abc"],
|
|
message: "--limit must be a positive integer, for example --limit 25.",
|
|
human: true,
|
|
},
|
|
{
|
|
name: "notify policy in human mode",
|
|
args: ["tasks", "notify", "task-123", "sometimes"],
|
|
message: "Notify policy must be done_only, state_changes, or silent.",
|
|
human: true,
|
|
},
|
|
{
|
|
name: "routed audit limit with leaf JSON",
|
|
args: ["tasks", "audit", "--json", "--limit", "5abc"],
|
|
message: "--limit must be a positive integer, for example --limit 25.",
|
|
},
|
|
{
|
|
name: "routed audit limit with parent JSON",
|
|
args: ["tasks", "--json", "audit", "--limit", "5abc"],
|
|
message: "--limit must be a positive integer, for example --limit 25.",
|
|
},
|
|
{
|
|
name: "Commander audit limit with leaf JSON",
|
|
args: ["tasks", "audit", "--limit", "5abc", "--json"],
|
|
message: "--limit must be a positive integer, for example --limit 25.",
|
|
commander: true,
|
|
},
|
|
{
|
|
name: "Commander audit limit with parent JSON",
|
|
args: ["tasks", "--json", "audit", "--limit", "5abc"],
|
|
message: "--limit must be a positive integer, for example --limit 25.",
|
|
commander: true,
|
|
},
|
|
{
|
|
name: "routed audit with an inherited runtime",
|
|
args: ["tasks", "--json", "--runtime", "cli", "audit"],
|
|
message: "`tasks audit` does not support inherited option --runtime.",
|
|
},
|
|
{
|
|
name: "Commander audit with an inherited status",
|
|
args: ["tasks", "--json", "--status", "running", "audit"],
|
|
message: "`tasks audit` does not support inherited option --status.",
|
|
commander: true,
|
|
},
|
|
{
|
|
name: "routed maintenance with an inherited runtime",
|
|
args: ["tasks", "--runtime", "cli", "maintenance", "--json"],
|
|
message: "`tasks maintenance` does not support inherited option --runtime.",
|
|
},
|
|
{
|
|
name: "routed TaskFlow list with an inherited task status",
|
|
args: ["tasks", "--json", "--status", "running", "flow", "list"],
|
|
message: "`tasks flow list` does not support inherited option --status.",
|
|
},
|
|
{
|
|
name: "Commander TaskFlow show with an inherited runtime",
|
|
args: ["tasks", "--runtime", "cli", "flow", "--json", "show", "flow-123"],
|
|
message: "`tasks flow show` does not support inherited option --runtime.",
|
|
commander: true,
|
|
},
|
|
{
|
|
name: "routed audit limit through dual-TTY finalization",
|
|
args: ["tasks", "audit", "--json", "--limit", "5abc"],
|
|
message: "--limit must be a positive integer, for example --limit 25.",
|
|
tty: true,
|
|
},
|
|
])("renders task registration validation failures for $name", async (testCase) => {
|
|
await withTempHome(
|
|
async (tempHome) => {
|
|
const preload = `data:text/javascript,${encodeURIComponent(
|
|
'Object.defineProperty(process.stdout, "isTTY", { value: true, configurable: true }); Object.defineProperty(process.stderr, "isTTY", { value: true, configurable: true });',
|
|
)}`;
|
|
const result = runBuiltCli(tempHome, testCase.args, {
|
|
OPENCLAW_STATE_DIR: path.join(tempHome, "isolated-state"),
|
|
OPENCLAW_CONFIG_PATH: path.join(tempHome, "missing-openclaw.json"),
|
|
...("commander" in testCase ? { OPENCLAW_DISABLE_ROUTE_FIRST: "1" } : {}),
|
|
...("tty" in testCase ? { NODE_OPTIONS: `--import=${preload}`, FORCE_COLOR: "1" } : {}),
|
|
});
|
|
|
|
expect(result.status, result.stderr).toBe(1);
|
|
expect(result.stdout, result.stderr).not.toMatch(/[\u001B\u0007]/u);
|
|
if ("human" in testCase) {
|
|
expect(result.stdout).toBe("");
|
|
} else {
|
|
expect(JSON.parse(result.stdout)).toEqual({
|
|
ok: false,
|
|
error: { type: "cli_error", message: testCase.message },
|
|
});
|
|
}
|
|
expect(result.stderr).toContain(testCase.message);
|
|
expect(result.stderr.split(testCase.message)).toHaveLength(2);
|
|
if ("tty" in testCase) {
|
|
expect(result.stderr).toContain("\u001B[?25h");
|
|
}
|
|
},
|
|
{ prefix: "openclaw-task-registration-json-failure-e2e-" },
|
|
);
|
|
});
|
|
});
|