Files
openclaw/src/agents/model-auth.test.ts
Peter Steinberger bb46b79d3c refactor: internalize OpenClaw agent runtime (#85341)
* refactor: extract agent core package

Introduce packages/agent-core as the OpenClaw-owned home for reusable agent loop, harness, session, prompt, and runtime dependency contracts.

* refactor: extract shared llm runtime

Move provider model registries, stream wrappers, OAuth helpers, and LLM utilities into src/llm with plugin-sdk barrels instead of depending on the old embedded runtime layout.

* refactor: remove pi runtime internals

Rename remaining Pi-shaped agent surfaces to OpenClaw agent runtime names, delete obsolete Pi docs and package graph checks, and add the third-party notice for incorporated code.

* refactor: tighten agent session runtime

Make agent-core/runtime dependencies explicit, consolidate compaction and session transcript helpers, and move model/session helpers behind OpenClaw-owned contracts.

* refactor: remove static model and pi auth paths

Drop static model catalogs and Pi auth bridges, move model/provider facts to manifest-owned runtime contracts, and harden internal embedded-agent utilities.

* refactor: remove legacy provider compat paths

* docs: remove agent parity notes

* fix: skip provider wildcard metadata parsing

* refactor: share session extension sdk loading

* refactor: inline acpx proxy error formatter

* refactor: fold edit recovery into edit tool

* fix: accept extension batch separator

* test: align startup provider plugin expectations

* fix: restore provider-scoped release discovery

* test: align static asset packaging expectations

* fix: run static provider catalogs during scoped discovery

* fix: add provider entry catalogs for scoped live discovery

* fix: load lightweight provider catalog entries

* fix: refresh provider-scoped plugin metadata

* fix: keep provider catalog entries on release live path

* fix: keep static manifest models in release live checks

* fix: harden release model discovery

* fix: reduce OpenAI live cache probe reasoning

* fix: disable OpenAI cache probe reasoning

* ci: extend OpenAI gateway live timeout

* fix: extend live gateway model budget

* fix: stabilize release validation regressions

* fix: honor provider aliases in model rows

* fix: stabilize release validation lanes

* fix: stabilize release memory qa

* ci: stabilize release validation lanes

* ci: prefer ipv4 for live docker node calls

* fix: restore shared tool-call stream wrapper

* ci: remove legacy pi test shard alias

* fix: clean up embedded agent test drift

* fix: stabilize runtime alias status

* fix: clean up embedded agent ci drift

* fix: restore release ci invariants

* fix: clean up post-rebase runtime drift

* fix: restore release ci checks

* fix: restore release ci after rebase

* fix: remove stale pi runtime path

* test: align compaction runtime expectations

* test: update plugin prerelease expectations

* fix: handle claude live tool approvals

* fix: stabilize release validation gates

* fix: finish agent runtime import

* test: finish post-rebase agent runtime mocks

* fix: keep codex compaction native

* fix: stabilize codex app-server hook tests

* test: isolate codex diagnostic active run

* test: remove codex diagnostic completion race

# Conflicts:
#	extensions/codex/src/app-server/run-attempt.test.ts

* ci: fix full release manifest performance run id

* refactor: narrow llm plugin sdk boundary

* chore: drop generated google boundary stamps

* fix: repair rebase fallout

* fix: clean up rebased runtime references

* fix: decode codex jwt payloads as base64url

* fix: preserve shipped pi runtime alias

* fix: add scoped sdk virtual modules

* fix: decode llm codex oauth jwt as base64url

* fix: avoid stale vertex adc negative cache

* fix: harden tool arg decoding and codeql path

* fix: keep vertex adc negative checks live

* refactor: consolidate codex jwt and edit helpers

* fix: await codex oauth node runtime imports

* fix: preserve sdk tool and notice contracts

* fix: preserve shipped compat config boundaries

* fix: align codex oauth callback host

* fix: terminate agent-core loop streams on failure

* fix: keep codex oauth callback alive during fallback

* ci: include session tools in critical codeql scans

* fix: keep Cloudflare Anthropic provider auth header

* docs: redirect legacy pi runtime pages

* fix: honor bundled web provider compat discovery

* fix: protect session output spill files

* fix: keep legacy agent dir env blocked

* fix: contain auto-discovered skill symlinks

* fix: harden agent core sdk proxy surfaces

* fix: restore approval reaction sdk compat

* fix: keep live docker runs bounded

* fix: keep codex oauth redirect host aligned

* fix: resolve post-rebase agent runtime drift

* fix: redact anthropic oauth parse failures

* fix: preserve responses strict tool shaping

* fix: repair agent runtime rebase cleanup

* docs: redirect retired parity pages

* fix: bound auto-discovered resources to roots

* fix: repair post-rebase agent test drift

* fix: preserve bundled provider allowlist migration

* fix: preserve manifest-owned provider aliases

* fix: declare photon image dependency

* fix: keep provider headers out of proxy body

* fix: preserve shipped env aliases

* fix: refresh control ui i18n generated state

* fix: quote read fallback paths

* fix: preview edits through configured backend

* test: satisfy core test typecheck

* fix: preserve ZAI usage auth fallback

* test: repair codex diagnostic test

* fix: repair agent runtime rebase drift

* test: finish embedded runner import rename

* fix: repair agent runtime rebase integrations

* test: align compaction oauth fallback expectations

* fix: allow sdk-auth session models

* fix: update doctor tool schema import

* fix: preserve bedrock plugin region

* fix: stream harmony-like prose immediately

* ci: include session runtime in codeql shards

* fix: repair latest rebase integrations

* fix: honor explicit codex websocket transport

* fix: keep openai-compatible credentials provider-scoped

* fix: refresh sdk api baseline after rebase

* fix: route cli runtime aliases through openclaw harness

* test: rename stale harness mock expectation

* test: rename embedded agent overflow calls

* test: clean embedded auth test wording

* test: use openclaw stream types in deepinfra cache test

* fix: refresh sdk api baseline on latest main

* fix: honor bundled discovery compat allowlists

* fix: refresh sdk api baseline after latest rebase

* fix: remove stale rebase imports

* test: rename stale model catalog mock

* test: mock renamed doctor runtime modules

* fix: map canonical kimi env auth

* fix: use internal model registry in bench script

* fix: migrate deepinfra provider catalog entry

* fix: enforce builtin tool suppression

* fix: route compaction auth and proxy payloads safely

* refactor: prune unused llm registry leftovers

* test: update codex hooks session import

* test: fix model picker ci coverage

* test: align model picker auth mock types
2026-05-27 19:24:04 +01:00

1565 lines
44 KiB
TypeScript
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
import type { Model } from "openclaw/plugin-sdk/llm";
import { afterEach, beforeAll, beforeEach, describe, expect, it, vi } from "vitest";
import type { ModelProviderConfig } from "../config/config.js";
import type { AuthProfileStore } from "./auth-profiles.js";
import {
CUSTOM_LOCAL_AUTH_MARKER,
GCP_VERTEX_CREDENTIALS_MARKER,
NON_ENV_SECRETREF_MARKER,
} from "./model-auth-markers.js";
vi.mock("../plugins/plugin-registry.js", () => ({
loadPluginRegistrySnapshotWithMetadata: () => ({
source: "derived",
snapshot: { plugins: [] },
diagnostics: [],
}),
loadPluginManifestRegistryForPluginRegistry: () => ({
diagnostics: [],
plugins: [
{
origin: "bundled",
nonSecretAuthMarkers: ["gcp-vertex-credentials", "ollama-local"],
providerAuthEnvVars: {
ollama: ["OLLAMA_API_KEY"],
},
},
],
}),
}));
vi.mock("../plugins/providers.js", () => ({
resolveOwningPluginIdsForProvider: () => [],
resolveOwningPluginIdsForProviderRef: () => [],
}));
vi.mock("../plugins/setup-registry.js", () => ({
resolvePluginSetupProvider: () => undefined,
}));
vi.mock("../plugins/provider-runtime.js", async () => {
const actual = await vi.importActual<typeof import("../plugins/provider-runtime.js")>(
"../plugins/provider-runtime.js",
);
return {
...actual,
buildProviderMissingAuthMessageWithPlugin: () => undefined,
resolveExternalAuthProfilesWithPlugins: () => [],
shouldDeferProviderSyntheticProfileAuthWithPlugin: () => false,
resolveProviderSyntheticAuthWithPlugin: (params: {
provider: string;
config?: {
plugins?: {
enabled?: boolean;
entries?: Record<
string,
{
enabled?: boolean;
config?: {
webSearch?: {
apiKey?: unknown;
};
};
}
>;
};
tools?: {
web?: {
search?: {
grok?: {
apiKey?: unknown;
};
};
};
};
};
modelApi?: string;
context: { providerConfig?: { api?: string; baseUrl?: string; models?: unknown[] } };
}) => {
if (params.provider === "plugin-web") {
if (
params.config?.plugins?.enabled === false ||
params.config?.plugins?.entries?.["plugin-web"]?.enabled === false
) {
return undefined;
}
const pluginApiKey =
params.config?.plugins?.entries?.["plugin-web"]?.config?.webSearch?.apiKey;
if (typeof pluginApiKey === "string" && pluginApiKey.trim()) {
return {
apiKey: pluginApiKey.trim(),
source: "plugins.entries.plugin-web.config.webSearch.apiKey",
mode: "api-key" as const,
};
}
if (pluginApiKey && typeof pluginApiKey === "object") {
return {
apiKey: NON_ENV_SECRETREF_MARKER,
source: "plugins.entries.plugin-web.config.webSearch.apiKey",
mode: "api-key" as const,
};
}
return undefined;
}
if (params.provider === "native-cli") {
return {
apiKey: "native-cli-access-token",
source: "Native CLI auth",
mode: "oauth" as const,
};
}
const effectiveApi = params.modelApi ?? params.context.providerConfig?.api;
if (
effectiveApi === "ollama" &&
(params.context.providerConfig?.baseUrl?.startsWith("http://192.168.") ||
params.modelApi === "ollama")
) {
return {
apiKey: "ollama-local",
source: `models.providers.${params.provider} (synthetic local key)`,
mode: "api-key" as const,
};
}
return undefined;
},
};
});
let applyAuthHeaderOverride: typeof import("./model-auth.js").applyAuthHeaderOverride;
let applyLocalNoAuthHeaderOverride: typeof import("./model-auth.js").applyLocalNoAuthHeaderOverride;
let createRuntimeProviderAuthLookup: typeof import("./model-auth.js").createRuntimeProviderAuthLookup;
let formatMissingAuthError: typeof import("./model-auth.js").formatMissingAuthError;
let hasUsableCustomProviderApiKey: typeof import("./model-auth.js").hasUsableCustomProviderApiKey;
let hasSyntheticLocalProviderAuthConfig: typeof import("./model-auth.js").hasSyntheticLocalProviderAuthConfig;
let requireApiKey: typeof import("./model-auth.js").requireApiKey;
let getApiKeyForModel: typeof import("./model-auth.js").getApiKeyForModel;
let resolveApiKeyForProvider: typeof import("./model-auth.js").resolveApiKeyForProvider;
let resolveAwsSdkEnvVarName: typeof import("./model-auth.js").resolveAwsSdkEnvVarName;
let resolveModelAuthMode: typeof import("./model-auth.js").resolveModelAuthMode;
let resolveUsableCustomProviderApiKey: typeof import("./model-auth.js").resolveUsableCustomProviderApiKey;
let cliCredentials: typeof import("./cli-credentials.js");
let clearRuntimeConfigSnapshot: typeof import("../config/config.js").clearRuntimeConfigSnapshot;
let setRuntimeConfigSnapshot: typeof import("../config/config.js").setRuntimeConfigSnapshot;
beforeAll(async () => {
vi.resetModules();
({ clearRuntimeConfigSnapshot, setRuntimeConfigSnapshot } = await import("../config/config.js"));
cliCredentials = await import("./cli-credentials.js");
({
applyAuthHeaderOverride,
applyLocalNoAuthHeaderOverride,
createRuntimeProviderAuthLookup,
formatMissingAuthError,
hasSyntheticLocalProviderAuthConfig,
getApiKeyForModel,
hasUsableCustomProviderApiKey,
requireApiKey,
resolveApiKeyForProvider,
resolveAwsSdkEnvVarName,
resolveModelAuthMode,
resolveUsableCustomProviderApiKey,
} = await import("./model-auth.js"));
});
beforeEach(() => {
clearRuntimeConfigSnapshot();
});
afterEach(() => {
clearRuntimeConfigSnapshot();
});
describe("createRuntimeProviderAuthLookup", () => {
it("omits synthetic auth refs when plugin synthetic auth is disabled", () => {
expect(
createRuntimeProviderAuthLookup({
includePluginSyntheticAuth: false,
env: {},
}).syntheticAuthProviderRefs,
).toBeUndefined();
});
});
async function withoutEnv<T>(key: string, fn: () => Promise<T>): Promise<T> {
const previous = process.env[key];
delete process.env[key];
try {
return await fn();
} finally {
if (previous === undefined) {
delete process.env[key];
} else {
process.env[key] = previous;
}
}
}
async function withEnv<T>(key: string, value: string, fn: () => Promise<T>): Promise<T> {
const previous = process.env[key];
process.env[key] = value;
try {
return await fn();
} finally {
if (previous === undefined) {
delete process.env[key];
} else {
process.env[key] = previous;
}
}
}
function createCustomProviderConfig(
baseUrl: string,
modelId = "llama3",
modelName = "Llama 3",
): ModelProviderConfig {
return {
baseUrl,
api: "openai-completions" as const,
models: [
{
id: modelId,
name: modelName,
reasoning: false,
input: ["text"],
cost: { input: 0, output: 0, cacheRead: 0, cacheWrite: 0 },
contextWindow: 8192,
maxTokens: 4096,
},
],
};
}
async function resolveCustomProviderAuth(
provider: string,
baseUrl: string,
modelId?: string,
modelName?: string,
) {
return resolveApiKeyForProvider({
provider,
cfg: {
models: {
providers: {
[provider]: createCustomProviderConfig(baseUrl, modelId, modelName),
},
},
},
});
}
function expectAuthFields(
auth: Awaited<ReturnType<typeof resolveApiKeyForProvider>>,
expected: {
apiKey: string;
mode: "api-key" | "oauth";
source?: string;
},
) {
expect(auth.apiKey).toBe(expected.apiKey);
expect(auth.mode).toBe(expected.mode);
if (expected.source !== undefined) {
expect(auth.source).toBe(expected.source);
}
}
describe("resolveAwsSdkEnvVarName", () => {
it("prefers bearer token over access keys and profile", () => {
const env = {
AWS_BEARER_TOKEN_BEDROCK: "bearer",
AWS_ACCESS_KEY_ID: "access",
AWS_SECRET_ACCESS_KEY: "secret", // pragma: allowlist secret
AWS_PROFILE: "default",
} as NodeJS.ProcessEnv;
expect(resolveAwsSdkEnvVarName(env)).toBe("AWS_BEARER_TOKEN_BEDROCK");
});
it("uses access keys when bearer token is missing", () => {
const env = {
AWS_ACCESS_KEY_ID: "access",
AWS_SECRET_ACCESS_KEY: "secret", // pragma: allowlist secret
AWS_PROFILE: "default",
} as NodeJS.ProcessEnv;
expect(resolveAwsSdkEnvVarName(env)).toBe("AWS_ACCESS_KEY_ID");
});
it("uses profile when no bearer token or access keys exist", () => {
const env = {
AWS_PROFILE: "default",
} as NodeJS.ProcessEnv;
expect(resolveAwsSdkEnvVarName(env)).toBe("AWS_PROFILE");
});
it("returns undefined when no AWS auth env is set", () => {
expect(resolveAwsSdkEnvVarName({} as NodeJS.ProcessEnv)).toBeUndefined();
});
});
describe("resolveModelAuthMode", () => {
it("returns mixed when provider has both token and api key profiles", () => {
const store: AuthProfileStore = {
version: 1,
profiles: {
"openai:token": {
type: "token",
provider: "openai",
token: "token-value",
},
"openai:key": {
type: "api_key",
provider: "openai",
key: "api-key",
},
},
};
expect(resolveModelAuthMode("openai", undefined, store)).toBe("mixed");
});
it("returns aws-sdk when provider auth is overridden", () => {
expect(
resolveModelAuthMode(
"amazon-bedrock",
{
models: {
providers: {
"amazon-bedrock": {
baseUrl: "https://bedrock-runtime.us-east-1.amazonaws.com",
models: [],
auth: "aws-sdk",
},
},
},
},
{ version: 1, profiles: {} },
),
).toBe("aws-sdk");
});
it("does not infer aws-sdk for bedrock alias without explicit auth override", () => {
expect(resolveModelAuthMode("bedrock", undefined, { version: 1, profiles: {} })).toBe(
"unknown",
);
});
it("does not infer aws-sdk for aws-bedrock alias without explicit auth override", () => {
expect(resolveModelAuthMode("aws-bedrock", undefined, { version: 1, profiles: {} })).toBe(
"unknown",
);
});
it("returns oauth for codex when Codex CLI auth is available", () => {
const readCodexCliCredentialsCached = vi
.spyOn(cliCredentials, "readCodexCliCredentialsCached")
.mockReturnValue({
type: "oauth",
provider: "openai-codex",
access: "token",
refresh: "refresh",
expires: Date.now() + 60_000,
});
try {
expect(resolveModelAuthMode("codex", undefined, { version: 1, profiles: {} })).toBe("oauth");
expect(readCodexCliCredentialsCached).toHaveBeenCalledWith({
ttlMs: 5_000,
allowKeychainPrompt: false,
});
} finally {
readCodexCliCredentialsCached.mockRestore();
}
});
});
describe("requireApiKey", () => {
it("formats missing auth errors with the checked credential source", () => {
expect(
formatMissingAuthError(
{
source: "env: OPENAI_API_KEY",
mode: "api-key",
},
"openai",
),
).toBe(
'No API key resolved for provider "openai" (auth mode: api-key, checked: env: OPENAI_API_KEY).',
);
});
it("normalizes line breaks in resolved API keys", () => {
const key = requireApiKey(
{
apiKey: "\n sk-test-abc\r\n",
source: "env: OPENAI_API_KEY",
mode: "api-key",
},
"openai",
);
expect(key).toBe("sk-test-abc");
});
it("throws when no API key is present", () => {
expect(() =>
requireApiKey(
{
source: "env: OPENAI_API_KEY",
mode: "api-key",
},
"openai",
),
).toThrow(
'No API key resolved for provider "openai" (auth mode: api-key, checked: env: OPENAI_API_KEY).',
);
});
});
describe("resolveUsableCustomProviderApiKey", () => {
it("returns literal custom provider keys", () => {
const resolved = resolveUsableCustomProviderApiKey({
cfg: {
models: {
providers: {
custom: {
baseUrl: "https://example.com/v1",
apiKey: "sk-custom-runtime", // pragma: allowlist secret
models: [],
},
},
},
},
provider: "custom",
});
expect(resolved).toEqual({
apiKey: "sk-custom-runtime",
source: "models.json",
});
});
it("does not treat non-env markers as usable credentials", () => {
const resolved = resolveUsableCustomProviderApiKey({
cfg: {
models: {
providers: {
custom: {
baseUrl: "https://example.com/v1",
apiKey: NON_ENV_SECRETREF_MARKER,
models: [],
},
},
},
},
provider: "custom",
});
expect(resolved).toBeNull();
});
it("does not treat the Vertex ADC marker as a usable models.json credential", () => {
const resolved = resolveUsableCustomProviderApiKey({
cfg: {
models: {
providers: {
"anthropic-vertex": {
baseUrl: "https://us-central1-aiplatform.googleapis.com",
apiKey: GCP_VERTEX_CREDENTIALS_MARKER,
models: [],
},
},
},
},
provider: "anthropic-vertex",
});
expect(resolved).toBeNull();
});
it("resolves known env marker names from process env for custom providers", () => {
const previous = process.env.OPENAI_API_KEY;
process.env.OPENAI_API_KEY = "sk-from-env"; // pragma: allowlist secret
try {
const resolved = resolveUsableCustomProviderApiKey({
cfg: {
models: {
providers: {
custom: {
baseUrl: "https://example.com/v1",
apiKey: "OPENAI_API_KEY",
models: [],
},
},
},
},
provider: "custom",
});
expect(resolved?.apiKey).toBe("sk-from-env");
expect(resolved?.source).toContain("OPENAI_API_KEY");
} finally {
if (previous === undefined) {
delete process.env.OPENAI_API_KEY;
} else {
process.env.OPENAI_API_KEY = previous;
}
}
});
it("resolves env SecretRefs from process env for custom providers", () => {
const previous = process.env.OPENAI_API_KEY;
process.env.OPENAI_API_KEY = "sk-secretref-env"; // pragma: allowlist secret
try {
const resolved = resolveUsableCustomProviderApiKey({
cfg: {
models: {
providers: {
custom: {
baseUrl: "https://example.com/v1",
apiKey: {
source: "env",
provider: "default",
id: "OPENAI_API_KEY",
},
models: [],
},
},
},
},
provider: "custom",
});
expect(resolved?.apiKey).toBe("sk-secretref-env");
expect(resolved?.source).toContain("OPENAI_API_KEY");
} finally {
if (previous === undefined) {
delete process.env.OPENAI_API_KEY;
} else {
process.env.OPENAI_API_KEY = previous;
}
}
});
it("resolves env SecretRefs with unknown env IDs from process env for custom providers", () => {
const previous = process.env.MY_CUSTOM_KEY;
process.env.MY_CUSTOM_KEY = "sk-custom-secretref-env"; // pragma: allowlist secret
try {
const resolved = resolveUsableCustomProviderApiKey({
cfg: {
models: {
providers: {
custom: {
baseUrl: "https://example.com/v1",
apiKey: {
source: "env",
provider: "default",
id: "MY_CUSTOM_KEY",
},
models: [],
},
},
},
},
provider: "custom",
});
expect(resolved?.apiKey).toBe("sk-custom-secretref-env");
expect(resolved?.source).toContain("MY_CUSTOM_KEY");
} finally {
if (previous === undefined) {
delete process.env.MY_CUSTOM_KEY;
} else {
process.env.MY_CUSTOM_KEY = previous;
}
}
});
it("resolves legacy __env__ markers from process env for custom providers", () => {
const previous = process.env.BAILIAN_API_KEY;
process.env.BAILIAN_API_KEY = "sk-bailian-env"; // pragma: allowlist secret
try {
const resolved = resolveUsableCustomProviderApiKey({
cfg: {
models: {
providers: {
bailian: {
baseUrl: "https://coding.dashscope.aliyuncs.com/v1",
api: "openai-completions",
apiKey: "__env__:BAILIAN_API_KEY", // pragma: allowlist secret
models: [],
},
},
},
},
provider: "bailian",
});
expect(resolved?.apiKey).toBe("sk-bailian-env");
expect(resolved?.source).toContain("BAILIAN_API_KEY");
} finally {
if (previous === undefined) {
delete process.env.BAILIAN_API_KEY;
} else {
process.env.BAILIAN_API_KEY = previous;
}
}
});
it("does not resolve env SecretRefs when provider allowlist excludes the env id", () => {
const previous = process.env.MY_CUSTOM_KEY;
process.env.MY_CUSTOM_KEY = "sk-custom-secretref-env"; // pragma: allowlist secret
try {
const resolved = resolveUsableCustomProviderApiKey({
cfg: {
secrets: {
providers: {
"custom-env": {
source: "env",
allowlist: ["OPENAI_API_KEY"],
},
},
},
models: {
providers: {
custom: {
baseUrl: "https://example.com/v1",
apiKey: {
source: "env",
provider: "custom-env",
id: "MY_CUSTOM_KEY",
},
models: [],
},
},
},
},
provider: "custom",
});
expect(resolved).toBeNull();
} finally {
if (previous === undefined) {
delete process.env.MY_CUSTOM_KEY;
} else {
process.env.MY_CUSTOM_KEY = previous;
}
}
});
it("does not resolve env SecretRefs when provider source is not env", () => {
const previous = process.env.MY_CUSTOM_KEY;
process.env.MY_CUSTOM_KEY = "sk-custom-secretref-env"; // pragma: allowlist secret
try {
const resolved = resolveUsableCustomProviderApiKey({
cfg: {
secrets: {
providers: {
"custom-env": {
source: "file",
path: "/tmp/secrets.json",
},
},
},
models: {
providers: {
custom: {
baseUrl: "https://example.com/v1",
apiKey: {
source: "env",
provider: "custom-env",
id: "MY_CUSTOM_KEY",
},
models: [],
},
},
},
},
provider: "custom",
});
expect(resolved).toBeNull();
} finally {
if (previous === undefined) {
delete process.env.MY_CUSTOM_KEY;
} else {
process.env.MY_CUSTOM_KEY = previous;
}
}
});
it("does not treat env SecretRefs with missing unknown env IDs as usable", () => {
const previous = process.env.MY_CUSTOM_KEY;
delete process.env.MY_CUSTOM_KEY;
try {
expect(
hasUsableCustomProviderApiKey(
{
models: {
providers: {
custom: {
baseUrl: "https://example.com/v1",
apiKey: {
source: "env",
provider: "default",
id: "MY_CUSTOM_KEY",
},
models: [],
},
},
},
},
"custom",
),
).toBe(false);
} finally {
if (previous === undefined) {
delete process.env.MY_CUSTOM_KEY;
} else {
process.env.MY_CUSTOM_KEY = previous;
}
}
});
it("does not treat non-env SecretRefs as usable models.json credentials", () => {
const resolved = resolveUsableCustomProviderApiKey({
cfg: {
models: {
providers: {
custom: {
baseUrl: "https://example.com/v1",
apiKey: {
source: "file",
provider: "vault",
id: "custom-provider-key",
},
models: [],
},
},
},
},
provider: "custom",
});
expect(resolved).toBeNull();
});
it("does not treat known env marker names as usable when env value is missing", () => {
const previous = process.env.OPENAI_API_KEY;
delete process.env.OPENAI_API_KEY;
try {
expect(
hasUsableCustomProviderApiKey(
{
models: {
providers: {
custom: {
baseUrl: "https://example.com/v1",
apiKey: "OPENAI_API_KEY",
models: [],
},
},
},
},
"custom",
),
).toBe(false);
} finally {
if (previous === undefined) {
delete process.env.OPENAI_API_KEY;
} else {
process.env.OPENAI_API_KEY = previous;
}
}
});
});
describe("resolveApiKeyForProvider", () => {
it("reuses plugin fallback auth without a models.providers entry", async () => {
const resolved = await withoutEnv("PLUGIN_WEB_API_KEY", () =>
resolveApiKeyForProvider({
provider: "plugin-web",
cfg: {
plugins: {
entries: {
"plugin-web": {
config: {
webSearch: {
apiKey: "plugin-web-fallback-key", // pragma: allowlist secret
},
},
},
},
},
},
store: { version: 1, profiles: {} },
}),
);
expectAuthFields(resolved, {
apiKey: "plugin-web-fallback-key",
source: "plugins.entries.plugin-web.config.webSearch.apiKey",
mode: "api-key",
});
});
it("prefers the active runtime snapshot for SecretRef-backed plugin fallback auth", async () => {
const sourceConfig = {
plugins: {
entries: {
"plugin-web": {
config: {
webSearch: {
apiKey: { source: "file", provider: "vault", id: "/plugin-web/api-key" },
},
},
},
},
},
};
const runtimeConfig = {
plugins: {
entries: {
"plugin-web": {
config: {
webSearch: {
apiKey: "plugin-web-runtime-key", // pragma: allowlist secret
},
},
},
},
},
};
setRuntimeConfigSnapshot(runtimeConfig, sourceConfig);
const resolved = await withoutEnv("PLUGIN_WEB_API_KEY", () =>
resolveApiKeyForProvider({
provider: "plugin-web",
cfg: sourceConfig,
store: { version: 1, profiles: {} },
}),
);
expectAuthFields(resolved, {
apiKey: "plugin-web-runtime-key",
source: "plugins.entries.plugin-web.config.webSearch.apiKey",
mode: "api-key",
});
});
it("does not reuse plugin fallback auth when the plugin is disabled", async () => {
await expect(
withoutEnv("PLUGIN_WEB_API_KEY", () =>
resolveApiKeyForProvider({
provider: "plugin-web",
cfg: {
plugins: {
entries: {
"plugin-web": {
enabled: false,
config: {
webSearch: {
apiKey: "plugin-web-fallback-key", // pragma: allowlist secret
},
},
},
},
},
},
store: { version: 1, profiles: {} },
}),
),
).rejects.toThrow('No API key found for provider "plugin-web"');
});
it("reuses plugin-owned native CLI auth", async () => {
const resolved = await resolveApiKeyForProvider({
provider: "native-cli",
cfg: {
agents: {
defaults: {
model: {
primary: "native-cli/demo-model",
},
},
},
},
store: { version: 1, profiles: {} },
});
expect(resolved).toEqual({
apiKey: "native-cli-access-token",
source: "Native CLI auth",
mode: "oauth",
});
});
it("prefers explicit api-key provider config over ambient auth profiles", async () => {
const resolved = await resolveApiKeyForProvider({
provider: "openai",
cfg: {
models: {
providers: {
openai: {
api: "openai-responses",
auth: "api-key",
apiKey: "sk-config-live", // pragma: allowlist secret
baseUrl: "https://api.openai.com/v1",
models: [],
},
},
},
},
store: {
version: 1,
profiles: {
"openai:default": {
type: "api_key",
provider: "openai",
key: "sk-profile-stale", // pragma: allowlist secret
},
},
},
});
expectAuthFields(resolved, {
apiKey: "sk-config-live",
source: "models.json",
mode: "api-key",
});
});
it("prefers non-secret local env markers over ambient profiles", async () => {
const resolved = await withEnv("OLLAMA_API_KEY", "ollama-local", () =>
resolveApiKeyForProvider({
provider: "ollama",
store: {
version: 1,
profiles: {
"ollama:default": {
type: "api_key",
provider: "ollama",
key: "ollama-cloud-profile", // pragma: allowlist secret
},
},
},
}),
);
expectAuthFields(resolved, {
apiKey: "ollama-local",
mode: "api-key",
});
expect(resolved.source).toContain("OLLAMA_API_KEY");
});
});
describe("resolveApiKeyForProvider synthetic local auth for custom providers", () => {
it("recognizes local baseUrl variants for synthetic auth config", () => {
const localBaseUrls = [
"http://127.0.0.1:8080/v1",
"http://192.168.0.222:11434/v1",
"http://localhost:11434/v1",
"http://[::1]:8080/v1",
"http://0.0.0.0:11434/v1",
"http://[::ffff:127.0.0.1]:8080/v1",
];
for (const baseUrl of localBaseUrls) {
expect(
hasSyntheticLocalProviderAuthConfig({
provider: "custom-local",
cfg: {
models: {
providers: {
"custom-local": createCustomProviderConfig(baseUrl),
},
},
},
}),
baseUrl,
).toBe(true);
}
});
it("synthesizes a local auth marker for custom providers with a local baseUrl and no apiKey", async () => {
const auth = await resolveCustomProviderAuth(
"custom-127-0-0-1-8080",
"http://127.0.0.1:8080/v1",
"qwen-3.5",
"Qwen 3.5",
);
expect(auth.apiKey).toBe(CUSTOM_LOCAL_AUTH_MARKER);
expect(auth.source).toContain("synthetic local key");
});
it("does not synthesize auth for remote custom providers without apiKey", async () => {
expect(
hasSyntheticLocalProviderAuthConfig({
provider: "my-remote",
cfg: {
models: {
providers: {
"my-remote": createCustomProviderConfig("https://api.example.com/v1"),
},
},
},
}),
).toBe(false);
await expect(
resolveApiKeyForProvider({
provider: "my-remote",
cfg: {
models: {
providers: {
"my-remote": {
baseUrl: "https://api.example.com/v1",
api: "openai-completions",
models: [
{
id: "gpt-5",
name: "GPT-5",
reasoning: false,
input: ["text"],
cost: { input: 0, output: 0, cacheRead: 0, cacheWrite: 0 },
contextWindow: 8192,
maxTokens: 4096,
},
],
},
},
},
},
}),
).rejects.toThrow("No API key found");
});
it("preserves custom named Ollama providers with explicit local marker auth", async () => {
const auth = await resolveApiKeyForProvider({
provider: "ollama-remote",
cfg: {
models: {
providers: {
"ollama-remote": {
baseUrl: "http://192.168.178.122:11434",
api: "ollama",
apiKey: "ollama-local",
models: [
{
id: "qwen3.5:27b",
name: "Qwen 3.5 27B",
reasoning: false,
input: ["text"],
cost: { input: 0, output: 0, cacheRead: 0, cacheWrite: 0 },
contextWindow: 8192,
maxTokens: 4096,
},
],
},
},
},
},
store: { version: 1, profiles: {} },
});
expectAuthFields(auth, {
apiKey: "ollama-local",
source: "models.json (local marker)",
mode: "api-key",
});
});
it("uses Ollama plugin synthetic auth for custom private provider ids without apiKey", async () => {
const auth = await resolveApiKeyForProvider({
provider: "ollama-gpu1",
cfg: {
models: {
providers: {
"ollama-gpu1": {
baseUrl: "http://192.168.178.122:11435",
api: "ollama",
models: [
{
id: "qwen3:14b",
name: "Qwen 3 14B",
reasoning: true,
input: ["text"],
cost: { input: 0, output: 0, cacheRead: 0, cacheWrite: 0 },
contextWindow: 16384,
maxTokens: 4096,
},
],
},
},
},
},
store: { version: 1, profiles: {} },
});
expectAuthFields(auth, {
apiKey: "ollama-local",
source: "models.providers.ollama-gpu1 (synthetic local key)",
mode: "api-key",
});
});
it("resolves synthetic auth when model overrides api to ollama within a non-ollama provider", async () => {
const auth = await getApiKeyForModel({
model: {
id: "my-router/local-llama",
name: "Local Llama",
provider: "my-router",
api: "ollama",
baseUrl: "http://localhost:11434",
reasoning: false,
input: ["text"],
cost: { input: 0, output: 0, cacheRead: 0, cacheWrite: 0 },
contextWindow: 8192,
maxTokens: 4096,
},
cfg: {
models: {
providers: {
"my-router": {
baseUrl: "http://localhost:8080/v1",
api: "openai-completions",
models: [
{
id: "my-router/local-llama",
name: "Local Llama",
api: "ollama",
baseUrl: "http://localhost:11434",
reasoning: false,
input: ["text"],
cost: { input: 0, output: 0, cacheRead: 0, cacheWrite: 0 },
contextWindow: 8192,
maxTokens: 4096,
},
],
},
},
},
},
store: { version: 1, profiles: {} },
});
expectAuthFields(auth, {
apiKey: "ollama-local",
source: "models.providers.my-router (synthetic local key)",
mode: "api-key",
});
});
it("accepts non-secret local markers for private LAN custom OpenAI-compatible providers", async () => {
const auth = await resolveApiKeyForProvider({
provider: "custom-192-168-0-222-11434",
cfg: {
models: {
providers: {
"custom-192-168-0-222-11434": {
baseUrl: "http://192.168.0.222:11434/v1",
api: "openai-completions",
apiKey: "ollama-local",
models: [
{
id: "qwen3.5:9b",
name: "Qwen 3.5 9B",
reasoning: false,
input: ["text"],
cost: { input: 0, output: 0, cacheRead: 0, cacheWrite: 0 },
contextWindow: 8192,
maxTokens: 4096,
},
],
},
},
},
},
store: { version: 1, profiles: {} },
});
expectAuthFields(auth, {
apiKey: CUSTOM_LOCAL_AUTH_MARKER,
source: "models.json (local marker)",
mode: "api-key",
});
});
it.each(["docker.orb.internal", "host.docker.internal", "host.orb.internal"])(
"accepts ollama-local marker auth for host-backed alias %s",
async (hostname) => {
const auth = await resolveApiKeyForProvider({
provider: "ollama",
cfg: {
models: {
providers: {
ollama: {
baseUrl: `http://${hostname}:11434`,
api: "ollama",
apiKey: "ollama-local",
models: [
{
id: "qwen3.5:27b",
name: "Qwen 3.5 27B",
reasoning: false,
input: ["text"],
cost: { input: 0, output: 0, cacheRead: 0, cacheWrite: 0 },
contextWindow: 262144,
maxTokens: 8192,
},
],
},
},
},
},
store: { version: 1, profiles: {} },
});
expectAuthFields(auth, {
apiKey: "ollama-local",
source: "models.json (local marker)",
mode: "api-key",
});
},
);
it("does not accept non-secret local markers for remote custom providers", async () => {
await expect(
resolveApiKeyForProvider({
provider: "custom-remote",
cfg: {
models: {
providers: {
"custom-remote": {
baseUrl: "https://api.example.com/v1",
api: "openai-completions",
apiKey: "ollama-local",
models: [
{
id: "qwen3.5:9b",
name: "Qwen 3.5 9B",
reasoning: false,
input: ["text"],
cost: { input: 0, output: 0, cacheRead: 0, cacheWrite: 0 },
contextWindow: 8192,
maxTokens: 4096,
},
],
},
},
},
},
store: { version: 1, profiles: {} },
}),
).rejects.toThrow('No API key found for provider "custom-remote"');
});
it("does not synthesize local auth when apiKey is explicitly configured but unresolved", async () => {
const previous = process.env.OPENAI_API_KEY;
delete process.env.OPENAI_API_KEY;
try {
await expect(
resolveApiKeyForProvider({
provider: "custom",
cfg: {
models: {
providers: {
custom: {
baseUrl: "http://127.0.0.1:8080/v1",
api: "openai-completions",
apiKey: "OPENAI_API_KEY",
models: [
{
id: "llama3",
name: "Llama 3",
reasoning: false,
input: ["text"],
cost: { input: 0, output: 0, cacheRead: 0, cacheWrite: 0 },
contextWindow: 8192,
maxTokens: 4096,
},
],
},
},
},
},
}),
).rejects.toThrow('No API key found for provider "custom"');
} finally {
if (previous === undefined) {
delete process.env.OPENAI_API_KEY;
} else {
process.env.OPENAI_API_KEY = previous;
}
}
});
it("does not synthesize local auth when auth mode explicitly requires oauth", async () => {
await expect(
resolveApiKeyForProvider({
provider: "custom",
cfg: {
models: {
providers: {
custom: {
baseUrl: "http://127.0.0.1:8080/v1",
api: "openai-completions",
auth: "oauth",
models: [
{
id: "llama3",
name: "Llama 3",
reasoning: false,
input: ["text"],
cost: { input: 0, output: 0, cacheRead: 0, cacheWrite: 0 },
contextWindow: 8192,
maxTokens: 4096,
},
],
},
},
},
},
}),
).rejects.toThrow('No API key found for provider "custom"');
});
it("uses explicit aws-sdk auth for local baseUrl overrides", async () => {
const auth = await resolveApiKeyForProvider({
provider: "amazon-bedrock",
cfg: {
models: {
providers: {
"amazon-bedrock": {
baseUrl: "http://127.0.0.1:8080/v1",
models: [],
auth: "aws-sdk",
},
},
},
},
});
expect(auth.mode).toBe("aws-sdk");
expect(auth.apiKey).toBeUndefined();
});
it("uses implicit aws-sdk auth for built-in Bedrock Converse models", async () => {
const auth = await getApiKeyForModel({
model: {
id: "us.anthropic.claude-sonnet-4-6-v1",
name: "Claude Sonnet",
provider: "amazon-bedrock",
api: "bedrock-converse-stream",
baseUrl: "https://bedrock-runtime.us-east-1.amazonaws.com",
reasoning: true,
input: ["text"],
cost: { input: 0, output: 0, cacheRead: 0, cacheWrite: 0 },
contextWindow: 200000,
maxTokens: 8192,
},
store: { version: 1, profiles: {} },
});
expect(auth.mode).toBe("aws-sdk");
expect(auth.apiKey).toBeUndefined();
});
});
describe("applyLocalNoAuthHeaderOverride", () => {
afterEach(() => {
vi.restoreAllMocks();
});
it("marks synthetic local OpenAI-compatible auth so SDK request headers clear Authorization", () => {
const model = applyLocalNoAuthHeaderOverride(
{
id: "local-llm",
name: "local-llm",
api: "openai-completions",
provider: "custom",
baseUrl: "http://127.0.0.1:8080/v1",
reasoning: false,
input: ["text"],
cost: { input: 0, output: 0, cacheRead: 0, cacheWrite: 0 },
contextWindow: 8192,
maxTokens: 4096,
headers: { "X-Test": "1" },
} as Model<"openai-completions">,
{
apiKey: CUSTOM_LOCAL_AUTH_MARKER,
source: "models.providers.custom (synthetic local key)",
mode: "api-key",
},
);
expect(model.headers?.Authorization).toBeNull();
expect(model.headers?.["X-Test"]).toBe("1");
});
});
describe("applyAuthHeaderOverride", () => {
const baseModel: Model<"openai-completions"> = {
id: "gemini-3.1-flash-lite",
name: "gemini-3.1-flash-lite",
api: "openai-completions" as const,
provider: "google",
baseUrl: "https://generativelanguage.googleapis.com/v1beta/openai",
reasoning: false,
input: ["text"] as ("text" | "image")[],
cost: { input: 0, output: 0, cacheRead: 0, cacheWrite: 0 },
contextWindow: 131072,
maxTokens: 8192,
};
it("injects Authorization Bearer header when authHeader is true", () => {
const result = applyAuthHeaderOverride(
baseModel,
{ apiKey: "test-api-key", source: "env", mode: "api-key" },
{
models: {
providers: {
google: {
baseUrl: "https://generativelanguage.googleapis.com/v1beta/openai",
api: "openai-completions",
authHeader: true,
models: [],
},
},
},
},
);
expect(result.headers).toEqual({ Authorization: "Bearer test-api-key" });
});
it("preserves existing model headers when injecting Authorization", () => {
const result = applyAuthHeaderOverride(
{ ...baseModel, headers: { "X-Custom": "value" } },
{ apiKey: "test-api-key", source: "env", mode: "api-key" },
{
models: {
providers: {
google: {
baseUrl: "https://generativelanguage.googleapis.com/v1beta/openai",
api: "openai-completions",
authHeader: true,
models: [],
},
},
},
},
);
expect(result.headers).toEqual({
"X-Custom": "value",
Authorization: "Bearer test-api-key",
});
});
it("returns model unchanged when authHeader is not set", () => {
const result = applyAuthHeaderOverride(
baseModel,
{ apiKey: "test-api-key", source: "env", mode: "api-key" },
{
models: {
providers: {
google: {
baseUrl: "https://generativelanguage.googleapis.com/v1beta/openai",
api: "openai-completions",
models: [],
},
},
},
},
);
expect(result).toBe(baseModel);
});
it("returns model unchanged when authHeader is false", () => {
const result = applyAuthHeaderOverride(
baseModel,
{ apiKey: "test-api-key", source: "env", mode: "api-key" },
{
models: {
providers: {
google: {
baseUrl: "https://generativelanguage.googleapis.com/v1beta/openai",
api: "openai-completions",
authHeader: false,
models: [],
},
},
},
},
);
expect(result).toBe(baseModel);
});
it("returns model unchanged when no API key is available", () => {
const result = applyAuthHeaderOverride(baseModel, null, {
models: {
providers: {
google: {
baseUrl: "https://generativelanguage.googleapis.com/v1beta/openai",
api: "openai-completions",
authHeader: true,
models: [],
},
},
},
});
expect(result).toBe(baseModel);
});
it("returns model unchanged when provider config is missing", () => {
const result = applyAuthHeaderOverride(
baseModel,
{ apiKey: "test-api-key", source: "env", mode: "api-key" },
undefined,
);
expect(result).toBe(baseModel);
});
it("rejects synthetic marker API keys", () => {
const result = applyAuthHeaderOverride(
baseModel,
{ apiKey: CUSTOM_LOCAL_AUTH_MARKER, source: "synthetic", mode: "api-key" },
{
models: {
providers: {
google: {
baseUrl: "https://generativelanguage.googleapis.com/v1beta/openai",
api: "openai-completions",
authHeader: true,
models: [],
},
},
},
},
);
expect(result).toBe(baseModel);
});
it("strips existing authorization header case-insensitively before injection", () => {
const result = applyAuthHeaderOverride(
{ ...baseModel, headers: { authorization: "old-value", "X-Custom": "keep" } },
{ apiKey: "test-api-key", source: "env", mode: "api-key" },
{
models: {
providers: {
google: {
baseUrl: "https://generativelanguage.googleapis.com/v1beta/openai",
api: "openai-completions",
authHeader: true,
models: [],
},
},
},
},
);
expect(result.headers).toEqual({
"X-Custom": "keep",
Authorization: "Bearer test-api-key",
});
});
});