206 lines
7.1 KiB
TypeScript
206 lines
7.1 KiB
TypeScript
import fs from "node:fs/promises";
|
|
import os from "node:os";
|
|
import path from "node:path";
|
|
import type { AgentTool } from "@mariozechner/pi-agent-core";
|
|
import sharp from "sharp";
|
|
import { describe, expect, it, vi } from "vitest";
|
|
import { __testing, createClawdbotCodingTools } from "./pi-tools.js";
|
|
|
|
describe("createClawdbotCodingTools", () => {
|
|
describe("Claude/Gemini alias support", () => {
|
|
it("adds Claude-style aliases to schemas without dropping metadata", () => {
|
|
const base: AgentTool = {
|
|
name: "write",
|
|
description: "test",
|
|
parameters: {
|
|
type: "object",
|
|
required: ["path", "content"],
|
|
properties: {
|
|
path: { type: "string", description: "Path" },
|
|
content: { type: "string", description: "Body" },
|
|
},
|
|
},
|
|
execute: vi.fn(),
|
|
};
|
|
|
|
const patched = __testing.patchToolSchemaForClaudeCompatibility(base);
|
|
const params = patched.parameters as {
|
|
properties?: Record<string, unknown>;
|
|
required?: string[];
|
|
};
|
|
const props = params.properties ?? {};
|
|
|
|
expect(props.file_path).toEqual(props.path);
|
|
expect(params.required ?? []).not.toContain("path");
|
|
expect(params.required ?? []).not.toContain("file_path");
|
|
});
|
|
|
|
it("normalizes file_path to path and enforces required groups at runtime", async () => {
|
|
const execute = vi.fn(async (_id, args) => args);
|
|
const tool: AgentTool = {
|
|
name: "write",
|
|
description: "test",
|
|
parameters: {
|
|
type: "object",
|
|
required: ["path", "content"],
|
|
properties: {
|
|
path: { type: "string" },
|
|
content: { type: "string" },
|
|
},
|
|
},
|
|
execute,
|
|
};
|
|
|
|
const wrapped = __testing.wrapToolParamNormalization(tool, [{ keys: ["path", "file_path"] }]);
|
|
|
|
await wrapped.execute("tool-1", { file_path: "foo.txt", content: "x" });
|
|
expect(execute).toHaveBeenCalledWith(
|
|
"tool-1",
|
|
{ path: "foo.txt", content: "x" },
|
|
undefined,
|
|
undefined,
|
|
);
|
|
|
|
await expect(wrapped.execute("tool-2", { content: "x" })).rejects.toThrow(
|
|
/Missing required parameter/,
|
|
);
|
|
await expect(wrapped.execute("tool-3", { file_path: " ", content: "x" })).rejects.toThrow(
|
|
/Missing required parameter/,
|
|
);
|
|
});
|
|
});
|
|
|
|
it("keeps read tool image metadata intact", async () => {
|
|
const tools = createClawdbotCodingTools();
|
|
const readTool = tools.find((tool) => tool.name === "read");
|
|
expect(readTool).toBeDefined();
|
|
|
|
const tmpDir = await fs.mkdtemp(path.join(os.tmpdir(), "clawdbot-read-"));
|
|
try {
|
|
const imagePath = path.join(tmpDir, "sample.png");
|
|
const png = await sharp({
|
|
create: {
|
|
width: 8,
|
|
height: 8,
|
|
channels: 3,
|
|
background: { r: 0, g: 128, b: 255 },
|
|
},
|
|
})
|
|
.png()
|
|
.toBuffer();
|
|
await fs.writeFile(imagePath, png);
|
|
|
|
const result = await readTool?.execute("tool-1", {
|
|
path: imagePath,
|
|
});
|
|
|
|
expect(result?.content?.some((block) => block.type === "image")).toBe(true);
|
|
const text = result?.content?.find((block) => block.type === "text") as
|
|
| { text?: string }
|
|
| undefined;
|
|
expect(text?.text ?? "").toContain("Read image file [image/png]");
|
|
const image = result?.content?.find((block) => block.type === "image") as
|
|
| { mimeType?: string }
|
|
| undefined;
|
|
expect(image?.mimeType).toBe("image/png");
|
|
} finally {
|
|
await fs.rm(tmpDir, { recursive: true, force: true });
|
|
}
|
|
});
|
|
it("returns text content without image blocks for text files", async () => {
|
|
const tools = createClawdbotCodingTools();
|
|
const readTool = tools.find((tool) => tool.name === "read");
|
|
expect(readTool).toBeDefined();
|
|
|
|
const tmpDir = await fs.mkdtemp(path.join(os.tmpdir(), "clawdbot-read-"));
|
|
try {
|
|
const textPath = path.join(tmpDir, "sample.txt");
|
|
const contents = "Hello from clawdbot read tool.";
|
|
await fs.writeFile(textPath, contents, "utf8");
|
|
|
|
const result = await readTool?.execute("tool-2", {
|
|
path: textPath,
|
|
});
|
|
|
|
expect(result?.content?.some((block) => block.type === "image")).toBe(false);
|
|
const textBlocks = result?.content?.filter((block) => block.type === "text") as
|
|
| Array<{ text?: string }>
|
|
| undefined;
|
|
expect(textBlocks?.length ?? 0).toBeGreaterThan(0);
|
|
const combinedText = textBlocks?.map((block) => block.text ?? "").join("\n");
|
|
expect(combinedText).toContain(contents);
|
|
} finally {
|
|
await fs.rm(tmpDir, { recursive: true, force: true });
|
|
}
|
|
});
|
|
it("filters tools by sandbox policy", () => {
|
|
const sandbox = {
|
|
enabled: true,
|
|
sessionKey: "sandbox:test",
|
|
workspaceDir: path.join(os.tmpdir(), "clawdbot-sandbox"),
|
|
agentWorkspaceDir: path.join(os.tmpdir(), "clawdbot-workspace"),
|
|
workspaceAccess: "none",
|
|
containerName: "clawdbot-sbx-test",
|
|
containerWorkdir: "/workspace",
|
|
docker: {
|
|
image: "clawdbot-sandbox:bookworm-slim",
|
|
containerPrefix: "clawdbot-sbx-",
|
|
workdir: "/workspace",
|
|
readOnlyRoot: true,
|
|
tmpfs: [],
|
|
network: "none",
|
|
user: "1000:1000",
|
|
capDrop: ["ALL"],
|
|
env: { LANG: "C.UTF-8" },
|
|
},
|
|
tools: {
|
|
allow: ["bash"],
|
|
deny: ["browser"],
|
|
},
|
|
browserAllowHostControl: false,
|
|
};
|
|
const tools = createClawdbotCodingTools({ sandbox });
|
|
expect(tools.some((tool) => tool.name === "exec")).toBe(true);
|
|
expect(tools.some((tool) => tool.name === "read")).toBe(false);
|
|
expect(tools.some((tool) => tool.name === "browser")).toBe(false);
|
|
});
|
|
it("hard-disables write/edit when sandbox workspaceAccess is ro", () => {
|
|
const sandbox = {
|
|
enabled: true,
|
|
sessionKey: "sandbox:test",
|
|
workspaceDir: path.join(os.tmpdir(), "clawdbot-sandbox"),
|
|
agentWorkspaceDir: path.join(os.tmpdir(), "clawdbot-workspace"),
|
|
workspaceAccess: "ro",
|
|
containerName: "clawdbot-sbx-test",
|
|
containerWorkdir: "/workspace",
|
|
docker: {
|
|
image: "clawdbot-sandbox:bookworm-slim",
|
|
containerPrefix: "clawdbot-sbx-",
|
|
workdir: "/workspace",
|
|
readOnlyRoot: true,
|
|
tmpfs: [],
|
|
network: "none",
|
|
user: "1000:1000",
|
|
capDrop: ["ALL"],
|
|
env: { LANG: "C.UTF-8" },
|
|
},
|
|
tools: {
|
|
allow: ["read", "write", "edit"],
|
|
deny: [],
|
|
},
|
|
browserAllowHostControl: false,
|
|
};
|
|
const tools = createClawdbotCodingTools({ sandbox });
|
|
expect(tools.some((tool) => tool.name === "read")).toBe(true);
|
|
expect(tools.some((tool) => tool.name === "write")).toBe(false);
|
|
expect(tools.some((tool) => tool.name === "edit")).toBe(false);
|
|
});
|
|
it("filters tools by agent tool policy even without sandbox", () => {
|
|
const tools = createClawdbotCodingTools({
|
|
config: { tools: { deny: ["browser"] } },
|
|
});
|
|
expect(tools.some((tool) => tool.name === "exec")).toBe(true);
|
|
expect(tools.some((tool) => tool.name === "browser")).toBe(false);
|
|
});
|
|
});
|