Plugin परीक्षण

OpenClaw Plugins के लिए परीक्षण उपयोगिताओं, पैटर्न और लिंट प्रवर्तन का संदर्भ।

परीक्षण उपयोगिताएँ

ये उपपथ OpenClaw के अपने बंडल किए गए Plugin परीक्षणों के लिए रिपॉज़िटरी-स्थानीय स्रोत एंट्रीपॉइंट हैं। इन्हें तृतीय-पक्ष Plugins के लिए package.json एक्सपोर्ट के रूप में प्रकाशित नहीं किया जाता, और ये Vitest या केवल रिपॉज़िटरी में उपलब्ध अन्य परीक्षण निर्भरताएँ इंपोर्ट कर सकते हैं।

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

बंडल किए गए Plugin परीक्षणों के लिए इन केंद्रित उपपथों का उपयोग करें। पूर्व openclaw/plugin-sdk/testing बैरल रिपॉज़िटरी-स्थानीय था, भेजे गए पैकेजों से बाहर रखा गया था और अब हटा दिया गया है। पूर्व openclaw/plugin-sdk/test-utils उपनाम भी इसके साथ हटा दिया गया था। pnpm run lint:plugins:no-extension-test-core-imports (scripts/check-no-extension-test-core-imports.ts) एक्सटेंशन परीक्षणों को ऊपर दिए गए केंद्रित परीक्षण उपपथों पर बनाए रखता है।

उपलब्ध एक्सपोर्ट

बंडल किए गए Plugin की कॉन्ट्रैक्ट सुइट केवल परीक्षण वाली रजिस्ट्री, मैनिफ़ेस्ट, सार्वजनिक आर्टिफ़ैक्ट और रनटाइम फ़िक्सचर सहायिकाओं के लिए भी इन SDK परीक्षण उपपथों का उपयोग करती हैं। बंडल की गई OpenClaw इन्वेंट्री पर निर्भर केवल-कोर सुइट इसके बजाय src/plugins/contracts के अंतर्गत रहती हैं।

प्रकार

केंद्रित परीक्षण उपपथ परीक्षण फ़ाइलों में उपयोगी प्रकारों को भी फिर से निर्यात करते हैं:

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

परीक्षण लक्ष्य समाधान

चैनल लक्ष्य समाधान के लिए मानक त्रुटि मामले जोड़ने हेतु installCommonResolveTargetErrorCases का उपयोग करें:

  describe("मेरे-चैनल का लक्ष्य समाधान", () => {  installCommonResolveTargetErrorCases({    resolveTarget: ({ to, mode, allowFrom }) => {      // आपके चैनल का लक्ष्य समाधान तर्क      return myChannelResolveTarget({ to, mode, allowFrom });    },    implicitAllowFrom: ["user1", "user2"],  });   // चैनल-विशिष्ट परीक्षण मामले जोड़ें  it("@username लक्ष्यों का समाधान करना चाहिए", () => {    // ...  });});

परीक्षण प्रतिरूप

पंजीकरण कॉन्ट्रैक्ट का परीक्षण

register(api) को हाथ से लिखा हुआ api मॉक देने वाले यूनिट परीक्षण OpenClaw के लोडर स्वीकृति गेट का परीक्षण नहीं करते। आपका Plugin जिस प्रत्येक पंजीकरण सतह पर निर्भर है, उसके लिए कम-से-कम एक लोडर-समर्थित स्मोक परीक्षण जोड़ें, विशेष रूप से हुक और मेमोरी जैसी विशिष्ट क्षमताओं के लिए।

आवश्यक मेटाडेटा अनुपस्थित होने या किसी Plugin द्वारा ऐसी क्षमता API को कॉल करने पर, जिसका वह स्वामी नहीं है, वास्तविक लोडर Plugin पंजीकरण को विफल कर देता है। उदाहरण के लिए, api.registerHook(...) के लिए हुक नाम आवश्यक है और api.registerMemoryCapability(...) के लिए Plugin मैनिफ़ेस्ट या निर्यातित प्रविष्टि में kind: "memory" घोषित होना आवश्यक है।

रनटाइम कॉन्फ़िगरेशन पहुँच का परीक्षण

openclaw/plugin-sdk/plugin-test-runtime से साझा Plugin रनटाइम मॉक को प्राथमिकता दें। इसकी रनटाइम कॉन्फ़िगरेशन सहायिकाएँ वर्तमान स्नैपशॉट और म्यूटेशन API का प्रतिरूपण करती हैं।

किसी चैनल Plugin का यूनिट परीक्षण

 describe("मेरा-चैनल Plugin", () => {  it("कॉन्फ़िगरेशन से अकाउंट का समाधान करना चाहिए", () => {    const cfg = {      channels: {        "my-channel": {          token: "test-token",          allowFrom: ["user1"],        },      },    };     const account = myPlugin.setup.resolveAccount(cfg, undefined);    expect(account.token).toBe("test-token");  });   it("सीक्रेट को मूर्त रूप दिए बिना अकाउंट का निरीक्षण करना चाहिए", () => {    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");    // कोई टोकन मान उजागर नहीं किया गया    expect(inspection).not.toHaveProperty("token");  });});

किसी प्रदाता Plugin का यूनिट परीक्षण

 describe("मेरा-प्रदाता Plugin", () => {  it("डायनेमिक मॉडल का समाधान करना चाहिए", () => {    const model = myProvider.resolveDynamicModel({      modelId: "custom-model-v2",      // ... संदर्भ    });     expect(model.id).toBe("custom-model-v2");    expect(model.provider).toBe("my-provider");    expect(model.api).toBe("openai-completions");  });   it("API कुंजी उपलब्ध होने पर कैटलॉग लौटाना चाहिए", async () => {    const result = await myProvider.catalog.run({      resolveProviderApiKey: () => ({ apiKey: "test-key" }),      // ... संदर्भ    });     expect(result?.provider?.models).toHaveLength(2);  });});

Plugin रनटाइम को मॉक करना

createPluginRuntimeStore का उपयोग करने वाले कोड के लिए परीक्षणों में रनटाइम को मॉक करें:

  const store = createPluginRuntimeStore<PluginRuntime>({  pluginId: "test-plugin",  errorMessage: "परीक्षण रनटाइम सेट नहीं है",}); // परीक्षण सेटअप मेंconst mockRuntime = {  agent: {    resolveAgentDir: vi.fn().mockReturnValue("/tmp/agent"),    // ... अन्य मॉक  },  config: {    current: vi.fn(() => ({}) as const),    mutateConfigFile: vi.fn(),    replaceConfigFile: vi.fn(),  },  // ... अन्य नेमस्पेस} as unknown as PluginRuntime; store.setRuntime(mockRuntime); // परीक्षणों के बादstore.clearRuntime();

प्रति-इंस्टेंस स्टब के साथ परीक्षण

प्रोटोटाइप म्यूटेशन के बजाय प्रति-इंस्टेंस स्टब को प्राथमिकता दें:

// अनुशंसित: प्रति-इंस्टेंस स्टबconst client = new MyChannelClient();client.sendMessage = vi.fn().mockResolvedValue({ id: "msg-1" }); // इससे बचें: प्रोटोटाइप म्यूटेशन// MyChannelClient.prototype.sendMessage = vi.fn();

कॉन्ट्रैक्ट परीक्षण (रेपो के भीतर के Plugin)

बंडल किए गए Plugin में कॉन्ट्रैक्ट परीक्षण होते हैं, जो पंजीकरण स्वामित्व सत्यापित करते हैं:

pnpm test src/plugins/contracts/

ये परीक्षण इसकी पुष्टि करते हैं:

• कौन-से Plugin कौन-से प्रदाता पंजीकृत करते हैं
• कौन-से Plugin कौन-से वाक् प्रदाता पंजीकृत करते हैं
• पंजीकरण आकृति की शुद्धता
• रनटाइम कॉन्ट्रैक्ट का अनुपालन

सीमित-दायरे वाले परीक्षण चलाना

किसी विशिष्ट Plugin के लिए:

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

केवल कॉन्ट्रैक्ट परीक्षणों के लिए:

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

लिंट प्रवर्तन (रेपो के भीतर के Plugin)

scripts/run-additional-boundary-checks.mjs CI में lint:plugins:* इंपोर्ट-सीमा जाँचों का एक समूह चलाता है; प्रत्येक को स्थानीय रूप से स्वतंत्र भी चलाया जा सकता है:

बाहरी Plugin पर ये लिंट नियम लागू नहीं होते, लेकिन उन्हीं प्रतिरूपों का पालन करने की अनुशंसा की जाती है।

परीक्षण कॉन्फ़िगरेशन

OpenClaw सूचनात्मक V8 कवरेज रिपोर्टिंग के साथ Vitest 4 का उपयोग करता है। Plugin परीक्षणों के लिए:

# सभी परीक्षण चलाएँpnpm test # विशिष्ट Plugin परीक्षण चलाएँpnpm test <bundled-plugin-root>/my-channel/src/channel.test.ts # किसी विशिष्ट परीक्षण नाम फ़िल्टर के साथ चलाएँpnpm test <bundled-plugin-root>/my-channel/ -t "अकाउंट का समाधान करता है" # कवरेज के साथ चलाएँpnpm test:coverage

यदि स्थानीय रन से मेमोरी पर दबाव पड़ता है:

OPENCLAW_VITEST_MAX_WORKERS=1 pnpm test

संबंधित

• SDK अवलोकन -- इंपोर्ट परंपराएँ
• SDK चैनल Plugin -- चैनल Plugin इंटरफ़ेस
• SDK प्रदाता Plugin -- प्रदाता Plugin हुक
• Plugin बनाना -- आरंभिक मार्गदर्शिका