This project provides a command line interface to verify pact files against a running provider. It is a single executable binary. It implements the V1.1 Pact specification.
The Pact Verifier works by taking all the interactions (requests and responses) from a number of pact files. For each interaction, it will make the request defined in the pact to a running service provider and check the response received back against the one defined in the pact file. All mismatches will then be reported.
The pact verifier is bundled as a single binary executable pact_verifier_cli. Running this with out any options displays the standard help.
```console pactverifiercli v0.1.0 Standalone Pact verifier
USAGE:
pactverifiercli [FLAGS] [OPTIONS] --file
FLAGS: --filter-no-state Only validate interactions that have no defined provider state --help Prints help information --state-change-as-query State change request data will be sent as query parameters instead of in the request body --state-change-teardown State change teardown requests are to be made after each interaction -v, --version Prints version information
OPTIONS:
-b, --broker-url
You can control the log level with the -l, --loglevel <loglevel> option. It defaults to warn, and the options that you can specify are: error, warn, info, debug, trace, none.
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 <broker-url> | Pact Broker | Loads all the pacts for the provider from the pact broker. Requires the -n, --provider-name <provider-name> option |
The running provider can be specified with the following options:
| Option | Description |
|--------|-------------|
| -h, --hostname <hostname> | The provider hostname, defaults to localhost |
| -p, --port <port> | The provider port (defaults to 8080) |
| -n, --provider-name <provider-name> | The name of the provider. Required if you are loading pacts from a pact broker |
The interactions that are verified can be filtered by the following options:
-c, --filter-consumer <filter-consumer>This will only verify the interactions of matching consumers. You can specify multiple consumers by either seperating the names with a comma, or repeating the option.
--filter-description <filter-description>This option will filter the interactions that are verified that match by desciption. You can use a regular expression to match.
--filter-state <filter-state>This option will filter the interactions that are verified that match by provider state. You can use a regular expression to match. Can't be used with the --filter-no-state option.
--filter-no-stateThis option will filter the interactions that are verified that don't have a defined provider state. Can't be used with the --filter-state option.
Provider states are a mechanism to define the state that the provider needs to be in to be able to verify a particular request. This is achieved by setting a state change URL that will receive a POST request with the provider state before the actual request is made.
-s, --state-change-url <state-change-url>This sets the URL that the POST requests will be made to before each actual request.
--state-change-as-queryBy default, the state for the state change request will be sent as a JSON document in the body of the request. This option forces it to be sent as a query parameter instead.
--state-change-teardownThis option will cause the verifier to also make a tear down request after the main request is made. It will receive a second field in the body or a query parameter named action with the value teardown.
This will verify all the pacts for the happy_provider found in the pact broker (running on localhost) against the provider running on localhost port 5050. Only the pacts for the consumers Consumer and Consumer2 will be verified.
```console $ pactverifiercli -b http://localhost -n 'happyprovider' -p 5050 --filter-consumer Consumer --filter-consumer Consumer2 21:59:28 [WARN] pactmatching::models: No metadata found in pact file "http://localhost/pacts/provider/happyprovider/consumer/Consumer/version/1.0.0", assuming V1.1 specification 21:59:28 [WARN] pactmatching::models: No metadata found in pact file "http://localhost/pacts/provider/happy_provider/consumer/Consumer2/version/1.0.0", assuming V1.1 specification
Verifying a pact between Consumer and happy_provider Given I am friends with Fred WARNING: State Change ignored as there is no state change URL Given I have no friends WARNING: State Change ignored as there is no state change URL a request to unfriend but no friends returns a response which has status code 200 (OK) includes headers has a matching body (OK) a request friends returns a response which has status code 200 (FAILED) includes headers "Content-Type" with value "application/json" (FAILED) has a matching body (FAILED) a request to unfriend returns a response which has status code 200 (OK) includes headers "Content-Type" with value "application/json" (OK) has a matching body (FAILED)
Verifying a pact between Consumer2 and happy_provider Given I am friends with Fred WARNING: State Change ignored as there is no state change URL Given I have no friends WARNING: State Change ignored as there is no state change URL a request to unfriend but no friends returns a response which has status code 200 (OK) includes headers has a matching body (OK) a request friends returns a response which has status code 200 (FAILED) includes headers "Content-Type" with value "application/json" (FAILED) has a matching body (FAILED) a request to unfriend returns a response which has status code 200 (OK) includes headers "Content-Type" with value "application/json" (OK) has a matching body (FAILED)
Failures:
0) Verifying a pact between Consumer and happy_provider - a request friends returns a response which has a matching body expected 'application/json' body but was 'text/plain'
1) Verifying a pact between Consumer and happy_provider - a request friends returns a response which has status code 200 expected 200 but was 404
2) Verifying a pact between Consumer and happy_provider - a request friends returns a response which includes header 'Content-Type' with value 'application/json' Expected header 'Content-Type' to have value 'application/json' but was 'text/plain'
3) Verifying a pact between Consumer and happy_provider Given I am friends with Fred - a request to unfriend returns a response which has a matching body $.body -> Type mismatch: Expected Map {"reply":"Bye"} but received "Ok"
4) Verifying a pact between Consumer2 and happy_provider - a request friends returns a response which has a matching body expected 'application/json' body but was 'text/plain'
5) Verifying a pact between Consumer2 and happy_provider - a request friends returns a response which has status code 200 expected 200 but was 404
6) Verifying a pact between Consumer2 and happy_provider - a request friends returns a response which includes header 'Content-Type' with value 'application/json' Expected header 'Content-Type' to have value 'application/json' but was 'text/plain'
7) Verifying a pact between Consumer2 and happy_provider Given I am friends with Fred - a request to unfriend returns a response which has a matching body $.body -> Type mismatch: Expected Map {"reply":"Bye"} but received "Ok"
There were 8 pact failures
```