File size: 12,932 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 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 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 | import { afterEach, describe, expect, it, vi } from "vitest";
import type { CliBackendToolPermissionResult } from "../../plugins/cli-backend.types.js";
import {
initializeGlobalHookRunner,
resetGlobalHookRunner,
} from "../../plugins/hook-runner-global.js";
import type { PluginHookHandlerMap } from "../../plugins/hook-types.js";
import { createMockPluginRegistry } from "../../plugins/hooks.test-fixtures.js";
import * as beforeToolCall from "../agent-tools.before-tool-call.js";
import { callGatewayTool } from "../tools/gateway.js";
import {
closePluginTestAdmissions,
createExecution,
requestNativeTool,
runPlugin,
SUCCESS_RESULT,
} from "./execute-plugin.test-support.js";
vi.mock("../tools/gateway.js", () => ({
callGatewayTool: vi.fn(),
}));
const mockCallGatewayTool = vi.mocked(callGatewayTool);
function installBeforeToolCallHook(
handler: PluginHookHandlerMap["before_tool_call"],
matcher?: [string, ...string[]],
) {
initializeGlobalHookRunner(
createMockPluginRegistry([
{
hookName: "before_tool_call",
handler: (...args) => Reflect.apply(handler, undefined, args),
...(matcher ? { matcher } : {}),
},
]),
);
}
afterEach(() => {
resetGlobalHookRunner();
closePluginTestAdmissions();
mockCallGatewayTool.mockReset();
vi.restoreAllMocks();
});
describe("plugin-owned CLI native tool policy", () => {
it("denies native tools when caller authority expires during policy or before a retained call", async () => {
const { context } = await createExecution({ nativeTools: ["WebFetch"] });
let callerCurrent = true;
context.params.assertCurrent = () => {
if (!callerCurrent) {
throw new Error("caller revoked");
}
};
const hook = vi.fn(async () => {
callerCurrent = false;
});
installBeforeToolCallHook(hook);
await runPlugin(context, async function* (execution) {
await expect(
requestNativeTool(execution, "WebFetch", { url: "https://example.com" }),
).resolves.toMatchObject({ behavior: "deny" });
await expect(
requestNativeTool(execution, "WebFetch", { url: "https://example.com/retained" }),
).resolves.toMatchObject({ behavior: "deny" });
expect(execution.abortSignal?.aborted).toBe(false);
yield SUCCESS_RESULT;
});
expect(hook).toHaveBeenCalledOnce();
expect(mockCallGatewayTool).not.toHaveBeenCalled();
});
it("runs canonical policy before native approval and carries rewritten params plus run context", async () => {
const policy = vi.spyOn(beforeToolCall, "runBeforeToolCallHook");
const hook = vi.fn(async (_event: unknown, _context: unknown) => ({
params: { url: "https://example.com/rewritten" },
}));
installBeforeToolCallHook(hook);
const { context } = await createExecution({ nativeTools: ["WebFetch"] });
Object.assign(context.params, {
messageChannel: "telegram",
messageProvider: "telegram",
currentChannelId: "chat-1",
chatId: "chat-1",
agentAccountId: "bot-1",
senderId: "user-1",
senderIsOwner: true,
currentThreadTs: "thread-1",
});
let decision: CliBackendToolPermissionResult | undefined;
await runPlugin(context, async function* (execution) {
decision = await requestNativeTool(execution, "WebFetch", {
url: "https://example.com/original",
});
yield SUCCESS_RESULT;
});
expect(decision).toEqual({
behavior: "allow",
updatedInput: { url: "https://example.com/rewritten" },
});
expect(hook).toHaveBeenCalledOnce();
expect(hook.mock.calls[0]?.[0]).toMatchObject({
toolName: "web_fetch",
params: { url: "https://example.com/original" },
toolCallId: "native-WebFetch",
runId: context.params.runId,
});
expect(hook.mock.calls[0]?.[1]).toMatchObject({
agentId: "main",
sessionKey: "agent:main:main",
sessionId: "sdk-session",
runId: context.params.runId,
channelId: "chat-1",
requester: {
channel: "telegram",
accountId: "bot-1",
senderId: "user-1",
senderIsOwner: true,
},
});
expect(policy.mock.calls[0]?.[0]).toMatchObject({
ctx: {
config: context.params.config,
cwd: "/tmp",
workspaceDir: "/tmp",
turnSourceChannel: "telegram",
turnSourceTo: "chat-1",
turnSourceAccountId: "bot-1",
turnSourceThreadId: "thread-1",
loopDetection: undefined,
},
});
expect(mockCallGatewayTool).not.toHaveBeenCalled();
});
it.each([
{ native: "Bash", canonical: "exec", input: { command: "echo blocked" } },
{
native: "WebFetch",
canonical: "web_fetch",
input: { url: "https://example.com", prompt: "summarize" },
},
{ native: "WebSearch", canonical: "web_search", input: { query: "blocked" } },
])(
"applies matched $canonical policy to native $native",
async ({ native, canonical, input }) => {
const hook = vi.fn(async () => ({ block: true, blockReason: `${canonical} blocked` }));
installBeforeToolCallHook(hook, [canonical]);
const { context } = await createExecution({ nativeTools: [native] });
let decision: CliBackendToolPermissionResult | undefined;
await runPlugin(context, async function* (execution) {
decision = await requestNativeTool(execution, native, input);
yield SUCCESS_RESULT;
});
expect(decision).toEqual({ behavior: "deny", message: `${canonical} blocked` });
expect(hook).toHaveBeenCalledWith(
expect.objectContaining({ toolName: canonical, params: input }),
expect.objectContaining({ toolName: canonical }),
);
expect(mockCallGatewayTool).not.toHaveBeenCalled();
},
);
it.each([
{ native: "Read", canonical: "read", input: { file_path: "/tmp/private.txt" } },
{
native: "Write",
canonical: "write",
input: { file_path: "/tmp/private.txt", content: "private" },
},
{
native: "Edit",
canonical: "edit",
input: { file_path: "/tmp/private.txt", old_string: "old", new_string: "new" },
},
])(
"applies path-based $canonical policy to native $native",
async ({ native, canonical, input }) => {
const hook = vi.fn(async (event: { params: Record<string, unknown> }) =>
event.params.path === "/tmp/private.txt"
? { block: true, blockReason: "private path blocked" }
: undefined,
);
installBeforeToolCallHook(hook, [canonical]);
const { context } = await createExecution({ nativeTools: [native] });
let decision: CliBackendToolPermissionResult | undefined;
await runPlugin(context, async function* (execution) {
decision = await requestNativeTool(execution, native, input);
yield SUCCESS_RESULT;
});
expect(decision).toEqual({ behavior: "deny", message: "private path blocked" });
expect(hook).toHaveBeenCalledWith(
expect.objectContaining({
toolName: canonical,
params: expect.objectContaining({ path: "/tmp/private.txt" }),
}),
expect.objectContaining({ toolName: canonical }),
);
},
);
it("projects rewritten canonical file arguments back into the native Edit schema", async () => {
const hook = vi.fn(async () => ({
params: {
path: "/tmp/approved.txt",
edits: [{ oldText: "safe-before", newText: "safe-after" }],
},
}));
installBeforeToolCallHook(hook, ["edit"]);
const { context } = await createExecution({ nativeTools: ["Edit"] });
let decision: CliBackendToolPermissionResult | undefined;
await runPlugin(context, async function* (execution) {
decision = await requestNativeTool(execution, "Edit", {
file_path: "/tmp/original.txt",
old_string: "before",
new_string: "after",
replace_all: false,
});
yield SUCCESS_RESULT;
});
expect(hook).toHaveBeenCalledWith(
expect.objectContaining({
toolName: "edit",
params: expect.objectContaining({
path: "/tmp/original.txt",
edits: [{ oldText: "before", newText: "after" }],
}),
}),
expect.anything(),
);
expect(decision).toEqual({
behavior: "allow",
updatedInput: {
file_path: "/tmp/approved.txt",
old_string: "safe-before",
new_string: "safe-after",
replace_all: false,
},
});
});
it("rejects conflicting native and canonical paths before invoking policy", async () => {
const hook = vi.fn(async () => undefined);
installBeforeToolCallHook(hook, ["read"]);
const { context } = await createExecution({ nativeTools: ["Read"] });
let decision: CliBackendToolPermissionResult | undefined;
await runPlugin(context, async function* (execution) {
decision = await requestNativeTool(execution, "Read", {
file_path: "/tmp/private.txt",
path: "/tmp/allowed.txt",
});
yield SUCCESS_RESULT;
});
expect(decision).toEqual(
expect.objectContaining({
behavior: "deny",
message: expect.stringContaining("conflicting"),
}),
);
expect(hook).not.toHaveBeenCalled();
});
it("rejects canonical edit rewrites that the native tool cannot represent", async () => {
const hook = vi.fn(async () => ({
params: {
edits: [
{ oldText: "first", newText: "one" },
{ oldText: "second", newText: "two" },
],
},
}));
installBeforeToolCallHook(hook, ["edit"]);
const { context } = await createExecution({ nativeTools: ["Edit"] });
let decision: CliBackendToolPermissionResult | undefined;
await runPlugin(context, async function* (execution) {
decision = await requestNativeTool(execution, "Edit", {
file_path: "/tmp/file.txt",
old_string: "before",
new_string: "after",
});
yield SUCCESS_RESULT;
});
expect(decision).toEqual(
expect.objectContaining({
behavior: "deny",
message: expect.stringContaining("native edit"),
}),
);
});
it.each([
{
name: "blocks",
handler: vi.fn(async () => ({ block: true, blockReason: "blocked by plugin policy" })),
message: "blocked by plugin policy",
},
{
name: "fails",
handler: vi.fn(async () => {
throw new Error("policy crashed");
}),
message: "before_tool_call hook failed",
},
])("fails closed when before_tool_call $name", async ({ handler, message }) => {
installBeforeToolCallHook(handler);
const { context } = await createExecution({ nativeTools: ["Bash"] });
let decision: CliBackendToolPermissionResult | undefined;
await runPlugin(context, async function* (execution) {
decision = await requestNativeTool(execution);
yield SUCCESS_RESULT;
});
expect(decision).toEqual(
expect.objectContaining({ behavior: "deny", message: expect.stringContaining(message) }),
);
expect(mockCallGatewayTool).not.toHaveBeenCalled();
});
it("aborts before_tool_call without reaching native approval", async () => {
const controller = new AbortController();
const hook = vi.fn(
async (_event: unknown, hookContext: { abortSignal?: AbortSignal }): Promise<undefined> =>
await new Promise((_, reject) => {
hookContext.abortSignal?.addEventListener(
"abort",
() => reject(new Error("policy aborted")),
{ once: true },
);
}),
);
installBeforeToolCallHook(hook);
const { context } = await createExecution({
abortSignal: controller.signal,
nativeTools: ["Bash"],
});
const run = runPlugin(context, async function* (execution) {
await requestNativeTool(execution);
yield SUCCESS_RESULT;
});
await vi.waitFor(() => expect(hook).toHaveBeenCalledOnce());
controller.abort(new Error("cancel policy"));
await expect(run).rejects.toMatchObject({ name: "AbortError" });
expect(mockCallGatewayTool).not.toHaveBeenCalled();
});
it("fails closed when canonical policy returns a non-record rewrite", async () => {
vi.spyOn(beforeToolCall, "runBeforeToolCallHook").mockResolvedValueOnce({
blocked: false,
params: "invalid",
});
const { context } = await createExecution({ nativeTools: ["Bash"] });
let decision: CliBackendToolPermissionResult | undefined;
await runPlugin(context, async function* (execution) {
decision = await requestNativeTool(execution);
yield SUCCESS_RESULT;
});
expect(decision).toEqual(
expect.objectContaining({
behavior: "deny",
message: expect.stringContaining("invalid input"),
}),
);
expect(mockCallGatewayTool).not.toHaveBeenCalled();
});
});
|