@pact-foundation/pact

What is @pact-foundation/pact?

@pact-foundation/pact is a consumer-driven contract testing tool for microservices and distributed systems. It allows you to define the interactions between service consumers and providers in a contract, which can then be used to verify that both sides adhere to the contract.

What are @pact-foundation/pact's main functionalities?

Consumer Pact

This code demonstrates how to set up a Pact mock provider for a consumer service. It defines an interaction where the provider is expected to return data when a GET request is made to the /data endpoint.

const { Pact } = require('@pact-foundation/pact');
const path = require('path');

const provider = new Pact({
  consumer: 'ConsumerService',
  provider: 'ProviderService',
  port: 1234,
  log: path.resolve(process.cwd(), 'logs', 'pact.log'),
  dir: path.resolve(process.cwd(), 'pacts'),
  logLevel: 'INFO'
});

provider.setup().then(() => {
  // Define interactions
  provider.addInteraction({
    state: 'provider has data',
    uponReceiving: 'a request for data',
    withRequest: {
      method: 'GET',
      path: '/data',
      headers: { 'Accept': 'application/json' }
    },
    willRespondWith: {
      status: 200,
      headers: { 'Content-Type': 'application/json' },
      body: { key: 'value' }
    }
  });

  // Verify interactions
  return provider.verify();
}).finally(() => provider.finalize());

Provider Verification

This code demonstrates how to verify a provider against a Pact file. It uses the Verifier class to ensure that the provider service meets the expectations defined in the Pact file.

const { Verifier } = require('@pact-foundation/pact');

const opts = {
  providerBaseUrl: 'http://localhost:8080',
  pactUrls: ['path/to/pact-file.json']
};

new Verifier().verifyProvider(opts).then(output => {
  console.log('Pact Verification Complete!');
  console.log(output);
}).catch(e => {
  console.error('Pact Verification Failed: ', e);
});

Pact Broker Integration

This code demonstrates how to publish Pact files to a Pact Broker. It uses the Publisher class to upload the Pact files, making them available for provider verification.

const { Publisher } = require('@pact-foundation/pact');

const opts = {
  pactFilesOrDirs: ['path/to/pacts'],
  pactBroker: 'http://pact-broker-url',
  consumerVersion: '1.0.0'
};

new Publisher(opts).publishPacts().then(() => {
  console.log('Pacts successfully published!');
}).catch(e => {
  console.error('Failed to publish pacts: ', e);
});

Other packages similar to @pact-foundation/pact

contractual

Contractual is another contract testing tool that focuses on defining and verifying contracts between microservices. It is similar to @pact-foundation/pact but offers a different API and may have different integrations and features.

hoverfly

Hoverfly is a tool for API simulation and testing. It allows you to create simulations of APIs and verify interactions. While it is not specifically a contract testing tool like @pact-foundation/pact, it can be used to achieve similar goals by simulating and verifying API interactions.

mockserver

MockServer is a tool for creating mock HTTP servers and verifying requests. It can be used for contract testing by defining expected interactions and verifying that the server behaves as expected. It offers a different approach compared to @pact-foundation/pact but can be used for similar purposes.

README

The README file is missing

Changelog

9.13.2 (2021-01-04)

Bug Fixes

• popsicle: Increase maxBufferSize of requests to infinity (8fd751a)
• small errors (076549e)