| 1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111 |
- import { describe, expect, test } from "bun:test"
- import { Effect, Layer, ManagedRuntime } from "effect"
- import os from "os"
- import path from "path"
- import { Shell } from "../../src/shell/shell"
- import { BashTool } from "../../src/tool/bash"
- import { Instance } from "../../src/project/instance"
- import { Filesystem } from "../../src/util/filesystem"
- import { tmpdir } from "../fixture/fixture"
- import type { Permission } from "../../src/permission"
- import { Truncate } from "../../src/tool/truncate"
- import { SessionID, MessageID } from "../../src/session/schema"
- import * as CrossSpawnSpawner from "../../src/effect/cross-spawn-spawner"
- import { AppFileSystem } from "../../src/filesystem"
- import { Plugin } from "../../src/plugin"
- const runtime = ManagedRuntime.make(
- Layer.mergeAll(CrossSpawnSpawner.defaultLayer, AppFileSystem.defaultLayer, Plugin.defaultLayer),
- )
- function initBash() {
- return runtime.runPromise(BashTool.pipe(Effect.flatMap((info) => Effect.promise(() => info.init()))))
- }
- const ctx = {
- sessionID: SessionID.make("ses_test"),
- messageID: MessageID.make(""),
- callID: "",
- agent: "build",
- abort: AbortSignal.any([]),
- messages: [],
- metadata: () => {},
- ask: async () => {},
- }
- Shell.acceptable.reset()
- const quote = (text: string) => `"${text}"`
- const squote = (text: string) => `'${text}'`
- const projectRoot = path.join(__dirname, "../..")
- const bin = quote(process.execPath.replaceAll("\\", "/"))
- const bash = (() => {
- const shell = Shell.acceptable()
- if (Shell.name(shell) === "bash") return shell
- return Shell.gitbash()
- })()
- const shells = (() => {
- if (process.platform !== "win32") {
- const shell = Shell.acceptable()
- return [{ label: Shell.name(shell), shell }]
- }
- const list = [bash, Bun.which("pwsh"), Bun.which("powershell"), process.env.COMSPEC || Bun.which("cmd.exe")]
- .filter((shell): shell is string => Boolean(shell))
- .map((shell) => ({ label: Shell.name(shell), shell }))
- return list.filter(
- (item, i) => list.findIndex((other) => other.shell.toLowerCase() === item.shell.toLowerCase()) === i,
- )
- })()
- const PS = new Set(["pwsh", "powershell"])
- const ps = shells.filter((item) => PS.has(item.label))
- const sh = () => Shell.name(Shell.acceptable())
- const evalarg = (text: string) => (sh() === "cmd" ? quote(text) : squote(text))
- const fill = (mode: "lines" | "bytes", n: number) => {
- const code =
- mode === "lines"
- ? "console.log(Array.from({length:Number(Bun.argv[1])},(_,i)=>i+1).join(String.fromCharCode(10)))"
- : "process.stdout.write(String.fromCharCode(97).repeat(Number(Bun.argv[1])))"
- const text = `${bin} -e ${evalarg(code)} ${n}`
- if (PS.has(sh())) return `& ${text}`
- return text
- }
- const glob = (p: string) =>
- process.platform === "win32" ? Filesystem.normalizePathPattern(p) : p.replaceAll("\\", "/")
- const forms = (dir: string) => {
- if (process.platform !== "win32") return [dir]
- const full = Filesystem.normalizePath(dir)
- const slash = full.replaceAll("\\", "/")
- const root = slash.replace(/^[A-Za-z]:/, "")
- return Array.from(new Set([full, slash, root, root.toLowerCase()]))
- }
- const withShell = (item: { label: string; shell: string }, fn: () => Promise<void>) => async () => {
- const prev = process.env.SHELL
- process.env.SHELL = item.shell
- Shell.acceptable.reset()
- Shell.preferred.reset()
- try {
- await fn()
- } finally {
- if (prev === undefined) delete process.env.SHELL
- else process.env.SHELL = prev
- Shell.acceptable.reset()
- Shell.preferred.reset()
- }
- }
- const each = (name: string, fn: (item: { label: string; shell: string }) => Promise<void>) => {
- for (const item of shells) {
- test(
- `${name} [${item.label}]`,
- withShell(item, () => fn(item)),
- )
- }
- }
- const capture = (requests: Array<Omit<Permission.Request, "id" | "sessionID" | "tool">>, stop?: Error) => ({
- ...ctx,
- ask: async (req: Omit<Permission.Request, "id" | "sessionID" | "tool">) => {
- requests.push(req)
- if (stop) throw stop
- },
- })
- const mustTruncate = (result: {
- metadata: { truncated?: boolean; exit?: number | null } & Record<string, unknown>
- output: string
- }) => {
- if (result.metadata.truncated) return
- throw new Error(
- [`shell: ${process.env.SHELL || ""}`, `exit: ${String(result.metadata.exit)}`, "output:", result.output].join("\n"),
- )
- }
- describe("tool.bash", () => {
- each("basic", async () => {
- await Instance.provide({
- directory: projectRoot,
- fn: async () => {
- const bash = await initBash()
- const result = await bash.execute(
- {
- command: "echo test",
- description: "Echo test message",
- },
- ctx,
- )
- expect(result.metadata.exit).toBe(0)
- expect(result.metadata.output).toContain("test")
- },
- })
- })
- })
- describe("tool.bash permissions", () => {
- each("asks for bash permission with correct pattern", async () => {
- await using tmp = await tmpdir()
- await Instance.provide({
- directory: tmp.path,
- fn: async () => {
- const bash = await initBash()
- const requests: Array<Omit<Permission.Request, "id" | "sessionID" | "tool">> = []
- await bash.execute(
- {
- command: "echo hello",
- description: "Echo hello",
- },
- capture(requests),
- )
- expect(requests.length).toBe(1)
- expect(requests[0].permission).toBe("bash")
- expect(requests[0].patterns).toContain("echo hello")
- },
- })
- })
- each("asks for bash permission with multiple commands", async () => {
- await using tmp = await tmpdir()
- await Instance.provide({
- directory: tmp.path,
- fn: async () => {
- const bash = await initBash()
- const requests: Array<Omit<Permission.Request, "id" | "sessionID" | "tool">> = []
- await bash.execute(
- {
- command: "echo foo && echo bar",
- description: "Echo twice",
- },
- capture(requests),
- )
- expect(requests.length).toBe(1)
- expect(requests[0].permission).toBe("bash")
- expect(requests[0].patterns).toContain("echo foo")
- expect(requests[0].patterns).toContain("echo bar")
- },
- })
- })
- for (const item of ps) {
- test(
- `parses PowerShell conditionals for permission prompts [${item.label}]`,
- withShell(item, async () => {
- await Instance.provide({
- directory: projectRoot,
- fn: async () => {
- const bash = await initBash()
- const requests: Array<Omit<Permission.Request, "id" | "sessionID" | "tool">> = []
- await bash.execute(
- {
- command: "Write-Host foo; if ($?) { Write-Host bar }",
- description: "Check PowerShell conditional",
- },
- capture(requests),
- )
- const bashReq = requests.find((r) => r.permission === "bash")
- expect(bashReq).toBeDefined()
- expect(bashReq!.patterns).toContain("Write-Host foo")
- expect(bashReq!.patterns).toContain("Write-Host bar")
- expect(bashReq!.always).toContain("Write-Host *")
- },
- })
- }),
- )
- }
- each("asks for external_directory permission for wildcard external paths", async () => {
- await Instance.provide({
- directory: projectRoot,
- fn: async () => {
- const bash = await initBash()
- const err = new Error("stop after permission")
- const requests: Array<Omit<Permission.Request, "id" | "sessionID" | "tool">> = []
- const file = process.platform === "win32" ? `${process.env.WINDIR!.replaceAll("\\", "/")}/*` : "/etc/*"
- const want = process.platform === "win32" ? glob(path.join(process.env.WINDIR!, "*")) : "/etc/*"
- await expect(
- bash.execute(
- {
- command: `cat ${file}`,
- description: "Read wildcard path",
- },
- capture(requests, err),
- ),
- ).rejects.toThrow(err.message)
- const extDirReq = requests.find((r) => r.permission === "external_directory")
- expect(extDirReq).toBeDefined()
- expect(extDirReq!.patterns).toContain(want)
- },
- })
- })
- if (process.platform === "win32") {
- if (bash) {
- test(
- "asks for nested bash command permissions [bash]",
- withShell({ label: "bash", shell: bash }, async () => {
- await using outerTmp = await tmpdir({
- init: async (dir) => {
- await Bun.write(path.join(dir, "outside.txt"), "x")
- },
- })
- await Instance.provide({
- directory: projectRoot,
- fn: async () => {
- const bash = await initBash()
- const file = path.join(outerTmp.path, "outside.txt").replaceAll("\\", "/")
- const requests: Array<Omit<Permission.Request, "id" | "sessionID" | "tool">> = []
- await bash.execute(
- {
- command: `echo $(cat "${file}")`,
- description: "Read nested bash file",
- },
- capture(requests),
- )
- const extDirReq = requests.find((r) => r.permission === "external_directory")
- const bashReq = requests.find((r) => r.permission === "bash")
- expect(extDirReq).toBeDefined()
- expect(extDirReq!.patterns).toContain(glob(path.join(outerTmp.path, "*")))
- expect(bashReq).toBeDefined()
- expect(bashReq!.patterns).toContain(`cat "${file}"`)
- },
- })
- }),
- )
- }
- }
- if (process.platform === "win32") {
- for (const item of ps) {
- test(
- `asks for external_directory permission for PowerShell paths after switches [${item.label}]`,
- withShell(item, async () => {
- await Instance.provide({
- directory: projectRoot,
- fn: async () => {
- const bash = await initBash()
- const err = new Error("stop after permission")
- const requests: Array<Omit<Permission.Request, "id" | "sessionID" | "tool">> = []
- await expect(
- bash.execute(
- {
- command: `Copy-Item -PassThru "${process.env.WINDIR!.replaceAll("\\", "/")}/win.ini" ./out`,
- description: "Copy Windows ini",
- },
- capture(requests, err),
- ),
- ).rejects.toThrow(err.message)
- const extDirReq = requests.find((r) => r.permission === "external_directory")
- expect(extDirReq).toBeDefined()
- expect(extDirReq!.patterns).toContain(glob(path.join(process.env.WINDIR!, "*")))
- },
- })
- }),
- )
- }
- for (const item of ps) {
- test(
- `asks for nested PowerShell command permissions [${item.label}]`,
- withShell(item, async () => {
- await Instance.provide({
- directory: projectRoot,
- fn: async () => {
- const bash = await initBash()
- const requests: Array<Omit<Permission.Request, "id" | "sessionID" | "tool">> = []
- const file = `${process.env.WINDIR!.replaceAll("\\", "/")}/win.ini`
- await bash.execute(
- {
- command: `Write-Output $(Get-Content ${file})`,
- description: "Read nested PowerShell file",
- },
- capture(requests),
- )
- const extDirReq = requests.find((r) => r.permission === "external_directory")
- const bashReq = requests.find((r) => r.permission === "bash")
- expect(extDirReq).toBeDefined()
- expect(extDirReq!.patterns).toContain(glob(path.join(process.env.WINDIR!, "*")))
- expect(bashReq).toBeDefined()
- expect(bashReq!.patterns).toContain(`Get-Content ${file}`)
- },
- })
- }),
- )
- }
- for (const item of ps) {
- test(
- `asks for external_directory permission for drive-relative PowerShell paths [${item.label}]`,
- withShell(item, async () => {
- await using tmp = await tmpdir()
- await Instance.provide({
- directory: tmp.path,
- fn: async () => {
- const bash = await initBash()
- const err = new Error("stop after permission")
- const requests: Array<Omit<Permission.Request, "id" | "sessionID" | "tool">> = []
- await expect(
- bash.execute(
- {
- command: 'Get-Content "C:../outside.txt"',
- description: "Read drive-relative file",
- },
- capture(requests, err),
- ),
- ).rejects.toThrow(err.message)
- expect(requests[0]?.permission).toBe("external_directory")
- if (requests[0]?.permission !== "external_directory") return
- expect(requests[0].patterns).toContain(glob(path.join(path.dirname(tmp.path), "*")))
- },
- })
- }),
- )
- }
- for (const item of ps) {
- test(
- `asks for external_directory permission for $HOME PowerShell paths [${item.label}]`,
- withShell(item, async () => {
- await Instance.provide({
- directory: projectRoot,
- fn: async () => {
- const bash = await initBash()
- const err = new Error("stop after permission")
- const requests: Array<Omit<Permission.Request, "id" | "sessionID" | "tool">> = []
- await expect(
- bash.execute(
- {
- command: 'Get-Content "$HOME/.ssh/config"',
- description: "Read home config",
- },
- capture(requests, err),
- ),
- ).rejects.toThrow(err.message)
- expect(requests[0]?.permission).toBe("external_directory")
- if (requests[0]?.permission !== "external_directory") return
- expect(requests[0].patterns).toContain(glob(path.join(os.homedir(), ".ssh", "*")))
- },
- })
- }),
- )
- }
- for (const item of ps) {
- test(
- `asks for external_directory permission for $PWD PowerShell paths [${item.label}]`,
- withShell(item, async () => {
- await using tmp = await tmpdir()
- await Instance.provide({
- directory: tmp.path,
- fn: async () => {
- const bash = await initBash()
- const err = new Error("stop after permission")
- const requests: Array<Omit<Permission.Request, "id" | "sessionID" | "tool">> = []
- await expect(
- bash.execute(
- {
- command: 'Get-Content "$PWD/../outside.txt"',
- description: "Read pwd-relative file",
- },
- capture(requests, err),
- ),
- ).rejects.toThrow(err.message)
- expect(requests[0]?.permission).toBe("external_directory")
- if (requests[0]?.permission !== "external_directory") return
- expect(requests[0].patterns).toContain(glob(path.join(path.dirname(tmp.path), "*")))
- },
- })
- }),
- )
- }
- for (const item of ps) {
- test(
- `asks for external_directory permission for $PSHOME PowerShell paths [${item.label}]`,
- withShell(item, async () => {
- await Instance.provide({
- directory: projectRoot,
- fn: async () => {
- const bash = await initBash()
- const err = new Error("stop after permission")
- const requests: Array<Omit<Permission.Request, "id" | "sessionID" | "tool">> = []
- await expect(
- bash.execute(
- {
- command: 'Get-Content "$PSHOME/outside.txt"',
- description: "Read pshome file",
- },
- capture(requests, err),
- ),
- ).rejects.toThrow(err.message)
- expect(requests[0]?.permission).toBe("external_directory")
- if (requests[0]?.permission !== "external_directory") return
- expect(requests[0].patterns).toContain(glob(path.join(path.dirname(item.shell), "*")))
- },
- })
- }),
- )
- }
- for (const item of ps) {
- test(
- `asks for external_directory permission for missing PowerShell env paths [${item.label}]`,
- withShell(item, async () => {
- const key = "OPENCODE_TEST_MISSING"
- const prev = process.env[key]
- delete process.env[key]
- try {
- await Instance.provide({
- directory: projectRoot,
- fn: async () => {
- const bash = await initBash()
- const err = new Error("stop after permission")
- const requests: Array<Omit<Permission.Request, "id" | "sessionID" | "tool">> = []
- const root = path.parse(process.env.WINDIR!).root.replace(/[\\/]+$/, "")
- await expect(
- bash.execute(
- {
- command: `Get-Content -Path "${root}$env:${key}\\Windows\\win.ini"`,
- description: "Read Windows ini with missing env",
- },
- capture(requests, err),
- ),
- ).rejects.toThrow(err.message)
- const extDirReq = requests.find((r) => r.permission === "external_directory")
- expect(extDirReq).toBeDefined()
- expect(extDirReq!.patterns).toContain(glob(path.join(process.env.WINDIR!, "*")))
- },
- })
- } finally {
- if (prev === undefined) delete process.env[key]
- else process.env[key] = prev
- }
- }),
- )
- }
- for (const item of ps) {
- test(
- `asks for external_directory permission for PowerShell env paths [${item.label}]`,
- withShell(item, async () => {
- await Instance.provide({
- directory: projectRoot,
- fn: async () => {
- const bash = await initBash()
- const requests: Array<Omit<Permission.Request, "id" | "sessionID" | "tool">> = []
- await bash.execute(
- {
- command: "Get-Content $env:WINDIR/win.ini",
- description: "Read Windows ini from env",
- },
- capture(requests),
- )
- const extDirReq = requests.find((r) => r.permission === "external_directory")
- expect(extDirReq).toBeDefined()
- expect(extDirReq!.patterns).toContain(
- Filesystem.normalizePathPattern(path.join(process.env.WINDIR!, "*")),
- )
- },
- })
- }),
- )
- }
- for (const item of ps) {
- test(
- `asks for external_directory permission for PowerShell FileSystem paths [${item.label}]`,
- withShell(item, async () => {
- await Instance.provide({
- directory: projectRoot,
- fn: async () => {
- const bash = await initBash()
- const err = new Error("stop after permission")
- const requests: Array<Omit<Permission.Request, "id" | "sessionID" | "tool">> = []
- await expect(
- bash.execute(
- {
- command: `Get-Content -Path FileSystem::${process.env.WINDIR!.replaceAll("\\", "/")}/win.ini`,
- description: "Read Windows ini from FileSystem provider",
- },
- capture(requests, err),
- ),
- ).rejects.toThrow(err.message)
- expect(requests[0]?.permission).toBe("external_directory")
- if (requests[0]?.permission !== "external_directory") return
- expect(requests[0].patterns).toContain(
- Filesystem.normalizePathPattern(path.join(process.env.WINDIR!, "*")),
- )
- },
- })
- }),
- )
- }
- for (const item of ps) {
- test(
- `asks for external_directory permission for braced PowerShell env paths [${item.label}]`,
- withShell(item, async () => {
- await Instance.provide({
- directory: projectRoot,
- fn: async () => {
- const bash = await initBash()
- const err = new Error("stop after permission")
- const requests: Array<Omit<Permission.Request, "id" | "sessionID" | "tool">> = []
- await expect(
- bash.execute(
- {
- command: "Get-Content ${env:WINDIR}/win.ini",
- description: "Read Windows ini from braced env",
- },
- capture(requests, err),
- ),
- ).rejects.toThrow(err.message)
- expect(requests[0]?.permission).toBe("external_directory")
- if (requests[0]?.permission !== "external_directory") return
- expect(requests[0].patterns).toContain(
- Filesystem.normalizePathPattern(path.join(process.env.WINDIR!, "*")),
- )
- },
- })
- }),
- )
- }
- for (const item of ps) {
- test(
- `treats Set-Location like cd for permissions [${item.label}]`,
- withShell(item, async () => {
- await Instance.provide({
- directory: projectRoot,
- fn: async () => {
- const bash = await initBash()
- const requests: Array<Omit<Permission.Request, "id" | "sessionID" | "tool">> = []
- await bash.execute(
- {
- command: "Set-Location C:/Windows",
- description: "Change location",
- },
- capture(requests),
- )
- const extDirReq = requests.find((r) => r.permission === "external_directory")
- const bashReq = requests.find((r) => r.permission === "bash")
- expect(extDirReq).toBeDefined()
- expect(extDirReq!.patterns).toContain(
- Filesystem.normalizePathPattern(path.join(process.env.WINDIR!, "*")),
- )
- expect(bashReq).toBeUndefined()
- },
- })
- }),
- )
- }
- for (const item of ps) {
- test(
- `does not add nested PowerShell expressions to permission prompts [${item.label}]`,
- withShell(item, async () => {
- await Instance.provide({
- directory: projectRoot,
- fn: async () => {
- const bash = await initBash()
- const requests: Array<Omit<Permission.Request, "id" | "sessionID" | "tool">> = []
- await bash.execute(
- {
- command: "Write-Output ('a' * 3)",
- description: "Write repeated text",
- },
- capture(requests),
- )
- const bashReq = requests.find((r) => r.permission === "bash")
- expect(bashReq).toBeDefined()
- expect(bashReq!.patterns).not.toContain("a * 3")
- expect(bashReq!.always).not.toContain("a *")
- },
- })
- }),
- )
- }
- }
- each("asks for external_directory permission when cd to parent", async () => {
- await using tmp = await tmpdir()
- await Instance.provide({
- directory: tmp.path,
- fn: async () => {
- const bash = await initBash()
- const err = new Error("stop after permission")
- const requests: Array<Omit<Permission.Request, "id" | "sessionID" | "tool">> = []
- await expect(
- bash.execute(
- {
- command: "cd ../",
- description: "Change to parent directory",
- },
- capture(requests, err),
- ),
- ).rejects.toThrow(err.message)
- const extDirReq = requests.find((r) => r.permission === "external_directory")
- expect(extDirReq).toBeDefined()
- },
- })
- })
- each("asks for external_directory permission when workdir is outside project", async () => {
- await using tmp = await tmpdir()
- await Instance.provide({
- directory: tmp.path,
- fn: async () => {
- const bash = await initBash()
- const err = new Error("stop after permission")
- const requests: Array<Omit<Permission.Request, "id" | "sessionID" | "tool">> = []
- await expect(
- bash.execute(
- {
- command: "echo ok",
- workdir: os.tmpdir(),
- description: "Echo from temp dir",
- },
- capture(requests, err),
- ),
- ).rejects.toThrow(err.message)
- const extDirReq = requests.find((r) => r.permission === "external_directory")
- expect(extDirReq).toBeDefined()
- expect(extDirReq!.patterns).toContain(glob(path.join(os.tmpdir(), "*")))
- },
- })
- })
- if (process.platform === "win32") {
- test("normalizes external_directory workdir variants on Windows", async () => {
- const err = new Error("stop after permission")
- await using outerTmp = await tmpdir()
- await using tmp = await tmpdir()
- await Instance.provide({
- directory: tmp.path,
- fn: async () => {
- const bash = await initBash()
- const want = Filesystem.normalizePathPattern(path.join(outerTmp.path, "*"))
- for (const dir of forms(outerTmp.path)) {
- const requests: Array<Omit<Permission.Request, "id" | "sessionID" | "tool">> = []
- await expect(
- bash.execute(
- {
- command: "echo ok",
- workdir: dir,
- description: "Echo from external dir",
- },
- capture(requests, err),
- ),
- ).rejects.toThrow(err.message)
- const extDirReq = requests.find((r) => r.permission === "external_directory")
- expect({ dir, patterns: extDirReq?.patterns, always: extDirReq?.always }).toEqual({
- dir,
- patterns: [want],
- always: [want],
- })
- }
- },
- })
- })
- if (bash) {
- test(
- "uses Git Bash /tmp semantics for external workdir",
- withShell({ label: "bash", shell: bash }, async () => {
- await Instance.provide({
- directory: projectRoot,
- fn: async () => {
- const bash = await initBash()
- const err = new Error("stop after permission")
- const requests: Array<Omit<Permission.Request, "id" | "sessionID" | "tool">> = []
- const want = glob(path.join(os.tmpdir(), "*"))
- await expect(
- bash.execute(
- {
- command: "echo ok",
- workdir: "/tmp",
- description: "Echo from Git Bash tmp",
- },
- capture(requests, err),
- ),
- ).rejects.toThrow(err.message)
- expect(requests[0]).toMatchObject({
- permission: "external_directory",
- patterns: [want],
- always: [want],
- })
- },
- })
- }),
- )
- test(
- "uses Git Bash /tmp semantics for external file paths",
- withShell({ label: "bash", shell: bash }, async () => {
- await Instance.provide({
- directory: projectRoot,
- fn: async () => {
- const bash = await initBash()
- const err = new Error("stop after permission")
- const requests: Array<Omit<Permission.Request, "id" | "sessionID" | "tool">> = []
- const want = glob(path.join(os.tmpdir(), "*"))
- await expect(
- bash.execute(
- {
- command: "cat /tmp/opencode-does-not-exist",
- description: "Read Git Bash tmp file",
- },
- capture(requests, err),
- ),
- ).rejects.toThrow(err.message)
- expect(requests[0]).toMatchObject({
- permission: "external_directory",
- patterns: [want],
- always: [want],
- })
- },
- })
- }),
- )
- }
- }
- each("asks for external_directory permission when file arg is outside project", async () => {
- await using outerTmp = await tmpdir({
- init: async (dir) => {
- await Bun.write(path.join(dir, "outside.txt"), "x")
- },
- })
- await using tmp = await tmpdir()
- await Instance.provide({
- directory: tmp.path,
- fn: async () => {
- const bash = await initBash()
- const err = new Error("stop after permission")
- const requests: Array<Omit<Permission.Request, "id" | "sessionID" | "tool">> = []
- const filepath = path.join(outerTmp.path, "outside.txt")
- await expect(
- bash.execute(
- {
- command: `cat ${filepath}`,
- description: "Read external file",
- },
- capture(requests, err),
- ),
- ).rejects.toThrow(err.message)
- const extDirReq = requests.find((r) => r.permission === "external_directory")
- const expected = glob(path.join(outerTmp.path, "*"))
- expect(extDirReq).toBeDefined()
- expect(extDirReq!.patterns).toContain(expected)
- expect(extDirReq!.always).toContain(expected)
- },
- })
- })
- each("does not ask for external_directory permission when rm inside project", async () => {
- await using tmp = await tmpdir({
- init: async (dir) => {
- await Bun.write(path.join(dir, "tmpfile"), "x")
- },
- })
- await Instance.provide({
- directory: tmp.path,
- fn: async () => {
- const bash = await initBash()
- const requests: Array<Omit<Permission.Request, "id" | "sessionID" | "tool">> = []
- await bash.execute(
- {
- command: `rm -rf ${path.join(tmp.path, "nested")}`,
- description: "Remove nested dir",
- },
- capture(requests),
- )
- const extDirReq = requests.find((r) => r.permission === "external_directory")
- expect(extDirReq).toBeUndefined()
- },
- })
- })
- each("includes always patterns for auto-approval", async () => {
- await using tmp = await tmpdir()
- await Instance.provide({
- directory: tmp.path,
- fn: async () => {
- const bash = await initBash()
- const requests: Array<Omit<Permission.Request, "id" | "sessionID" | "tool">> = []
- await bash.execute(
- {
- command: "git log --oneline -5",
- description: "Git log",
- },
- capture(requests),
- )
- expect(requests.length).toBe(1)
- expect(requests[0].always.length).toBeGreaterThan(0)
- expect(requests[0].always.some((item) => item.endsWith("*"))).toBe(true)
- },
- })
- })
- each("does not ask for bash permission when command is cd only", async () => {
- await using tmp = await tmpdir()
- await Instance.provide({
- directory: tmp.path,
- fn: async () => {
- const bash = await initBash()
- const requests: Array<Omit<Permission.Request, "id" | "sessionID" | "tool">> = []
- await bash.execute(
- {
- command: "cd .",
- description: "Stay in current directory",
- },
- capture(requests),
- )
- const bashReq = requests.find((r) => r.permission === "bash")
- expect(bashReq).toBeUndefined()
- },
- })
- })
- each("matches redirects in permission pattern", async () => {
- await using tmp = await tmpdir()
- await Instance.provide({
- directory: tmp.path,
- fn: async () => {
- const bash = await initBash()
- const err = new Error("stop after permission")
- const requests: Array<Omit<Permission.Request, "id" | "sessionID" | "tool">> = []
- await expect(
- bash.execute(
- { command: "echo test > output.txt", description: "Redirect test output" },
- capture(requests, err),
- ),
- ).rejects.toThrow(err.message)
- const bashReq = requests.find((r) => r.permission === "bash")
- expect(bashReq).toBeDefined()
- expect(bashReq!.patterns).toContain("echo test > output.txt")
- },
- })
- })
- each("always pattern has space before wildcard to not include different commands", async () => {
- await using tmp = await tmpdir()
- await Instance.provide({
- directory: tmp.path,
- fn: async () => {
- const bash = await initBash()
- const requests: Array<Omit<Permission.Request, "id" | "sessionID" | "tool">> = []
- await bash.execute({ command: "ls -la", description: "List" }, capture(requests))
- const bashReq = requests.find((r) => r.permission === "bash")
- expect(bashReq).toBeDefined()
- expect(bashReq!.always[0]).toBe("ls *")
- },
- })
- })
- })
- describe("tool.bash abort", () => {
- test("preserves output when aborted", async () => {
- await Instance.provide({
- directory: projectRoot,
- fn: async () => {
- const bash = await initBash()
- const controller = new AbortController()
- const collected: string[] = []
- const result = bash.execute(
- {
- command: `echo before && sleep 30`,
- description: "Long running command",
- },
- {
- ...ctx,
- abort: controller.signal,
- metadata: (input) => {
- const output = (input.metadata as { output?: string })?.output
- if (output && output.includes("before") && !controller.signal.aborted) {
- collected.push(output)
- controller.abort()
- }
- },
- },
- )
- const res = await result
- expect(res.output).toContain("before")
- expect(res.output).toContain("User aborted the command")
- expect(collected.length).toBeGreaterThan(0)
- },
- })
- }, 15_000)
- test("terminates command on timeout", async () => {
- await Instance.provide({
- directory: projectRoot,
- fn: async () => {
- const bash = await initBash()
- const result = await bash.execute(
- {
- command: `echo started && sleep 60`,
- description: "Timeout test",
- timeout: 500,
- },
- ctx,
- )
- expect(result.output).toContain("started")
- expect(result.output).toContain("bash tool terminated command after exceeding timeout")
- },
- })
- }, 15_000)
- test.skipIf(process.platform === "win32")("captures stderr in output", async () => {
- await Instance.provide({
- directory: projectRoot,
- fn: async () => {
- const bash = await initBash()
- const result = await bash.execute(
- {
- command: `echo stdout_msg && echo stderr_msg >&2`,
- description: "Stderr test",
- },
- ctx,
- )
- expect(result.output).toContain("stdout_msg")
- expect(result.output).toContain("stderr_msg")
- expect(result.metadata.exit).toBe(0)
- },
- })
- })
- test("returns non-zero exit code", async () => {
- await Instance.provide({
- directory: projectRoot,
- fn: async () => {
- const bash = await initBash()
- const result = await bash.execute(
- {
- command: `exit 42`,
- description: "Non-zero exit",
- },
- ctx,
- )
- expect(result.metadata.exit).toBe(42)
- },
- })
- })
- test("streams metadata updates progressively", async () => {
- await Instance.provide({
- directory: projectRoot,
- fn: async () => {
- const bash = await initBash()
- const updates: string[] = []
- const result = await bash.execute(
- {
- command: `echo first && sleep 0.1 && echo second`,
- description: "Streaming test",
- },
- {
- ...ctx,
- metadata: (input) => {
- const output = (input.metadata as { output?: string })?.output
- if (output) updates.push(output)
- },
- },
- )
- expect(result.output).toContain("first")
- expect(result.output).toContain("second")
- expect(updates.length).toBeGreaterThan(1)
- },
- })
- })
- })
- describe("tool.bash truncation", () => {
- test("truncates output exceeding line limit", async () => {
- await Instance.provide({
- directory: projectRoot,
- fn: async () => {
- const bash = await initBash()
- const lineCount = Truncate.MAX_LINES + 500
- const result = await bash.execute(
- {
- command: fill("lines", lineCount),
- description: "Generate lines exceeding limit",
- },
- ctx,
- )
- mustTruncate(result)
- expect(result.output).toContain("truncated")
- expect(result.output).toContain("The tool call succeeded but the output was truncated")
- },
- })
- })
- test("truncates output exceeding byte limit", async () => {
- await Instance.provide({
- directory: projectRoot,
- fn: async () => {
- const bash = await initBash()
- const byteCount = Truncate.MAX_BYTES + 10000
- const result = await bash.execute(
- {
- command: fill("bytes", byteCount),
- description: "Generate bytes exceeding limit",
- },
- ctx,
- )
- mustTruncate(result)
- expect(result.output).toContain("truncated")
- expect(result.output).toContain("The tool call succeeded but the output was truncated")
- },
- })
- })
- test("does not truncate small output", async () => {
- await Instance.provide({
- directory: projectRoot,
- fn: async () => {
- const bash = await initBash()
- const result = await bash.execute(
- {
- command: "echo hello",
- description: "Echo hello",
- },
- ctx,
- )
- expect((result.metadata as { truncated?: boolean }).truncated).toBe(false)
- expect(result.output).toContain("hello")
- },
- })
- })
- test("full output is saved to file when truncated", async () => {
- await Instance.provide({
- directory: projectRoot,
- fn: async () => {
- const bash = await initBash()
- const lineCount = Truncate.MAX_LINES + 100
- const result = await bash.execute(
- {
- command: fill("lines", lineCount),
- description: "Generate lines for file check",
- },
- ctx,
- )
- mustTruncate(result)
- const filepath = (result.metadata as { outputPath?: string }).outputPath
- expect(filepath).toBeTruthy()
- const saved = await Filesystem.readText(filepath!)
- const lines = saved.trim().split(/\r?\n/)
- expect(lines.length).toBe(lineCount)
- expect(lines[0]).toBe("1")
- expect(lines[lineCount - 1]).toBe(String(lineCount))
- },
- })
- })
- })
|