Pact

Pact ▸
- Static members
- .create
- .Verifier
- .Matchers
PactProvider ▸
- Instance members
- #addInteraction
- #verify
- #finalize
- #writePact
- #removeInteractions
setup
Matchers ▸
- Static members
- .term
- .eachLike
- .somethingLike
ProviderVerifier
MockService ▸
- Instance members
- #constructor
- #addInteraction
- #removeInteractions
- #verify
- #writePact
Interaction ▸
- Instance members
- #constructor
- #given
- #uponReceiving
- #withRequest
- #willRespondWith
- #json

Need help reading this?

Pact

src/pact.js

Pact module.

Pact

Static Members

▸ create

Creates a new PactProvider.

create

Parameters

opts (Object)

Name	Description
opts.consumer `string`	the name of the consumer
opts.provider `string`	the name of the provider
opts.port `number`	port of the mock service, defaults to 1234
opts.host `string`	host address of the mock service, defaults to 127.0.0.1
opts.ssl `boolean`	SSL flag to identify the protocol to be used (default false, HTTP)

▸ Verifier

Exposes Verifier

Verifier

▸ Matchers

Exposes Matchers#term

Matchers

PactProvider

src/pact.js

PactProvider

Instance Members

▸ addInteraction(interactionObj)

Add an interaction to the MockService.

addInteraction(interactionObj: Interaction): Promise

Parameters

interactionObj (Interaction)

Returns

Promise:

▸ verify()

Checks with the Mock Service if the expected interactions have been exercised.

verify(): Promise

Returns

Promise:

▸ finalize()

Writes the Pact and clears any interactions left behind and shutdown the mock server

finalize(): Promise

Returns

Promise:

▸ writePact()

Writes the pact file out to file. Should be called when all tests have been performed for a given Consumer <-> Provider pair. It will write out the Pact to the configured file.

writePact(): Promise

Returns

Promise:

▸ removeInteractions()

Clear up any interactions in the Provider Mock Server.

removeInteractions(): Promise

Returns

Promise:

setup

src/pact.js

Start the Mock Server.

setup(): Promise

Returns

Promise:

Matchers

src/dsl/matchers.js

Matchers

Static Members

▸ term(opts)

The term matcher.

term(opts: Object)

Parameters

opts (Object)

Name	Description
opts.generate `string`	a value to represent the matched String
opts.matcher `string`	a Regex representing the value

▸ eachLike(content, opts)

The eachLike matcher

eachLike(content: string, opts: Object)

Parameters

content (string)

opts (Object)

Name	Description
opts.min `Number`

▸ somethingLike(value)

The somethingLike matcher

somethingLike(value: string)

Parameters

value (string) the value to be somethingLike

ProviderVerifier

src/dsl/verifier.js

Provider Verifier service

ProviderVerifier

MockService

src/dsl/mockService.js

Mock Service is the HTTP interface to setup the Pact Mock Service. See https://github.com/bethesque/pact-mock_service and https://gist.github.com/bethesque/9d81f21d6f77650811f4.

MockService

Instance Members

▸ constructor(consumer, provider, port, host, ssl)

constructor(consumer: string, provider: string, port: number, host: string, ssl: boolean)

Parameters

consumer (string) the consumer name

provider (string) the provider name

port (number) the mock service port, defaults to 1234

host (string) the mock service host, defaults to 127.0.0.1

ssl (boolean) which protocol to use, defaults to false (HTTP)

▸ addInteraction(interaction)

Adds an interaction

addInteraction(interaction: Interaction): Promise

Parameters

interaction (Interaction)

Returns

Promise:

▸ removeInteractions()

Removes all interactions.

removeInteractions(): Promise

Returns

Promise:

▸ verify()

Verify all interactions.

verify(): Promise

Returns

Promise:

▸ writePact()

Writes the Pact file.

writePact(): Promise

Returns

Promise:

Interaction

src/dsl/interaction.js

An Interaction is where you define the state of your interaction with a Provider.

Interaction

Instance Members

▸ constructor()

Creates a new Interaction.

constructor(): Interaction

Returns

Interaction: interaction

▸ given(providerState)

Gives a state the provider should be in for this interaction.

given(providerState: string): Interaction

Parameters

providerState (string) The state of the provider.

Returns

Interaction: interaction

▸ uponReceiving(description)

A free style description of the interaction.

uponReceiving(description: string): Interaction

Parameters

description (string) A description of the interaction.

Returns

Interaction: interaction

▸ withRequest(requestOpts)

The request that represents this interaction triggered by the consumer.

withRequest(requestOpts: Object): Interaction

Parameters

requestOpts (Object)

Name	Description
requestOpts.method `string`	The HTTP method
requestOpts.path `string`	The path of the URL
requestOpts.query `string`	Any query string in the interaction
requestOpts.headers `Object`	A key-value pair oject of headers
requestOpts.body `Object`	The body, in String format or Object format

Returns

Interaction: interaction

▸ willRespondWith(responseOpts)

The response expected by the consumer.

willRespondWith(responseOpts: Object)

Parameters

responseOpts (Object)

Name	Description
responseOpts.status `string`	The HTTP status
responseOpts.headers `string`
responseOpts.body `Object`

▸ json()

Returns the interaction object created.

json(): Object

Returns

Object: