Module pact_ffi::verifier

The verifier module provides a number of exported functions using C bindings for controlling the pact verification process. These can be used in any language that supports C bindings.

Modules

handle

Handle interface to creating a verifier

verifier

Exported verifier functions

Structs

Argument

Contain the various attributes of an argument given to the verifier

OptionsFlags

Contain the lists of the two types of argument: options and flags

Functions

pactffi_verifier_add_custom_header

Adds a custom header to be added to the requests made to the provider.

pactffi_verifier_add_directory_source

Adds a Pact directory as a source to verify. All pacts from the directory that match the provider name will be verified.

pactffi_verifier_add_file_source

Adds a Pact file as a source to verify.

pactffi_verifier_broker_source

Adds a Pact broker as a source to verify. This will fetch all the pact files from the broker that match the provider name.

pactffi_verifier_broker_source_with_selectors

Adds a Pact broker as a source to verify. This will fetch all the pact files from the broker that match the provider name and the consumer version selectors (See https://docs.pact.io/pact_broker/advanced_topics/consumer_version_selectors/).

pactffi_verifier_cli_args

External interface to retrieve the options and arguments available when calling the CLI interface, returning them as a JSON string.

pactffi_verifier_execute

Runs the verification.

pactffi_verifier_json

Extracts the verification result as a JSON document. The returned string will need to be freed with the free_string function call to avoid leaking memory.

pactffi_verifier_logs

Extracts the logs for the verification run. This needs the memory buffer log sink to be setup before the verification is executed. The returned string will need to be freed with the free_string function call to avoid leaking memory.

pactffi_verifier_logs_for_provider

Extracts the logs for the verification run for the provider name. This needs the memory buffer log sink to be setup before the verification is executed. The returned string will need to be freed with the free_string function call to avoid leaking memory.

pactffi_verifier_newDeprecated

Get a Handle to a newly created verifier. You should call pactffi_verifier_shutdown when done with the verifier to free all allocated resources.

pactffi_verifier_new_for_application

Get a Handle to a newly created verifier. You should call pactffi_verifier_shutdown when done with the verifier to free all allocated resources

pactffi_verifier_output

Extracts the standard output for the verification run. The returned string will need to be freed with the free_string function call to avoid leaking memory.

pactffi_verifier_set_consumer_filters

Set the consumer filters for the Pact verifier.

pactffi_verifier_set_filter_info

Set the filters for the Pact verifier.

pactffi_verifier_set_provider_info

Set the provider details for the Pact verifier. Passing a NULL for any field will use the default value for that field.

pactffi_verifier_set_provider_state

Set the provider state for the Pact verifier.

pactffi_verifier_set_publish_options

Set the options used when publishing verification results to the Pact Broker

pactffi_verifier_set_verification_options

Set the options used by the verifier when calling the provider

pactffi_verifier_shutdown

Shutdown the verifier and release all resources

pactffi_verifier_url_source

Adds a URL as a source to verify. The Pact file will be fetched from the URL.

pactffi_verify^⚠Deprecated

External interface to verifier a provider