search

pactflow / example-bi-directional-consumer-mountebank

Example BDCT consumer using Mountebank stubs
2 stars 33 forks source link

readme

Example NodeJS Consumer - Mountebank (BYO Adapter)

Build

Can I deploy Status

Overview of Example

This is an example of a NodeJS "Product" API consumer that uses Mountebank, Pact, PactFlow and GitHub Actions to generate and publish Pact consumer contracts.

It performs pre-deployment cross-compatibility checks to ensure that it is compatible with specified providers using the Bi-Directional contract capability of PactFlow.

See the full PactFlow Bi-Directional Workshop for which this can be substituted in as the "consumer".

Overview of Part of Bi-Directional Contract Testing Flow

In the following diagram, You can see how the consumer testing process works - it's the same as the current Pact process.

When we call "can-i-deploy" the cross-contract validation process kicks off on PactFlow, to ensure any consumer consumes a valid subset of the OAS for the provider.

Consumer Test

The project uses a Makefile to simulate a very simple build pipeline with two stages - test and deploy.

When you run the CI pipeline (see below for doing this), the pipeline should perform the following activities (simplified):

Consumer Pipeline

Compatibile with Providers

This project is currently compatible with the following provider(s):

See Environment variables on how to set these up.

Pre-requisites

Software:

Environment variables

To be able to run some of the commands locally, you will need to export the following environment variables into your shell:

Set PACT_PROVIDER to one of the following

Usage

Steps

OS/Platform specific considerations

The makefile is configured to run on Unix based systems such as you would find in most common CI/CD pipelines.

They can be run locally on Unix/Mac, or on Windows via WSL2.

Windows

You can still try this example locally on Windows using powershell and running commands manually.

Click to see windows specific instructions here These will be the same commands that are used in the makefile with a few manual tweaks. 1. Make sure you have set all of the environment variables, in powershell they can be set like so. ``` $env:GIT_BRANCH="main" ``` 2. Publish the pact that was generated. The step uses the pact-cli docker image to publish the pact to your pactflow account. The path for `` needs to be converted from Windows paths to UNIX ones as the Docker container is using UNIX. Either hard code this or set it as another environment variable. `C:\Users\Person\Documents\example-bi-directional-consumer-dotnet` becomes `/c/Users/Candy/Documents/PactFlow/example-bi-directional-consumer-dotnet` $env:VARIABLE_NAME refers to the environment variables in windows. ``` docker run --rm -v : -e PACT_BROKER_BASE_URL -e PACT_BROKER_TOKEN pactfoundation/pact-cli publish --consumer-app-version $env:GIT_COMMIT --branch $env:GIT_BRANCH ``` 4. Check can-i-deploy to see if your provider is compatible with your pact. ``` docker run --rm -v : -e PACT_BROKER_BASE_URL -e PACT_BROKER_TOKEN pactfoundation/pact-cli broker can-i-deploy --pacticipant pactflow-example-bi-directional-consumer-dotnet --version $env:GIT_COMMIT --to-environment production --retry-while-unknown 0 --retry-interval 10 ``` 5. Have a look at what other commands are available in the Makefile. All of them can be ran locally from Powershell by changing the windows paths to UNIX and replacing the environment variable references. Any variable referenced as `${VARIABLE}` can be changed to `$env:VARIABLE` to reference environment variables in Powershell.

Caveats

Related topics / posts / discussions

Found an issue?

Reach out via a GitHub Issue, or reach us over in the Pact foundation Slack