diff --git a/test/helpers/plugins/provider-contract-suites.ts b/test/helpers/plugins/provider-contract-suites.ts new file mode 100644 index 00000000000..0961e8202b6 --- /dev/null +++ b/test/helpers/plugins/provider-contract-suites.ts @@ -0,0 +1,198 @@ +import { expect, it } from "vitest"; +import type { OpenClawConfig } from "../../../src/config/config.js"; +import type { + ProviderPlugin, + WebFetchProviderPlugin, + WebSearchProviderPlugin, +} from "../../../src/plugins/types.js"; + +type Lazy = T | (() => T); + +function resolveLazy(value: Lazy): T { + return typeof value === "function" ? (value as () => T)() : value; +} + +export function installProviderPluginContractSuite(params: { provider: Lazy }) { + it("satisfies the base provider plugin contract", () => { + const provider = resolveLazy(params.provider); + const authIds = provider.auth.map((method) => method.id); + const wizardChoiceIds = new Set(); + + expect(provider.id).toMatch(/^[a-z0-9][a-z0-9-]*$/); + expect(provider.label.trim()).not.toBe(""); + + if (provider.docsPath) { + expect(provider.docsPath.startsWith("/")).toBe(true); + } + if (provider.aliases) { + expect(provider.aliases).toEqual([...new Set(provider.aliases)]); + } + if (provider.envVars) { + expect(provider.envVars).toEqual([...new Set(provider.envVars)]); + expect(provider.envVars.every((entry) => entry.trim().length > 0)).toBe(true); + } + + expect(Array.isArray(provider.auth)).toBe(true); + expect(authIds).toEqual([...new Set(authIds)]); + for (const method of provider.auth) { + expect(method.id.trim()).not.toBe(""); + expect(method.label.trim()).not.toBe(""); + if (method.hint !== undefined) { + expect(method.hint.trim()).not.toBe(""); + } + if (method.wizard) { + if (method.wizard.choiceId) { + expect(method.wizard.choiceId.trim()).not.toBe(""); + expect(wizardChoiceIds.has(method.wizard.choiceId)).toBe(false); + wizardChoiceIds.add(method.wizard.choiceId); + } + if (method.wizard.methodId) { + expect(authIds).toContain(method.wizard.methodId); + } + if (method.wizard.modelAllowlist?.allowedKeys) { + expect(method.wizard.modelAllowlist.allowedKeys).toEqual([ + ...new Set(method.wizard.modelAllowlist.allowedKeys), + ]); + } + if (method.wizard.modelAllowlist?.initialSelections) { + expect(method.wizard.modelAllowlist.initialSelections).toEqual([ + ...new Set(method.wizard.modelAllowlist.initialSelections), + ]); + } + } + expect(typeof method.run).toBe("function"); + } + + if (provider.wizard?.setup || provider.wizard?.modelPicker) { + expect(provider.auth.length).toBeGreaterThan(0); + } + if (provider.wizard?.setup) { + if (provider.wizard.setup.choiceId) { + expect(provider.wizard.setup.choiceId.trim()).not.toBe(""); + expect(wizardChoiceIds.has(provider.wizard.setup.choiceId)).toBe(false); + } + if (provider.wizard.setup.methodId) { + expect(authIds).toContain(provider.wizard.setup.methodId); + } + if (provider.wizard.setup.modelAllowlist?.allowedKeys) { + expect(provider.wizard.setup.modelAllowlist.allowedKeys).toEqual([ + ...new Set(provider.wizard.setup.modelAllowlist.allowedKeys), + ]); + } + if (provider.wizard.setup.modelAllowlist?.initialSelections) { + expect(provider.wizard.setup.modelAllowlist.initialSelections).toEqual([ + ...new Set(provider.wizard.setup.modelAllowlist.initialSelections), + ]); + } + } + if (provider.wizard?.modelPicker?.methodId) { + expect(authIds).toContain(provider.wizard.modelPicker.methodId); + } + }); +} + +export function installWebSearchProviderContractSuite(params: { + provider: Lazy; + credentialValue: Lazy; +}) { + it("satisfies the base web search provider contract", () => { + const provider = resolveLazy(params.provider); + const credentialValue = resolveLazy(params.credentialValue); + + expect(provider.id).toMatch(/^[a-z0-9][a-z0-9-]*$/); + expect(provider.label.trim()).not.toBe(""); + expect(provider.hint.trim()).not.toBe(""); + expect(provider.placeholder.trim()).not.toBe(""); + expect(provider.signupUrl.startsWith("https://")).toBe(true); + if (provider.docsUrl) { + expect(provider.docsUrl.startsWith("http")).toBe(true); + } + + expect(provider.envVars).toEqual([...new Set(provider.envVars)]); + expect(provider.envVars.every((entry) => entry.trim().length > 0)).toBe(true); + + const searchConfigTarget: Record = {}; + provider.setCredentialValue(searchConfigTarget, credentialValue); + expect(provider.getCredentialValue(searchConfigTarget)).toEqual(credentialValue); + + const config = { + tools: { + web: { + search: { + provider: provider.id, + ...searchConfigTarget, + }, + }, + }, + } as OpenClawConfig; + const tool = provider.createTool({ config, searchConfig: searchConfigTarget }); + + expect(tool).not.toBeNull(); + expect(tool?.description.trim()).not.toBe(""); + expect(tool?.parameters).toEqual(expect.any(Object)); + expect(typeof tool?.execute).toBe("function"); + if (provider.runSetup) { + expect(typeof provider.runSetup).toBe("function"); + } + }); +} + +export function installWebFetchProviderContractSuite(params: { + provider: Lazy; + credentialValue: Lazy; + pluginId?: string; +}) { + it("satisfies the base web fetch provider contract", () => { + const provider = resolveLazy(params.provider); + const credentialValue = resolveLazy(params.credentialValue); + + expect(provider.id).toMatch(/^[a-z0-9][a-z0-9-]*$/); + expect(provider.label.trim()).not.toBe(""); + expect(provider.hint.trim()).not.toBe(""); + expect(provider.placeholder.trim()).not.toBe(""); + expect(provider.signupUrl.startsWith("https://")).toBe(true); + if (provider.docsUrl) { + expect(provider.docsUrl.startsWith("http")).toBe(true); + } + + expect(provider.envVars).toEqual([...new Set(provider.envVars)]); + expect(provider.envVars.every((entry) => entry.trim().length > 0)).toBe(true); + expect(provider.credentialPath.trim()).not.toBe(""); + if (provider.inactiveSecretPaths) { + expect(provider.inactiveSecretPaths).toEqual([...new Set(provider.inactiveSecretPaths)]); + expect(provider.inactiveSecretPaths).toContain(provider.credentialPath); + } + + const fetchConfigTarget: Record = {}; + provider.setCredentialValue(fetchConfigTarget, credentialValue); + expect(provider.getCredentialValue(fetchConfigTarget)).toEqual(credentialValue); + + if (provider.setConfiguredCredentialValue && provider.getConfiguredCredentialValue) { + const configTarget = {} as OpenClawConfig; + provider.setConfiguredCredentialValue(configTarget, credentialValue); + expect(provider.getConfiguredCredentialValue(configTarget)).toEqual(credentialValue); + } + + if (provider.applySelectionConfig && params.pluginId) { + const applied = provider.applySelectionConfig({} as OpenClawConfig); + expect(applied.plugins?.entries?.[params.pluginId]?.enabled).toBe(true); + } + + const config = { + tools: { + web: { + fetch: { + provider: provider.id, + ...fetchConfigTarget, + }, + }, + }, + } as OpenClawConfig; + const tool = provider.createTool({ config, fetchConfig: fetchConfigTarget }); + + expect(tool).not.toBeNull(); + expect(tool?.description.trim()).not.toBe(""); + expect(tool?.parameters).toEqual(expect.any(Object)); + expect(typeof tool?.execute).toBe("function"); + }); +} diff --git a/test/helpers/plugins/provider-contract.ts b/test/helpers/plugins/provider-contract.ts index a0cb4756024..00caf0e7646 100644 --- a/test/helpers/plugins/provider-contract.ts +++ b/test/helpers/plugins/provider-contract.ts @@ -5,7 +5,7 @@ import { requireProviderContractProvider, resolveProviderContractProvidersForPluginIds, } from "../../../src/plugins/contracts/registry.js"; -import { installProviderPluginContractSuite } from "../../../src/plugins/contracts/suites.js"; +import { installProviderPluginContractSuite } from "./provider-contract-suites.js"; export function describeProviderContracts(pluginId: string) { const providerIds = diff --git a/test/helpers/plugins/web-fetch-provider-contract.ts b/test/helpers/plugins/web-fetch-provider-contract.ts index 311e999711b..34298a65441 100644 --- a/test/helpers/plugins/web-fetch-provider-contract.ts +++ b/test/helpers/plugins/web-fetch-provider-contract.ts @@ -3,7 +3,7 @@ import { pluginRegistrationContractRegistry, resolveWebFetchProviderContractEntriesForPluginId, } from "../../../src/plugins/contracts/registry.js"; -import { installWebFetchProviderContractSuite } from "../../../src/plugins/contracts/suites.js"; +import { installWebFetchProviderContractSuite } from "./provider-contract-suites.js"; export function describeWebFetchProviderContracts(pluginId: string) { const providerIds = diff --git a/test/helpers/plugins/web-search-provider-contract.ts b/test/helpers/plugins/web-search-provider-contract.ts index d07f0dfa611..d4bcdf84968 100644 --- a/test/helpers/plugins/web-search-provider-contract.ts +++ b/test/helpers/plugins/web-search-provider-contract.ts @@ -3,7 +3,7 @@ import { pluginRegistrationContractRegistry, resolveWebSearchProviderContractEntriesForPluginId, } from "../../../src/plugins/contracts/registry.js"; -import { installWebSearchProviderContractSuite } from "../../../src/plugins/contracts/suites.js"; +import { installWebSearchProviderContractSuite } from "./provider-contract-suites.js"; export function describeWebSearchProviderContracts(pluginId: string) { const providerIds =