Plugin testi

OpenClaw Pluginleri için test yardımcı programları, kalıpları ve lint uygulamasına ilişkin referans.

Test yardımcı programları

Bu alt yollar, OpenClaw'ın kendi paketle birlikte sunulan Plugin testleri için depoya yerel kaynak giriş noktalarıdır. Üçüncü taraf Pluginler için yayımlanmış package.json dışa aktarımları değildir ve Vitest'i veya yalnızca depoda bulunan diğer test bağımlılıklarını içe aktarabilirler.

   shouldAckReaction,  removeAckReactionAfterReply,} from "openclaw/plugin-sdk/channel-feedback";               bundledPluginRoot,  createCliRuntimeCapture,  typedCases,} from "openclaw/plugin-sdk/test-fixtures"; 

Paketle birlikte sunulan Plugin testleri için bu odaklanmış alt yolları kullanın. Önceki openclaw/plugin-sdk/testing barrel'ı depoya yereldi, yayımlanan paketlerin dışında tutuluyordu ve kaldırıldı. Önceki openclaw/plugin-sdk/test-utils takma adı da onunla birlikte kaldırıldı. pnpm run lint:plugins:no-extension-test-core-imports (scripts/check-no-extension-test-core-imports.ts) uzantı testlerinin yukarıdaki odaklanmış test alt yollarını kullanmasını sağlar.

Kullanılabilir dışa aktarımlar

Paketle birlikte sunulan Plugin sözleşme paketleri ayrıca yalnızca test amaçlı kayıt defteri, manifest, herkese açık yapıt ve çalışma zamanı fikstürü yardımcıları için bu SDK test alt yollarını kullanır. Paketle birlikte sunulan OpenClaw envanterine bağımlı olan yalnızca çekirdeğe yönelik paketler ise bunun yerine src/plugins/contracts altında kalır.

Türler

Odaklı test alt yolları, test dosyalarında yararlı olan türleri de yeniden dışa aktarır:

   ChannelAccountSnapshot,  ChannelGatewayContext,} from "openclaw/plugin-sdk/channel-contract";  

Test hedefi çözümleme

Kanal hedefi çözümlemesine yönelik standart hata durumlarını eklemek için installCommonResolveTargetErrorCases kullanın:

  describe("my-channel hedef çözümlemesi", () => {  installCommonResolveTargetErrorCases({    resolveTarget: ({ to, mode, allowFrom }) => {      // Kanalınızın hedef çözümleme mantığı      return myChannelResolveTarget({ to, mode, allowFrom });    },    implicitAllowFrom: ["user1", "user2"],  });   // Kanala özgü test durumları ekleyin  it("@username hedeflerini çözümlemelidir", () => {    // ...  });});

Test kalıpları

Kayıt sözleşmelerini test etme

El ile yazılmış bir api taklidini register(api) öğesine ileten birim testleri, OpenClaw'ın yükleyici kabul denetimlerini çalıştırmaz. Plugin'inizin bağımlı olduğu her kayıt yüzeyi için, özellikle kancalar ve bellek gibi özel yetenekler için yükleyici destekli en az bir duman testi ekleyin.

Gerekli meta veriler eksik olduğunda veya bir Plugin sahip olmadığı bir yetenek API'sini çağırdığında gerçek yükleyici Plugin kaydını başarısız kılar. Örneğin, api.registerHook(...) bir kanca adı gerektirir ve api.registerMemoryCapability(...), Plugin manifestinin veya dışa aktarılan girdinin kind: "memory" bildirmesini gerektirir.

Çalışma zamanı yapılandırmasına erişimi test etme

openclaw/plugin-sdk/plugin-test-runtime içindeki paylaşılan Plugin çalışma zamanı taklidini tercih edin. Çalışma zamanı yapılandırma yardımcıları, geçerli anlık görüntü ve değişiklik API'lerini modeller.

Bir kanal Plugin'ini birim testiyle sınama

 describe("my-channel Plugin'i", () => {  it("hesabı yapılandırmadan çözümlemelidir", () => {    const cfg = {      channels: {        "my-channel": {          token: "test-token",          allowFrom: ["user1"],        },      },    };     const account = myPlugin.setup.resolveAccount(cfg, undefined);    expect(account.token).toBe("test-token");  });   it("gizli değerleri somutlaştırmadan hesabı incelemelidir", () => {    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");    // Token değeri açığa çıkarılmaz    expect(inspection).not.toHaveProperty("token");  });});

Bir sağlayıcı Plugin'ini birim testiyle sınama

 describe("my-provider Plugin'i", () => {  it("dinamik modelleri çözümlemelidir", () => {    const model = myProvider.resolveDynamicModel({      modelId: "custom-model-v2",      // ... bağlam    });     expect(model.id).toBe("custom-model-v2");    expect(model.provider).toBe("my-provider");    expect(model.api).toBe("openai-completions");  });   it("API anahtarı kullanılabilir olduğunda kataloğu döndürmelidir", async () => {    const result = await myProvider.catalog.run({      resolveProviderApiKey: () => ({ apiKey: "test-key" }),      // ... bağlam    });     expect(result?.provider?.models).toHaveLength(2);  });});

Plugin çalışma zamanını taklit etme

createPluginRuntimeStore kullanan kod için testlerde çalışma zamanını taklit edin:

  const store = createPluginRuntimeStore<PluginRuntime>({  pluginId: "test-plugin",  errorMessage: "test çalışma zamanı ayarlanmadı",}); // Test kurulumundaconst mockRuntime = {  agent: {    resolveAgentDir: vi.fn().mockReturnValue("/tmp/agent"),    // ... diğer taklitler  },  config: {    current: vi.fn(() => ({}) as const),    mutateConfigFile: vi.fn(),    replaceConfigFile: vi.fn(),  },  // ... diğer ad alanları} as unknown as PluginRuntime; store.setRuntime(mockRuntime); // Testlerden sonrastore.clearRuntime();

Örnek başına saplamalarla test etme

Prototip değişikliği yerine örnek başına saplamaları tercih edin:

// Tercih edilen: örnek başına saplamaconst client = new MyChannelClient();client.sendMessage = vi.fn().mockResolvedValue({ id: "msg-1" }); // Kaçının: prototip değişikliği// MyChannelClient.prototype.sendMessage = vi.fn();

Sözleşme testleri (depo içi Plugin'ler)

Paketle birlikte sunulan Plugin'lerin kayıt sahipliğini doğrulayan sözleşme testleri vardır:

pnpm test src/plugins/contracts/

Bu testler şunları doğrular:

• Hangi Plugin'lerin hangi sağlayıcıları kaydettiği
• Hangi Plugin'lerin hangi konuşma sağlayıcılarını kaydettiği
• Kayıt biçiminin doğruluğu
• Çalışma zamanı sözleşmesine uygunluk

Kapsamlı testleri çalıştırma

Belirli bir Plugin için:

pnpm test <bundled-plugin-root>/my-channel/

Yalnızca sözleşme testleri için:

pnpm test src/plugins/contracts/shape.contract.test.tspnpm test src/plugins/contracts/auth-choice.contract.test.tspnpm test src/plugins/contracts/runtime-seams.contract.test.ts

Lint uygulaması (depo içi Plugin'ler)

scripts/run-additional-boundary-checks.mjs, CI'da bir dizi lint:plugins:* içe aktarma sınırı denetimi çalıştırır; bunların her biri yerel olarak bağımsız biçimde de çalıştırılabilir:

Harici Plugin'ler bu lint kurallarına tabi değildir, ancak aynı kalıpların izlenmesi önerilir.

Test yapılandırması

OpenClaw, bilgilendirici V8 kapsam raporlamasıyla Vitest 4 kullanır. Plugin testleri için:

# Tüm testleri çalıştırpnpm test # Belirli Plugin testlerini çalıştırpnpm test <bundled-plugin-root>/my-channel/src/channel.test.ts # Belirli bir test adı filtresiyle çalıştırpnpm test <bundled-plugin-root>/my-channel/ -t "resolves account" # Kapsamla çalıştırpnpm test:coverage

Yerel çalıştırmalar bellek baskısına neden olursa:

OPENCLAW_VITEST_MAX_WORKERS=1 pnpm test

İlgili

• SDK'ya Genel Bakış -- içe aktarma kuralları
• SDK Kanal Plugin'leri -- kanal Plugin'i arayüzü
• SDK Sağlayıcı Plugin'leri -- sağlayıcı Plugin kancaları
• Plugin Oluşturma -- başlangıç kılavuzu