This project provides a server that can generate responses based on pact files. It is a single executable binary. It implements the V4 Pact specification.
The stub server works by taking all the interactions (requests and responses) from a number of pact files. For each interaction, it will compare any incoming request against those defined in the pact files. If there is a match (based on method, path and query parameters), it will return the response from the pact file.
Note: The stub server was designed to supporting prototyping of mobile applications by stubbing out the backend servers. It will always try to return a response, even when there is not an extract match with the pact files.
The pact stub server is bundled as a single binary executable pact-stub-server. Running this without any options displays the standard help.
```console ❯ pact-stub-server Pact Stub Server 0.5.2
Usage: pact-stub-server [OPTIONS]
Options:
-l, --loglevel
You can control the log level with the -l, --loglevel <loglevel> option. It defaults to info, and the options that you can specify are: error, warn, info, debug, trace, none.
If you specify the -o, --cors option, then any un-matched OPTION request will result in a default 200 response. By default the
Access-Control-Allow-Origin header will be set to *. If you provide the --cors-referer flag, then it will be set to the
value of the Referer header from the request.
You can specify the pacts to verify with the following options. They can be repeated to set multiple sources.
| Option | Type | Description |
|--------|------|-------------|
| -f, --file <file> | File | Loads a pact from the given file |
| -u, --url <url> | URL | Loads a pact from a URL resource |
| -d, --dir <dir> | Directory | Loads all the pacts from the given directory |
| -b, --broker-url <url> | URL | Loads all the latest pacts from the Pact Broker |
Note: For URLs and Pact Brokers that are authenticated, you can use the --user option to set the username and password or the
--token to use a bearer token.
If you need to load pact files from a HTTPS URL that is using a self-signed certificate, you can use the --insecure-tls
flag to disable the TLS certificate validation. WARNING: this disables all certificate validations, including expired
certificates.
You can filter the interactions by provider state by supplying the --provider-state option. This takes a regular
expression that is applied to all interactions before the requests are matched.
For Pacts fetched from a Pact broker, you can filter the Pacts by the consumer and/or provider names using:
```
--consumer-names
--provider-names
The running server can be controlled with the following options:
| Option | Description |
|--------|-------------|
| -p, --port <port> | The port to bind to. If not specified, a random port will be allocated by the operating system. |
A docker image is published to pactfoundation/pact-stub-server.
Example of using it:
```
docker pull pactfoundation/pact-stub-server docker run -t -p 8080:8080 -v "$(pwd)/pacts/:/app/pacts" pactfoundation/pact-stub-server -p 8080 -d pacts
curl -v $(docker-machine ip $(docker-machine active)):8080/bazbat curl -v $(docker-machine ip $(docker-machine active)):8080/foobar ```