setup-sdk-testing

Set up and run contract, Arazzo, and integration tests for Speakeasy-generated SDKs.

Updated Feb 23, 2026
One-click install
npx skills add https://github.com/berea-ch/bereach-sdk-ts --skill setup-sdk-testing-berea-ch
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: setup-sdk-testing
Source: https://github.com/berea-ch/bereach-sdk-ts/tree/main/.agents/skills/setup-sdk-testing
Command: npx skills add https://github.com/berea-ch/bereach-sdk-ts --skill setup-sdk-testing-berea-ch

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill simplifies the process of setting up and executing tests for generated SDKs, ensuring their quality and reliability through contract testing, custom workflows, and integration tests.

Core Features & Use Cases

  • Contract Testing: Automatically generate and run tests to verify SDK adherence to the OpenAPI contract.
  • Arazzo Workflows: Define and execute multi-step API interaction tests for complex scenarios.
  • Integration Testing: Validate SDK behavior against live APIs with real-world data.
  • Use Case: After regenerating an SDK, use this Skill to run contract tests to catch regressions and then execute custom Arazzo tests to ensure a critical user workflow functions as expected.

Quick Start

Use the setup-sdk-testing skill to enable contract testing by adding generation.tests.generateTests: true to your gen.yaml file and regenerating the SDK.

Frequently Asked Questions about setup-sdk-testing

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I set up contract testing for a Speakeasy-generated SDK?

To enable contract testing for a Speakeasy-generated SDK, add `generation.tests.generateTests: true` to your `gen.yaml` file and regenerate the SDK. This automatically generates and runs tests to verify adherence to the OpenAPI contract.

What is Arazzo workflow testing and when do I need it for SDK validation?

Arazzo workflow testing defines and executes multi-step API interaction tests for complex scenarios within SDK validation. You need it to ensure critical user workflows function as expected after regenerating an SDK, moving beyond basic contract adherence.

Can I run integration tests against live APIs using this SDK testing setup?

Yes, you can run integration tests against live APIs to validate SDK behavior with real-world data. This end-to-end validation ensures your generated SDK interacts correctly with actual API endpoints during regression detection.

What's the best way to catch regressions after regenerating an SDK?

The best way to catch regressions after regenerating an SDK is to run contract tests followed by custom Arazzo tests. This combination verifies OpenAPI contract adherence and validates critical user workflows to ensure overall SDK quality.

Do I need a live API environment to validate SDK behavior?

You do not need a live API environment for all validation; contract testing verifies SDK adherence to the OpenAPI contract without live calls. However, integration testing requires a live API to validate behavior with real-world data.