Pular para o conteúdo principal

​
Teste de Plugin

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

​
Utilitários de teste

Importação: openclaw/plugin-sdk/testing O subcaminho de teste exporta um conjunto restrito de helpers para autores de plugins: 
import {
  installCommonResolveTargetErrorCases,
  shouldAckReaction,
  removeAckReactionAfterReply,
} from "openclaw/plugin-sdk/testing";

​
Exportações disponíveis

ExportPropósito
installCommonResolveTargetErrorCasesCasos de teste compartilhados para tratamento de erros de resolução de alvo
shouldAckReactionVerifica se um canal deve adicionar uma reação de confirmação
removeAckReactionAfterReplyRemove a reação de confirmação após a entrega da resposta

​
Tipos

O subcaminho de teste também reexporta tipos úteis em arquivos de teste: 
import type {
  ChannelAccountSnapshot,
  ChannelGatewayContext,
  OpenClawConfig,
  PluginRuntime,
  RuntimeEnv,
  MockFn,
} from "openclaw/plugin-sdk/testing";

​
Testando a resolução de alvo

Use installCommonResolveTargetErrorCases para adicionar casos de erro padrão para resolução de alvo do canal: 
import { describe } from "vitest";
import { installCommonResolveTargetErrorCases } from "openclaw/plugin-sdk/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

​
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);
  });
});

​
Mockando o 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: {
    loadConfig: vi.fn(),
    writeConfigFile: 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 protótipo: 
// 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 empacotados têm testes de contrato que verificam a propriedade do registro: 
pnpm test -- src/plugins/contracts/
Esses testes verificam:
  • Quais plugins registram quais provedores
  • Quais plugins registram quais provedores de fala
  • Correção da forma 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.contract.test.ts
pnpm test -- src/plugins/contracts/runtime.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 importações monolíticas da raiz — o barrel raiz openclaw/plugin-sdk é rejeitado
  2. Sem importações diretas de src/ — plugins não podem importar ../../src/ diretamente
  3. Sem autoimportações — 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 teste

O OpenClaw usa Vitest com limites de cobertura do V8. Para testes de Plugin: 
# 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 as execuções locais causarem pressão de memória: 
OPENCLAW_VITEST_MAX_WORKERS=1 pnpm test

​
Relacionados