Marketplace

contract-test-design

Design consumer-driven contract testing strategies using Pact, verify provider contracts, and manage API evolution with contract-first approaches.

allowed_tools: Read, Write, Glob, Grep, Task, WebSearch, WebFetch

$ Installieren

git clone https://github.com/melodic-software/claude-code-plugins /tmp/claude-code-plugins && cp -r /tmp/claude-code-plugins/plugins/test-strategy/skills/contract-test-design ~/.claude/skills/claude-code-plugins

// tip: Run this command in your terminal to install the skill


name: contract-test-design description: Design consumer-driven contract testing strategies using Pact, verify provider contracts, and manage API evolution with contract-first approaches. allowed-tools: Read, Write, Glob, Grep, Task, WebSearch, WebFetch

Contract Test Design

When to Use This Skill

Use this skill when:

  • Contract Test Design tasks - Working on consumer-driven contract testing strategies using Pact
  • Planning or design - Need guidance on contract testing approaches
  • Best practices - Want to follow established patterns and standards

Overview

Contract testing verifies that services communicate correctly by testing the contract (API agreement) between a consumer and provider. Consumer-driven contracts (CDC) ensure providers don't break their consumers.


Contract Testing vs Other Test Types

AspectE2E TestsIntegration TestsContract Tests
ScopeFull systemComponent + depsConsumer-provider
SpeedSlow (minutes)Medium (seconds)Fast (ms)
ReliabilityOften flakyModerateVery stable
Deployment couplingHighMediumLow (async)
Failure localizationPoorModerateExcellent
MaintenanceHighMediumLow

Consumer-Driven Contract Flow

┌─────────────────────────────────────────────────────────────┐
│                    CONSUMER SIDE                            │
│                                                             │
│  1. Consumer writes test   2. Test generates contract       │
│     ┌──────────────┐          ┌──────────────┐              │
│     │ Consumer     │          │   Contract   │              │
│     │ Test         │  ─────►  │   (JSON)     │              │
│     └──────────────┘          └──────────────┘              │
│                                      │                      │
└──────────────────────────────────────┼──────────────────────┘
                                       │
                                       ▼ Publish to Broker
                              ┌──────────────────┐
                              │  Contract Broker │
                              │  (Pact Broker)   │
                              └────────┬─────────┘
                                       │
┌──────────────────────────────────────┼──────────────────────┐
│                    PROVIDER SIDE     │                      │
│                                      ▼                      │
│  3. Provider verifies contract                              │
│     ┌──────────────┐          ┌──────────────┐              │
│     │  Provider    │  ◄─────  │   Contract   │              │
│     │  Verification│          │   (JSON)     │              │
│     └──────────────┘          └──────────────┘              │
│            │                                                │
│            ▼                                                │
│  4. Provider tests pass = Contract honored                  │
│                                                             │
└─────────────────────────────────────────────────────────────┘

Quick Reference: Breaking Changes

Change TypeBreaking?Action
Remove fieldYesBlock deployment
Change field typeYesBlock deployment
Add required fieldYesBlock deployment
Add optional fieldNoAllow
Add new endpointNoAllow

Tooling Selection

PurposeToolRationale
Contract FrameworkPactNet.NET native, mature
BrokerPact BrokerStandard, free tier
Async ContractsPact MessageSame ecosystem
Schema ValidationOpenAPIIndustry standard

References

ReferenceContentWhen to Load
strategy-template.mdContract testing strategy template, service maps, workflowsPlanning contract testing strategy
pact-dotnet-implementation.mdConsumer tests, provider verification, provider statesImplementing Pact in .NET
message-contracts.mdAsync message/event contract testingTesting event-driven architectures
matchers-cicd.mdPact matchers, breaking change detection, CI/CD pipelinesMatcher syntax, CI/CD integration

Integration Points

Inputs from:

  • API specifications → Contract definitions
  • Service architecture → Consumer-provider map
  • test-strategy-planning skill → Contract test scope

Outputs to:

  • CI/CD pipeline → Contract verification gates
  • API governance → Breaking change detection
  • api-design-fundamentals skill → Contract-first design

Test Scenarios

Scenario 1: Planning contract testing strategy

Query: "Help me design a contract testing strategy for our microservices"

Expected: Skill activates, provides strategy template, guides through service mapping

Scenario 2: Implementing Pact tests

Query: "Show me how to write Pact consumer tests in .NET"

Expected: Skill activates, loads pact-dotnet-implementation.md reference, provides code examples

Scenario 3: CI/CD integration

Query: "How do I integrate contract testing into our GitHub Actions pipeline?"

Expected: Skill activates, loads matchers-cicd.md reference, provides pipeline examples


Last Updated: 2025-12-28

Version History

  • v1.1.0 (2025-12-28): Refactored to progressive disclosure - extracted implementation to references/
  • v1.0.0 (2025-12-26): Initial release

Repository

melodic-software
melodic-software
Author
melodic-software/claude-code-plugins/plugins/test-strategy/skills/contract-test-design
3
Stars
0
Forks
Updated4d ago
Added1w ago