ngadde/example-bi-directional-provider-restassured

Example spring boot provider using RestAssured and the Pactflow bi-directional contracts feature

Example Java Provider - RestAssured

• Example Java Provider - RestAssured
  • Overview of Example
  • Overview of Part of Bi-Directional Contract Testing Flow
  • Compatibile with Consumers
  • Pre-requisites
    • Environment variables
  • Usage
    • Steps
  • OS/Platform specific considerations
    • Windows
  • Caveats
  • Related topics / posts / discussions
  • Other examples of how to do this form of testing
  • Found an issue?

Overview of Example

This is an example of a Spring boot "Product" API Provider that uses RestAssured, Pact, Pactflow and GitHub Actions to generate and publish Pact provider contracts.

It performs pre-deployment cross-compatability checks to ensure that it is compatible with specified consumers using the Bi-Directional contract capability of Pactflow.

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

Overview of Part of Bi-Directional Contract Testing Flow

In the following diagram, you can see how the provider testing process works.

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.

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):

• Test
  • Run tests to check spec compliance with openAPI spec
  • Create branch tag via Pact CLI
  • Publish openAPI spec, along with a version with the name of the current branch
  • Check if we are safe to deploy to Production with can-i-deploy (ie. has the cross-contract validation has been successfully performed)
• Deploy (only from <main|master>)
  • Deploy app to Production
  • Record the Production deployment in the Pact Broker

Compatibile with Consumers

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

• pactflow-example-bi-directional-consumer-nock
• pactflow-example-bi-directional-consumer-msw
• pactflow-example-bi-directional-consumer-wiremock
• pactflow-example-bi-directional-consumer-mountebank

Pre-requisites

Software:

• Tools listed at: https://docs.pactflow.io/docs/workshops/ci-cd/set-up-ci/prerequisites/
• A pactflow.io account with an valid API token

Environment variables

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

• PACT_BROKER_TOKEN: a valid API token for Pactflow
• PACT_BROKER_BASE_URL: a fully qualified domain name with protocol to your pact broker e.g. https://testdemo.pactflow.io

Usage

Steps

• make test - run the tests locally
• make fake_ci - run the CI process, but locally

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 <path_to_project_root> 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 <path_to_project_root>:<path_to_project_root> -e PACT_BROKER_BASE_URL -e PACT_BROKER_TOKEN pactfoundation/pact-cli publish <path_to_pacts_folder> --consumer-app-version $env:GIT_COMMIT --tag $env:GIT_BRANCH
   
   

3. Check can-i-deploy to see if your provider is compatible with your pact.

   docker run --rm -v <path_to_project_root>:<path_to_project_root> -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
   

4. 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

• OAS considerations

Related topics / posts / discussions

• Consumer Side Bi-Directional Contract Testing Guide
• Provider Side Bi-Directional Contract Testing Guide

Other examples of how to do this form of testing

• https://hazelcast.com/blog/contract-first-development-using-restassured-and-openapi/
• https://www.openapi4j.org/operation-validator-adapters/spring.html
• https://springframework.guru/should-i-use-spring-rest-docs-or-openapi/
• https://github.com/OpenAPITools/openapi-generator (generate rest assured tests from spec)

Found an issue?

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