| 12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570 |
- import { test, expect, describe, mock, afterEach, beforeEach } from "bun:test"
- import { Effect, Layer, Option } from "effect"
- import { NodeFileSystem, NodePath } from "@effect/platform-node"
- import { Config } from "@/config/config"
- import { ConfigManaged } from "@/config/managed"
- import { ConfigParse } from "../../src/config/parse"
- import { EffectFlock } from "@opencode-ai/core/util/effect-flock"
- import { Instance } from "../../src/project/instance"
- import { WithInstance } from "../../src/project/with-instance"
- import { Auth } from "../../src/auth"
- import { Account } from "../../src/account/account"
- import { AccessToken, AccountID, OrgID } from "../../src/account/schema"
- import { AppFileSystem } from "@opencode-ai/core/filesystem"
- import { Env } from "../../src/env"
- import { provideTestInstance, provideTmpdirInstance } from "../fixture/fixture"
- import { tmpdir } from "../fixture/fixture"
- import { InstanceRuntime } from "@/project/instance-runtime"
- import { CrossSpawnSpawner } from "@opencode-ai/core/cross-spawn-spawner"
- import { testEffect } from "../lib/effect"
- /** Infra layer that provides FileSystem, Path, ChildProcessSpawner for test fixtures */
- const infra = CrossSpawnSpawner.defaultLayer.pipe(
- Layer.provideMerge(Layer.mergeAll(NodeFileSystem.layer, NodePath.layer)),
- )
- import path from "path"
- import fs from "fs/promises"
- import { pathToFileURL } from "url"
- import { Global } from "@opencode-ai/core/global"
- import { ProjectID } from "../../src/project/schema"
- import { Filesystem } from "@/util/filesystem"
- import { ConfigPlugin } from "@/config/plugin"
- import { Npm } from "@opencode-ai/core/npm"
- const emptyAccount = Layer.mock(Account.Service)({
- active: () => Effect.succeed(Option.none()),
- activeOrg: () => Effect.succeed(Option.none()),
- })
- const emptyAuth = Layer.mock(Auth.Service)({
- all: () => Effect.succeed({}),
- })
- const testFlock = EffectFlock.defaultLayer
- const noopNpm = Layer.mock(Npm.Service)({
- install: () => Effect.void,
- add: () => Effect.die("not implemented"),
- which: () => Effect.succeed(Option.none()),
- })
- const layer = Config.layer.pipe(
- Layer.provide(testFlock),
- Layer.provide(AppFileSystem.defaultLayer),
- Layer.provide(Env.defaultLayer),
- Layer.provide(emptyAuth),
- Layer.provide(emptyAccount),
- Layer.provideMerge(infra),
- Layer.provide(noopNpm),
- )
- const it = testEffect(layer)
- const load = () => Effect.runPromise(Config.Service.use((svc) => svc.get()).pipe(Effect.scoped, Effect.provide(layer)))
- const save = (config: Config.Info) =>
- Effect.runPromise(Config.Service.use((svc) => svc.update(config)).pipe(Effect.scoped, Effect.provide(layer)))
- const saveGlobal = (config: Config.Info) =>
- Effect.runPromise(
- Config.Service.use((svc) => svc.updateGlobal(config)).pipe(
- Effect.map((result) => result.info),
- Effect.scoped,
- Effect.provide(layer),
- ),
- )
- const clear = async (wait = false) => {
- await Effect.runPromise(Config.Service.use((svc) => svc.invalidate()).pipe(Effect.scoped, Effect.provide(layer)))
- if (wait) await InstanceRuntime.disposeAllInstances()
- }
- const listDirs = () =>
- Effect.runPromise(Config.Service.use((svc) => svc.directories()).pipe(Effect.scoped, Effect.provide(layer)))
- const ready = () =>
- Effect.runPromise(Config.Service.use((svc) => svc.waitForDependencies()).pipe(Effect.scoped, Effect.provide(layer)))
- // Get managed config directory from environment (set in preload.ts)
- const managedConfigDir = process.env.OPENCODE_TEST_MANAGED_CONFIG_DIR!
- beforeEach(async () => {
- await clear(true)
- })
- afterEach(async () => {
- await fs.rm(managedConfigDir, { force: true, recursive: true }).catch(() => {})
- await clear(true)
- })
- async function writeManagedSettings(settings: object, filename = "opencode.json") {
- await fs.mkdir(managedConfigDir, { recursive: true })
- await Filesystem.write(path.join(managedConfigDir, filename), JSON.stringify(settings))
- }
- async function writeConfig(dir: string, config: object, name = "opencode.json") {
- await Filesystem.write(path.join(dir, name), JSON.stringify(config))
- }
- async function check(map: (dir: string) => string) {
- if (process.platform !== "win32") return
- await using globalTmp = await tmpdir()
- await using tmp = await tmpdir({ git: true, config: { snapshot: true } })
- const prev = Global.Path.config
- ;(Global.Path as { config: string }).config = globalTmp.path
- await clear()
- try {
- await writeConfig(globalTmp.path, {
- $schema: "https://opencode.ai/config.json",
- snapshot: false,
- })
- await WithInstance.provide({
- directory: map(tmp.path),
- fn: async () => {
- const cfg = await load()
- expect(cfg.snapshot).toBe(true)
- expect(Instance.directory).toBe(Filesystem.resolve(tmp.path))
- expect(Instance.project.id).not.toBe(ProjectID.global)
- },
- })
- } finally {
- await InstanceRuntime.disposeAllInstances()
- ;(Global.Path as { config: string }).config = prev
- await clear()
- }
- }
- test("loads config with defaults when no files exist", async () => {
- await using tmp = await tmpdir()
- await WithInstance.provide({
- directory: tmp.path,
- fn: async () => {
- const config = await load()
- expect(config.username).toBeDefined()
- },
- })
- })
- test("loads JSON config file", async () => {
- await using tmp = await tmpdir({
- init: async (dir) => {
- await writeConfig(dir, {
- $schema: "https://opencode.ai/config.json",
- model: "test/model",
- username: "testuser",
- })
- },
- })
- await WithInstance.provide({
- directory: tmp.path,
- fn: async () => {
- const config = await load()
- expect(config.model).toBe("test/model")
- expect(config.username).toBe("testuser")
- },
- })
- })
- test("loads shell config field", async () => {
- await using tmp = await tmpdir({
- init: async (dir) => {
- await writeConfig(dir, {
- $schema: "https://opencode.ai/config.json",
- shell: "bash",
- })
- },
- })
- await WithInstance.provide({
- directory: tmp.path,
- fn: async () => {
- const config = await load()
- expect(config.shell).toBe("bash")
- },
- })
- })
- test("updates config and preserves empty shell sentinel", async () => {
- await using tmp = await tmpdir({
- init: async (dir) => {
- await writeConfig(
- dir,
- {
- $schema: "https://opencode.ai/config.json",
- shell: "bash",
- },
- "config.json",
- )
- },
- })
- await WithInstance.provide({
- directory: tmp.path,
- fn: async () => {
- await save({ shell: "" })
- const writtenConfig = await Filesystem.readJson<{ shell?: string }>(path.join(tmp.path, "config.json"))
- expect(writtenConfig.shell).toBe("")
- },
- })
- })
- test("updates global config and omits empty shell key in json", async () => {
- await using tmp = await tmpdir({
- init: async (dir) => {
- await writeConfig(dir, {
- $schema: "https://opencode.ai/config.json",
- shell: "bash",
- })
- },
- })
- const prev = Global.Path.config
- ;(Global.Path as { config: string }).config = tmp.path
- await clear(true)
- try {
- await saveGlobal({ shell: "" })
- const writtenConfig = await Filesystem.readJson<{ shell?: string }>(path.join(tmp.path, "opencode.json"))
- expect("shell" in writtenConfig).toBe(false)
- } finally {
- ;(Global.Path as { config: string }).config = prev
- await clear(true)
- }
- })
- test("updates global config and omits empty shell key in jsonc", async () => {
- await using tmp = await tmpdir({
- init: async (dir) => {
- await Filesystem.write(
- path.join(dir, "opencode.jsonc"),
- JSON.stringify({
- $schema: "https://opencode.ai/config.json",
- shell: "bash",
- model: "test/model",
- }),
- )
- },
- })
- const prev = Global.Path.config
- ;(Global.Path as { config: string }).config = tmp.path
- await clear(true)
- try {
- await saveGlobal({ shell: "" })
- const file = path.join(tmp.path, "opencode.jsonc")
- const writtenConfig = await Filesystem.readText(file)
- const parsed = ConfigParse.schema(Config.Info.zod, ConfigParse.jsonc(writtenConfig, file), file)
- expect(writtenConfig).not.toContain('"shell"')
- expect(parsed.shell).toBeUndefined()
- expect(parsed.model).toBe("test/model")
- } finally {
- ;(Global.Path as { config: string }).config = prev
- await clear(true)
- }
- })
- test("loads formatter boolean config", async () => {
- await using tmp = await tmpdir({
- init: async (dir) => {
- await writeConfig(dir, {
- $schema: "https://opencode.ai/config.json",
- formatter: true,
- })
- },
- })
- await WithInstance.provide({
- directory: tmp.path,
- fn: async () => {
- const config = await load()
- expect(config.formatter).toBe(true)
- },
- })
- })
- test("loads lsp boolean config", async () => {
- await using tmp = await tmpdir({
- init: async (dir) => {
- await writeConfig(dir, {
- $schema: "https://opencode.ai/config.json",
- lsp: true,
- })
- },
- })
- await WithInstance.provide({
- directory: tmp.path,
- fn: async () => {
- const config = await load()
- expect(config.lsp).toBe(true)
- },
- })
- })
- test("loads project config from Git Bash and MSYS2 paths on Windows", async () => {
- // Git Bash and MSYS2 both use /<drive>/... paths on Windows.
- await check((dir) => {
- const drive = dir[0].toLowerCase()
- const rest = dir.slice(2).replaceAll("\\", "/")
- return `/${drive}${rest}`
- })
- })
- test("loads project config from Cygwin paths on Windows", async () => {
- await check((dir) => {
- const drive = dir[0].toLowerCase()
- const rest = dir.slice(2).replaceAll("\\", "/")
- return `/cygdrive/${drive}${rest}`
- })
- })
- test("ignores legacy tui keys in opencode config", async () => {
- await using tmp = await tmpdir({
- init: async (dir) => {
- await writeConfig(dir, {
- $schema: "https://opencode.ai/config.json",
- model: "test/model",
- theme: "legacy",
- tui: { scroll_speed: 4 },
- })
- },
- })
- await WithInstance.provide({
- directory: tmp.path,
- fn: async () => {
- const config = await load()
- expect(config.model).toBe("test/model")
- expect((config as Record<string, unknown>).theme).toBeUndefined()
- expect((config as Record<string, unknown>).tui).toBeUndefined()
- },
- })
- })
- test("loads JSONC config file", async () => {
- await using tmp = await tmpdir({
- init: async (dir) => {
- await Filesystem.write(
- path.join(dir, "opencode.jsonc"),
- `{
- // This is a comment
- "$schema": "https://opencode.ai/config.json",
- "model": "test/model",
- "username": "testuser"
- }`,
- )
- },
- })
- await WithInstance.provide({
- directory: tmp.path,
- fn: async () => {
- const config = await load()
- expect(config.model).toBe("test/model")
- expect(config.username).toBe("testuser")
- },
- })
- })
- test("jsonc overrides json in the same directory", async () => {
- await using tmp = await tmpdir({
- init: async (dir) => {
- await writeConfig(
- dir,
- {
- $schema: "https://opencode.ai/config.json",
- model: "base",
- username: "base",
- },
- "opencode.jsonc",
- )
- await writeConfig(dir, {
- $schema: "https://opencode.ai/config.json",
- model: "override",
- })
- },
- })
- await WithInstance.provide({
- directory: tmp.path,
- fn: async () => {
- const config = await load()
- expect(config.model).toBe("base")
- expect(config.username).toBe("base")
- },
- })
- })
- test("handles environment variable substitution", async () => {
- const originalEnv = process.env["TEST_VAR"]
- process.env["TEST_VAR"] = "test-user"
- try {
- await using tmp = await tmpdir({
- init: async (dir) => {
- await writeConfig(dir, {
- $schema: "https://opencode.ai/config.json",
- username: "{env:TEST_VAR}",
- })
- },
- })
- await WithInstance.provide({
- directory: tmp.path,
- fn: async () => {
- const config = await load()
- expect(config.username).toBe("test-user")
- },
- })
- } finally {
- if (originalEnv !== undefined) {
- process.env["TEST_VAR"] = originalEnv
- } else {
- delete process.env["TEST_VAR"]
- }
- }
- })
- test("preserves env variables when adding $schema to config", async () => {
- const originalEnv = process.env["PRESERVE_VAR"]
- process.env["PRESERVE_VAR"] = "secret_value"
- try {
- await using tmp = await tmpdir({
- init: async (dir) => {
- // Config without $schema - should trigger auto-add
- await Filesystem.write(
- path.join(dir, "opencode.json"),
- JSON.stringify({
- username: "{env:PRESERVE_VAR}",
- }),
- )
- },
- })
- await WithInstance.provide({
- directory: tmp.path,
- fn: async () => {
- const config = await load()
- expect(config.username).toBe("secret_value")
- // Read the file to verify the env variable was preserved
- const content = await Filesystem.readText(path.join(tmp.path, "opencode.json"))
- expect(content).toContain("{env:PRESERVE_VAR}")
- expect(content).not.toContain("secret_value")
- expect(content).toContain("$schema")
- },
- })
- } finally {
- if (originalEnv !== undefined) {
- process.env["PRESERVE_VAR"] = originalEnv
- } else {
- delete process.env["PRESERVE_VAR"]
- }
- }
- })
- test("resolves env templates in account config with account token", async () => {
- const originalControlToken = process.env["OPENCODE_CONSOLE_TOKEN"]
- const fakeAccount = Layer.mock(Account.Service)({
- active: () =>
- Effect.succeed(
- Option.some({
- id: AccountID.make("account-1"),
- email: "user@example.com",
- url: "https://control.example.com",
- active_org_id: OrgID.make("org-1"),
- }),
- ),
- activeOrg: () =>
- Effect.succeed(
- Option.some({
- account: {
- id: AccountID.make("account-1"),
- email: "user@example.com",
- url: "https://control.example.com",
- active_org_id: OrgID.make("org-1"),
- },
- org: {
- id: OrgID.make("org-1"),
- name: "Example Org",
- },
- }),
- ),
- config: () =>
- Effect.succeed(
- Option.some({
- provider: { opencode: { options: { apiKey: "{env:OPENCODE_CONSOLE_TOKEN}" } } },
- }),
- ),
- token: () => Effect.succeed(Option.some(AccessToken.make("st_test_token"))),
- })
- const layer = Config.layer.pipe(
- Layer.provide(testFlock),
- Layer.provide(AppFileSystem.defaultLayer),
- Layer.provide(Env.defaultLayer),
- Layer.provide(emptyAuth),
- Layer.provide(fakeAccount),
- Layer.provideMerge(infra),
- Layer.provide(noopNpm),
- )
- try {
- await provideTmpdirInstance(() =>
- Config.Service.use((svc) =>
- Effect.gen(function* () {
- const config = yield* svc.get()
- expect(config.provider?.["opencode"]?.options?.apiKey).toBe("st_test_token")
- }),
- ),
- ).pipe(Effect.scoped, Effect.provide(layer), Effect.runPromise)
- } finally {
- if (originalControlToken !== undefined) {
- process.env["OPENCODE_CONSOLE_TOKEN"] = originalControlToken
- } else {
- delete process.env["OPENCODE_CONSOLE_TOKEN"]
- }
- }
- })
- test("handles file inclusion substitution", async () => {
- await using tmp = await tmpdir({
- init: async (dir) => {
- await Filesystem.write(path.join(dir, "included.txt"), "test-user")
- await writeConfig(dir, {
- $schema: "https://opencode.ai/config.json",
- username: "{file:included.txt}",
- })
- },
- })
- await WithInstance.provide({
- directory: tmp.path,
- fn: async () => {
- const config = await load()
- expect(config.username).toBe("test-user")
- },
- })
- })
- test("handles file inclusion with replacement tokens", async () => {
- await using tmp = await tmpdir({
- init: async (dir) => {
- await Filesystem.write(path.join(dir, "included.md"), "const out = await Bun.$`echo hi`")
- await writeConfig(dir, {
- $schema: "https://opencode.ai/config.json",
- username: "{file:included.md}",
- })
- },
- })
- await WithInstance.provide({
- directory: tmp.path,
- fn: async () => {
- const config = await load()
- expect(config.username).toBe("const out = await Bun.$`echo hi`")
- },
- })
- })
- test("validates config schema and throws on invalid fields", async () => {
- await using tmp = await tmpdir({
- init: async (dir) => {
- await writeConfig(dir, {
- $schema: "https://opencode.ai/config.json",
- invalid_field: "should cause error",
- })
- },
- })
- await provideTestInstance({
- directory: tmp.path,
- fn: async () => {
- // Strict schema should throw an error for invalid fields
- await expect(load()).rejects.toThrow()
- },
- })
- })
- test("throws error for invalid JSON", async () => {
- await using tmp = await tmpdir({
- init: async (dir) => {
- await Filesystem.write(path.join(dir, "opencode.json"), "{ invalid json }")
- },
- })
- await provideTestInstance({
- directory: tmp.path,
- fn: async () => {
- await expect(load()).rejects.toThrow()
- },
- })
- })
- test("handles agent configuration", async () => {
- await using tmp = await tmpdir({
- init: async (dir) => {
- await writeConfig(dir, {
- $schema: "https://opencode.ai/config.json",
- agent: {
- test_agent: {
- model: "test/model",
- temperature: 0.7,
- description: "test agent",
- },
- },
- })
- },
- })
- await WithInstance.provide({
- directory: tmp.path,
- fn: async () => {
- const config = await load()
- expect(config.agent?.["test_agent"]).toEqual(
- expect.objectContaining({
- model: "test/model",
- temperature: 0.7,
- description: "test agent",
- }),
- )
- },
- })
- })
- test("treats agent variant as model-scoped setting (not provider option)", async () => {
- await using tmp = await tmpdir({
- init: async (dir) => {
- await writeConfig(dir, {
- $schema: "https://opencode.ai/config.json",
- agent: {
- test_agent: {
- model: "openai/gpt-5.2",
- variant: "xhigh",
- max_tokens: 123,
- },
- },
- })
- },
- })
- await WithInstance.provide({
- directory: tmp.path,
- fn: async () => {
- const config = await load()
- const agent = config.agent?.["test_agent"]
- expect(agent?.variant).toBe("xhigh")
- expect(agent?.options).toMatchObject({
- max_tokens: 123,
- })
- expect(agent?.options).not.toHaveProperty("variant")
- },
- })
- })
- test("handles command configuration", async () => {
- await using tmp = await tmpdir({
- init: async (dir) => {
- await writeConfig(dir, {
- $schema: "https://opencode.ai/config.json",
- command: {
- test_command: {
- template: "test template",
- description: "test command",
- agent: "test_agent",
- },
- },
- })
- },
- })
- await WithInstance.provide({
- directory: tmp.path,
- fn: async () => {
- const config = await load()
- expect(config.command?.["test_command"]).toEqual({
- template: "test template",
- description: "test command",
- agent: "test_agent",
- })
- },
- })
- })
- test("migrates autoshare to share field", async () => {
- await using tmp = await tmpdir({
- init: async (dir) => {
- await Filesystem.write(
- path.join(dir, "opencode.json"),
- JSON.stringify({
- $schema: "https://opencode.ai/config.json",
- autoshare: true,
- }),
- )
- },
- })
- await WithInstance.provide({
- directory: tmp.path,
- fn: async () => {
- const config = await load()
- expect(config.share).toBe("auto")
- expect(config.autoshare).toBe(true)
- },
- })
- })
- test("migrates mode field to agent field", async () => {
- await using tmp = await tmpdir({
- init: async (dir) => {
- await Filesystem.write(
- path.join(dir, "opencode.json"),
- JSON.stringify({
- $schema: "https://opencode.ai/config.json",
- mode: {
- test_mode: {
- model: "test/model",
- temperature: 0.5,
- },
- },
- }),
- )
- },
- })
- await WithInstance.provide({
- directory: tmp.path,
- fn: async () => {
- const config = await load()
- expect(config.agent?.["test_mode"]).toEqual({
- model: "test/model",
- temperature: 0.5,
- mode: "primary",
- options: {},
- permission: {},
- })
- },
- })
- })
- test("loads config from .opencode directory", async () => {
- await using tmp = await tmpdir({
- init: async (dir) => {
- const opencodeDir = path.join(dir, ".opencode")
- await fs.mkdir(opencodeDir, { recursive: true })
- const agentDir = path.join(opencodeDir, "agent")
- await fs.mkdir(agentDir, { recursive: true })
- await Filesystem.write(
- path.join(agentDir, "test.md"),
- `---
- model: test/model
- ---
- Test agent prompt`,
- )
- },
- })
- await WithInstance.provide({
- directory: tmp.path,
- fn: async () => {
- const config = await load()
- expect(config.agent?.["test"]).toEqual(
- expect.objectContaining({
- name: "test",
- model: "test/model",
- prompt: "Test agent prompt",
- }),
- )
- },
- })
- })
- test("agent markdown permission config preserves user key order", async () => {
- await using tmp = await tmpdir({
- init: async (dir) => {
- const agentDir = path.join(dir, ".opencode", "agent")
- await fs.mkdir(agentDir, { recursive: true })
- await Filesystem.write(
- path.join(agentDir, "ordered.md"),
- `---
- permission:
- bash: allow
- "*": deny
- edit: ask
- ---
- Ordered permissions`,
- )
- },
- })
- await WithInstance.provide({
- directory: tmp.path,
- fn: async () => {
- const config = await load()
- expect(Object.keys(config.agent?.ordered?.permission ?? {})).toEqual(["bash", "*", "edit"])
- },
- })
- })
- test("loads agents from .opencode/agents (plural)", async () => {
- await using tmp = await tmpdir({
- init: async (dir) => {
- const opencodeDir = path.join(dir, ".opencode")
- await fs.mkdir(opencodeDir, { recursive: true })
- const agentsDir = path.join(opencodeDir, "agents")
- await fs.mkdir(path.join(agentsDir, "nested"), { recursive: true })
- await Filesystem.write(
- path.join(agentsDir, "helper.md"),
- `---
- model: test/model
- mode: subagent
- ---
- Helper agent prompt`,
- )
- await Filesystem.write(
- path.join(agentsDir, "nested", "child.md"),
- `---
- model: test/model
- mode: subagent
- ---
- Nested agent prompt`,
- )
- },
- })
- await WithInstance.provide({
- directory: tmp.path,
- fn: async () => {
- const config = await load()
- expect(config.agent?.["helper"]).toMatchObject({
- name: "helper",
- model: "test/model",
- mode: "subagent",
- prompt: "Helper agent prompt",
- })
- expect(config.agent?.["nested/child"]).toMatchObject({
- name: "nested/child",
- model: "test/model",
- mode: "subagent",
- prompt: "Nested agent prompt",
- })
- },
- })
- })
- test("loads commands from .opencode/command (singular)", async () => {
- await using tmp = await tmpdir({
- init: async (dir) => {
- const opencodeDir = path.join(dir, ".opencode")
- await fs.mkdir(opencodeDir, { recursive: true })
- const commandDir = path.join(opencodeDir, "command")
- await fs.mkdir(path.join(commandDir, "nested"), { recursive: true })
- await Filesystem.write(
- path.join(commandDir, "hello.md"),
- `---
- description: Test command
- ---
- Hello from singular command`,
- )
- await Filesystem.write(
- path.join(commandDir, "nested", "child.md"),
- `---
- description: Nested command
- ---
- Nested command template`,
- )
- },
- })
- await WithInstance.provide({
- directory: tmp.path,
- fn: async () => {
- const config = await load()
- expect(config.command?.["hello"]).toEqual({
- description: "Test command",
- template: "Hello from singular command",
- })
- expect(config.command?.["nested/child"]).toEqual({
- description: "Nested command",
- template: "Nested command template",
- })
- },
- })
- })
- test("loads commands from .opencode/commands (plural)", async () => {
- await using tmp = await tmpdir({
- init: async (dir) => {
- const opencodeDir = path.join(dir, ".opencode")
- await fs.mkdir(opencodeDir, { recursive: true })
- const commandsDir = path.join(opencodeDir, "commands")
- await fs.mkdir(path.join(commandsDir, "nested"), { recursive: true })
- await Filesystem.write(
- path.join(commandsDir, "hello.md"),
- `---
- description: Test command
- ---
- Hello from plural commands`,
- )
- await Filesystem.write(
- path.join(commandsDir, "nested", "child.md"),
- `---
- description: Nested command
- ---
- Nested command template`,
- )
- },
- })
- await WithInstance.provide({
- directory: tmp.path,
- fn: async () => {
- const config = await load()
- expect(config.command?.["hello"]).toEqual({
- description: "Test command",
- template: "Hello from plural commands",
- })
- expect(config.command?.["nested/child"]).toEqual({
- description: "Nested command",
- template: "Nested command template",
- })
- },
- })
- })
- test("updates config and writes to file", async () => {
- await using tmp = await tmpdir()
- await WithInstance.provide({
- directory: tmp.path,
- fn: async () => {
- const newConfig = { model: "updated/model" }
- await save(newConfig as any)
- const writtenConfig = await Filesystem.readJson<{ model: string }>(path.join(tmp.path, "config.json"))
- expect(writtenConfig.model).toBe("updated/model")
- },
- })
- })
- test("gets config directories", async () => {
- await using tmp = await tmpdir()
- await WithInstance.provide({
- directory: tmp.path,
- fn: async () => {
- const dirs = await listDirs()
- expect(dirs.length).toBeGreaterThanOrEqual(1)
- },
- })
- })
- test("does not try to install dependencies in read-only OPENCODE_CONFIG_DIR", async () => {
- if (process.platform === "win32") return
- await using tmp = await tmpdir<string>({
- init: async (dir) => {
- const ro = path.join(dir, "readonly")
- await fs.mkdir(ro, { recursive: true })
- await fs.chmod(ro, 0o555)
- return ro
- },
- dispose: async (dir) => {
- const ro = path.join(dir, "readonly")
- await fs.chmod(ro, 0o755).catch(() => {})
- return ro
- },
- })
- const prev = process.env.OPENCODE_CONFIG_DIR
- process.env.OPENCODE_CONFIG_DIR = tmp.extra
- try {
- await WithInstance.provide({
- directory: tmp.path,
- fn: async () => {
- await load()
- },
- })
- } finally {
- if (prev === undefined) delete process.env.OPENCODE_CONFIG_DIR
- else process.env.OPENCODE_CONFIG_DIR = prev
- }
- })
- test("installs dependencies in writable OPENCODE_CONFIG_DIR", async () => {
- await using tmp = await tmpdir<string>({
- init: async (dir) => {
- const cfg = path.join(dir, "configdir")
- await fs.mkdir(cfg, { recursive: true })
- return cfg
- },
- })
- const prev = process.env.OPENCODE_CONFIG_DIR
- process.env.OPENCODE_CONFIG_DIR = tmp.extra
- const testLayer = Config.layer.pipe(
- Layer.provide(testFlock),
- Layer.provide(AppFileSystem.defaultLayer),
- Layer.provide(Env.defaultLayer),
- Layer.provide(emptyAuth),
- Layer.provide(emptyAccount),
- Layer.provideMerge(infra),
- Layer.provide(noopNpm),
- )
- try {
- await WithInstance.provide({
- directory: tmp.path,
- fn: async () => {
- await Effect.runPromise(Config.Service.use((svc) => svc.get()).pipe(Effect.scoped, Effect.provide(testLayer)))
- await Effect.runPromise(
- Config.Service.use((svc) => svc.waitForDependencies()).pipe(Effect.scoped, Effect.provide(testLayer)),
- )
- },
- })
- // TODO: this is a hack to wait for backgruounded gitignore
- await new Promise((resolve) => setTimeout(resolve, 1000))
- expect(await Filesystem.exists(path.join(tmp.extra, ".gitignore"))).toBe(true)
- expect(await Filesystem.readText(path.join(tmp.extra, ".gitignore"))).toContain("package-lock.json")
- } finally {
- if (prev === undefined) delete process.env.OPENCODE_CONFIG_DIR
- else process.env.OPENCODE_CONFIG_DIR = prev
- }
- })
- // Note: deduplication and serialization of npm installs is now handled by the
- // core Npm.Service (via EffectFlock). Those behaviors are tested in the core
- // package's npm tests, not here.
- test("resolves scoped npm plugins in config", async () => {
- await using tmp = await tmpdir({
- init: async (dir) => {
- const pluginDir = path.join(dir, "node_modules", "@scope", "plugin")
- await fs.mkdir(pluginDir, { recursive: true })
- await Filesystem.write(
- path.join(dir, "package.json"),
- JSON.stringify({ name: "config-fixture", version: "1.0.0", type: "module" }, null, 2),
- )
- await Filesystem.write(
- path.join(pluginDir, "package.json"),
- JSON.stringify(
- {
- name: "@scope/plugin",
- version: "1.0.0",
- type: "module",
- main: "./index.js",
- },
- null,
- 2,
- ),
- )
- await Filesystem.write(path.join(pluginDir, "index.js"), "export default {}\n")
- await Filesystem.write(
- path.join(dir, "opencode.json"),
- JSON.stringify({ $schema: "https://opencode.ai/config.json", plugin: ["@scope/plugin"] }, null, 2),
- )
- },
- })
- await provideTestInstance({
- directory: tmp.path,
- fn: async () => {
- const config = await load()
- const pluginEntries = config.plugin ?? []
- expect(pluginEntries).toContain("@scope/plugin")
- },
- })
- })
- test("merges plugin arrays from global and local configs", async () => {
- await using tmp = await tmpdir({
- init: async (dir) => {
- // Create a nested project structure with local .opencode config
- const projectDir = path.join(dir, "project")
- const opencodeDir = path.join(projectDir, ".opencode")
- await fs.mkdir(opencodeDir, { recursive: true })
- // Global config with plugins
- await Filesystem.write(
- path.join(dir, "opencode.json"),
- JSON.stringify({
- $schema: "https://opencode.ai/config.json",
- plugin: ["global-plugin-1", "global-plugin-2"],
- }),
- )
- // Local .opencode config with different plugins
- await Filesystem.write(
- path.join(opencodeDir, "opencode.json"),
- JSON.stringify({
- $schema: "https://opencode.ai/config.json",
- plugin: ["local-plugin-1"],
- }),
- )
- },
- })
- await provideTestInstance({
- directory: path.join(tmp.path, "project"),
- fn: async () => {
- const config = await load()
- const plugins = config.plugin ?? []
- // Should contain both global and local plugins
- expect(plugins.some((p) => p.includes("global-plugin-1"))).toBe(true)
- expect(plugins.some((p) => p.includes("global-plugin-2"))).toBe(true)
- expect(plugins.some((p) => p.includes("local-plugin-1"))).toBe(true)
- // Should have all 3 plugins (not replaced, but merged)
- const pluginNames = plugins.filter((p) => p.includes("global-plugin") || p.includes("local-plugin"))
- expect(pluginNames.length).toBeGreaterThanOrEqual(3)
- },
- })
- })
- test("does not error when only custom agent is a subagent", async () => {
- await using tmp = await tmpdir({
- init: async (dir) => {
- const opencodeDir = path.join(dir, ".opencode")
- await fs.mkdir(opencodeDir, { recursive: true })
- const agentDir = path.join(opencodeDir, "agent")
- await fs.mkdir(agentDir, { recursive: true })
- await Filesystem.write(
- path.join(agentDir, "helper.md"),
- `---
- model: test/model
- mode: subagent
- ---
- Helper subagent prompt`,
- )
- },
- })
- await WithInstance.provide({
- directory: tmp.path,
- fn: async () => {
- const config = await load()
- expect(config.agent?.["helper"]).toMatchObject({
- name: "helper",
- model: "test/model",
- mode: "subagent",
- prompt: "Helper subagent prompt",
- })
- },
- })
- })
- test("merges instructions arrays from global and local configs", async () => {
- await using tmp = await tmpdir({
- init: async (dir) => {
- const projectDir = path.join(dir, "project")
- const opencodeDir = path.join(projectDir, ".opencode")
- await fs.mkdir(opencodeDir, { recursive: true })
- await Filesystem.write(
- path.join(dir, "opencode.json"),
- JSON.stringify({
- $schema: "https://opencode.ai/config.json",
- instructions: ["global-instructions.md", "shared-rules.md"],
- }),
- )
- await Filesystem.write(
- path.join(opencodeDir, "opencode.json"),
- JSON.stringify({
- $schema: "https://opencode.ai/config.json",
- instructions: ["local-instructions.md"],
- }),
- )
- },
- })
- await WithInstance.provide({
- directory: path.join(tmp.path, "project"),
- fn: async () => {
- const config = await load()
- const instructions = config.instructions ?? []
- expect(instructions).toContain("global-instructions.md")
- expect(instructions).toContain("shared-rules.md")
- expect(instructions).toContain("local-instructions.md")
- expect(instructions.length).toBe(3)
- },
- })
- })
- test("deduplicates duplicate instructions from global and local configs", async () => {
- await using tmp = await tmpdir({
- init: async (dir) => {
- const projectDir = path.join(dir, "project")
- const opencodeDir = path.join(projectDir, ".opencode")
- await fs.mkdir(opencodeDir, { recursive: true })
- await Filesystem.write(
- path.join(dir, "opencode.json"),
- JSON.stringify({
- $schema: "https://opencode.ai/config.json",
- instructions: ["duplicate.md", "global-only.md"],
- }),
- )
- await Filesystem.write(
- path.join(opencodeDir, "opencode.json"),
- JSON.stringify({
- $schema: "https://opencode.ai/config.json",
- instructions: ["duplicate.md", "local-only.md"],
- }),
- )
- },
- })
- await WithInstance.provide({
- directory: path.join(tmp.path, "project"),
- fn: async () => {
- const config = await load()
- const instructions = config.instructions ?? []
- expect(instructions).toContain("global-only.md")
- expect(instructions).toContain("local-only.md")
- expect(instructions).toContain("duplicate.md")
- const duplicates = instructions.filter((i) => i === "duplicate.md")
- expect(duplicates.length).toBe(1)
- expect(instructions.length).toBe(3)
- },
- })
- })
- test("deduplicates duplicate plugins from global and local configs", async () => {
- await using tmp = await tmpdir({
- init: async (dir) => {
- // Create a nested project structure with local .opencode config
- const projectDir = path.join(dir, "project")
- const opencodeDir = path.join(projectDir, ".opencode")
- await fs.mkdir(opencodeDir, { recursive: true })
- // Global config with plugins
- await Filesystem.write(
- path.join(dir, "opencode.json"),
- JSON.stringify({
- $schema: "https://opencode.ai/config.json",
- plugin: ["duplicate-plugin", "global-plugin-1"],
- }),
- )
- // Local .opencode config with some overlapping plugins
- await Filesystem.write(
- path.join(opencodeDir, "opencode.json"),
- JSON.stringify({
- $schema: "https://opencode.ai/config.json",
- plugin: ["duplicate-plugin", "local-plugin-1"],
- }),
- )
- },
- })
- await provideTestInstance({
- directory: path.join(tmp.path, "project"),
- fn: async () => {
- const config = await load()
- const plugins = config.plugin ?? []
- // Should contain all unique plugins
- expect(plugins.some((p) => p.includes("global-plugin-1"))).toBe(true)
- expect(plugins.some((p) => p.includes("local-plugin-1"))).toBe(true)
- expect(plugins.some((p) => p.includes("duplicate-plugin"))).toBe(true)
- // Should deduplicate the duplicate plugin
- const duplicatePlugins = plugins.filter((p) => p.includes("duplicate-plugin"))
- expect(duplicatePlugins.length).toBe(1)
- // Should have exactly 3 unique plugins
- const pluginNames = plugins.filter(
- (p) => p.includes("global-plugin") || p.includes("local-plugin") || p.includes("duplicate-plugin"),
- )
- expect(pluginNames.length).toBe(3)
- },
- })
- })
- test("keeps plugin origins aligned with merged plugin list", async () => {
- await using tmp = await tmpdir({
- init: async (dir) => {
- const project = path.join(dir, "project")
- const local = path.join(project, ".opencode")
- await fs.mkdir(local, { recursive: true })
- await Filesystem.write(
- path.join(dir, "opencode.json"),
- JSON.stringify({
- $schema: "https://opencode.ai/config.json",
- plugin: [["shared-plugin@1.0.0", { source: "global" }], "global-only@1.0.0"],
- }),
- )
- await Filesystem.write(
- path.join(local, "opencode.json"),
- JSON.stringify({
- $schema: "https://opencode.ai/config.json",
- plugin: [["shared-plugin@2.0.0", { source: "local" }], "local-only@1.0.0"],
- }),
- )
- },
- })
- await provideTestInstance({
- directory: path.join(tmp.path, "project"),
- fn: async () => {
- const cfg = await load()
- const plugins = cfg.plugin ?? []
- const origins = cfg.plugin_origins ?? []
- const names = plugins.map((item) => ConfigPlugin.pluginSpecifier(item))
- expect(names).toContain("shared-plugin@2.0.0")
- expect(names).not.toContain("shared-plugin@1.0.0")
- expect(names).toContain("global-only@1.0.0")
- expect(names).toContain("local-only@1.0.0")
- expect(origins.map((item) => item.spec)).toEqual(plugins)
- const hit = origins.find((item) => ConfigPlugin.pluginSpecifier(item.spec) === "shared-plugin@2.0.0")
- expect(hit?.scope).toBe("local")
- },
- })
- })
- // Legacy tools migration tests
- test("migrates legacy tools config to permissions - allow", async () => {
- await using tmp = await tmpdir({
- init: async (dir) => {
- await Filesystem.write(
- path.join(dir, "opencode.json"),
- JSON.stringify({
- $schema: "https://opencode.ai/config.json",
- agent: {
- test: {
- tools: {
- bash: true,
- read: true,
- },
- },
- },
- }),
- )
- },
- })
- await WithInstance.provide({
- directory: tmp.path,
- fn: async () => {
- const config = await load()
- expect(config.agent?.["test"]?.permission).toEqual({
- bash: "allow",
- read: "allow",
- })
- },
- })
- })
- test("migrates legacy tools config to permissions - deny", async () => {
- await using tmp = await tmpdir({
- init: async (dir) => {
- await Filesystem.write(
- path.join(dir, "opencode.json"),
- JSON.stringify({
- $schema: "https://opencode.ai/config.json",
- agent: {
- test: {
- tools: {
- bash: false,
- webfetch: false,
- },
- },
- },
- }),
- )
- },
- })
- await WithInstance.provide({
- directory: tmp.path,
- fn: async () => {
- const config = await load()
- expect(config.agent?.["test"]?.permission).toEqual({
- bash: "deny",
- webfetch: "deny",
- })
- },
- })
- })
- test("migrates legacy write tool to edit permission", async () => {
- await using tmp = await tmpdir({
- init: async (dir) => {
- await Filesystem.write(
- path.join(dir, "opencode.json"),
- JSON.stringify({
- $schema: "https://opencode.ai/config.json",
- agent: {
- test: {
- tools: {
- write: true,
- },
- },
- },
- }),
- )
- },
- })
- await WithInstance.provide({
- directory: tmp.path,
- fn: async () => {
- const config = await load()
- expect(config.agent?.["test"]?.permission).toEqual({
- edit: "allow",
- })
- },
- })
- })
- // Managed settings tests
- // Note: preload.ts sets OPENCODE_TEST_MANAGED_CONFIG which Global.Path.managedConfig uses
- test("managed settings override user settings", async () => {
- await using tmp = await tmpdir({
- init: async (dir) => {
- await writeConfig(dir, {
- $schema: "https://opencode.ai/config.json",
- model: "user/model",
- share: "auto",
- username: "testuser",
- })
- },
- })
- await writeManagedSettings({
- $schema: "https://opencode.ai/config.json",
- model: "managed/model",
- share: "disabled",
- })
- await WithInstance.provide({
- directory: tmp.path,
- fn: async () => {
- const config = await load()
- expect(config.model).toBe("managed/model")
- expect(config.share).toBe("disabled")
- expect(config.username).toBe("testuser")
- },
- })
- })
- test("managed settings override project settings", async () => {
- await using tmp = await tmpdir({
- init: async (dir) => {
- await writeConfig(dir, {
- $schema: "https://opencode.ai/config.json",
- autoupdate: true,
- disabled_providers: [],
- })
- },
- })
- await writeManagedSettings({
- $schema: "https://opencode.ai/config.json",
- autoupdate: false,
- disabled_providers: ["openai"],
- })
- await WithInstance.provide({
- directory: tmp.path,
- fn: async () => {
- const config = await load()
- expect(config.autoupdate).toBe(false)
- expect(config.disabled_providers).toEqual(["openai"])
- },
- })
- })
- test("missing managed settings file is not an error", async () => {
- await using tmp = await tmpdir({
- init: async (dir) => {
- await writeConfig(dir, {
- $schema: "https://opencode.ai/config.json",
- model: "user/model",
- })
- },
- })
- await WithInstance.provide({
- directory: tmp.path,
- fn: async () => {
- const config = await load()
- expect(config.model).toBe("user/model")
- },
- })
- })
- test("migrates legacy edit tool to edit permission", async () => {
- await using tmp = await tmpdir({
- init: async (dir) => {
- await Filesystem.write(
- path.join(dir, "opencode.json"),
- JSON.stringify({
- $schema: "https://opencode.ai/config.json",
- agent: {
- test: {
- tools: {
- edit: false,
- },
- },
- },
- }),
- )
- },
- })
- await WithInstance.provide({
- directory: tmp.path,
- fn: async () => {
- const config = await load()
- expect(config.agent?.["test"]?.permission).toEqual({
- edit: "deny",
- })
- },
- })
- })
- test("migrates legacy patch tool to edit permission", async () => {
- await using tmp = await tmpdir({
- init: async (dir) => {
- await Filesystem.write(
- path.join(dir, "opencode.json"),
- JSON.stringify({
- $schema: "https://opencode.ai/config.json",
- agent: {
- test: {
- tools: {
- patch: true,
- },
- },
- },
- }),
- )
- },
- })
- await WithInstance.provide({
- directory: tmp.path,
- fn: async () => {
- const config = await load()
- expect(config.agent?.["test"]?.permission).toEqual({
- edit: "allow",
- })
- },
- })
- })
- test("migrates mixed legacy tools config", async () => {
- await using tmp = await tmpdir({
- init: async (dir) => {
- await Filesystem.write(
- path.join(dir, "opencode.json"),
- JSON.stringify({
- $schema: "https://opencode.ai/config.json",
- agent: {
- test: {
- tools: {
- bash: true,
- write: true,
- read: false,
- webfetch: true,
- },
- },
- },
- }),
- )
- },
- })
- await WithInstance.provide({
- directory: tmp.path,
- fn: async () => {
- const config = await load()
- expect(config.agent?.["test"]?.permission).toEqual({
- bash: "allow",
- edit: "allow",
- read: "deny",
- webfetch: "allow",
- })
- },
- })
- })
- test("merges legacy tools with existing permission config", async () => {
- await using tmp = await tmpdir({
- init: async (dir) => {
- await Filesystem.write(
- path.join(dir, "opencode.json"),
- JSON.stringify({
- $schema: "https://opencode.ai/config.json",
- agent: {
- test: {
- permission: {
- glob: "allow",
- },
- tools: {
- bash: true,
- },
- },
- },
- }),
- )
- },
- })
- await WithInstance.provide({
- directory: tmp.path,
- fn: async () => {
- const config = await load()
- expect(config.agent?.["test"]?.permission).toEqual({
- glob: "allow",
- bash: "allow",
- })
- },
- })
- })
- test("permission config preserves user key order", async () => {
- // Permission precedence follows the order users write in config, so parsing
- // must not canonicalise known keys ahead of wildcard or custom keys.
- await using tmp = await tmpdir({
- init: async (dir) => {
- await Filesystem.write(
- path.join(dir, "opencode.json"),
- JSON.stringify({
- $schema: "https://opencode.ai/config.json",
- permission: {
- "*": "deny",
- edit: "ask",
- write: "ask",
- external_directory: "ask",
- read: "allow",
- todowrite: "allow",
- "thoughts_*": "allow",
- "reasoning_model_*": "allow",
- "tools_*": "allow",
- "pr_comments_*": "allow",
- },
- }),
- )
- },
- })
- await WithInstance.provide({
- directory: tmp.path,
- fn: async () => {
- const config = await load()
- expect(Object.keys(config.permission!)).toEqual([
- "*",
- "edit",
- "write",
- "external_directory",
- "read",
- "todowrite",
- "thoughts_*",
- "reasoning_model_*",
- "tools_*",
- "pr_comments_*",
- ])
- },
- })
- })
- test("Effect config parser preserves permission order while rejecting unknown top-level keys", () => {
- const config = ConfigParse.effectSchema(
- Config.Info,
- {
- permission: {
- bash: "allow",
- "*": "deny",
- edit: "ask",
- },
- },
- "test",
- )
- expect(Object.keys(config.permission!)).toEqual(["bash", "*", "edit"])
- try {
- ConfigParse.effectSchema(Config.Info, { invalid_field: true }, "test")
- throw new Error("expected config parse to fail")
- } catch (err) {
- const error = err as { data?: { issues?: Array<{ code?: string; keys?: string[]; path?: string[] }> } }
- expect(error.data?.issues?.[0]).toMatchObject({ code: "unrecognized_keys", keys: ["invalid_field"], path: [] })
- }
- })
- // MCP config merging tests
- test("project config can override MCP server enabled status", async () => {
- await using tmp = await tmpdir({
- init: async (dir) => {
- // Simulates a base config (like from remote .well-known) with disabled MCP
- await Filesystem.write(
- path.join(dir, "opencode.json"),
- JSON.stringify({
- $schema: "https://opencode.ai/config.json",
- mcp: {
- jira: {
- type: "remote",
- url: "https://jira.example.com/mcp",
- enabled: false,
- },
- wiki: {
- type: "remote",
- url: "https://wiki.example.com/mcp",
- enabled: false,
- },
- },
- }),
- )
- // Project config enables just jira
- await Filesystem.write(
- path.join(dir, "opencode.jsonc"),
- JSON.stringify({
- $schema: "https://opencode.ai/config.json",
- mcp: {
- jira: {
- type: "remote",
- url: "https://jira.example.com/mcp",
- enabled: true,
- },
- },
- }),
- )
- },
- })
- await WithInstance.provide({
- directory: tmp.path,
- fn: async () => {
- const config = await load()
- // jira should be enabled (overridden by project config)
- expect(config.mcp?.jira).toEqual({
- type: "remote",
- url: "https://jira.example.com/mcp",
- enabled: true,
- })
- // wiki should still be disabled (not overridden)
- expect(config.mcp?.wiki).toEqual({
- type: "remote",
- url: "https://wiki.example.com/mcp",
- enabled: false,
- })
- },
- })
- })
- test("MCP config deep merges preserving base config properties", async () => {
- await using tmp = await tmpdir({
- init: async (dir) => {
- // Base config with full MCP definition
- await Filesystem.write(
- path.join(dir, "opencode.json"),
- JSON.stringify({
- $schema: "https://opencode.ai/config.json",
- mcp: {
- myserver: {
- type: "remote",
- url: "https://myserver.example.com/mcp",
- enabled: false,
- headers: {
- "X-Custom-Header": "value",
- },
- },
- },
- }),
- )
- // Override just enables it, should preserve other properties
- await Filesystem.write(
- path.join(dir, "opencode.jsonc"),
- JSON.stringify({
- $schema: "https://opencode.ai/config.json",
- mcp: {
- myserver: {
- type: "remote",
- url: "https://myserver.example.com/mcp",
- enabled: true,
- },
- },
- }),
- )
- },
- })
- await WithInstance.provide({
- directory: tmp.path,
- fn: async () => {
- const config = await load()
- expect(config.mcp?.myserver).toEqual({
- type: "remote",
- url: "https://myserver.example.com/mcp",
- enabled: true,
- headers: {
- "X-Custom-Header": "value",
- },
- })
- },
- })
- })
- test("local .opencode config can override MCP from project config", async () => {
- await using tmp = await tmpdir({
- init: async (dir) => {
- // Project config with disabled MCP
- await Filesystem.write(
- path.join(dir, "opencode.json"),
- JSON.stringify({
- $schema: "https://opencode.ai/config.json",
- mcp: {
- docs: {
- type: "remote",
- url: "https://docs.example.com/mcp",
- enabled: false,
- },
- },
- }),
- )
- // Local .opencode directory config enables it
- const opencodeDir = path.join(dir, ".opencode")
- await fs.mkdir(opencodeDir, { recursive: true })
- await Filesystem.write(
- path.join(opencodeDir, "opencode.json"),
- JSON.stringify({
- $schema: "https://opencode.ai/config.json",
- mcp: {
- docs: {
- type: "remote",
- url: "https://docs.example.com/mcp",
- enabled: true,
- },
- },
- }),
- )
- },
- })
- await WithInstance.provide({
- directory: tmp.path,
- fn: async () => {
- const config = await load()
- expect(config.mcp?.docs?.enabled).toBe(true)
- },
- })
- })
- test("project config overrides remote well-known config", async () => {
- const originalFetch = globalThis.fetch
- let fetchedUrl: string | undefined
- globalThis.fetch = mock((url: string | URL | Request) => {
- const urlStr = url instanceof Request ? url.url : url instanceof URL ? url.href : url
- if (urlStr.includes(".well-known/opencode")) {
- fetchedUrl = urlStr
- return Promise.resolve(
- new Response(
- JSON.stringify({
- config: {
- mcp: { jira: { type: "remote", url: "https://jira.example.com/mcp", enabled: false } },
- },
- }),
- { status: 200 },
- ),
- )
- }
- return originalFetch(url)
- }) as unknown as typeof fetch
- const fakeAuth = Layer.mock(Auth.Service)({
- all: () =>
- Effect.succeed({
- "https://example.com": new Auth.WellKnown({ type: "wellknown", key: "TEST_TOKEN", token: "test-token" }),
- }),
- })
- const layer = Config.layer.pipe(
- Layer.provide(testFlock),
- Layer.provide(AppFileSystem.defaultLayer),
- Layer.provide(Env.defaultLayer),
- Layer.provide(fakeAuth),
- Layer.provide(emptyAccount),
- Layer.provideMerge(infra),
- Layer.provide(noopNpm),
- )
- try {
- await provideTmpdirInstance(
- () =>
- Config.Service.use((svc) =>
- Effect.gen(function* () {
- const config = yield* svc.get()
- expect(fetchedUrl).toBe("https://example.com/.well-known/opencode")
- expect(config.mcp?.jira?.enabled).toBe(true)
- }),
- ),
- {
- git: true,
- config: { mcp: { jira: { type: "remote", url: "https://jira.example.com/mcp", enabled: true } } },
- },
- ).pipe(Effect.scoped, Effect.provide(layer), Effect.runPromise)
- } finally {
- globalThis.fetch = originalFetch
- }
- })
- test("wellknown URL with trailing slash is normalized", async () => {
- const originalFetch = globalThis.fetch
- let fetchedUrl: string | undefined
- globalThis.fetch = mock((url: string | URL | Request) => {
- const urlStr = url instanceof Request ? url.url : url instanceof URL ? url.href : url
- if (urlStr.includes(".well-known/opencode")) {
- fetchedUrl = urlStr
- return Promise.resolve(
- new Response(
- JSON.stringify({
- config: {
- mcp: { slack: { type: "remote", url: "https://slack.example.com/mcp", enabled: true } },
- },
- }),
- { status: 200 },
- ),
- )
- }
- return originalFetch(url)
- }) as unknown as typeof fetch
- const fakeAuth = Layer.mock(Auth.Service)({
- all: () =>
- Effect.succeed({
- "https://example.com/": new Auth.WellKnown({ type: "wellknown", key: "TEST_TOKEN", token: "test-token" }),
- }),
- })
- const layer = Config.layer.pipe(
- Layer.provide(testFlock),
- Layer.provide(AppFileSystem.defaultLayer),
- Layer.provide(Env.defaultLayer),
- Layer.provide(fakeAuth),
- Layer.provide(emptyAccount),
- Layer.provideMerge(infra),
- Layer.provide(noopNpm),
- )
- try {
- await provideTmpdirInstance(
- () =>
- Config.Service.use((svc) =>
- Effect.gen(function* () {
- yield* svc.get()
- expect(fetchedUrl).toBe("https://example.com/.well-known/opencode")
- }),
- ),
- { git: true },
- ).pipe(Effect.scoped, Effect.provide(layer), Effect.runPromise)
- } finally {
- globalThis.fetch = originalFetch
- }
- })
- test("wellknown remote_config supports templated env vars in headers", async () => {
- const originalFetch = globalThis.fetch
- const originalToken = process.env.TEST_TOKEN
- let wellknownFetchedUrl: string | undefined
- let remoteFetchedUrl: string | undefined
- let remoteHeaders: HeadersInit | undefined
- globalThis.fetch = mock((url: string | URL | Request, init?: RequestInit) => {
- const urlStr = url instanceof Request ? url.url : url instanceof URL ? url.href : url
- if (urlStr.includes(".well-known/opencode")) {
- wellknownFetchedUrl = urlStr
- return Promise.resolve(
- new Response(
- JSON.stringify({
- remote_config: {
- url: "https://config.example.com/opencode.json",
- headers: {
- Authorization: "Bearer {env:TEST_TOKEN}",
- },
- },
- }),
- { status: 200 },
- ),
- )
- }
- if (urlStr.includes("config.example.com")) {
- remoteFetchedUrl = urlStr
- remoteHeaders = init?.headers
- return Promise.resolve(
- new Response(
- JSON.stringify({
- mcp: { confluence: { type: "remote", url: "https://confluence.example.com/mcp", enabled: true } },
- }),
- { status: 200 },
- ),
- )
- }
- return originalFetch(url, init)
- }) as unknown as typeof fetch
- const fakeAuth = Layer.mock(Auth.Service)({
- all: () =>
- Effect.succeed({
- "https://example.com": new Auth.WellKnown({ type: "wellknown", key: "TEST_TOKEN", token: "test-token" }),
- }),
- })
- const layer = Config.layer.pipe(
- Layer.provide(testFlock),
- Layer.provide(AppFileSystem.defaultLayer),
- Layer.provide(Env.defaultLayer),
- Layer.provide(fakeAuth),
- Layer.provide(emptyAccount),
- Layer.provideMerge(infra),
- Layer.provide(noopNpm),
- )
- try {
- await provideTmpdirInstance(
- () =>
- Config.Service.use((svc) =>
- Effect.gen(function* () {
- const config = yield* svc.get()
- expect(wellknownFetchedUrl).toBe("https://example.com/.well-known/opencode")
- expect(remoteFetchedUrl).toBe("https://config.example.com/opencode.json")
- expect(remoteHeaders).toEqual({ Authorization: "Bearer test-token" })
- expect(config.mcp?.confluence?.enabled).toBe(true)
- }),
- ),
- { git: true },
- ).pipe(Effect.scoped, Effect.provide(layer), Effect.runPromise)
- } finally {
- globalThis.fetch = originalFetch
- if (originalToken === undefined) delete process.env.TEST_TOKEN
- else process.env.TEST_TOKEN = originalToken
- }
- })
- describe("resolvePluginSpec", () => {
- test("keeps package specs unchanged", async () => {
- await using tmp = await tmpdir()
- const file = path.join(tmp.path, "opencode.json")
- expect(await ConfigPlugin.resolvePluginSpec("oh-my-opencode@2.4.3", file)).toBe("oh-my-opencode@2.4.3")
- expect(await ConfigPlugin.resolvePluginSpec("@scope/pkg", file)).toBe("@scope/pkg")
- })
- test("resolves windows-style relative plugin directory specs", async () => {
- if (process.platform !== "win32") return
- await using tmp = await tmpdir({
- init: async (dir) => {
- const plugin = path.join(dir, "plugin")
- await fs.mkdir(plugin, { recursive: true })
- await Filesystem.write(path.join(plugin, "index.ts"), "export default {}")
- },
- })
- const file = path.join(tmp.path, "opencode.json")
- const hit = await ConfigPlugin.resolvePluginSpec(".\\plugin", file)
- expect(ConfigPlugin.pluginSpecifier(hit)).toBe(pathToFileURL(path.join(tmp.path, "plugin", "index.ts")).href)
- })
- test("resolves relative file plugin paths to file urls", async () => {
- await using tmp = await tmpdir({
- init: async (dir) => {
- await Filesystem.write(path.join(dir, "plugin.ts"), "export default {}")
- },
- })
- const file = path.join(tmp.path, "opencode.json")
- const hit = await ConfigPlugin.resolvePluginSpec("./plugin.ts", file)
- expect(ConfigPlugin.pluginSpecifier(hit)).toBe(pathToFileURL(path.join(tmp.path, "plugin.ts")).href)
- })
- test("resolves plugin directory paths to directory urls", async () => {
- await using tmp = await tmpdir({
- init: async (dir) => {
- const plugin = path.join(dir, "plugin")
- await fs.mkdir(plugin, { recursive: true })
- await Filesystem.writeJson(path.join(plugin, "package.json"), {
- name: "demo-plugin",
- type: "module",
- main: "./index.ts",
- })
- await Filesystem.write(path.join(plugin, "index.ts"), "export default {}")
- },
- })
- const file = path.join(tmp.path, "opencode.json")
- const hit = await ConfigPlugin.resolvePluginSpec("./plugin", file)
- expect(ConfigPlugin.pluginSpecifier(hit)).toBe(pathToFileURL(path.join(tmp.path, "plugin")).href)
- })
- test("resolves plugin directories without package.json to index.ts", async () => {
- await using tmp = await tmpdir({
- init: async (dir) => {
- const plugin = path.join(dir, "plugin")
- await fs.mkdir(plugin, { recursive: true })
- await Filesystem.write(path.join(plugin, "index.ts"), "export default {}")
- },
- })
- const file = path.join(tmp.path, "opencode.json")
- const hit = await ConfigPlugin.resolvePluginSpec("./plugin", file)
- expect(ConfigPlugin.pluginSpecifier(hit)).toBe(pathToFileURL(path.join(tmp.path, "plugin", "index.ts")).href)
- })
- })
- describe("deduplicatePluginOrigins", () => {
- const dedupe = (plugins: ConfigPlugin.Spec[]) =>
- ConfigPlugin.deduplicatePluginOrigins(
- plugins.map((spec) => ({
- spec,
- source: "",
- scope: "global" as const,
- })),
- ).map((item) => item.spec)
- test("removes duplicates keeping higher priority (later entries)", () => {
- const plugins = ["global-plugin@1.0.0", "shared-plugin@1.0.0", "local-plugin@2.0.0", "shared-plugin@2.0.0"]
- const result = dedupe(plugins)
- expect(result).toContain("global-plugin@1.0.0")
- expect(result).toContain("local-plugin@2.0.0")
- expect(result).toContain("shared-plugin@2.0.0")
- expect(result).not.toContain("shared-plugin@1.0.0")
- expect(result.length).toBe(3)
- })
- test("keeps path plugins separate from package plugins", () => {
- const plugins = ["oh-my-opencode@2.4.3", "file:///project/.opencode/plugin/oh-my-opencode.js"]
- const result = dedupe(plugins)
- expect(result).toEqual(plugins)
- })
- test("deduplicates direct path plugins by exact spec", () => {
- const plugins = ["file:///project/.opencode/plugin/demo.ts", "file:///project/.opencode/plugin/demo.ts"]
- const result = dedupe(plugins)
- expect(result).toEqual(["file:///project/.opencode/plugin/demo.ts"])
- })
- test("preserves order of remaining plugins", () => {
- const plugins = ["a-plugin@1.0.0", "b-plugin@1.0.0", "c-plugin@1.0.0"]
- const result = dedupe(plugins)
- expect(result).toEqual(["a-plugin@1.0.0", "b-plugin@1.0.0", "c-plugin@1.0.0"])
- })
- test("loads auto-discovered local plugins as file urls", async () => {
- await using tmp = await tmpdir({
- init: async (dir) => {
- const projectDir = path.join(dir, "project")
- const opencodeDir = path.join(projectDir, ".opencode")
- const pluginDir = path.join(opencodeDir, "plugin")
- await fs.mkdir(pluginDir, { recursive: true })
- await Filesystem.write(
- path.join(dir, "opencode.json"),
- JSON.stringify({
- $schema: "https://opencode.ai/config.json",
- plugin: ["my-plugin@1.0.0"],
- }),
- )
- await Filesystem.write(path.join(pluginDir, "my-plugin.js"), "export default {}")
- },
- })
- await provideTestInstance({
- directory: path.join(tmp.path, "project"),
- fn: async () => {
- const config = await load()
- const plugins = config.plugin ?? []
- expect(plugins.some((p) => ConfigPlugin.pluginSpecifier(p) === "my-plugin@1.0.0")).toBe(true)
- expect(plugins.some((p) => ConfigPlugin.pluginSpecifier(p).startsWith("file://"))).toBe(true)
- },
- })
- })
- })
- describe("OPENCODE_DISABLE_PROJECT_CONFIG", () => {
- test("skips project config files when flag is set", async () => {
- const originalEnv = process.env["OPENCODE_DISABLE_PROJECT_CONFIG"]
- process.env["OPENCODE_DISABLE_PROJECT_CONFIG"] = "true"
- try {
- await using tmp = await tmpdir({
- init: async (dir) => {
- // Create a project config that would normally be loaded
- await Filesystem.write(
- path.join(dir, "opencode.json"),
- JSON.stringify({
- $schema: "https://opencode.ai/config.json",
- model: "project/model",
- username: "project-user",
- }),
- )
- },
- })
- await WithInstance.provide({
- directory: tmp.path,
- fn: async () => {
- const config = await load()
- // Project config should NOT be loaded - model should be default, not "project/model"
- expect(config.model).not.toBe("project/model")
- expect(config.username).not.toBe("project-user")
- },
- })
- } finally {
- if (originalEnv === undefined) {
- delete process.env["OPENCODE_DISABLE_PROJECT_CONFIG"]
- } else {
- process.env["OPENCODE_DISABLE_PROJECT_CONFIG"] = originalEnv
- }
- }
- })
- test("skips project .opencode/ directories when flag is set", async () => {
- const originalEnv = process.env["OPENCODE_DISABLE_PROJECT_CONFIG"]
- process.env["OPENCODE_DISABLE_PROJECT_CONFIG"] = "true"
- try {
- await using tmp = await tmpdir({
- init: async (dir) => {
- // Create a .opencode directory with a command
- const opencodeDir = path.join(dir, ".opencode", "command")
- await fs.mkdir(opencodeDir, { recursive: true })
- await Filesystem.write(path.join(opencodeDir, "test-cmd.md"), "# Test Command\nThis is a test command.")
- },
- })
- await WithInstance.provide({
- directory: tmp.path,
- fn: async () => {
- const directories = await listDirs()
- // Project .opencode should NOT be in directories list
- const hasProjectOpencode = directories.some((d) => d.startsWith(tmp.path))
- expect(hasProjectOpencode).toBe(false)
- },
- })
- } finally {
- if (originalEnv === undefined) {
- delete process.env["OPENCODE_DISABLE_PROJECT_CONFIG"]
- } else {
- process.env["OPENCODE_DISABLE_PROJECT_CONFIG"] = originalEnv
- }
- }
- })
- test("still loads global config when flag is set", async () => {
- const originalEnv = process.env["OPENCODE_DISABLE_PROJECT_CONFIG"]
- process.env["OPENCODE_DISABLE_PROJECT_CONFIG"] = "true"
- try {
- await using tmp = await tmpdir()
- await WithInstance.provide({
- directory: tmp.path,
- fn: async () => {
- // Should still get default config (from global or defaults)
- const config = await load()
- expect(config).toBeDefined()
- expect(config.username).toBeDefined()
- },
- })
- } finally {
- if (originalEnv === undefined) {
- delete process.env["OPENCODE_DISABLE_PROJECT_CONFIG"]
- } else {
- process.env["OPENCODE_DISABLE_PROJECT_CONFIG"] = originalEnv
- }
- }
- })
- test("skips relative instructions with warning when flag is set but no config dir", async () => {
- const originalDisable = process.env["OPENCODE_DISABLE_PROJECT_CONFIG"]
- const originalConfigDir = process.env["OPENCODE_CONFIG_DIR"]
- try {
- // Ensure no config dir is set
- delete process.env["OPENCODE_CONFIG_DIR"]
- process.env["OPENCODE_DISABLE_PROJECT_CONFIG"] = "true"
- await using tmp = await tmpdir({
- init: async (dir) => {
- // Create a config with relative instruction path
- await Filesystem.write(
- path.join(dir, "opencode.json"),
- JSON.stringify({
- $schema: "https://opencode.ai/config.json",
- instructions: ["./CUSTOM.md"],
- }),
- )
- // Create the instruction file (should be skipped)
- await Filesystem.write(path.join(dir, "CUSTOM.md"), "# Custom Instructions")
- },
- })
- await WithInstance.provide({
- directory: tmp.path,
- fn: async () => {
- // The relative instruction should be skipped without error
- // We're mainly verifying this doesn't throw and the config loads
- const config = await load()
- expect(config).toBeDefined()
- // The instruction should have been skipped (warning logged)
- // We can't easily test the warning was logged, but we verify
- // the relative path didn't cause an error
- },
- })
- } finally {
- if (originalDisable === undefined) {
- delete process.env["OPENCODE_DISABLE_PROJECT_CONFIG"]
- } else {
- process.env["OPENCODE_DISABLE_PROJECT_CONFIG"] = originalDisable
- }
- if (originalConfigDir === undefined) {
- delete process.env["OPENCODE_CONFIG_DIR"]
- } else {
- process.env["OPENCODE_CONFIG_DIR"] = originalConfigDir
- }
- }
- })
- test("OPENCODE_CONFIG_DIR still works when flag is set", async () => {
- const originalDisable = process.env["OPENCODE_DISABLE_PROJECT_CONFIG"]
- const originalConfigDir = process.env["OPENCODE_CONFIG_DIR"]
- try {
- await using configDirTmp = await tmpdir({
- init: async (dir) => {
- // Create config in the custom config dir
- await Filesystem.write(
- path.join(dir, "opencode.json"),
- JSON.stringify({
- $schema: "https://opencode.ai/config.json",
- model: "configdir/model",
- }),
- )
- },
- })
- await using projectTmp = await tmpdir({
- init: async (dir) => {
- // Create config in project (should be ignored)
- await Filesystem.write(
- path.join(dir, "opencode.json"),
- JSON.stringify({
- $schema: "https://opencode.ai/config.json",
- model: "project/model",
- }),
- )
- },
- })
- process.env["OPENCODE_DISABLE_PROJECT_CONFIG"] = "true"
- process.env["OPENCODE_CONFIG_DIR"] = configDirTmp.path
- await WithInstance.provide({
- directory: projectTmp.path,
- fn: async () => {
- const config = await load()
- // Should load from OPENCODE_CONFIG_DIR, not project
- expect(config.model).toBe("configdir/model")
- },
- })
- } finally {
- if (originalDisable === undefined) {
- delete process.env["OPENCODE_DISABLE_PROJECT_CONFIG"]
- } else {
- process.env["OPENCODE_DISABLE_PROJECT_CONFIG"] = originalDisable
- }
- if (originalConfigDir === undefined) {
- delete process.env["OPENCODE_CONFIG_DIR"]
- } else {
- process.env["OPENCODE_CONFIG_DIR"] = originalConfigDir
- }
- }
- })
- })
- describe("OPENCODE_CONFIG_CONTENT token substitution", () => {
- test("substitutes {env:} tokens in OPENCODE_CONFIG_CONTENT", async () => {
- const originalEnv = process.env["OPENCODE_CONFIG_CONTENT"]
- const originalTestVar = process.env["TEST_CONFIG_VAR"]
- process.env["TEST_CONFIG_VAR"] = "test_api_key_12345"
- process.env["OPENCODE_CONFIG_CONTENT"] = JSON.stringify({
- $schema: "https://opencode.ai/config.json",
- username: "{env:TEST_CONFIG_VAR}",
- })
- try {
- await using tmp = await tmpdir()
- await WithInstance.provide({
- directory: tmp.path,
- fn: async () => {
- const config = await load()
- expect(config.username).toBe("test_api_key_12345")
- },
- })
- } finally {
- if (originalEnv !== undefined) {
- process.env["OPENCODE_CONFIG_CONTENT"] = originalEnv
- } else {
- delete process.env["OPENCODE_CONFIG_CONTENT"]
- }
- if (originalTestVar !== undefined) {
- process.env["TEST_CONFIG_VAR"] = originalTestVar
- } else {
- delete process.env["TEST_CONFIG_VAR"]
- }
- }
- })
- test("substitutes {file:} tokens in OPENCODE_CONFIG_CONTENT", async () => {
- const originalEnv = process.env["OPENCODE_CONFIG_CONTENT"]
- try {
- await using tmp = await tmpdir({
- init: async (dir) => {
- await Filesystem.write(path.join(dir, "api_key.txt"), "secret_key_from_file")
- process.env["OPENCODE_CONFIG_CONTENT"] = JSON.stringify({
- $schema: "https://opencode.ai/config.json",
- username: "{file:./api_key.txt}",
- })
- },
- })
- await WithInstance.provide({
- directory: tmp.path,
- fn: async () => {
- const config = await load()
- expect(config.username).toBe("secret_key_from_file")
- },
- })
- } finally {
- if (originalEnv !== undefined) {
- process.env["OPENCODE_CONFIG_CONTENT"] = originalEnv
- } else {
- delete process.env["OPENCODE_CONFIG_CONTENT"]
- }
- }
- })
- })
- // parseManagedPlist unit tests — pure function, no OS interaction
- test("parseManagedPlist strips MDM metadata keys", async () => {
- const config = ConfigParse.effectSchema(
- Config.Info,
- ConfigParse.jsonc(
- await ConfigManaged.parseManagedPlist(
- JSON.stringify({
- PayloadDisplayName: "OpenCode Managed",
- PayloadIdentifier: "ai.opencode.managed.test",
- PayloadType: "ai.opencode.managed",
- PayloadUUID: "AAAA-BBBB-CCCC",
- PayloadVersion: 1,
- _manualProfile: true,
- share: "disabled",
- model: "mdm/model",
- }),
- ),
- "test:mobileconfig",
- ),
- "test:mobileconfig",
- )
- expect(config.share).toBe("disabled")
- expect(config.model).toBe("mdm/model")
- // MDM keys must not leak into the parsed config
- expect((config as any).PayloadUUID).toBeUndefined()
- expect((config as any).PayloadType).toBeUndefined()
- expect((config as any)._manualProfile).toBeUndefined()
- })
- test("parseManagedPlist parses server settings", async () => {
- const config = ConfigParse.effectSchema(
- Config.Info,
- ConfigParse.jsonc(
- await ConfigManaged.parseManagedPlist(
- JSON.stringify({
- $schema: "https://opencode.ai/config.json",
- server: { hostname: "127.0.0.1", mdns: false },
- autoupdate: true,
- }),
- ),
- "test:mobileconfig",
- ),
- "test:mobileconfig",
- )
- expect(config.server?.hostname).toBe("127.0.0.1")
- expect(config.server?.mdns).toBe(false)
- expect(config.autoupdate).toBe(true)
- })
- test("parseManagedPlist parses permission rules", async () => {
- const config = ConfigParse.effectSchema(
- Config.Info,
- ConfigParse.jsonc(
- await ConfigManaged.parseManagedPlist(
- JSON.stringify({
- $schema: "https://opencode.ai/config.json",
- permission: {
- "*": "ask",
- bash: { "*": "ask", "rm -rf *": "deny", "curl *": "deny" },
- grep: "allow",
- glob: "allow",
- webfetch: "ask",
- "~/.ssh/*": "deny",
- },
- }),
- ),
- "test:mobileconfig",
- ),
- "test:mobileconfig",
- )
- expect(config.permission?.["*"]).toBe("ask")
- expect(config.permission?.grep).toBe("allow")
- expect(config.permission?.webfetch).toBe("ask")
- expect(config.permission?.["~/.ssh/*"]).toBe("deny")
- const bash = config.permission?.bash as Record<string, string>
- expect(bash?.["rm -rf *"]).toBe("deny")
- expect(bash?.["curl *"]).toBe("deny")
- })
- test("parseManagedPlist parses enabled_providers", async () => {
- const config = ConfigParse.effectSchema(
- Config.Info,
- ConfigParse.jsonc(
- await ConfigManaged.parseManagedPlist(
- JSON.stringify({
- $schema: "https://opencode.ai/config.json",
- enabled_providers: ["anthropic", "google"],
- }),
- ),
- "test:mobileconfig",
- ),
- "test:mobileconfig",
- )
- expect(config.enabled_providers).toEqual(["anthropic", "google"])
- })
- test("parseManagedPlist handles empty config", async () => {
- const config = ConfigParse.effectSchema(
- Config.Info,
- ConfigParse.jsonc(
- await ConfigManaged.parseManagedPlist(JSON.stringify({ $schema: "https://opencode.ai/config.json" })),
- "test:mobileconfig",
- ),
- "test:mobileconfig",
- )
- expect(config.$schema).toBe("https://opencode.ai/config.json")
- })
|