Pact Node

An idiomatic Node interface for the Pact mock service (Consumer) and Verification (Provider) process.

• Pact Node
  • Installation
  • Usage
  • Documentation
    • Set Log Level
    • Mock Servers
      • Create Mock Server
      • List Mock Servers
      • Remove All Mock Servers
      • Start a Mock Server
      • Stop a Mock server
      • Delete a Mock server
      • Check if a Mock server is running
      • Mock Server Events
    • Provider Verification
    • Pact Broker Publishing
    • Stub Servers
      • Create Stub Server
  • Contributing
  • Testing
  • Questions?

Installation

npm install @pact-foundation/pact-node --save

Usage

Simply require the library and call the create function to start the mock service

var pact = require('@pact-foundation/pact-node');
var server = pact.createServer({port: 9999});
server.start().then(function() {
    // Do your testing/development here
});

Or if you're using Typescript instead of plain old Javascript

import pact from "@pact-foundation/pact-node";
const server = pact.createServer({port: 9999});
server.start().then(() => {
    // Do your testing/development here
});

Or you can also use the CLI

$# pact mock --port 9999

To see the list commands possible with the CLI, simply ask for help $# pact --help

Documentation

Set Log Level

var pact = require('@pact-foundation/pact-node');
pact.logLevel('debug');

Mock Servers

Mock servers are used by Pact to record interactions and create pact contracts.

Create Mock Server

var pact = require('@pact-foundation/pact-node');
var server = pact.createServer({
    ...
});

Options:

List Mock Servers

If you ever need to see which servers are currently created.

var pact = require('@pact-foundation/pact-node');
var servers = pact.listServers();
console.log(JSON.stringify(servers));

Remove All Mock Servers

Remove all servers once you're done with them in one fell swoop.

var pact = require('@pact-foundation/pact-node');
pact.removeAllServers();

Start a Mock Server

Start the current server.

var pact = require('@pact-foundation/pact-node');
pact.createServer().start().then(function(){
    // Do something after it started
});

Stop a Mock server

Stop the current server.

var pact = require('@pact-foundation/pact-node');
pact.createServer().stop().then(function(){
    // Do something after it stopped
});

Delete a Mock server

Stop the current server and deletes it from the list.

var pact = require('@pact-foundation/pact-node');
pact.createServer().delete().then(function(){
    // Do something after it was killed
});

Check if a Mock server is running

var pact = require('@pact-foundation/pact-node');
pact.createServer().running;

Mock Server Events

There's 3 different events available, 'start', 'stop' and 'delete'. They can be listened to the same way as an EventEmitter.

var pact = require('@pact-foundation/pact-node');
var server = pact.createServer();
server.on('start', function() { console.log('started'); });
server.on('stop', function() { console.log('stopped'); });
server.on('delete', function() { console.log('deleted'); });

Provider Verification

Read more about Verify Pacts.

var pact = require('@pact-foundation/pact-node');

pact.verifyPacts({
    ...
});

Options:

Pact Broker Publishing

var pact = require('@pact-foundation/pact-node');
var opts = {
    ...
};

pact.publishPacts(opts).then(function () {
    // do something
});

Options:

Stub Servers

Stub servers create runnable APIs from existing pact files.

The interface is comparable to the Mock Server API.

Create Stub Server

var pact = require('@pact-foundation/pact-node');
var server = pact.createStub({
    ...
});

Options:

Contributing

To develop this project, simply install the dependencies and run npm run watch to for continual development, linting and testing when a source file changes.

Testing

Running npm test will execute the tests that has the *.spec.js pattern.

Questions?

Please search for potential answers or post question on our official Pact StackOverflow.