Files
openclaw/src/cli/program.nodes-media.e2e.test.ts
2026-05-13 06:17:56 +01:00

355 lines
11 KiB
TypeScript

import * as fs from "node:fs/promises";
import { Command } from "commander";
import { afterAll, beforeAll, beforeEach, describe, expect, it, vi } from "vitest";
import { IOS_NODE, createIosNodeListResponse } from "./program.nodes-test-helpers.js";
import { callGateway, installBaseProgramMocks, runtime } from "./program.test-mocks.js";
installBaseProgramMocks();
let registerNodesCli: typeof import("./nodes-cli.js").registerNodesCli;
function getFirstRuntimeLogLine(): string {
const first = runtime.log.mock.calls[0]?.[0];
if (typeof first !== "string") {
throw new Error(`Expected runtime.log first arg to be string, got ${typeof first}`);
}
return first;
}
async function expectLoggedSingleMediaFile(params?: {
expectedContent?: string;
expectedPathPattern?: RegExp;
}): Promise<string> {
const out = getFirstRuntimeLogLine();
const mediaPath = out.replace(/^MEDIA:/, "").trim();
if (params?.expectedPathPattern) {
expect(mediaPath).toMatch(params.expectedPathPattern);
}
try {
await expect(fs.readFile(mediaPath, "utf8")).resolves.toBe(params?.expectedContent ?? "hi");
} finally {
await fs.unlink(mediaPath).catch(() => {});
}
return mediaPath;
}
function mockNodeGateway(command?: string, payload?: Record<string, unknown>) {
callGateway.mockImplementation(async (...args: unknown[]) => {
const opts = (args[0] ?? {}) as { method?: string };
if (opts.method === "node.list") {
return createIosNodeListResponse();
}
if (opts.method === "node.invoke" && command) {
return {
ok: true,
nodeId: IOS_NODE.nodeId,
command,
payload,
};
}
return { ok: true };
});
}
function nodeInvokeCalls(): Array<{
method?: unknown;
params: Record<string, unknown>;
commandParams: Record<string, unknown>;
}> {
return callGateway.mock.calls
.map((call) => call[0] as { method?: unknown; params?: Record<string, unknown> })
.filter((call) => call.method === "node.invoke")
.map((call) => {
const params = call.params ?? {};
const commandParams = (params.params ?? {}) as Record<string, unknown>;
return { method: call.method, params, commandParams };
});
}
function latestNodeInvokeCall() {
const call = nodeInvokeCalls().at(-1);
if (!call) {
throw new Error("expected node.invoke gateway call");
}
return call;
}
function expectUuidString(value: unknown) {
expect(value).toEqual(
expect.stringMatching(
/^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$/i,
),
);
}
describe("cli program (nodes media)", () => {
let program: Command;
beforeAll(async () => {
({ registerNodesCli } = await import("./nodes-cli.js"));
program = new Command();
program.exitOverride();
await registerNodesCli(program);
});
async function runNodesCommand(argv: string[]) {
runtime.log.mockClear();
await program.parseAsync(argv, { from: "user" });
}
async function expectCameraSnapParseFailure(args: string[], expectedError: RegExp) {
mockNodeGateway();
const parseProgram = new Command();
parseProgram.exitOverride();
await registerNodesCli(parseProgram);
runtime.error.mockClear();
await expect(parseProgram.parseAsync(args, { from: "user" })).rejects.toThrow(/exit/i);
expect(runtime.error).toHaveBeenCalledWith(expect.stringMatching(expectedError));
}
async function runAndExpectUrlPayloadMediaFile(params: {
command: "camera.snap" | "camera.clip";
payload: Record<string, unknown>;
argv: string[];
expectedPathPattern: RegExp;
}) {
mockNodeGateway(params.command, params.payload);
await runNodesCommand(params.argv);
await expectLoggedSingleMediaFile({
expectedPathPattern: params.expectedPathPattern,
expectedContent: "url-content",
});
}
beforeEach(() => {
vi.clearAllMocks();
});
it("runs nodes camera snap and prints two MEDIA paths", async () => {
mockNodeGateway("camera.snap", { format: "jpg", base64: "aGk=", width: 1, height: 1 });
await runNodesCommand(["nodes", "camera", "snap", "--node", "ios-node"]);
const invokeCalls = nodeInvokeCalls();
const facings = invokeCalls
.map((call) => call.commandParams.facing)
.filter((facing): facing is string => Boolean(facing))
.toSorted((a, b) => a.localeCompare(b));
expect(facings).toEqual(["back", "front"]);
const out = getFirstRuntimeLogLine();
const mediaPaths: string[] = [];
for (const line of out.split("\n")) {
if (!line.startsWith("MEDIA:")) {
continue;
}
const mediaPath = line.replace(/^MEDIA:/, "");
if (mediaPath.length > 0) {
mediaPaths.push(mediaPath);
}
}
expect(mediaPaths).toHaveLength(2);
expect(mediaPaths[0]).toContain("openclaw-camera-snap-");
expect(mediaPaths[1]).toContain("openclaw-camera-snap-");
try {
// Content bytes are covered by single-output camera/file tests; here we
// only verify dual snapshot behavior and that both paths were written.
expect((await fs.stat(mediaPaths[0])).isFile()).toBe(true);
expect((await fs.stat(mediaPaths[1])).isFile()).toBe(true);
} finally {
await Promise.all(mediaPaths.map((p) => fs.unlink(p).catch(() => {})));
}
});
it("runs nodes camera clip and prints one MEDIA path", async () => {
mockNodeGateway("camera.clip", {
format: "mp4",
base64: "aGk=",
durationMs: 3000,
hasAudio: true,
});
await runNodesCommand(["nodes", "camera", "clip", "--node", "ios-node", "--duration", "3000"]);
const invoke = latestNodeInvokeCall();
expect(invoke.method).toBe("node.invoke");
expect(invoke.params.nodeId).toBe("ios-node");
expect(invoke.params.command).toBe("camera.clip");
expect(invoke.params.timeoutMs).toBe(90000);
expectUuidString(invoke.params.idempotencyKey);
expect(invoke.commandParams.facing).toBe("front");
expect(invoke.commandParams.durationMs).toBe(3000);
expect(invoke.commandParams.includeAudio).toBe(true);
expect(invoke.commandParams.format).toBe("mp4");
await expectLoggedSingleMediaFile({
expectedPathPattern: /openclaw-camera-clip-front-.*\.mp4$/,
});
});
it("runs nodes camera snap with facing front and passes params", async () => {
mockNodeGateway("camera.snap", { format: "jpg", base64: "aGk=", width: 1, height: 1 });
await runNodesCommand([
"nodes",
"camera",
"snap",
"--node",
"ios-node",
"--facing",
"front",
"--max-width",
"640",
"--quality",
"0.8",
"--delay-ms",
"2000",
"--device-id",
"cam-123",
]);
const invoke = latestNodeInvokeCall();
expect(invoke.method).toBe("node.invoke");
expect(invoke.params.nodeId).toBe("ios-node");
expect(invoke.params.command).toBe("camera.snap");
expect(invoke.params.timeoutMs).toBe(20000);
expectUuidString(invoke.params.idempotencyKey);
expect(invoke.commandParams.facing).toBe("front");
expect(invoke.commandParams.maxWidth).toBe(640);
expect(invoke.commandParams.quality).toBe(0.8);
expect(invoke.commandParams.delayMs).toBe(2000);
expect(invoke.commandParams.deviceId).toBe("cam-123");
await expectLoggedSingleMediaFile();
});
it("runs nodes camera clip with --no-audio", async () => {
mockNodeGateway("camera.clip", {
format: "mp4",
base64: "aGk=",
durationMs: 3000,
hasAudio: false,
});
await runNodesCommand([
"nodes",
"camera",
"clip",
"--node",
"ios-node",
"--duration",
"3000",
"--no-audio",
"--device-id",
"cam-123",
]);
const invoke = latestNodeInvokeCall();
expect(invoke.method).toBe("node.invoke");
expect(invoke.params.nodeId).toBe("ios-node");
expect(invoke.params.command).toBe("camera.clip");
expect(invoke.params.timeoutMs).toBe(90000);
expectUuidString(invoke.params.idempotencyKey);
expect(invoke.commandParams.includeAudio).toBe(false);
expect(invoke.commandParams.deviceId).toBe("cam-123");
await expectLoggedSingleMediaFile();
});
it("runs nodes camera clip with human duration (10s)", async () => {
mockNodeGateway("camera.clip", {
format: "mp4",
base64: "aGk=",
durationMs: 10_000,
hasAudio: true,
});
await runNodesCommand(["nodes", "camera", "clip", "--node", "ios-node", "--duration", "10s"]);
const invoke = latestNodeInvokeCall();
expect(invoke.method).toBe("node.invoke");
expect(invoke.params.nodeId).toBe("ios-node");
expect(invoke.params.command).toBe("camera.clip");
expect(invoke.commandParams.durationMs).toBe(10_000);
});
it("fails nodes camera snap on invalid facing", async () => {
await expectCameraSnapParseFailure(
["nodes", "camera", "snap", "--node", "ios-node", "--facing", "nope"],
/invalid facing/i,
);
});
it("fails nodes camera snap when --facing both and --device-id are combined", async () => {
await expectCameraSnapParseFailure(
[
"nodes",
"camera",
"snap",
"--node",
"ios-node",
"--facing",
"both",
"--device-id",
"cam-123",
],
/facing=both is not allowed when --device-id is set/i,
);
});
describe("URL-based payloads", () => {
let originalFetch: typeof globalThis.fetch;
beforeAll(() => {
originalFetch = globalThis.fetch;
globalThis.fetch = vi.fn(
async () =>
new Response("url-content", {
status: 200,
headers: { "content-length": "11" },
}),
) as unknown as typeof globalThis.fetch;
});
afterAll(() => {
globalThis.fetch = originalFetch;
});
it.each([
{
label: "runs nodes camera snap with url payload",
command: "camera.snap" as const,
payload: {
format: "jpg",
url: `https://${IOS_NODE.remoteIp}/photo.jpg`,
width: 640,
height: 480,
},
argv: ["nodes", "camera", "snap", "--node", "ios-node", "--facing", "front"],
expectedPathPattern: /openclaw-camera-snap-front-.*\.jpg$/,
},
{
label: "runs nodes camera clip with url payload",
command: "camera.clip" as const,
payload: {
format: "mp4",
url: `https://${IOS_NODE.remoteIp}/clip.mp4`,
durationMs: 5000,
hasAudio: true,
},
argv: ["nodes", "camera", "clip", "--node", "ios-node", "--duration", "5000"],
expectedPathPattern: /openclaw-camera-clip-front-.*\.mp4$/,
},
])("$label", async ({ command, payload, argv, expectedPathPattern }) => {
await runAndExpectUrlPayloadMediaFile({
command,
payload,
argv,
expectedPathPattern,
});
});
});
});