summaryrefslogtreecommitdiffhomepage
path: root/packages/tool-edit-file/src/edit-file.test.ts
diff options
context:
space:
mode:
authorAdam Malczewski <[email protected]>2026-06-10 16:01:33 +0900
committerAdam Malczewski <[email protected]>2026-06-10 16:01:33 +0900
commitbf862168f0fd7b10d02ae04a9d82f7c37b9d85e5 (patch)
tree073048a5775c605d8c28862d0f8c83e63327a17e /packages/tool-edit-file/src/edit-file.test.ts
parent9e7554cde98f45df30dad1f9d356b6954138685b (diff)
downloaddispatch-bf862168f0fd7b10d02ae04a9d82f7c37b9d85e5.tar.gz
dispatch-bf862168f0fd7b10d02ae04a9d82f7c37b9d85e5.zip
feat(tools): add run_shell, edit_file, write_file + read_file directory listing
Four standard-tier tool extensions (one tool per extension, zero ABI change): - tool-read-file: read_file now lists directory contents (sorted, /-suffixed subdirs) - tool-shell: run_shell (foreground, streamed, cancellable, cwd, timeout + output cap) - tool-edit-file: edit_file (oldString/newString/replaceAll; errors on absent/non-unique) - tool-write-file: write_file (explicit overwrite flag) Registered in host-bin CORE_EXTENSIONS. Live boot clean (shell capability accepted). 686 vitest + 89 bun = 775 tests; tsc -b EXIT 0; biome clean.
Diffstat (limited to 'packages/tool-edit-file/src/edit-file.test.ts')
-rw-r--r--packages/tool-edit-file/src/edit-file.test.ts361
1 files changed, 361 insertions, 0 deletions
diff --git a/packages/tool-edit-file/src/edit-file.test.ts b/packages/tool-edit-file/src/edit-file.test.ts
new file mode 100644
index 0000000..dba3d9e
--- /dev/null
+++ b/packages/tool-edit-file/src/edit-file.test.ts
@@ -0,0 +1,361 @@
+import { mkdtemp, readFile, rm, writeFile } from "node:fs/promises";
+import { tmpdir } from "node:os";
+import { join } from "node:path";
+import { createLogger, type ToolExecuteContext } from "@dispatch/kernel";
+import { afterEach, beforeEach, describe, expect, it } from "vitest";
+import {
+ computeReplacement,
+ createEditFileTool,
+ isPathWithinWorkdir,
+ validateArgs,
+} from "./edit-file.js";
+
+function stubCtx(overrides?: Partial<ToolExecuteContext>): ToolExecuteContext {
+ return {
+ toolCallId: "test-call-1",
+ onOutput: () => {},
+ signal: AbortSignal.timeout(5000),
+ log: createLogger(
+ { extensionId: "test" },
+ { emit: () => {} },
+ { now: () => 0, newId: () => "id" },
+ ),
+ ...overrides,
+ };
+}
+
+let workdir: string;
+
+beforeEach(async () => {
+ workdir = await mkdtemp(join(tmpdir(), "tool-edit-file-test-"));
+});
+
+afterEach(async () => {
+ await rm(workdir, { recursive: true, force: true });
+});
+
+describe("validateArgs", () => {
+ it("returns validated args for valid input", () => {
+ const result = validateArgs({ path: "f.txt", oldString: "a", newString: "b" });
+ expect(result).toEqual({ path: "f.txt", oldString: "a", newString: "b", replaceAll: false });
+ });
+
+ it("parses replaceAll true", () => {
+ const result = validateArgs({
+ path: "f.txt",
+ oldString: "a",
+ newString: "b",
+ replaceAll: true,
+ });
+ expect(result).toEqual({ path: "f.txt", oldString: "a", newString: "b", replaceAll: true });
+ });
+
+ it("defaults replaceAll to false when omitted", () => {
+ const result = validateArgs({ path: "f.txt", oldString: "a", newString: "b" });
+ expect(result).toHaveProperty("replaceAll", false);
+ });
+
+ it("returns error for null args", () => {
+ const result = validateArgs(null);
+ expect(result).toHaveProperty("error");
+ });
+
+ it("returns error for missing path", () => {
+ const result = validateArgs({ oldString: "a", newString: "b" });
+ expect(result).toHaveProperty("error");
+ });
+
+ it("returns error for missing oldString", () => {
+ const result = validateArgs({ path: "f.txt", newString: "b" });
+ expect(result).toHaveProperty("error");
+ });
+
+ it("returns error for missing newString", () => {
+ const result = validateArgs({ path: "f.txt", oldString: "a" });
+ expect(result).toHaveProperty("error");
+ });
+
+ it("returns error for non-string path", () => {
+ const result = validateArgs({ path: 123, oldString: "a", newString: "b" });
+ expect(result).toHaveProperty("error");
+ });
+
+ it("returns error for non-string oldString", () => {
+ const result = validateArgs({ path: "f.txt", oldString: 123, newString: "b" });
+ expect(result).toHaveProperty("error");
+ });
+});
+
+describe("computeReplacement", () => {
+ it("replaces a single occurrence", () => {
+ const result = computeReplacement("hello world", "world", "there", false);
+ expect(result).toEqual({ content: "hello there", count: 1 });
+ });
+
+ it("replaces all occurrences when replaceAll is true", () => {
+ const result = computeReplacement("aaa", "a", "b", true);
+ expect(result).toEqual({ content: "bbb", count: 3 });
+ });
+
+ it("returns identical error when newString equals oldString", () => {
+ const result = computeReplacement("hello", "hello", "hello", false);
+ expect(result).toEqual({ kind: "identical" });
+ });
+
+ it("returns notFound error when oldString is not in content", () => {
+ const result = computeReplacement("hello", "xyz", "abc", false);
+ expect(result).toEqual({ kind: "notFound" });
+ });
+
+ it("returns notUnique error when oldString occurs multiple times and replaceAll is false", () => {
+ const result = computeReplacement("abc abc abc", "abc", "xyz", false);
+ expect(result).toEqual({ kind: "notUnique", count: 3 });
+ });
+
+ it("replaces only the single match when unique", () => {
+ const result = computeReplacement("foo bar baz", "bar", "qux", false);
+ expect(result).toEqual({ content: "foo qux baz", count: 1 });
+ });
+
+ it("handles replaceAll with multiple occurrences", () => {
+ const result = computeReplacement("one two one two", "two", "three", true);
+ expect(result).toEqual({ content: "one three one three", count: 2 });
+ });
+
+ it("handles empty oldString as notFound (empty string not searched)", () => {
+ // empty oldString would cause infinite loop in split, so we treat it as not-found
+ const result = computeReplacement("hello", "", "x", false);
+ expect(result).toEqual({ kind: "notFound" });
+ });
+
+ it("handles oldString at start of content", () => {
+ const result = computeReplacement("hello world", "hello", "goodbye", false);
+ expect(result).toEqual({ content: "goodbye world", count: 1 });
+ });
+
+ it("handles oldString at end of content", () => {
+ const result = computeReplacement("hello world", "world", "there", false);
+ expect(result).toEqual({ content: "hello there", count: 1 });
+ });
+
+ it("handles multiline oldString and newString", () => {
+ const content = "line1\nold line\nline3";
+ const result = computeReplacement(content, "old line", "new line", false);
+ expect(result).toEqual({ content: "line1\nnew line\nline3", count: 1 });
+ });
+});
+
+describe("isPathWithinWorkdir", () => {
+ it("accepts a path within workdir", () => {
+ expect(isPathWithinWorkdir("/tmp/workdir/file.txt", "/tmp/workdir")).toBe(true);
+ });
+
+ it("accepts the workdir itself", () => {
+ expect(isPathWithinWorkdir("/tmp/workdir", "/tmp/workdir")).toBe(true);
+ });
+
+ it("rejects a path outside workdir", () => {
+ expect(isPathWithinWorkdir("/tmp/other/file.txt", "/tmp/workdir")).toBe(false);
+ });
+
+ it("rejects a prefix attack (workdir prefix but different dir)", () => {
+ expect(isPathWithinWorkdir("/tmp/workdir-evil/file.txt", "/tmp/workdir")).toBe(false);
+ });
+});
+
+describe("createEditFileTool", () => {
+ it("replaces a single occurrence", async () => {
+ const filePath = join(workdir, "test.txt");
+ await writeFile(filePath, "hello world\n", "utf8");
+
+ const tool = createEditFileTool(workdir);
+ const result = await tool.execute(
+ { path: "test.txt", oldString: "world", newString: "there" },
+ stubCtx(),
+ );
+
+ expect(result.isError).toBeUndefined();
+ expect(result.content).toContain("Replaced 1 occurrence");
+
+ const content = await readFile(filePath, "utf8");
+ expect(content).toBe("hello there\n");
+ });
+
+ it("replaces all occurrences when replaceAll is true", async () => {
+ const filePath = join(workdir, "test.txt");
+ await writeFile(filePath, "aaa\n", "utf8");
+
+ const tool = createEditFileTool(workdir);
+ const result = await tool.execute(
+ { path: "test.txt", oldString: "a", newString: "b", replaceAll: true },
+ stubCtx(),
+ );
+
+ expect(result.isError).toBeUndefined();
+ expect(result.content).toContain("Replaced 3 occurrences");
+
+ const content = await readFile(filePath, "utf8");
+ expect(content).toBe("bbb\n");
+ });
+
+ it("errors when oldString is not found", async () => {
+ const filePath = join(workdir, "test.txt");
+ await writeFile(filePath, "hello\n", "utf8");
+
+ const tool = createEditFileTool(workdir);
+ const result = await tool.execute(
+ { path: "test.txt", oldString: "xyz", newString: "abc" },
+ stubCtx(),
+ );
+
+ expect(result.isError).toBe(true);
+ expect(result.content).toContain("oldString not found");
+ });
+
+ it("errors when oldString is non-unique and replaceAll is false", async () => {
+ const filePath = join(workdir, "test.txt");
+ await writeFile(filePath, "abc abc abc\n", "utf8");
+
+ const tool = createEditFileTool(workdir);
+ const result = await tool.execute(
+ { path: "test.txt", oldString: "abc", newString: "xyz" },
+ stubCtx(),
+ );
+
+ expect(result.isError).toBe(true);
+ expect(result.content).toContain("Found 3 matches");
+ });
+
+ it("errors when newString equals oldString", async () => {
+ const filePath = join(workdir, "test.txt");
+ await writeFile(filePath, "hello\n", "utf8");
+
+ const tool = createEditFileTool(workdir);
+ const result = await tool.execute(
+ { path: "test.txt", oldString: "hello", newString: "hello" },
+ stubCtx(),
+ );
+
+ expect(result.isError).toBe(true);
+ expect(result.content).toContain("newString must differ from oldString");
+ });
+
+ it("errors / not-found for a nonexistent file", async () => {
+ const tool = createEditFileTool(workdir);
+ const result = await tool.execute(
+ { path: "nonexistent.txt", oldString: "a", newString: "b" },
+ stubCtx(),
+ );
+
+ expect(result.isError).toBe(true);
+ expect(result.content).toContain("not found");
+ });
+
+ it("rejects a path outside the working directory", async () => {
+ const tool = createEditFileTool(workdir);
+ const result = await tool.execute(
+ { path: "../escape.txt", oldString: "a", newString: "b" },
+ stubCtx(),
+ );
+
+ expect(result.isError).toBe(true);
+ expect(result.content).toContain("outside the working directory");
+ });
+
+ it("rejects an absolute path outside workdir", async () => {
+ const tool = createEditFileTool(workdir);
+ const result = await tool.execute(
+ { path: "/etc/passwd", oldString: "a", newString: "b" },
+ stubCtx(),
+ );
+
+ expect(result.isError).toBe(true);
+ expect(result.content).toContain("outside the working directory");
+ });
+
+ it("handles symlink escape attempt", async () => {
+ const outsideDir = await mkdtemp(join(tmpdir(), "outside-"));
+ const outsideFile = join(outsideDir, "secret.txt");
+ await writeFile(outsideFile, "secret data", "utf8");
+
+ const symlinkPath = join(workdir, "link.txt");
+ const { symlink } = await import("node:fs/promises");
+ await symlink(outsideFile, symlinkPath);
+
+ const tool = createEditFileTool(workdir);
+ const result = await tool.execute(
+ { path: "link.txt", oldString: "secret", newString: "leaked" },
+ stubCtx(),
+ );
+
+ expect(result.isError).toBe(true);
+ expect(result.content).toContain("outside the working directory");
+
+ await rm(outsideDir, { recursive: true, force: true });
+ });
+
+ it("reads file under ctx.cwd when set", async () => {
+ const ctxDir = await mkdtemp(join(tmpdir(), "ctx-cwd-test-"));
+ try {
+ const filePath = join(ctxDir, "ctx-file.txt");
+ await writeFile(filePath, "hello world", "utf8");
+
+ const tool = createEditFileTool(workdir);
+ const result = await tool.execute(
+ { path: "ctx-file.txt", oldString: "world", newString: "there" },
+ stubCtx({ cwd: ctxDir }),
+ );
+
+ expect(result.isError).toBeUndefined();
+ expect(result.content).toContain("Replaced 1 occurrence");
+
+ const content = await readFile(filePath, "utf8");
+ expect(content).toBe("hello there");
+ } finally {
+ await rm(ctxDir, { recursive: true, force: true });
+ }
+ });
+
+ it("falls back to baked workdir when ctx.cwd is omitted", async () => {
+ const filePath = join(workdir, "baked-file.txt");
+ await writeFile(filePath, "hello world", "utf8");
+
+ const tool = createEditFileTool(workdir);
+ const ctx = stubCtx();
+ expect(ctx.cwd).toBeUndefined();
+ const result = await tool.execute(
+ { path: "baked-file.txt", oldString: "world", newString: "there" },
+ ctx,
+ );
+
+ expect(result.isError).toBeUndefined();
+ expect(result.content).toContain("Replaced 1 occurrence");
+ });
+
+ it("never throws on bad input (always returns ToolResult)", async () => {
+ const tool = createEditFileTool(workdir);
+
+ const inputs = [null, undefined, 42, "string", {}, { path: "" }, { path: 123 }];
+ for (const input of inputs) {
+ const result = await tool.execute(input, stubCtx());
+ expect(result).toHaveProperty("content");
+ expect(typeof result.content).toBe("string");
+ }
+ });
+
+ it("concurrencySafe is false", () => {
+ const tool = createEditFileTool(workdir);
+ expect(tool.concurrencySafe).toBe(false);
+ });
+
+ it("has correct name and parameters shape", () => {
+ const tool = createEditFileTool(workdir);
+ expect(tool.name).toBe("edit_file");
+ expect(tool.parameters.type).toBe("object");
+ expect(tool.parameters.required).toEqual(["path", "oldString", "newString"]);
+ expect(tool.parameters.properties?.path?.type).toBe("string");
+ expect(tool.parameters.properties?.oldString?.type).toBe("string");
+ expect(tool.parameters.properties?.newString?.type).toBe("string");
+ expect(tool.parameters.properties?.replaceAll?.type).toBe("boolean");
+ });
+});