Plugin SDK reference

Plugin 테스트

OpenClaw Plugin의 테스트 유틸리티, 패턴 및 린트 적용에 관한 참조 문서입니다.

테스트 유틸리티

다음 하위 경로는 OpenClaw에 자체 번들로 포함된 Plugin 테스트를 위한 저장소 로컬 소스 진입점입니다. 서드 파티 Plugin을 대상으로 공개된 package.json 내보내기가 아니며, Vitest 또는 저장소에서만 사용하는 다른 테스트 의존성을 가져올 수 있습니다.

typescript
   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)는 확장 기능 테스트 파일에서 둘 중 하나를 새로 가져오는 것을 거부하며, 둘 다 호환성 기록 테스트용으로만 유지됩니다.

사용 가능한 내보내기

내보내기 용도
createTestPluginApi 직접 등록 단위 테스트를 위한 최소 Plugin API 모의 객체를 구성합니다. plugin-sdk/plugin-test-api에서 가져옵니다.
AUTH_PROFILE_RUNTIME_CONTRACT 네이티브 에이전트 런타임 어댑터용 공유 인증 프로필 계약 픽스처입니다. plugin-sdk/agent-runtime-test-contracts에서 가져옵니다.
DELIVERY_NO_REPLY_RUNTIME_CONTRACT 네이티브 에이전트 런타임 어댑터용 공유 전달 억제 계약 픽스처입니다. plugin-sdk/agent-runtime-test-contracts에서 가져옵니다.
OUTCOME_FALLBACK_RUNTIME_CONTRACT 네이티브 에이전트 런타임 어댑터용 공유 폴백 분류 계약 픽스처입니다. plugin-sdk/agent-runtime-test-contracts에서 가져옵니다.
createParameterFreeTool 네이티브 런타임 계약 테스트를 위한 동적 도구 스키마 픽스처를 구성합니다. plugin-sdk/agent-runtime-test-contracts에서 가져옵니다.
expectChannelInboundContextContract 채널 인바운드 컨텍스트 형태를 검증합니다. plugin-sdk/channel-contract-testing에서 가져옵니다.
installChannelOutboundPayloadContractSuite 채널 아웃바운드 페이로드 계약 사례를 설치합니다. plugin-sdk/channel-contract-testing에서 가져옵니다.
createStartAccountContext 채널 계정 수명 주기 컨텍스트를 구성합니다. plugin-sdk/channel-test-helpers에서 가져옵니다.
installChannelActionsContractSuite 일반 채널 메시지 동작 계약 사례를 설치합니다. plugin-sdk/channel-test-helpers에서 가져옵니다.
installChannelSetupContractSuite 일반 채널 설정 계약 사례를 설치합니다. plugin-sdk/channel-test-helpers에서 가져옵니다.
installChannelStatusContractSuite 일반 채널 상태 계약 사례를 설치합니다. plugin-sdk/channel-test-helpers에서 가져옵니다.
expectDirectoryIds 디렉터리 목록 함수에서 반환된 채널 디렉터리 ID를 검증합니다. plugin-sdk/channel-test-helpers에서 가져옵니다.
assertBundledChannelEntries 번들 채널 진입점이 예상된 공개 계약을 노출하는지 검증합니다. plugin-sdk/channel-test-helpers에서 가져옵니다.
formatEnvelopeTimestamp 결정론적 엔벌로프 타임스탬프의 형식을 지정합니다. plugin-sdk/channel-test-helpers에서 가져옵니다.
expectPairingReplyText 채널 페어링 응답 텍스트를 검증하고 해당 코드를 추출합니다. plugin-sdk/channel-test-helpers에서 가져옵니다.
describePluginRegistrationContract Plugin 등록 계약 검사를 설치합니다. plugin-sdk/plugin-test-contracts에서 가져옵니다.
registerSingleProviderPlugin 로더 스모크 테스트에서 하나의 제공자 Plugin을 등록합니다. plugin-sdk/plugin-test-runtime에서 가져옵니다.
registerProviderPlugin 하나의 Plugin에서 모든 제공자 종류를 캡처합니다. plugin-sdk/plugin-test-runtime에서 가져옵니다.
registerProviderPlugins 여러 Plugin의 제공자 등록을 캡처합니다. plugin-sdk/plugin-test-runtime에서 가져옵니다.
requireRegisteredProvider 제공자 컬렉션에 특정 ID가 포함되어 있는지 검증합니다. plugin-sdk/plugin-test-runtime에서 가져옵니다.
createRuntimeEnv 모의 CLI/Plugin 런타임 환경을 구성합니다. plugin-sdk/plugin-test-runtime에서 가져옵니다.
createPluginRuntimeMock 모의 Plugin 런타임 표면을 구성합니다. plugin-sdk/plugin-test-runtime에서 가져옵니다.
createPluginSetupWizardStatus 채널 Plugin용 설정 상태 도우미를 구성합니다. plugin-sdk/plugin-test-runtime에서 가져옵니다.
createTestWizardPrompter 모의 설정 마법사 프롬프터를 구성합니다. plugin-sdk/plugin-test-runtime에서 가져옵니다.
createRuntimeTaskFlow 격리된 런타임 TaskFlow 상태를 생성합니다. plugin-sdk/plugin-test-runtime에서 가져옵니다.
runProviderCatalog 테스트 종속성을 사용하여 제공자 카탈로그 훅을 실행합니다. plugin-sdk/plugin-test-runtime에서 가져옵니다.
resolveProviderWizardOptions 계약 테스트에서 제공자 설정 마법사의 선택 항목을 결정합니다. plugin-sdk/plugin-test-runtime에서 가져옵니다.
resolveProviderModelPickerEntries 계약 테스트에서 제공자 모델 선택기의 항목을 결정합니다. plugin-sdk/plugin-test-runtime에서 가져옵니다.
buildProviderPluginMethodChoice 검증에 사용할 제공자 마법사 선택 항목 ID를 구성합니다. plugin-sdk/plugin-test-runtime에서 가져옵니다.
setProviderWizardProvidersResolverForTest 격리된 테스트를 위해 제공자 마법사의 제공자 목록을 주입합니다. plugin-sdk/plugin-test-runtime에서 가져옵니다.
describeOpenAIProviderRuntimeContract 제공자 계열 런타임 계약 검사를 설치합니다. plugin-sdk/provider-test-contracts에서 가져옵니다.
expectPassthroughReplayPolicy 제공자 재실행 정책이 제공자 소유 도구와 메타데이터를 그대로 전달하는지 검증합니다. plugin-sdk/provider-test-contracts에서 가져옵니다.
runRealtimeSttLiveTest 공유 오디오 픽스처로 실시간 STT 제공자 라이브 테스트를 실행합니다. plugin-sdk/provider-test-contracts에서 가져옵니다.
normalizeTranscriptForMatch 퍼지 검증 전에 라이브 전사 출력을 정규화합니다. plugin-sdk/provider-test-contracts에서 가져옵니다.
expectExplicitVideoGenerationCapabilities 비디오 제공자가 명시적인 생성 모드 기능을 선언하는지 검증합니다. plugin-sdk/provider-test-contracts에서 가져옵니다.
expectExplicitMusicGenerationCapabilities 음악 제공자가 명시적인 생성/편집 기능을 선언하는지 검증합니다. plugin-sdk/provider-test-contracts에서 가져옵니다.
mockSuccessfulDashscopeVideoTask 성공한 DashScope 호환 비디오 작업 응답을 설치합니다. plugin-sdk/provider-test-contracts에서 가져옵니다.
getProviderHttpMocks 명시적으로 활성화하는 제공자 HTTP/인증 Vitest 모의 객체에 접근합니다. plugin-sdk/provider-http-test-mocks에서 가져옵니다.
installProviderHttpMockCleanup 각 테스트 후 제공자 HTTP/인증 모의 객체를 초기화합니다. plugin-sdk/provider-http-test-mocks에서 가져옵니다.
installCommonResolveTargetErrorCases 대상 결정 오류 처리를 위한 공유 테스트 사례입니다. plugin-sdk/channel-target-testing에서 가져옵니다.
shouldAckReaction 채널이 확인 반응을 추가해야 하는지 확인합니다. plugin-sdk/channel-feedback에서 가져옵니다.
removeAckReactionAfterReply 응답 전달 후 확인 반응을 제거합니다. plugin-sdk/channel-feedback에서 가져옵니다.
createTestRegistry 채널 Plugin 레지스트리 픽스처를 구성합니다. plugin-sdk/plugin-test-runtime 또는 plugin-sdk/channel-test-helpers에서 가져옵니다.
createEmptyPluginRegistry 빈 Plugin 레지스트리 픽스처를 구성합니다. plugin-sdk/plugin-test-runtime 또는 plugin-sdk/channel-test-helpers에서 가져옵니다.
setActivePluginRegistry Plugin 런타임 테스트용 레지스트리 픽스처를 설치합니다. plugin-sdk/plugin-test-runtime 또는 plugin-sdk/channel-test-helpers에서 가져옵니다.
createRequestCaptureJsonFetch 미디어 도우미 테스트에서 JSON 가져오기 요청을 캡처합니다. plugin-sdk/test-env에서 가져옵니다.
withServer 일회용 로컬 HTTP 서버를 대상으로 테스트를 실행합니다. plugin-sdk/test-env에서 가져옵니다.
createMockIncomingRequest 최소 인바운드 HTTP 요청 객체를 구성합니다. plugin-sdk/test-env에서 가져옵니다.
withFetchPreconnect 사전 연결 훅이 설치된 상태로 가져오기 테스트를 실행합니다. plugin-sdk/test-env에서 가져옵니다.
withEnv / withEnvAsync 환경 변수를 일시적으로 패치합니다. plugin-sdk/test-env에서 가져옵니다.
createTempHomeEnv / withTempHome / withTempDir 격리된 파일 시스템 테스트 픽스처를 생성합니다. plugin-sdk/test-env에서 가져옵니다.
createMockServerResponse 최소 HTTP 서버 응답 모의 객체를 생성합니다. plugin-sdk/test-env에서 가져옵니다.
createProviderUsageFetch 제공자 사용량 가져오기 픽스처를 구성합니다. plugin-sdk/test-env에서 가져옵니다.
useFrozenTime / useRealTime 시간에 민감한 테스트를 위해 타이머를 고정하고 복원합니다. plugin-sdk/test-env에서 가져옵니다.
createCliRuntimeCapture 테스트에서 CLI 런타임 출력을 캡처합니다. plugin-sdk/test-fixtures에서 가져옵니다.
importFreshModule 모듈 캐시를 우회하도록 새로운 쿼리 토큰으로 ESM 모듈을 가져옵니다. plugin-sdk/test-fixtures에서 가져옵니다.
bundledPluginRoot / bundledPluginFile 번들 Plugin 소스 또는 배포판 픽스처 경로를 결정합니다. plugin-sdk/test-fixtures에서 가져옵니다.
mockNodeBuiltinModule 범위가 제한된 Node 내장 Vitest 모의 객체를 설치합니다. plugin-sdk/test-node-mocks에서 가져옵니다.
createSandboxTestContext 샌드박스 테스트 컨텍스트를 구성합니다. plugin-sdk/test-fixtures에서 가져옵니다.
writeSkill Skills 픽스처를 작성합니다. plugin-sdk/test-fixtures에서 가져옵니다.
makeAgentAssistantMessage 에이전트 트랜스크립트 메시지 픽스처를 생성합니다. plugin-sdk/test-fixtures에서 가져옵니다.
peekSystemEvents / resetSystemEventsForTest 시스템 이벤트 픽스처를 검사하고 초기화합니다. plugin-sdk/test-fixtures에서 가져옵니다.
sanitizeTerminalText 어설션을 위해 터미널 출력을 정리합니다. plugin-sdk/test-fixtures에서 가져옵니다.
countLines / hasBalancedFences 청크 분할 출력 형식을 검증합니다. plugin-sdk/test-fixtures에서 가져옵니다.
typedCases 테이블 기반 테스트에서 리터럴 타입을 보존합니다. plugin-sdk/test-fixtures에서 가져옵니다.

번들 Plugin 계약 스위트도 테스트 전용 레지스트리, 매니페스트, 공개 아티팩트 및 런타임 픽스처 헬퍼를 위해 이러한 SDK 테스트 하위 경로를 사용합니다. 대신 번들 OpenClaw 인벤토리에 의존하는 코어 전용 스위트는 src/plugins/contracts 아래에 유지됩니다.

타입

집중형 테스트 하위 경로는 테스트 파일에서 유용한 타입도 다시 내보냅니다.

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

테스트 대상 해석

채널 대상 해석에 대한 표준 오류 사례를 추가하려면 installCommonResolveTargetErrorCases를 사용하세요.

typescript
  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", () => {    // ...  });});

테스트 패턴

등록 계약 테스트

직접 작성한 api 모의 객체를 register(api)에 전달하는 단위 테스트는 OpenClaw의 로더 허용 게이트를 검증하지 않습니다. Plugin이 의존하는 각 등록 표면에 대해 로더 기반 스모크 테스트를 하나 이상 추가하세요. 특히 훅과 메모리 같은 독점 기능에 중요합니다.

필수 메타데이터가 누락되었거나 Plugin이 소유하지 않은 기능 API를 호출하면 실제 로더에서 Plugin 등록이 실패합니다. 예를 들어 api.registerHook(...)에는 훅 이름이 필요하며, api.registerMemoryCapability(...)를 사용하려면 Plugin 매니페스트 또는 내보낸 엔트리에 kind: "memory"가 선언되어 있어야 합니다.

런타임 구성 접근 테스트

openclaw/plugin-sdk/plugin-test-runtime의 공유 Plugin 런타임 모의 객체를 사용하세요. 이 객체의 runtime.config.loadConfig()runtime.config.writeConfigFile(...) 모의 객체는 기본적으로 예외를 발생시키므로, 테스트에서 폐기 예정인 호환성 API의 새로운 사용을 감지할 수 있습니다. 테스트가 레거시 호환성 동작을 명시적으로 다루는 경우에만 해당 모의 객체를 재정의하세요.

채널 Plugin 단위 테스트

typescript
 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");  });});

공급자 Plugin 단위 테스트

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

Plugin 런타임 모의 처리

createPluginRuntimeStore를 사용하는 코드의 경우 테스트에서 런타임을 모의 처리하세요.

typescript
  const store = createPluginRuntimeStore<PluginRuntime>({  pluginId: "test-plugin",  errorMessage: "test runtime not set",}); // In test setupconst 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 testsstore.clearRuntime();

인스턴스별 스텁을 사용한 테스트

프로토타입 변경보다 인스턴스별 스텁을 사용하세요.

typescript
// Preferred: per-instance stubconst client = new MyChannelClient();client.sendMessage = vi.fn().mockResolvedValue({ id: "msg-1" }); // Avoid: prototype mutation// MyChannelClient.prototype.sendMessage = vi.fn();

계약 테스트(저장소 내 Plugin)

번들 Plugin에는 등록 소유권을 검증하는 계약 테스트가 있습니다.

bash
pnpm test src/plugins/contracts/

이 테스트는 다음을 확인합니다.

  • 어떤 Plugin이 어떤 공급자를 등록하는지
  • 어떤 Plugin이 어떤 음성 공급자를 등록하는지
  • 등록 형상의 정확성
  • 런타임 계약 준수

범위 지정 테스트 실행

특정 Plugin의 경우:

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

계약 테스트만 실행하는 경우:

bash
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:* 가져오기 경계 검사를 실행하며, 각 검사는 로컬에서도 독립적으로 실행할 수 있습니다.

명령 적용 규칙
pnpm run lint:plugins:no-monolithic-plugin-sdk-entry-imports 번들 Plugin은 단일 구조의 openclaw/plugin-sdk 루트 배럴을 가져올 수 없습니다.
pnpm run lint:plugins:no-extension-src-imports 프로덕션 확장 파일은 저장소의 src/** 트리를 직접 가져올 수 없습니다(../../src/...).
pnpm run lint:plugins:no-extension-test-core-imports 확장 테스트 파일은 openclaw/plugin-sdk/testing, plugin-sdk/test-utils 또는 기타 코어 전용 테스트 헬퍼를 가져올 수 없습니다.

외부 Plugin에는 이러한 린트 규칙이 적용되지 않지만, 동일한 패턴을 따르는 것이 좋습니다.

테스트 구성

OpenClaw는 정보 제공용 V8 커버리지 보고와 함께 Vitest 4를 사용합니다. Plugin 테스트의 경우:

bash
# Run all testspnpm test # Run specific plugin testspnpm test <bundled-plugin-root>/my-channel/src/channel.test.ts # Run with a specific test name filterpnpm test <bundled-plugin-root>/my-channel/ -t "resolves account" # Run with coveragepnpm test:coverage

로컬 실행으로 메모리 압박이 발생하는 경우:

bash
OPENCLAW_VITEST_MAX_WORKERS=1 pnpm test

관련 문서

Was this useful?
On this page

On this page