diff options
Diffstat (limited to 'spec/contracts')
| -rw-r--r-- | spec/contracts/README.md | 15 |
1 files changed, 15 insertions, 0 deletions
diff --git a/spec/contracts/README.md b/spec/contracts/README.md new file mode 100644 index 00000000000..d1f902064f1 --- /dev/null +++ b/spec/contracts/README.md @@ -0,0 +1,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) |