Example NodeJS Provider - ReadyAPI

Source Code

https://github.com/pactflow/example-bi-directional-provider-readyapi

badge__1_.svg: https://github.com/pactflow/example-bi-directional-provider-readyapi/actions

can--i--deploy-main_to_production-brightgreen.svg: https://testdemo.pactflow.io/pacticipants/pactflow-example-bi-directional-provider-readyapi/branches/master/latest-version/can-i-deploy/to-environment/production/badge

Overview of Example

This is an example of a NodeJS "Product" API Provider that uses ReadyAPI, Pact, API Hub for Contract Testing and GitHub Actions to generate and publish Pact provider contracts.

It performs pre-deployment cross-compatibility checks to ensure that it is compatible with specified consumers using the Bi-Directional contract capability of API Hub for Contract Testing.

See the full API Hub for Contract Testing Bi-Directional Workshop for which this can be substituted in as the "provider".

Key points

It:

  • Is an API written in Express JS

  • Has a ReadyAPI Project (see pf-swh-rapi-demo-readyapi-project.xml) generated from an OpenAPI specification

  • Uses ReadyAPIs API testing capabilities to create test suites/cases from the OpenAPI specification

  • Uses ReadyAPIs dockerised test runner, to run the ReadyAPI testing suite in headless mode.

  • Uploads the OpenAPI spec and ReadyAPI results to API Hub for Contract Testing

What is uploaded to API Hub for Contract Testing is an OpenAPI specification that represents what you actually tested with ReadyAPI, to give us confidence it is compatible with a Pact consumer.

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 API Hub for Contract Testing, to ensure any consumer consumes a valid subset of the OAS for the provider.

provider-scope.png

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

provider-pipeline.png

  • Test

    • Run tests to check provider codebase compliance with openAPI spec

    • Publishes the openAPI specification and verification results, along with a version and branch name, to API Hub for Contract Testing.

    • 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

Compatible with Consumers

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

See Environment variables on how to set these up

Pre-requisites

Software:

  • Tools listed at Prerequisites

  • A pactflow.io account with a valid API Token

  • A ReadyAPI application downloaded to your machine

  • A time-bound free trial license will suffice for a demo run locally on your machine

  • note - currently only tested on a Mac

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 API Hub for Contract Testing

  • PACT_BROKER_BASE_URL: a fully qualified domain name with protocol to your pact broker e.g., https://testdemo.pactflow.io

Usage

Steps

  • make install - install project dependencies

Run each step separately

  • make test_and_publish - tests the provider and publishes provider contracts to API Hub for Contract Testing

  • This will perform the following 2 calls

    • make test

    • make publish_provider_contract

  • make can_i_deploy - runs can-i-deploy to check if its safe to deploy the provider

  • make deploy - deploys the app and records deployment

or run the whole lot in one go

  • make ci - run the CI process, but locally (uses Docker by default)

Installing alternate pact CLI tools.

If you don't have docker, you can use one of the ruby tools. The standalone, doesn't require that you install Ruby on your host machine.

  • make install-pact-ruby-cli - installs the pact ruby CLI tool

  • make install-pact-ruby-standalone - installs the pact standalone CLI depending on your platform

  • make uninstall-pact-ruby-standalone - uninstalls the pact standalone CLI

Using alternate pact CLI tools.

  • PACT_TOOL=docker make ci - run the CI process, using the pact Docker CLI tool

  • PACT_TOOL=ruby_standalone make ci - run the CI process, using the pact standalone CLI tool

  • PACT_TOOL=ruby_cli make ci - run the CI process, using the pact ruby CLI tool

OS/Platform specific considerations

The makefile has been configured to run on Unix/Windows and MacOS based systems, and tested against Github Actions

They can be run locally on Unix/Windows and MacOS, or on Windows via WSL2 or a shell with bash.

Related topics / posts / discussions

Found an issue?

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

In this section:
© 2024
Publication date: