File size: 7,320 Bytes
fcd8223 | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 | import fs from "node:fs";
import os from "node:os";
import path from "node:path";
import { afterEach, describe, expect, it, vi } from "vitest";
import { testing } from "./invoke.test-support.js";
describe("runCommand", () => {
afterEach(() => {
vi.restoreAllMocks();
});
it("captures stdout, stderr, and exit status", async () => {
await expect(
testing.runCommand(
[
process.execPath,
"-e",
"process.stdout.write('captured stdout'); process.stderr.write('captured stderr')",
],
undefined,
undefined,
undefined,
),
).resolves.toEqual({
exitCode: 0,
timedOut: false,
success: true,
stdout: "captured stdout",
stderr: "captured stderr",
error: null,
truncated: false,
});
});
it.each(["before", "after"] as const)(
"checks node launch policy %s native execution",
async (timing) => {
let allowed = timing === "after";
const pending = testing.runCommand(
[
process.execPath,
"-e",
"process.stdin.resume(); process.stdin.once('end', () => process.stdout.write('completed'))",
],
undefined,
{ PATH: process.env.PATH ?? "" },
5_000,
undefined,
() => {
if (!allowed) {
throw new Error("exec approval changed before execution");
}
},
);
// The canonical node runner spawns synchronously before returning its promise.
allowed = false;
if (timing === "before") {
await expect(pending).rejects.toThrow("exec approval changed before execution");
} else {
const result = await pending;
expect(result.success).toBe(true);
expect(result.stdout).toBe("completed");
}
},
);
it("closes stdin for commands that wait for EOF", async () => {
await expect(
testing.runCommand(
[
process.execPath,
"-e",
"process.stdin.resume(); process.stdin.once('end', () => process.stdout.write('eof'))",
],
undefined,
undefined,
2_000,
),
).resolves.toMatchObject({ success: true, stdout: "eof" });
});
it("preserves nonzero command results", async () => {
await expect(
testing.runCommand(
[process.execPath, "-e", "process.stderr.write('failed'); process.exit(7)"],
undefined,
undefined,
undefined,
),
).resolves.toMatchObject({
exitCode: 7,
timedOut: false,
success: false,
stderr: "failed",
error: null,
});
});
it.runIf(process.platform !== "win32")("force-kills timed-out command trees", async () => {
const startedAt = Date.now();
const result = await testing.runCommand(
[process.execPath, "-e", "process.on('SIGTERM', () => {}); setInterval(() => {}, 1000)"],
undefined,
undefined,
25,
);
expect(result).toMatchObject({ timedOut: true, success: false, error: null });
expect(Date.now() - startedAt).toBeLessThan(2_000);
});
it.runIf(process.platform !== "win32")("force-kills cancelled command trees", async () => {
const controller = new AbortController();
const startedAt = Date.now();
const cancelling = setTimeout(() => controller.abort(), 25);
try {
const result = await testing.runCommand(
[process.execPath, "-e", "process.on('SIGTERM', () => {}); setInterval(() => {}, 1000)"],
undefined,
undefined,
undefined,
controller.signal,
);
expect(result).toMatchObject({ timedOut: false, success: false, error: null });
expect(Date.now() - startedAt).toBeLessThan(2_000);
} finally {
clearTimeout(cancelling);
}
});
it("keeps the combined output prefix bounded", async () => {
const result = await testing.runCommand(
[process.execPath, "-e", "process.stdout.write('x'.repeat(200_001))"],
undefined,
undefined,
undefined,
);
expect(result.stdout).toHaveLength(200_000);
expect(result.stdout).toBe("x".repeat(200_000));
expect(result.truncated).toBe(true);
});
it("preserves child launch errors", async () => {
const result = await testing.runCommand(
[`openclaw-missing-${process.pid}-${Date.now()}`],
undefined,
undefined,
undefined,
);
expect(result).toMatchObject({ exitCode: undefined, timedOut: false, success: false });
expect(result.error).toMatch(/ENOENT|not found/i);
});
describe("working directory failures", () => {
const enoent = (message: string) =>
Object.assign(new Error(message), { code: "ENOENT" }) as NodeJS.ErrnoException;
it("blames a missing working directory instead of the shell", () => {
const cwd = path.join(os.tmpdir(), `node-exec-missing-${process.pid}-${Date.now()}`);
expect(testing.clarifyNodeExecCwdSpawnError(enoent("spawn /bin/sh ENOENT"), cwd)).toBe(
`node exec working directory does not exist on the node host: ${cwd} (os reported: spawn /bin/sh ENOENT)`,
);
});
it("flags a cwd that exists but is not a directory", async () => {
const file = path.join(os.tmpdir(), `node-exec-file-${process.pid}-${Date.now()}.txt`);
fs.writeFileSync(file, "x");
try {
const result = await testing.runCommand(
[process.execPath, "-e", "process.exit(0)"],
file,
undefined,
undefined,
);
expect(result).toMatchObject({ success: false });
expect(result.error).toContain(
`node exec working directory is not a directory on the node host: ${file}`,
);
} finally {
fs.rmSync(file, { force: true });
}
});
it("clarifies a missing cwd during execution", async () => {
const cwd = path.join(os.tmpdir(), `node-exec-run-missing-${process.pid}-${Date.now()}`);
const result = await testing.runCommand(
[process.execPath, "-e", "process.exit(0)"],
cwd,
undefined,
undefined,
);
expect(result).toMatchObject({ success: false });
expect(result.error).toContain(
`node exec working directory does not exist on the node host: ${cwd}`,
);
});
it("preserves executable and unrelated errors", () => {
const missingExecutable = "spawn /usr/bin/does-not-exist ENOENT";
expect(testing.clarifyNodeExecCwdSpawnError(enoent(missingExecutable), os.tmpdir())).toBe(
missingExecutable,
);
expect(testing.clarifyNodeExecCwdSpawnError(enoent("spawn /bin/sh ENOENT"), undefined)).toBe(
"spawn /bin/sh ENOENT",
);
const denied = Object.assign(new Error("spawn EACCES"), {
code: "EACCES",
}) as NodeJS.ErrnoException;
expect(testing.clarifyNodeExecCwdSpawnError(denied, "/missing")).toBe("spawn EACCES");
});
it("preserves the spawn error when the cwd cannot be inspected", () => {
const message = "spawn /bin/sh ENOENT";
vi.spyOn(fs, "statSync").mockImplementationOnce(() => {
throw Object.assign(new Error("permission denied"), { code: "EACCES" });
});
expect(testing.clarifyNodeExecCwdSpawnError(enoent(message), "/unreadable")).toBe(message);
});
});
});
|