File size: 6,544 Bytes
e249c6d | 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 | import { readFile, rm } from "node:fs/promises";
import path from "node:path";
// Bash tool helper tests cover conversion from model-facing timeout seconds to
// timer-safe millisecond values.
import { MAX_TIMER_TIMEOUT_MS } from "@openclaw/normalization-core/number-coercion";
import { describe, expect, it, vi } from "vitest";
import { buildShellCommandInvocation } from "../../shell-utils.js";
import {
expectNativeBashSpill,
nativeBashSpillScenarios,
} from "../bash-output-spill.test-support.js";
import type { BashOperations } from "./bash-operations.js";
import { createBashTool, createLocalBashOperations } from "./bash.js";
import { resolveBashTimeoutMs } from "./bash.test-support.js";
describe("bash tool timeout helpers", () => {
it("converts positive timeout seconds to timer-safe milliseconds", () => {
expect(resolveBashTimeoutMs(1)).toBe(1_000);
expect(resolveBashTimeoutMs(1.5)).toBe(1_500);
expect(resolveBashTimeoutMs(0.0005)).toBe(1);
});
it("caps oversized timeout seconds", () => {
// Node timers cannot safely represent arbitrary user-provided seconds.
expect(resolveBashTimeoutMs(Number.MAX_SAFE_INTEGER)).toBe(MAX_TIMER_TIMEOUT_MS);
});
it("allows an absent timeout", () => {
expect(resolveBashTimeoutMs(undefined)).toBeUndefined();
});
it.each([Number.NaN, 0, -1])("rejects invalid timeout %s", (timeout) => {
expect(() => resolveBashTimeoutMs(timeout)).toThrow(
"Invalid timeout: must be a positive finite number of seconds",
);
});
it.each([Number.NaN, 0, -1])("rejects invalid timeout %s before execution", async (timeout) => {
const exec = vi.fn<BashOperations["exec"]>();
const tool = createBashTool(process.cwd(), { operations: { exec } });
await expect(
tool.execute("call-invalid-timeout", { command: "echo ok", timeout }),
).rejects.toThrow("Invalid timeout: must be a positive finite number of seconds");
expect(exec).not.toHaveBeenCalled();
});
it("omits the command argv and supplies stdin for legacy WSL bash", () => {
expect(
buildShellCommandInvocation("printf ready", {
shell: "C:\\Windows\\System32\\bash.exe",
args: ["-s"],
commandTransport: "stdin",
}),
).toEqual({
argv: ["C:\\Windows\\System32\\bash.exe", "-s"],
input: "printf ready",
stdin: "pipe",
});
});
});
describe("bash tool output lifecycle", () => {
it("reports a long final line's tail and size after its newline", async () => {
const text = `${"x".repeat(250_000)}END-MARKER\n`;
const operations: BashOperations = {
exec: async (_command, _cwd, { onData }) => {
onData(Buffer.from(text), "stdout");
return { exitCode: 0 };
},
};
const result = await createBashTool(process.cwd(), { operations }).execute("long-line", {
command: "ignored",
});
const details = result.details;
if (
!details ||
typeof details !== "object" ||
!("fullOutputPath" in details) ||
typeof details.fullOutputPath !== "string"
) {
throw new Error("Expected a full output path for truncated Bash output");
}
const fullOutputPath = details.fullOutputPath;
try {
expect(result.content[0]).toMatchObject({
type: "text",
text: expect.stringContaining(
"END-MARKER\n\n[Showing last 50.0KB of line 1 (line is 244.2KB).",
),
});
expect(await readFile(fullOutputPath, "utf8")).toBe(text);
} finally {
await rm(fullOutputPath, { force: true });
}
});
it.runIf(process.platform !== "win32").each(nativeBashSpillScenarios)(
"settles real Bash output for %s",
async (scenario) => {
await expectNativeBashSpill("tool", scenario);
},
);
it.runIf(process.platform !== "win32")("surfaces a configured shell launch error", async () => {
const operations = createLocalBashOperations({
shellPath: path.join(process.cwd(), "package.json"),
});
await expect(operations.exec("echo ok", process.cwd(), { onData: () => {} })).rejects.toThrow(
/EACCES|permission denied/i,
);
});
it("ignores output callbacks after execution settles", async () => {
const operations: BashOperations = {
exec: async (_command, _cwd, { onData }) => {
onData(Buffer.from("before\n"));
setTimeout(() => onData(Buffer.from("late\n")), 0);
return { exitCode: 0 };
},
};
const tool = createBashTool(process.cwd(), { operations });
const result = await tool.execute("call-late-output", { command: "ignored" });
await new Promise<void>((resolve) => {
setTimeout(resolve, 20);
});
expect(result.content[0]).toEqual({ type: "text", text: "before\n" });
});
it.runIf(process.platform !== "win32")(
"tags stdout and stderr from the local shell backend",
async () => {
const operations = createLocalBashOperations();
const chunks: Array<{ data: Buffer; stream?: "stdout" | "stderr" }> = [];
const result = await operations.exec("printf stdout; printf stderr >&2", process.cwd(), {
onData: (data, stream) => chunks.push({ data, stream }),
});
expect(result.exitCode).toBe(0);
expect(
Buffer.concat(
chunks.filter((chunk) => chunk.stream === "stdout").map((chunk) => chunk.data),
).toString("utf8"),
).toBe("stdout");
expect(
Buffer.concat(
chunks.filter((chunk) => chunk.stream === "stderr").map((chunk) => chunk.data),
).toString("utf8"),
).toBe("stderr");
expect(chunks.every((chunk) => chunk.stream !== undefined)).toBe(true);
},
);
it("decodes a split multi-byte character when the other stream interleaves", async () => {
// stdout and stderr are independent pipes: each needs its own decoder, or a
// character straddling a stdout read boundary is corrupted by an stderr write
// landing between its bytes.
const operations: BashOperations = {
exec: async (_command, _cwd, { onData }) => {
onData(Buffer.from([0xe6, 0x97]), "stdout"); // leading bytes of 日
onData(Buffer.from("E"), "stderr"); // interleaves mid-character
onData(Buffer.from([0xa5, 0x0a]), "stdout");
return { exitCode: 0 };
},
};
const tool = createBashTool(process.cwd(), { operations });
const result = await tool.execute("call-split-utf8", { command: "ignored" });
expect(result.content[0]).toEqual({ type: "text", text: "E日\n" });
});
});
|