Pular para o conteúdo principal

Documentation Index

Fetch the complete documentation index at: https://docs.openclaw.ai/llms.txt

Use this file to discover all available pages before exploring further.

Referência para utilitários, padrões e aplicação de lint de testes para Plugins do OpenClaw.
Procurando exemplos de testes? Os guias práticos incluem exemplos de teste completos: Testes de Plugin de canal e Testes de Plugin de provedor.

Utilitários de teste

Estes subcaminhos de auxiliares de teste são entrypoints de código-fonte locais do repositório para os próprios testes de Plugins integrados do OpenClaw. Eles não são exportações de pacote para Plugins de terceiros. Importação do mock da API de Plugin: openclaw/plugin-sdk/plugin-test-api Importação do contrato de runtime do agente: openclaw/plugin-sdk/agent-runtime-test-contracts Importação do contrato de canal: openclaw/plugin-sdk/channel-contract-testing Importação do auxiliar de teste de canal: openclaw/plugin-sdk/channel-test-helpers Importação de teste de destino de canal: openclaw/plugin-sdk/channel-target-testing Importação do contrato de Plugin: openclaw/plugin-sdk/plugin-test-contracts Importação de teste de runtime de Plugin: openclaw/plugin-sdk/plugin-test-runtime Importação do contrato de provedor: openclaw/plugin-sdk/provider-test-contracts Importação do mock HTTP de provedor: openclaw/plugin-sdk/provider-http-test-mocks Importação de teste de ambiente/rede: openclaw/plugin-sdk/test-env Importação de fixture genérica: openclaw/plugin-sdk/test-fixtures Importação do mock de builtin do Node: openclaw/plugin-sdk/test-node-mocks Prefira os subcaminhos focados abaixo para novos testes de Plugin. O barrel amplo openclaw/plugin-sdk/testing existe apenas para compatibilidade legada. As proteções do repositório rejeitam novas importações reais de plugin-sdk/testing e plugin-sdk/test-utils; esses nomes permanecem apenas como superfícies de compatibilidade obsoletas para testes de registros de compatibilidade.
import {
  shouldAckReaction,
  removeAckReactionAfterReply,
} from "openclaw/plugin-sdk/channel-feedback";
import { installCommonResolveTargetErrorCases } from "openclaw/plugin-sdk/channel-target-testing";
import { AUTH_PROFILE_RUNTIME_CONTRACT } from "openclaw/plugin-sdk/agent-runtime-test-contracts";
import { createTestPluginApi } from "openclaw/plugin-sdk/plugin-test-api";
import { expectChannelInboundContextContract } from "openclaw/plugin-sdk/channel-contract-testing";
import { createStartAccountContext } from "openclaw/plugin-sdk/channel-test-helpers";
import { describePluginRegistrationContract } from "openclaw/plugin-sdk/plugin-test-contracts";
import { registerSingleProviderPlugin } from "openclaw/plugin-sdk/plugin-test-runtime";
import { describeOpenAIProviderRuntimeContract } from "openclaw/plugin-sdk/provider-test-contracts";
import { getProviderHttpMocks } from "openclaw/plugin-sdk/provider-http-test-mocks";
import { withEnv, withFetchPreconnect, withServer } from "openclaw/plugin-sdk/test-env";
import {
  bundledPluginRoot,
  createCliRuntimeCapture,
  typedCases,
} from "openclaw/plugin-sdk/test-fixtures";
import { mockNodeBuiltinModule } from "openclaw/plugin-sdk/test-node-mocks";

Exportações disponíveis

ExportaçãoFinalidade
createTestPluginApiCria um mock mínimo da API de Plugin para testes de unidade de registro direto. Importe de plugin-sdk/plugin-test-api
AUTH_PROFILE_RUNTIME_CONTRACTFixture compartilhada do contrato de perfil de autenticação para adaptadores de runtime de agente nativos. Importe de plugin-sdk/agent-runtime-test-contracts
DELIVERY_NO_REPLY_RUNTIME_CONTRACTFixture compartilhada do contrato de supressão de entrega para adaptadores de runtime de agente nativos. Importe de plugin-sdk/agent-runtime-test-contracts
OUTCOME_FALLBACK_RUNTIME_CONTRACTFixture compartilhada do contrato de classificação de fallback para adaptadores de runtime de agente nativos. Importe de plugin-sdk/agent-runtime-test-contracts
createParameterFreeToolCria fixtures de esquema de ferramenta dinâmica para testes de contrato de runtime nativo. Importe de plugin-sdk/agent-runtime-test-contracts
expectChannelInboundContextContractVerifica o formato do contexto de entrada do canal. Importe de plugin-sdk/channel-contract-testing
installChannelOutboundPayloadContractSuiteInstala casos de contrato de payload de saída do canal. Importe de plugin-sdk/channel-contract-testing
createStartAccountContextCria contextos de ciclo de vida de conta do canal. Importe de plugin-sdk/channel-test-helpers
installChannelActionsContractSuiteInstala casos genéricos de contrato de ação de mensagem do canal. Importe de plugin-sdk/channel-test-helpers
installChannelSetupContractSuiteInstala casos genéricos de contrato de configuração do canal. Importe de plugin-sdk/channel-test-helpers
installChannelStatusContractSuiteInstala casos genéricos de contrato de status do canal. Importe de plugin-sdk/channel-test-helpers
expectDirectoryIdsVerifica ids do diretório do canal a partir de uma função de listagem de diretório. Importe de plugin-sdk/channel-test-helpers
assertBundledChannelEntriesVerifica se os entrypoints de canal incluídos expõem o contrato público esperado. Importe de plugin-sdk/channel-test-helpers
formatEnvelopeTimestampFormata timestamps determinísticos de envelopes. Importe de plugin-sdk/channel-test-helpers
expectPairingReplyTextVerifica o texto de resposta de pareamento do canal e extrai seu código. Importe de plugin-sdk/channel-test-helpers
describePluginRegistrationContractInstala verificações de contrato de registro de Plugin. Importe de plugin-sdk/plugin-test-contracts
registerSingleProviderPluginRegistra um Plugin de provedor em testes smoke do carregador. Importe de plugin-sdk/plugin-test-runtime
registerProviderPluginCaptura todos os tipos de provedor de um Plugin. Importe de plugin-sdk/plugin-test-runtime
registerProviderPluginsCaptura registros de provedores entre múltiplos plugins. Importe de plugin-sdk/plugin-test-runtime
requireRegisteredProviderVerifica se uma coleção de provedores contém um id. Importe de plugin-sdk/plugin-test-runtime
createRuntimeEnvCria um ambiente de runtime de CLI/Plugin mockado. Importe de plugin-sdk/plugin-test-runtime
createPluginSetupWizardStatusCria auxiliares de status de configuração para plugins de canal. Importe de plugin-sdk/plugin-test-runtime
describeOpenAIProviderRuntimeContractInstala verificações de contrato de runtime da família de provedores. Importe de plugin-sdk/provider-test-contracts
expectPassthroughReplayPolicyVerifica se políticas de replay de provedor repassam ferramentas e metadados pertencentes ao provedor. Importe de plugin-sdk/provider-test-contracts
runRealtimeSttLiveTestExecuta um teste ao vivo de provedor STT em tempo real com fixtures de áudio compartilhadas. Importe de plugin-sdk/provider-test-contracts
normalizeTranscriptForMatchNormaliza a saída de transcrição ao vivo antes de asserções aproximadas. Importe de plugin-sdk/provider-test-contracts
expectExplicitVideoGenerationCapabilitiesVerifica se provedores de vídeo declaram capacidades explícitas de modo de geração. Importe de plugin-sdk/provider-test-contracts
expectExplicitMusicGenerationCapabilitiesVerifica se provedores de música declaram capacidades explícitas de geração/edição. Importe de plugin-sdk/provider-test-contracts
mockSuccessfulDashscopeVideoTaskInstala uma resposta bem-sucedida de tarefa de vídeo compatível com DashScope. Importe de plugin-sdk/provider-test-contracts
getProviderHttpMocksAcessa mocks Vitest HTTP/autenticação de provedor com adesão explícita. Importe de plugin-sdk/provider-http-test-mocks
installProviderHttpMockCleanupRedefine mocks HTTP/autenticação de provedor após cada teste. Importe de plugin-sdk/provider-http-test-mocks
installCommonResolveTargetErrorCasesCasos de teste compartilhados para tratamento de erros de resolução de destino. Importe de plugin-sdk/channel-target-testing
shouldAckReactionVerifica se um canal deve adicionar uma reação de confirmação. Importe de plugin-sdk/channel-feedback
removeAckReactionAfterReplyRemove a reação de confirmação após a entrega da resposta. Importe de plugin-sdk/channel-feedback
createTestRegistryCria uma fixture de registro de Plugin de canal. Importe de plugin-sdk/plugin-test-runtime ou plugin-sdk/channel-test-helpers
createEmptyPluginRegistryCria uma fixture de registro de Plugin vazio. Importe de plugin-sdk/plugin-test-runtime ou plugin-sdk/channel-test-helpers
setActivePluginRegistryInstala uma fixture de registro para testes de runtime de Plugin. Importe de plugin-sdk/plugin-test-runtime ou plugin-sdk/channel-test-helpers
createRequestCaptureJsonFetchCaptura requisições JSON de fetch em testes de auxiliares de mídia. Importe de plugin-sdk/test-env
withServerExecuta testes contra um servidor HTTP local descartável. Importe de plugin-sdk/test-env
createMockIncomingRequestCria um objeto mínimo de requisição HTTP de entrada. Importe de plugin-sdk/test-env
withFetchPreconnectExecuta testes de fetch com hooks de preconexão instalados. Importe de plugin-sdk/test-env
withEnv / withEnvAsyncAltera temporariamente variáveis de ambiente. Importe de plugin-sdk/test-env
createTempHomeEnv / withTempHome / withTempDirCria fixtures isoladas de teste do sistema de arquivos. Importe de plugin-sdk/test-env
createMockServerResponseCria um mock mínimo de resposta de servidor HTTP. Importe de plugin-sdk/test-env
createCliRuntimeCaptureCaptura a saída de runtime da CLI em testes. Importe de plugin-sdk/test-fixtures
importFreshModuleImporta um módulo ESM com um token de consulta novo para ignorar o cache de módulos. Importe de plugin-sdk/test-fixtures
bundledPluginRoot / bundledPluginFileResolve caminhos de fixture de origem ou dist de Plugin incluído. Importe de plugin-sdk/test-fixtures
mockNodeBuiltinModuleInstala mocks Vitest restritos de módulos embutidos do Node. Importe de plugin-sdk/test-node-mocks
createSandboxTestContextCria contextos de teste de sandbox. Importe de plugin-sdk/test-fixtures
writeSkillGrava fixtures de skill. Importe de plugin-sdk/test-fixtures
makeAgentAssistantMessageCria fixtures de mensagem de transcrição de agente. Importe de plugin-sdk/test-fixtures
peekSystemEvents / resetSystemEventsForTestInspeciona e redefine fixtures de eventos do sistema. Importe de plugin-sdk/test-fixtures
sanitizeTerminalTextSanitiza a saída do terminal para asserções. Importe de plugin-sdk/test-fixtures
countLines / hasBalancedFencesVerifica o formato da saída de fragmentação. Importe de plugin-sdk/test-fixtures
runProviderCatalogExecuta um hook de catálogo de provedor com dependências de teste
resolveProviderWizardOptionsResolve escolhas do assistente de configuração de provedor em testes de contrato
resolveProviderModelPickerEntriesResolve entradas do seletor de modelos de provedor em testes de contrato
buildProviderPluginMethodChoiceCria ids de escolha do assistente de provedor para asserções
setProviderWizardProvidersResolverForTestInjeta provedores do assistente de provedor para testes isolados
createProviderUsageFetchCriar fixtures de busca de uso do provedor
useFrozenTime / useRealTimeCongelar e restaurar temporizadores para testes sensíveis ao tempo. Importe de plugin-sdk/test-env
createTestWizardPrompterCriar um prompter simulado do assistente de configuração
createRuntimeTaskFlowCriar estado isolado de fluxo de tarefas em tempo de execução
typedCasesPreservar tipos literais para testes orientados por tabela. Importe de plugin-sdk/test-fixtures
As suítes de contrato de plugins incluídos também usam subcaminhos de teste do SDK para helpers de fixture de registro, manifesto, artefato público e runtime usados apenas em testes. Suítes somente do core que dependem do inventário incluído do OpenClaw permanecem em src/plugins/contracts. Mantenha novos testes de extensões em um subcaminho focado e documentado do SDK, como plugin-sdk/plugin-test-api, plugin-sdk/channel-contract-testing, plugin-sdk/agent-runtime-test-contracts, plugin-sdk/channel-test-helpers, plugin-sdk/plugin-test-contracts, plugin-sdk/plugin-test-runtime, plugin-sdk/provider-test-contracts, plugin-sdk/provider-http-test-mocks, plugin-sdk/test-env ou plugin-sdk/test-fixtures, em vez de importar diretamente o barrel amplo de compatibilidade plugin-sdk/testing, arquivos src/** do repositório ou pontes test/helpers/* do repositório.

Tipos

Subcaminhos focados de teste também reexportam tipos úteis em arquivos de teste:
import type {
  ChannelAccountSnapshot,
  ChannelGatewayContext,
} from "openclaw/plugin-sdk/channel-contract";
import type { OpenClawConfig } from "openclaw/plugin-sdk/config-contracts";
import type { MockFn, PluginRuntime, RuntimeEnv } from "openclaw/plugin-sdk/plugin-test-runtime";

Resolução de destino em testes

Use installCommonResolveTargetErrorCases para adicionar casos de erro padrão para resolução de destino de canal:
import { describe } from "vitest";
import { installCommonResolveTargetErrorCases } from "openclaw/plugin-sdk/channel-target-testing";

describe("my-channel target resolution", () => {
  installCommonResolveTargetErrorCases({
    resolveTarget: ({ to, mode, allowFrom }) => {
      // Your channel's target resolution logic
      return myChannelResolveTarget({ to, mode, allowFrom });
    },
    implicitAllowFrom: ["user1", "user2"],
  });

  // Add channel-specific test cases
  it("should resolve @username targets", () => {
    // ...
  });
});

Padrões de teste

Testando contratos de registro

Testes unitários que passam um mock api escrito manualmente para register(api) não exercitam as portas de aceitação do loader do OpenClaw. Adicione pelo menos um teste de fumaça com loader para cada superfície de registro da qual seu plugin depende, especialmente hooks e capacidades exclusivas, como memória. O loader real falha o registro do plugin quando metadados obrigatórios estão ausentes ou quando um plugin chama uma API de capacidade que ele não possui. Por exemplo, api.registerHook(...) exige um nome de hook, e api.registerMemoryCapability(...) exige que o manifesto do plugin ou a entrada exportada declare kind: "memory".

Testando acesso à configuração de runtime

Prefira o mock compartilhado de runtime de plugin de openclaw/plugin-sdk/channel-test-helpers ao testar plugins de canal incluídos. Os mocks obsoletos runtime.config.loadConfig() e runtime.config.writeConfigFile(...) lançam erro por padrão para que os testes capturem novos usos de APIs de compatibilidade. Sobrescreva esses mocks apenas quando o teste estiver cobrindo explicitamente comportamento legado de compatibilidade.

Teste unitário de um plugin de canal

import { describe, it, expect, vi } from "vitest";

describe("my-channel plugin", () => {
  it("should resolve account from config", () => {
    const cfg = {
      channels: {
        "my-channel": {
          token: "test-token",
          allowFrom: ["user1"],
        },
      },
    };

    const account = myPlugin.setup.resolveAccount(cfg, undefined);
    expect(account.token).toBe("test-token");
  });

  it("should inspect account without materializing secrets", () => {
    const cfg = {
      channels: {
        "my-channel": { token: "test-token" },
      },
    };

    const inspection = myPlugin.setup.inspectAccount(cfg, undefined);
    expect(inspection.configured).toBe(true);
    expect(inspection.tokenStatus).toBe("available");
    // No token value exposed
    expect(inspection).not.toHaveProperty("token");
  });
});

Teste unitário de um plugin de provedor

import { describe, it, expect } from "vitest";

describe("my-provider plugin", () => {
  it("should resolve dynamic models", () => {
    const model = myProvider.resolveDynamicModel({
      modelId: "custom-model-v2",
      // ... context
    });

    expect(model.id).toBe("custom-model-v2");
    expect(model.provider).toBe("my-provider");
    expect(model.api).toBe("openai-completions");
  });

  it("should return catalog when API key is available", async () => {
    const result = await myProvider.catalog.run({
      resolveProviderApiKey: () => ({ apiKey: "test-key" }),
      // ... context
    });

    expect(result?.provider?.models).toHaveLength(2);
  });
});

Fazendo mock do runtime do plugin

Para código que usa createPluginRuntimeStore, faça mock do runtime nos testes:
import { createPluginRuntimeStore } from "openclaw/plugin-sdk/runtime-store";
import type { PluginRuntime } from "openclaw/plugin-sdk/runtime-store";

const store = createPluginRuntimeStore<PluginRuntime>({
  pluginId: "test-plugin",
  errorMessage: "test runtime not set",
});

// In test setup
const mockRuntime = {
  agent: {
    resolveAgentDir: vi.fn().mockReturnValue("/tmp/agent"),
    // ... other mocks
  },
  config: {
    current: vi.fn(() => ({}) as const),
    mutateConfigFile: vi.fn(),
    replaceConfigFile: vi.fn(),
  },
  // ... other namespaces
} as unknown as PluginRuntime;

store.setRuntime(mockRuntime);

// After tests
store.clearRuntime();

Testando com stubs por instância

Prefira stubs por instância em vez de mutação de prototype:
// Preferred: per-instance stub
const client = new MyChannelClient();
client.sendMessage = vi.fn().mockResolvedValue({ id: "msg-1" });

// Avoid: prototype mutation
// MyChannelClient.prototype.sendMessage = vi.fn();

Testes de contrato (plugins no repositório)

Plugins incluídos têm testes de contrato que verificam a propriedade do registro:
pnpm test -- src/plugins/contracts/
Esses testes validam:
  • Quais plugins registram quais provedores
  • Quais plugins registram quais provedores de fala
  • Correção do formato de registro
  • Conformidade com o contrato de runtime

Executando testes com escopo

Para um plugin específico:
pnpm test -- <bundled-plugin-root>/my-channel/
Somente para testes de contrato:
pnpm test -- src/plugins/contracts/shape.contract.test.ts
pnpm test -- src/plugins/contracts/auth-choice.contract.test.ts
pnpm test -- src/plugins/contracts/runtime-seams.contract.test.ts

Aplicação de lint (plugins no repositório)

Três regras são aplicadas por pnpm check para plugins no repositório:
  1. Sem imports monolíticos da raiz — o barrel raiz openclaw/plugin-sdk é rejeitado
  2. Sem imports diretos de src/ — plugins não podem importar ../../src/ diretamente
  3. Sem autoimports — plugins não podem importar seu próprio subcaminho plugin-sdk/<name>
Plugins externos não estão sujeitos a essas regras de lint, mas seguir os mesmos padrões é recomendado.

Configuração de testes

OpenClaw usa Vitest com limites de cobertura V8. Para testes de plugins:
# Run all tests
pnpm test

# Run specific plugin tests
pnpm test -- <bundled-plugin-root>/my-channel/src/channel.test.ts

# Run with a specific test name filter
pnpm test -- <bundled-plugin-root>/my-channel/ -t "resolves account"

# Run with coverage
pnpm test:coverage
Se execuções locais causarem pressão de memória:
OPENCLAW_VITEST_MAX_WORKERS=1 pnpm test

Relacionado