https://github.com/danielsiwiec/containerized-contract-tests
https://github.com/danielsiwiec/containerized-contract-tests
cdc consumer-driven-contracts docker testing
Last synced: about 1 month ago
JSON representation
- Host: GitHub
- URL: https://github.com/danielsiwiec/containerized-contract-tests
- Owner: danielsiwiec
- Created: 2018-10-15T02:23:59.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2018-11-19T06:11:54.000Z (over 6 years ago)
- Last Synced: 2025-02-05T01:24:31.694Z (3 months ago)
- Topics: cdc, consumer-driven-contracts, docker, testing
- Language: JavaScript
- Size: 76.2 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Containerized Consumer Driven Contracts
This demo will walk you through the following steps:
1. Starting a provider service (express API)
1. Running a consumer application (node client)
1. Publishing a contract by a consumer
1. Exercising the contract against a provider
## Typical workflow
1. The *Provider* builds a service
1. The *Consumer* integrates with it and has now a dependency on part of the *Provider* service
1. The *Consumer* specifies its dependency in a suite of Contract Tests, in a technology of their choosing
1. The *Consumer* publishes the image
1. The *Provider* picks up the image and runs it in a container, passing pre-defined variables (hostname, etc)
1. The *Provider* subscribes to new versions of the image and runs it on every new version
## Prerequisites
* Docker
## Provider
This is an animal service with a single endpoint **GET \\{animal}** returning a JSON body. In this section we will start the service and exercise its endpoint.
### Running
Start the *Provider* service:
```shell
make provider
```
This will build a Docker image for the *Provider* and start a container.
At this point, the server is running. In order to simulate a real-life scenario of the server running in the cloud, a tunneling service ([ngrok](https://ngrok.com/)) has been used. The output will give you a publicly accessible endpoint for the service (e.g. https://c0587a05.ngrok.io)
You can exercise the endpoint in the following way:
```bash
curl https://c0587a05.ngrok.io/dog
```
You should see the following response:
```json
{
"family": "mamal",
"sounds": "woof!",
"famousMember": "Odie"
}
```
## Consumer
The *Consumer* is an application relying on the *Provider* for it's functionality. In this section we will run the consumer client application, as well as run contract tests against the provider.
### Running
The consumer application needs the provider's endpoint. It'll be read from the *Provider* container and passed through an environment variable. Run the *Consumer* client:
```shell
make consumer
```
This command builds a consumer image and runs the container, passing in the endpoint as an environment variable. The variable is read from the *Provider* container.
You should see a similar output to this:
```shell
Duck is a bird and it makes quack quack!
```
## Publishing and exercising the contract
In this section, we will do the following:
1. (Consumer) Build and publish the contract test Docker image
1. (Provider) Start the container and run the contract tests against the instance
### Build and publish the contract image
Go to the contract folder:
```shell
make contract-build
```
This will build a Docker image with the contract tests in it.
### Exercise the contract against the provider
Start a container to run the contract tests and pass the PROVIDER_URL variable:
```shell
make contract-run
```
Similar as before - the variable is read from the *Provider* container.
You should see an output similar to this:
```shell
PASS tests/duck.test.js
Animal service
✓ should describe a duck (569ms)
Test Suites: 1 passed, 1 total
Tests: 1 passed, 1 total
Snapshots: 0 total
Time: 0.986s
Ran all test suites.
```