mirror of
https://github.com/openclaw/openclaw.git
synced 2026-05-09 09:07:39 +00:00
* feat: add LiteLLM provider types, env var, credentials, and auth choice Add litellm-api-key auth choice, LITELLM_API_KEY env var mapping, setLitellmApiKey() credential storage, and LITELLM_DEFAULT_MODEL_REF. * feat: add LiteLLM onboarding handler and provider config Add applyLitellmProviderConfig which properly registers models.providers.litellm with baseUrl, api type, and model definitions. This fixes the critical bug from PR #6488 where the provider entry was never created, causing model resolution to fail at runtime. * docs: add LiteLLM provider documentation Add setup guide covering onboarding, manual config, virtual keys, model routing, and usage tracking. Link from provider index. * docs: add LiteLLM to sidebar navigation in docs.json Add providers/litellm to both English and Chinese provider page lists so the docs page appears in the sidebar navigation. * test: add LiteLLM non-interactive onboarding test Wire up litellmApiKey flag inference and auth-choice handler for the non-interactive onboarding path, and add an integration test covering profile, model default, and credential storage. * fix: register --litellm-api-key CLI flag and add preferred provider mapping Wire up the missing Commander CLI option, action handler mapping, and help text for --litellm-api-key. Add litellm-api-key to the preferred provider map for consistency with other providers. * fix: remove zh-CN sidebar entry for litellm (no localized page yet) * style: format buildLitellmModelDefinition return type * fix(onboarding): harden LiteLLM provider setup (#12823) * refactor(onboarding): keep auth-choice provider dispatcher under size limit --------- Co-authored-by: Peter Steinberger <steipete@gmail.com>
92 lines
3.4 KiB
TypeScript
92 lines
3.4 KiB
TypeScript
import fs from "node:fs/promises";
|
|
import os from "node:os";
|
|
import path from "node:path";
|
|
import { describe, expect, it, vi } from "vitest";
|
|
|
|
describe("onboard (non-interactive): LiteLLM", () => {
|
|
it("stores the API key and configures the default model", async () => {
|
|
const prev = {
|
|
home: process.env.HOME,
|
|
stateDir: process.env.OPENCLAW_STATE_DIR,
|
|
configPath: process.env.OPENCLAW_CONFIG_PATH,
|
|
skipChannels: process.env.OPENCLAW_SKIP_CHANNELS,
|
|
skipGmail: process.env.OPENCLAW_SKIP_GMAIL_WATCHER,
|
|
skipCron: process.env.OPENCLAW_SKIP_CRON,
|
|
skipCanvas: process.env.OPENCLAW_SKIP_CANVAS_HOST,
|
|
token: process.env.OPENCLAW_GATEWAY_TOKEN,
|
|
password: process.env.OPENCLAW_GATEWAY_PASSWORD,
|
|
};
|
|
|
|
process.env.OPENCLAW_SKIP_CHANNELS = "1";
|
|
process.env.OPENCLAW_SKIP_GMAIL_WATCHER = "1";
|
|
process.env.OPENCLAW_SKIP_CRON = "1";
|
|
process.env.OPENCLAW_SKIP_CANVAS_HOST = "1";
|
|
delete process.env.OPENCLAW_GATEWAY_TOKEN;
|
|
delete process.env.OPENCLAW_GATEWAY_PASSWORD;
|
|
|
|
const tempHome = await fs.mkdtemp(path.join(os.tmpdir(), "openclaw-onboard-litellm-"));
|
|
process.env.HOME = tempHome;
|
|
process.env.OPENCLAW_STATE_DIR = tempHome;
|
|
process.env.OPENCLAW_CONFIG_PATH = path.join(tempHome, "openclaw.json");
|
|
vi.resetModules();
|
|
|
|
const runtime = {
|
|
log: () => {},
|
|
error: (msg: string) => {
|
|
throw new Error(msg);
|
|
},
|
|
exit: (code: number) => {
|
|
throw new Error(`exit:${code}`);
|
|
},
|
|
};
|
|
|
|
try {
|
|
const { runNonInteractiveOnboarding } = await import("./onboard-non-interactive.js");
|
|
await runNonInteractiveOnboarding(
|
|
{
|
|
nonInteractive: true,
|
|
authChoice: "litellm-api-key",
|
|
litellmApiKey: "litellm-test-key",
|
|
skipHealth: true,
|
|
skipChannels: true,
|
|
skipSkills: true,
|
|
json: true,
|
|
},
|
|
runtime,
|
|
);
|
|
|
|
const { CONFIG_PATH } = await import("../config/config.js");
|
|
const cfg = JSON.parse(await fs.readFile(CONFIG_PATH, "utf8")) as {
|
|
auth?: {
|
|
profiles?: Record<string, { provider?: string; mode?: string }>;
|
|
};
|
|
agents?: { defaults?: { model?: { primary?: string } } };
|
|
};
|
|
|
|
expect(cfg.auth?.profiles?.["litellm:default"]?.provider).toBe("litellm");
|
|
expect(cfg.auth?.profiles?.["litellm:default"]?.mode).toBe("api_key");
|
|
expect(cfg.agents?.defaults?.model?.primary).toBe("litellm/claude-opus-4-6");
|
|
|
|
const { ensureAuthProfileStore } = await import("../agents/auth-profiles.js");
|
|
const store = ensureAuthProfileStore();
|
|
const profile = store.profiles["litellm:default"];
|
|
expect(profile?.type).toBe("api_key");
|
|
if (profile?.type === "api_key") {
|
|
expect(profile.provider).toBe("litellm");
|
|
expect(profile.key).toBe("litellm-test-key");
|
|
}
|
|
} finally {
|
|
await fs.rm(tempHome, { recursive: true, force: true });
|
|
process.env.HOME = prev.home;
|
|
process.env.OPENCLAW_STATE_DIR = prev.stateDir;
|
|
process.env.OPENCLAW_CONFIG_PATH = prev.configPath;
|
|
process.env.OPENCLAW_SKIP_CHANNELS = prev.skipChannels;
|
|
process.env.OPENCLAW_SKIP_GMAIL_WATCHER = prev.skipGmail;
|
|
process.env.OPENCLAW_SKIP_CRON = prev.skipCron;
|
|
process.env.OPENCLAW_SKIP_CANVAS_HOST = prev.skipCanvas;
|
|
process.env.OPENCLAW_GATEWAY_TOKEN = prev.token;
|
|
process.env.OPENCLAW_GATEWAY_PASSWORD = prev.password;
|
|
}
|
|
}, 60_000);
|
|
});
|