WSO2 Contract Test Runner
github.com
- Free plan
- Linux
- Self-hosted
What WSO2 Contract Test Runner is
WSO2 Contract Test Runner is a free, open-source library for testing live REST API endpoints against contracts defined by consumers. It sends requests and compares returned responses with the expected results in JSON contract files. Each contract can contain a request, expected response, assertions, and optional post-conditions. Assertions cover status codes, JSON body and header paths, exact values, regular expressions, empty values, structure, arrays, and objects. Suite configuration can run contracts before or after tests; contracts scheduled before a suite run synchronously first. Post-conditions can place extracted response values in suite-scoped or global environment variables for later contracts. A contract may also pause for a specified number of seconds after assertions complete. The documented Docker workflow mounts contract and configuration files into a container. Sample requests use bearer authorization and cookies from environment variables, with certificate keystore and client truststore files shown in the volume layout. The project is Apache-2.0 licensed, supports consumer and provider verification, and lists XML path support as a todo.
Who it suits
It suits developers and QA teams verifying live APIs against consumer-defined contracts. Linux and self-hosted deployment are listed.
Good to know, and what to watch
- Free Apache-2.0 licensed library
- JSON contracts include detailed assertions
- Runs before- and after-suite contracts
- Extracts values into environment variables
- Docker workflow uses mounted files
- XML path support is listed as a todo
- Linux and self-hosted platforms only
- No paid plans or free trial listed
Plans
Every plan and priceContract Test Runner
Open source
The verdict
WSO2 Contract Test Runner provides contract-driven checks for live REST APIs, with extensive JSON assertions and suite controls. Its narrow XML support and self-hosted Linux focus matter when planning broader platform coverage.
What the maker publishes
- Assertions
- Supported checks include status codes, JSON body and header paths, exact values, regular expressions, emptiness, structure, arrays, and objects. source
- Authentication inputs
- The README's sample request uses bearer authorization and a cookie, with values supplied through environment variables. source
- Contract format
- Contracts are JSON files with request, expected response, assertions, and optional post-conditions. source
- Docker execution
- The documented workflow runs tests by placing contract and configuration files in a mounted volume and running a Docker image. source
- Environment variables
- Post-conditions can extract response values into suite-scoped or global environment variables for use by other contracts. source
- Intended users
- The README describes a framework for testing live API endpoints against consumer-defined contracts. source
- License
- The repository identifies its license as Apache-2.0. source
- Maker security
- WSO2's security page lists ISO 27001:2022 certification and SOC 2 Type 2 compliance for the company, but does not specify coverage for this repository. source
- Notable limitation
- The README lists XML path support as a todo. source
- Purpose
- It is a consumer-based contract testing library that calls live REST API endpoints and compares their responses with predefined contract responses. source
- Suite setup
- Suite configuration can run contracts before or after tests, and before-suite contracts run synchronously before suite tests. source
- TLS configuration
- The example volume layout includes a certificate keystore and a client truststore. source
- Waits
- A contract can specify a wait time in seconds to pause after its assertions finish. source
Checked against the maker's pages on 5 Oct 2026.