summaryrefslogtreecommitdiff
path: root/spec/contracts/README.md
blob: d1f902064f16e8dcfad6fad46e1219ebf7132c6c (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
# Contract testing for GitLab

This directory contains the contract test suites for GitLab, which use the [Pact](https://pact.io/) framework.

The consumer tests are written using [`jest-pact`](https://github.com/pact-foundation/jest-pact) and the provider tests are written using [`pact-ruby`](https://github.com/pact-foundation/pact-ruby).

## Write the tests

- [Writing consumer tests](../../doc/development/testing_guide/contract/consumer_tests.md)
- [Writing provider tests](../../doc/development/testing_guide/contract/provider_tests.md)

### Run the tests

- [Running consumer tests](../../doc/development/testing_guide/contract/index.md#run-the-consumer-tests)
- [Running provider tests](../../doc/development/testing_guide/contract/index.md#run-the-provider-tests)