This project provides a command line interface to verify pact files against a running provider. It is a single executable binary. It implements the V3 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.
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.
|File||Loads a pact from the given file|
|URL||Loads a pact from a URL resource|
|Directory||Loads all the pacts from the given directory|
|Pact Broker||Loads all the pacts for the provider from the pact broker. Requires the |
The running provider can be specified with the following options:
|The provider hostname, defaults to |
|The provider port (defaults to protocol default 80/443)|
|The name of the provider. Required if you are loading pacts from a pact broker|
|If the provider is mounted on a sub-path, you can use this option to set the base path to add to all requests|
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 separating the names with a comma, or repeating the option.
This option will filter the interactions that are verified that match by description. You can use a regular expression to match.
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
This option will filter the interactions that are verified that don't have a defined provider state. Can't be used
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.
NOTE: For verifying messages fetched via HTTP, the provider state is also passed in the request to fetch the message, so the state change URL is not required.
-s, --state-change-url <state-change-url>#
This sets the URL that the POST requests will be made to before each actual request.
By 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.
This 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
Accepts a set of Consumer Version Selectors encoded as JSON.
An example well formed argument value might be:
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
Consumer2 will be verified.
Message pacts can be verified, the messages just need to be fetched from an HTTP endpoint. The verifier will send a POST request to the configured provider and expect the message payload in the response. The POST request will include the description and any provider states configured in the Pact file for the message, formatted as JSON.
Example POST request:
Message metadata can be included as base64 encoded key/value pairs in the response, packed into the
Pact-Message-Metadata HTTP header, and will be compared against any expected metadata in the pact file.
The values may contain any valid JSON.
For example, given this metadata:
we would encode it into a base64 string, giving us
Pact uses the rustls-native-certs crate, which will respect the platform's native certificate store when operating as a TLS client:
This is supported on Windows, macOS and Linux:
- On Windows, certificates are loaded from the system certificate store. The schannel crate is used to access the Windows certificate store APIs.
- On macOS, certificates are loaded from the keychain. The user, admin and system trust settings are merged together as documented by Apple. The security-framework crate is used to access the keystore APIs.
- On Linux and other UNIX-like operating systems, the openssl-probe crate is used to discover the filename of the system CA bundle.
On Linux the standard OpenSSL environment variables
SSL_CERT_DIR will also be respected.
Pact files that require plugins can be verified with version 0.9.0-beta.0+. For details on how plugins work, see the Pact plugin project.
Each required plugin is defined in the
plugins section in the Pact metadata in the Pact file. The plugins will be
loaded from the plugin directory. By default, this is
~/.pact/plugins or the value of the
variable. Each plugin required by the Pact file must be installed there. You will need to follow the installation
instructions for each plugin, but the default is to unpack the plugin into a sub-directory
(i.e., for the Protobuf plugin 0.0.0 it will be
protobuf-0.0.0). The plugin manifest file must be present for the
plugin to be able to be loaded.