| 1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690 |
- import { test, expect, describe, mock, afterEach } from "bun:test"
- import { Config } from "../../src/config/config"
- import { Instance } from "../../src/project/instance"
- import { Auth } from "../../src/auth"
- import { tmpdir } from "../fixture/fixture"
- import path from "path"
- import fs from "fs/promises"
- import { pathToFileURL } from "url"
- import { Global } from "../../src/global"
- // Get managed config directory from environment (set in preload.ts)
- const managedConfigDir = process.env.OPENCODE_TEST_MANAGED_CONFIG_DIR!
- afterEach(async () => {
- await fs.rm(managedConfigDir, { force: true, recursive: true }).catch(() => {})
- })
- async function writeManagedSettings(settings: object, filename = "opencode.json") {
- await fs.mkdir(managedConfigDir, { recursive: true })
- await Bun.write(path.join(managedConfigDir, filename), JSON.stringify(settings))
- }
- async function writeConfig(dir: string, config: object, name = "opencode.json") {
- await Bun.write(path.join(dir, name), JSON.stringify(config))
- }
- test("loads config with defaults when no files exist", async () => {
- await using tmp = await tmpdir()
- await Instance.provide({
- directory: tmp.path,
- fn: async () => {
- const config = await Config.get()
- 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 Instance.provide({
- directory: tmp.path,
- fn: async () => {
- const config = await Config.get()
- expect(config.model).toBe("test/model")
- expect(config.username).toBe("testuser")
- },
- })
- })
- test("loads JSONC config file", async () => {
- await using tmp = await tmpdir({
- init: async (dir) => {
- await Bun.write(
- path.join(dir, "opencode.jsonc"),
- `{
- // This is a comment
- "$schema": "https://opencode.ai/config.json",
- "model": "test/model",
- "username": "testuser"
- }`,
- )
- },
- })
- await Instance.provide({
- directory: tmp.path,
- fn: async () => {
- const config = await Config.get()
- expect(config.model).toBe("test/model")
- expect(config.username).toBe("testuser")
- },
- })
- })
- test("merges multiple config files with correct precedence", 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 Instance.provide({
- directory: tmp.path,
- fn: async () => {
- const config = await Config.get()
- expect(config.model).toBe("override")
- expect(config.username).toBe("base")
- },
- })
- })
- test("handles environment variable substitution", async () => {
- const originalEnv = process.env["TEST_VAR"]
- process.env["TEST_VAR"] = "test_theme"
- try {
- await using tmp = await tmpdir({
- init: async (dir) => {
- await writeConfig(dir, {
- $schema: "https://opencode.ai/config.json",
- theme: "{env:TEST_VAR}",
- })
- },
- })
- await Instance.provide({
- directory: tmp.path,
- fn: async () => {
- const config = await Config.get()
- expect(config.theme).toBe("test_theme")
- },
- })
- } 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 Bun.write(
- path.join(dir, "opencode.json"),
- JSON.stringify({
- theme: "{env:PRESERVE_VAR}",
- }),
- )
- },
- })
- await Instance.provide({
- directory: tmp.path,
- fn: async () => {
- const config = await Config.get()
- expect(config.theme).toBe("secret_value")
- // Read the file to verify the env variable was preserved
- const content = await Bun.file(path.join(tmp.path, "opencode.json")).text()
- 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("handles file inclusion substitution", async () => {
- await using tmp = await tmpdir({
- init: async (dir) => {
- await Bun.write(path.join(dir, "included.txt"), "test_theme")
- await writeConfig(dir, {
- $schema: "https://opencode.ai/config.json",
- theme: "{file:included.txt}",
- })
- },
- })
- await Instance.provide({
- directory: tmp.path,
- fn: async () => {
- const config = await Config.get()
- expect(config.theme).toBe("test_theme")
- },
- })
- })
- 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 Instance.provide({
- directory: tmp.path,
- fn: async () => {
- // Strict schema should throw an error for invalid fields
- await expect(Config.get()).rejects.toThrow()
- },
- })
- })
- test("throws error for invalid JSON", async () => {
- await using tmp = await tmpdir({
- init: async (dir) => {
- await Bun.write(path.join(dir, "opencode.json"), "{ invalid json }")
- },
- })
- await Instance.provide({
- directory: tmp.path,
- fn: async () => {
- await expect(Config.get()).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 Instance.provide({
- directory: tmp.path,
- fn: async () => {
- const config = await Config.get()
- expect(config.agent?.["test_agent"]).toEqual(
- expect.objectContaining({
- model: "test/model",
- temperature: 0.7,
- description: "test agent",
- }),
- )
- },
- })
- })
- 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 Instance.provide({
- directory: tmp.path,
- fn: async () => {
- const config = await Config.get()
- 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 Bun.write(
- path.join(dir, "opencode.json"),
- JSON.stringify({
- $schema: "https://opencode.ai/config.json",
- autoshare: true,
- }),
- )
- },
- })
- await Instance.provide({
- directory: tmp.path,
- fn: async () => {
- const config = await Config.get()
- 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 Bun.write(
- path.join(dir, "opencode.json"),
- JSON.stringify({
- $schema: "https://opencode.ai/config.json",
- mode: {
- test_mode: {
- model: "test/model",
- temperature: 0.5,
- },
- },
- }),
- )
- },
- })
- await Instance.provide({
- directory: tmp.path,
- fn: async () => {
- const config = await Config.get()
- 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 Bun.write(
- path.join(agentDir, "test.md"),
- `---
- model: test/model
- ---
- Test agent prompt`,
- )
- },
- })
- await Instance.provide({
- directory: tmp.path,
- fn: async () => {
- const config = await Config.get()
- expect(config.agent?.["test"]).toEqual(
- expect.objectContaining({
- name: "test",
- model: "test/model",
- prompt: "Test agent prompt",
- }),
- )
- },
- })
- })
- 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 Bun.write(
- path.join(agentsDir, "helper.md"),
- `---
- model: test/model
- mode: subagent
- ---
- Helper agent prompt`,
- )
- await Bun.write(
- path.join(agentsDir, "nested", "child.md"),
- `---
- model: test/model
- mode: subagent
- ---
- Nested agent prompt`,
- )
- },
- })
- await Instance.provide({
- directory: tmp.path,
- fn: async () => {
- const config = await Config.get()
- 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 Bun.write(
- path.join(commandDir, "hello.md"),
- `---
- description: Test command
- ---
- Hello from singular command`,
- )
- await Bun.write(
- path.join(commandDir, "nested", "child.md"),
- `---
- description: Nested command
- ---
- Nested command template`,
- )
- },
- })
- await Instance.provide({
- directory: tmp.path,
- fn: async () => {
- const config = await Config.get()
- 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 Bun.write(
- path.join(commandsDir, "hello.md"),
- `---
- description: Test command
- ---
- Hello from plural commands`,
- )
- await Bun.write(
- path.join(commandsDir, "nested", "child.md"),
- `---
- description: Nested command
- ---
- Nested command template`,
- )
- },
- })
- await Instance.provide({
- directory: tmp.path,
- fn: async () => {
- const config = await Config.get()
- 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 Instance.provide({
- directory: tmp.path,
- fn: async () => {
- const newConfig = { model: "updated/model" }
- await Config.update(newConfig as any)
- const writtenConfig = JSON.parse(await Bun.file(path.join(tmp.path, "config.json")).text())
- expect(writtenConfig.model).toBe("updated/model")
- },
- })
- })
- test("gets config directories", async () => {
- await using tmp = await tmpdir()
- await Instance.provide({
- directory: tmp.path,
- fn: async () => {
- const dirs = await Config.directories()
- expect(dirs.length).toBeGreaterThanOrEqual(1)
- },
- })
- })
- 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 Bun.write(
- path.join(dir, "package.json"),
- JSON.stringify({ name: "config-fixture", version: "1.0.0", type: "module" }, null, 2),
- )
- await Bun.write(
- path.join(pluginDir, "package.json"),
- JSON.stringify(
- {
- name: "@scope/plugin",
- version: "1.0.0",
- type: "module",
- main: "./index.js",
- },
- null,
- 2,
- ),
- )
- await Bun.write(path.join(pluginDir, "index.js"), "export default {}\n")
- await Bun.write(
- path.join(dir, "opencode.json"),
- JSON.stringify({ $schema: "https://opencode.ai/config.json", plugin: ["@scope/plugin"] }, null, 2),
- )
- },
- })
- await Instance.provide({
- directory: tmp.path,
- fn: async () => {
- const config = await Config.get()
- const pluginEntries = config.plugin ?? []
- const baseUrl = pathToFileURL(path.join(tmp.path, "opencode.json")).href
- const expected = import.meta.resolve("@scope/plugin", baseUrl)
- expect(pluginEntries.includes(expected)).toBe(true)
- const scopedEntry = pluginEntries.find((entry) => entry === expected)
- expect(scopedEntry).toBeDefined()
- expect(scopedEntry?.includes("/node_modules/@scope/plugin/")).toBe(true)
- },
- })
- })
- 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 Bun.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 Bun.write(
- path.join(opencodeDir, "opencode.json"),
- JSON.stringify({
- $schema: "https://opencode.ai/config.json",
- plugin: ["local-plugin-1"],
- }),
- )
- },
- })
- await Instance.provide({
- directory: path.join(tmp.path, "project"),
- fn: async () => {
- const config = await Config.get()
- 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 Bun.write(
- path.join(agentDir, "helper.md"),
- `---
- model: test/model
- mode: subagent
- ---
- Helper subagent prompt`,
- )
- },
- })
- await Instance.provide({
- directory: tmp.path,
- fn: async () => {
- const config = await Config.get()
- 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 Bun.write(
- path.join(dir, "opencode.json"),
- JSON.stringify({
- $schema: "https://opencode.ai/config.json",
- instructions: ["global-instructions.md", "shared-rules.md"],
- }),
- )
- await Bun.write(
- path.join(opencodeDir, "opencode.json"),
- JSON.stringify({
- $schema: "https://opencode.ai/config.json",
- instructions: ["local-instructions.md"],
- }),
- )
- },
- })
- await Instance.provide({
- directory: path.join(tmp.path, "project"),
- fn: async () => {
- const config = await Config.get()
- 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 Bun.write(
- path.join(dir, "opencode.json"),
- JSON.stringify({
- $schema: "https://opencode.ai/config.json",
- instructions: ["duplicate.md", "global-only.md"],
- }),
- )
- await Bun.write(
- path.join(opencodeDir, "opencode.json"),
- JSON.stringify({
- $schema: "https://opencode.ai/config.json",
- instructions: ["duplicate.md", "local-only.md"],
- }),
- )
- },
- })
- await Instance.provide({
- directory: path.join(tmp.path, "project"),
- fn: async () => {
- const config = await Config.get()
- 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 Bun.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 Bun.write(
- path.join(opencodeDir, "opencode.json"),
- JSON.stringify({
- $schema: "https://opencode.ai/config.json",
- plugin: ["duplicate-plugin", "local-plugin-1"],
- }),
- )
- },
- })
- await Instance.provide({
- directory: path.join(tmp.path, "project"),
- fn: async () => {
- const config = await Config.get()
- 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)
- },
- })
- })
- // Legacy tools migration tests
- test("migrates legacy tools config to permissions - allow", async () => {
- await using tmp = await tmpdir({
- init: async (dir) => {
- await Bun.write(
- path.join(dir, "opencode.json"),
- JSON.stringify({
- $schema: "https://opencode.ai/config.json",
- agent: {
- test: {
- tools: {
- bash: true,
- read: true,
- },
- },
- },
- }),
- )
- },
- })
- await Instance.provide({
- directory: tmp.path,
- fn: async () => {
- const config = await Config.get()
- 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 Bun.write(
- path.join(dir, "opencode.json"),
- JSON.stringify({
- $schema: "https://opencode.ai/config.json",
- agent: {
- test: {
- tools: {
- bash: false,
- webfetch: false,
- },
- },
- },
- }),
- )
- },
- })
- await Instance.provide({
- directory: tmp.path,
- fn: async () => {
- const config = await Config.get()
- 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 Bun.write(
- path.join(dir, "opencode.json"),
- JSON.stringify({
- $schema: "https://opencode.ai/config.json",
- agent: {
- test: {
- tools: {
- write: true,
- },
- },
- },
- }),
- )
- },
- })
- await Instance.provide({
- directory: tmp.path,
- fn: async () => {
- const config = await Config.get()
- 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 Instance.provide({
- directory: tmp.path,
- fn: async () => {
- const config = await Config.get()
- 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: [],
- theme: "dark",
- })
- },
- })
- await writeManagedSettings({
- $schema: "https://opencode.ai/config.json",
- autoupdate: false,
- disabled_providers: ["openai"],
- })
- await Instance.provide({
- directory: tmp.path,
- fn: async () => {
- const config = await Config.get()
- expect(config.autoupdate).toBe(false)
- expect(config.disabled_providers).toEqual(["openai"])
- expect(config.theme).toBe("dark")
- },
- })
- })
- 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 Instance.provide({
- directory: tmp.path,
- fn: async () => {
- const config = await Config.get()
- expect(config.model).toBe("user/model")
- },
- })
- })
- test("migrates legacy edit tool to edit permission", async () => {
- await using tmp = await tmpdir({
- init: async (dir) => {
- await Bun.write(
- path.join(dir, "opencode.json"),
- JSON.stringify({
- $schema: "https://opencode.ai/config.json",
- agent: {
- test: {
- tools: {
- edit: false,
- },
- },
- },
- }),
- )
- },
- })
- await Instance.provide({
- directory: tmp.path,
- fn: async () => {
- const config = await Config.get()
- 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 Bun.write(
- path.join(dir, "opencode.json"),
- JSON.stringify({
- $schema: "https://opencode.ai/config.json",
- agent: {
- test: {
- tools: {
- patch: true,
- },
- },
- },
- }),
- )
- },
- })
- await Instance.provide({
- directory: tmp.path,
- fn: async () => {
- const config = await Config.get()
- expect(config.agent?.["test"]?.permission).toEqual({
- edit: "allow",
- })
- },
- })
- })
- test("migrates legacy multiedit tool to edit permission", async () => {
- await using tmp = await tmpdir({
- init: async (dir) => {
- await Bun.write(
- path.join(dir, "opencode.json"),
- JSON.stringify({
- $schema: "https://opencode.ai/config.json",
- agent: {
- test: {
- tools: {
- multiedit: false,
- },
- },
- },
- }),
- )
- },
- })
- await Instance.provide({
- directory: tmp.path,
- fn: async () => {
- const config = await Config.get()
- expect(config.agent?.["test"]?.permission).toEqual({
- edit: "deny",
- })
- },
- })
- })
- test("migrates mixed legacy tools config", async () => {
- await using tmp = await tmpdir({
- init: async (dir) => {
- await Bun.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 Instance.provide({
- directory: tmp.path,
- fn: async () => {
- const config = await Config.get()
- 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 Bun.write(
- path.join(dir, "opencode.json"),
- JSON.stringify({
- $schema: "https://opencode.ai/config.json",
- agent: {
- test: {
- permission: {
- glob: "allow",
- },
- tools: {
- bash: true,
- },
- },
- },
- }),
- )
- },
- })
- await Instance.provide({
- directory: tmp.path,
- fn: async () => {
- const config = await Config.get()
- expect(config.agent?.["test"]?.permission).toEqual({
- glob: "allow",
- bash: "allow",
- })
- },
- })
- })
- test("permission config preserves key order", async () => {
- await using tmp = await tmpdir({
- init: async (dir) => {
- await Bun.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",
- todoread: "allow",
- "thoughts_*": "allow",
- "reasoning_model_*": "allow",
- "tools_*": "allow",
- "pr_comments_*": "allow",
- },
- }),
- )
- },
- })
- await Instance.provide({
- directory: tmp.path,
- fn: async () => {
- const config = await Config.get()
- expect(Object.keys(config.permission!)).toEqual([
- "*",
- "edit",
- "write",
- "external_directory",
- "read",
- "todowrite",
- "todoread",
- "thoughts_*",
- "reasoning_model_*",
- "tools_*",
- "pr_comments_*",
- ])
- },
- })
- })
- // 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 Bun.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: false,
- },
- wiki: {
- type: "remote",
- url: "https://wiki.example.com/mcp",
- enabled: false,
- },
- },
- }),
- )
- // Project config enables just jira
- await Bun.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: true,
- },
- },
- }),
- )
- },
- })
- await Instance.provide({
- directory: tmp.path,
- fn: async () => {
- const config = await Config.get()
- // 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 Bun.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: false,
- headers: {
- "X-Custom-Header": "value",
- },
- },
- },
- }),
- )
- // Override just enables it, should preserve other properties
- await Bun.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: true,
- },
- },
- }),
- )
- },
- })
- await Instance.provide({
- directory: tmp.path,
- fn: async () => {
- const config = await Config.get()
- 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 Bun.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 Bun.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 Instance.provide({
- directory: tmp.path,
- fn: async () => {
- const config = await Config.get()
- expect(config.mcp?.docs?.enabled).toBe(true)
- },
- })
- })
- test("project config overrides remote well-known config", async () => {
- const originalFetch = globalThis.fetch
- let fetchedUrl: string | undefined
- const mockFetch = mock((url: string | URL | Request) => {
- const urlStr = url.toString()
- 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)
- })
- globalThis.fetch = mockFetch as unknown as typeof fetch
- const originalAuthAll = Auth.all
- Auth.all = mock(() =>
- Promise.resolve({
- "https://example.com": {
- type: "wellknown" as const,
- key: "TEST_TOKEN",
- token: "test-token",
- },
- }),
- )
- try {
- await using tmp = await tmpdir({
- git: true,
- init: async (dir) => {
- // Project config enables jira (overriding remote default)
- await Bun.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: true,
- },
- },
- }),
- )
- },
- })
- await Instance.provide({
- directory: tmp.path,
- fn: async () => {
- const config = await Config.get()
- // Verify fetch was called for wellknown config
- expect(fetchedUrl).toBe("https://example.com/.well-known/opencode")
- // Project config (enabled: true) should override remote (enabled: false)
- expect(config.mcp?.jira?.enabled).toBe(true)
- },
- })
- } finally {
- globalThis.fetch = originalFetch
- Auth.all = originalAuthAll
- }
- })
- describe("getPluginName", () => {
- test("extracts name from file:// URL", () => {
- expect(Config.getPluginName("file:///path/to/plugin/foo.js")).toBe("foo")
- expect(Config.getPluginName("file:///path/to/plugin/bar.ts")).toBe("bar")
- expect(Config.getPluginName("file:///some/path/my-plugin.js")).toBe("my-plugin")
- })
- test("extracts name from npm package with version", () => {
- expect(Config.getPluginName("[email protected]")).toBe("oh-my-opencode")
- expect(Config.getPluginName("[email protected]")).toBe("some-plugin")
- expect(Config.getPluginName("plugin@latest")).toBe("plugin")
- })
- test("extracts name from scoped npm package", () => {
- expect(Config.getPluginName("@scope/[email protected]")).toBe("@scope/pkg")
- expect(Config.getPluginName("@opencode/[email protected]")).toBe("@opencode/plugin")
- })
- test("returns full string for package without version", () => {
- expect(Config.getPluginName("some-plugin")).toBe("some-plugin")
- expect(Config.getPluginName("@scope/pkg")).toBe("@scope/pkg")
- })
- })
- describe("deduplicatePlugins", () => {
- test("removes duplicates keeping higher priority (later entries)", () => {
- const plugins = ["[email protected]", "[email protected]", "[email protected]", "[email protected]"]
- const result = Config.deduplicatePlugins(plugins)
- expect(result).toContain("[email protected]")
- expect(result).toContain("[email protected]")
- expect(result).toContain("[email protected]")
- expect(result).not.toContain("[email protected]")
- expect(result.length).toBe(3)
- })
- test("prefers local file over npm package with same name", () => {
- const plugins = ["[email protected]", "file:///project/.opencode/plugin/oh-my-opencode.js"]
- const result = Config.deduplicatePlugins(plugins)
- expect(result.length).toBe(1)
- expect(result[0]).toBe("file:///project/.opencode/plugin/oh-my-opencode.js")
- })
- test("preserves order of remaining plugins", () => {
- const plugins = ["[email protected]", "[email protected]", "[email protected]"]
- const result = Config.deduplicatePlugins(plugins)
- expect(result).toEqual(["[email protected]", "[email protected]", "[email protected]"])
- })
- test("local plugin directory overrides global opencode.json plugin", 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 Bun.write(
- path.join(dir, "opencode.json"),
- JSON.stringify({
- $schema: "https://opencode.ai/config.json",
- plugin: ["[email protected]"],
- }),
- )
- await Bun.write(path.join(pluginDir, "my-plugin.js"), "export default {}")
- },
- })
- await Instance.provide({
- directory: path.join(tmp.path, "project"),
- fn: async () => {
- const config = await Config.get()
- const plugins = config.plugin ?? []
- const myPlugins = plugins.filter((p) => Config.getPluginName(p) === "my-plugin")
- expect(myPlugins.length).toBe(1)
- expect(myPlugins[0].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 Bun.write(
- path.join(dir, "opencode.json"),
- JSON.stringify({
- $schema: "https://opencode.ai/config.json",
- model: "project/model",
- username: "project-user",
- }),
- )
- },
- })
- await Instance.provide({
- directory: tmp.path,
- fn: async () => {
- const config = await Config.get()
- // 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 Bun.write(path.join(opencodeDir, "test-cmd.md"), "# Test Command\nThis is a test command.")
- },
- })
- await Instance.provide({
- directory: tmp.path,
- fn: async () => {
- const directories = await Config.directories()
- // 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 Instance.provide({
- directory: tmp.path,
- fn: async () => {
- // Should still get default config (from global or defaults)
- const config = await Config.get()
- 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 Bun.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 Bun.write(path.join(dir, "CUSTOM.md"), "# Custom Instructions")
- },
- })
- await Instance.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 Config.get()
- 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 Bun.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 Bun.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 Instance.provide({
- directory: projectTmp.path,
- fn: async () => {
- const config = await Config.get()
- // 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
- }
- }
- })
- })
|