Verifier

Verifier for Pact.

The Verifier is used to verify that a provider meets the expectations of a consumer. This is done by replaying interactions from the consumer against the provider, and ensuring that the provider's responses match the expectations set by the consumer.

The interactions to be verified can be sourced either from local Pact files or from a Pact Broker. The Verifier can be configured to filter interactions based on their description and state, and to set the provider information and transports.

When performing the verification, Pact will replay the interactions from the consumer against the provider and ensure that the provider's responses match the expectations set by the consumer.

Info

The interface provided by this module could be improved. If you have any suggestions, please consider creating a new GitHub discussion or reaching out over Slack.

Usage

The general usage of the Verifier is as follows:

from pact.v3 import Verifier


# In the case of local Pact files
verifier = (
    Verifier("My Provider")
    .add_transport("http", url="http://localhost:8080")
    .add_source("pact/to/pacts/")
)
verifier.verify()

# In the case of a Pact Broker
verifier = (
    Verifier("My Provider")
    .add_transport("http", url="http://localhost:8080")
    .broker_source("https://broker.example.com/")
)
verifier.verify()

State Handling

In general, the consumer will write interactions assuming that the provider is in a certain state. For example, a consumer requesting information about a user with ID 123 will have specified given("user with ID 123 exists"). It is the responsibility of the provider to ensure that this state is met before the interaction is replayed.

In order to change the provider's internal state, Pact relies on a callback endpoint. The specific manner in which this endpoint is implemented is up to the provider as it is highly dependent on the provider's architecture.

One common approach is to define the endpoint during testing only, and for the endpoint to mock the expected calls to the database and/or external services. This allows the provider to be tested in isolation from the rest of the system, and assertions can be made about the calls made to the endpoint.

An alternative approach might be to run a dedicated service which is responsible for writing to the database such that the provider can retrieve the expected data. This approach is more complex, but could be useful in cases where test databases are already in use.

Attributes

logger = logging.getLogger(__name__) module-attribute

Classes

BrokerSelectorBuilder(verifier: Verifier, url: str, username: str | None, password: str | None, token: str | None)

A Broker selector.

This class encapsulates the logic for selecting Pacts from a Pact broker.

This constructor should not be called directly. Instead, use the broker_source method of the Verifier class with selector=True.

Source code in src/pact/v3/verifier.py

def __init__(
    self,
    verifier: Verifier,
    url: str,
    username: str | None,
    password: str | None,
    token: str | None,
) -> None:
    """
    Instantiate a new Broker Selector.

    This constructor should not be called directly. Instead, use the
    `broker_source` method of the `Verifier` class with `selector=True`.
    """
    self._verifier = verifier
    self._url = url
    self._username = username
    self._password = password
    self._token = token

    # If the instance is dropped without having the `build()` method called,
    # raise a warning.
    self._built = False

    self._include_pending: bool = False
    "Whether to include pending Pacts."

    self._include_wip_since: date | None = None
    "Whether to include work in progress Pacts since a given date."

    self._provider_tags: list[str] | None = None
    "List of provider tags to match."

    self._provider_branch: str | None = None
    "The provider branch."

    self._consumer_versions: list[str] | None = None
    "List of consumer version regex patterns."

    self._consumer_tags: list[str] | None = None
    "List of consumer tags to match."

Functions

build() -> Verifier

Build the Broker Selector.

RETURNS	DESCRIPTION
Verifier	The Verifier instance with the broker source added.

Source code in src/pact/v3/verifier.py

def build(self) -> Verifier:
    """
    Build the Broker Selector.

    Returns:
        The Verifier instance with the broker source added.
    """
    pact.v3.ffi.verifier_broker_source_with_selectors(
        self._verifier._handle,  # noqa: SLF001
        self._url,
        self._username,
        self._password,
        self._token,
        self._include_pending,
        self._include_wip_since,
        self._provider_tags or [],
        self._provider_branch,
        self._consumer_versions or [],
        self._consumer_tags or [],
    )
    self._built = True
    return self._verifier

consumer_tags(*tags: str) -> Self

Set the consumer tags.

Source code in src/pact/v3/verifier.py

def consumer_tags(self, *tags: str) -> Self:
    """
    Set the consumer tags.
    """
    self._consumer_tags = list(tags)
    return self

consumer_versions(*versions: str) -> Self

Set the consumer versions.

Source code in src/pact/v3/verifier.py

def consumer_versions(self, *versions: str) -> Self:
    """
    Set the consumer versions.
    """
    self._consumer_versions = list(versions)
    return self

exclude_pending() -> Self

Exclude pending Pacts.

Source code in src/pact/v3/verifier.py

def exclude_pending(self) -> Self:
    """
    Exclude pending Pacts.
    """
    self._include_pending = False
    return self

exclude_wip() -> Self

Exclude work in progress Pacts.

Source code in src/pact/v3/verifier.py

def exclude_wip(self) -> Self:
    """
    Exclude work in progress Pacts.
    """
    self._include_wip_since = None
    return self

include_pending() -> Self

Include pending Pacts.

Source code in src/pact/v3/verifier.py

def include_pending(self) -> Self:
    """
    Include pending Pacts.
    """
    self._include_pending = True
    return self

include_wip_since(d: str | date) -> Self

Include work in progress Pacts since a given date.

Source code in src/pact/v3/verifier.py

def include_wip_since(self, d: str | date) -> Self:
    """
    Include work in progress Pacts since a given date.
    """
    if isinstance(d, str):
        d = date.fromisoformat(d)
    self._include_wip_since = d
    return self

provider_branch(branch: str) -> Self

Set the provider branch.

Source code in src/pact/v3/verifier.py

def provider_branch(self, branch: str) -> Self:
    """
    Set the provider branch.
    """
    self._provider_branch = branch
    return self

provider_tags(*tags: str) -> Self

Set the provider tags.

Source code in src/pact/v3/verifier.py

def provider_tags(self, *tags: str) -> Self:
    """
    Set the provider tags.
    """
    self._provider_tags = list(tags)
    return self

Verifier(name: str, host: str | None = None)

A Verifier between a consumer and a provider.

This class encapsulates the logic for verifying that a provider meets the expectations of a consumer. This is done by replaying interactions from the consumer against the provider, and ensuring that the provider's responses match the expectations set by the consumer.

PARAMETER	DESCRIPTION
name	The name of the provider to verify. This is used to identify which interactions the provider is involved in, and then Pact will replay these interactions against the provider. TYPE: str
host	The host on which the Pact verifier is running. This is used to communicate with the provider. If not specified, the default value is localhost. TYPE: str | None DEFAULT: None

Source code in src/pact/v3/verifier.py

def __init__(self, name: str, host: str | None = None) -> None:
    """
    Create a new Verifier.

    Args:
        name:
            The name of the provider to verify. This is used to identify
            which interactions the provider is involved in, and then Pact
            will replay these interactions against the provider.

        host:
            The host on which the Pact verifier is running. This is used to
            communicate with the provider. If not specified, the default
            value is `localhost`.
    """
    self._name = name
    self._host = host or "localhost"
    self._handle = pact.v3.ffi.verifier_new_for_application()

    # In order to provide a fluent interface, we remember some options which
    # are set using the same FFI method. In particular, we remember
    # transport methods defined, and then before verification call the
    # `set_info` and `add_transport` FFI methods as needed.
    self._transports: list[_ProviderTransport] = []
    self._message_producer: MessageProducer | nullcontext[None] = nullcontext()
    self._state_handler: StateCallback | nullcontext[None] = nullcontext()
    self._disable_ssl_verification = False
    self._request_timeout = 5000

Attributes

logs: str property

Get the logs.

results: dict[str, Any] property

Get the results.

Functions

add_custom_header(name: str, value: str) -> Self

Add a customer header to the request.

These headers are added to every request made to the provider.

PARAMETER	DESCRIPTION
name	The key of the header. TYPE: str
value	The value of the header. TYPE: str

Source code in src/pact/v3/verifier.py

def add_custom_header(self, name: str, value: str) -> Self:
    """
    Add a customer header to the request.

    These headers are added to every request made to the provider.

    Args:
        name:
            The key of the header.

        value:
            The value of the header.
    """
    pact.v3.ffi.verifier_add_custom_header(self._handle, name, value)
    return self

add_custom_headers(headers: dict[str, str] | Iterable[tuple[str, str]]) -> Self

Add multiple customer headers to the request.

These headers are added to every request made to the provider.

PARAMETER	DESCRIPTION
headers	The headers to add. This can be a dictionary or an iterable of key-value pairs. The iterable is preferred as it ensures that repeated headers are not lost. TYPE: dict[str, str] | Iterable[tuple[str, str]]

Source code in src/pact/v3/verifier.py

def add_custom_headers(
    self,
    headers: dict[str, str] | Iterable[tuple[str, str]],
) -> Self:
    """
    Add multiple customer headers to the request.

    These headers are added to every request made to the provider.

    Args:
        headers:
            The headers to add. This can be a dictionary or an iterable of
            key-value pairs. The iterable is preferred as it ensures that
            repeated headers are not lost.
    """
    if isinstance(headers, dict):
        headers = headers.items()
    for name, value in headers:
        self.add_custom_header(name, value)
    return self

add_source(source: str | Path | URL, *, username: str | None = None, password: str | None = None, token: str | None = None) -> Self

add_source(
    source: str | URL,
    *,
    username: str | None = None,
    password: str | None = None,
) -> Self

add_source(
    source: str | URL, *, token: str | None = None
) -> Self

add_source(source: str | Path) -> Self

Adds a source to the verifier.

This will use one or more Pact files as the source of interactions to verify.

PARAMETER	DESCRIPTION
source	The source of the interactions. This may be either of the following: A local file path to a Pact file. A local file path to a directory containing Pact files. A URL to a Pact file. If using a URL, the username and password parameters can be used to provide basic HTTP authentication, or the token parameter can be used to provide bearer token authentication. The username and password parameters can also be passed as part of the URL. TYPE: str | Path | URL
username	The username to use for basic HTTP authentication. This is only used when the source is a URL. TYPE: str | None DEFAULT: None
password	The password to use for basic HTTP authentication. This is only used when the source is a URL. TYPE: str | None DEFAULT: None
token	The token to use for bearer token authentication. This is only used when the source is a URL. Note that this is mutually exclusive with username and password. TYPE: str | None DEFAULT: None

Source code in src/pact/v3/verifier.py

def add_source(
    self,
    source: str | Path | URL,
    *,
    username: str | None = None,
    password: str | None = None,
    token: str | None = None,
) -> Self:
    """
    Adds a source to the verifier.

    This will use one or more Pact files as the source of interactions to
    verify.

    Args:
        source:
            The source of the interactions. This may be either of the
            following:

            - A local file path to a Pact file.
            - A local file path to a directory containing Pact files.
            - A URL to a Pact file.

            If using a URL, the `username` and `password` parameters can be
            used to provide basic HTTP authentication, or the `token`
            parameter can be used to provide bearer token authentication.
            The `username` and `password` parameters can also be passed as
            part of the URL.

        username:
            The username to use for basic HTTP authentication. This is only
            used when the source is a URL.

        password:
            The password to use for basic HTTP authentication. This is only
            used when the source is a URL.

        token:
            The token to use for bearer token authentication. This is only
            used when the source is a URL. Note that this is mutually
            exclusive with `username` and `password`.
    """
    if isinstance(source, Path):
        return self._add_source_local(source)

    if isinstance(source, URL):
        if source.scheme == "file":
            return self._add_source_local(source.path)

        if source.scheme in ("http", "https"):
            return self._add_source_remote(
                source,
                username=username,
                password=password,
                token=token,
            )

        msg = f"Invalid source scheme: {source.scheme}"
        raise ValueError(msg)

    # Strings are ambiguous, so we need identify them as either local or
    # remote.
    if "://" in source:
        return self._add_source_remote(
            URL(source),
            username=username,
            password=password,
            token=token,
        )
    return self._add_source_local(source)

add_transport(*, url: str | URL | None = None, protocol: str | None = None, port: int | None = None, path: str | None = None, scheme: str | None = None) -> Self

Add a provider transport method.

If the provider supports multiple transport methods, or non-HTTP(S) methods, this method allows these additional transport methods to be added. It can be called multiple times to add multiple transport methods.

As some transport methods may not use ports, paths or schemes, these parameters are optional. Note that while optional, these may still be used during testing as Pact uses HTTP(S) to communicate with the provider. For example, if you are implementing your own message verification, it needs to be exposed over HTTP and the port and path arguments are used for this testing communication.

PARAMETER	DESCRIPTION
url	A convenient way to set the provider transport. This option is mutually exclusive with the other options. TYPE: str | URL | None DEFAULT: None
protocol	The protocol to use. This will typically be one of: http for communications over HTTP(S) message for non-plugin message-based communications Any other protocol will be treated as a custom protocol and will be handled by a plugin. If url is not specified, this parameter is required. TYPE: str | None DEFAULT: None
port	The provider port. If the protocol does not use ports, this parameter should be None. If not specified, the default port for the scheme will be used (provided the scheme is known). TYPE: int | None DEFAULT: None
path	The provider context path. For protocols which do not use paths, this parameter should be None. For protocols which do use paths, this parameter should be specified to avoid any ambiguity, though if left unspecified, the root path will be used. If a non-root path is used, the path given here will be prepended to the path in the interaction. For example, if the path is /api, and the interaction path is /users, the request will be made to /api/users. TYPE: str | None DEFAULT: None
scheme	The provider scheme, if applicable to the protocol. This is typically only used for the http protocol, where this value can either be http (the default) or https. TYPE: str | None DEFAULT: None

Source code in src/pact/v3/verifier.py

def add_transport(
    self,
    *,
    url: str | URL | None = None,
    protocol: str | None = None,
    port: int | None = None,
    path: str | None = None,
    scheme: str | None = None,
) -> Self:
    """
    Add a provider transport method.

    If the provider supports multiple transport methods, or non-HTTP(S)
    methods, this method allows these additional transport methods to be
    added. It can be called multiple times to add multiple transport
    methods.

    As some transport methods may not use ports, paths or schemes, these
    parameters are optional. Note that while optional, these _may_ still be
    used during testing as Pact uses HTTP(S) to communicate with the
    provider. For example, if you are implementing your own message
    verification, it needs to be exposed over HTTP and the `port` and `path`
    arguments are used for this testing communication.

    Args:
        url:
            A convenient way to set the provider transport. This option
            is mutually exclusive with the other options.

        protocol:
            The protocol to use. This will typically be one of:

            -   `http` for communications over HTTP(S)

            -   `message` for non-plugin message-based communications

            Any other protocol will be treated as a custom protocol and will
            be handled by a plugin.

            If `url` is _not_ specified, this parameter is required.

        port:
            The provider port.

            If the protocol does not use ports, this parameter should be
            `None`. If not specified, the default port for the scheme will
            be used (provided the scheme is known).

        path:
            The provider context path.

            For protocols which do not use paths, this parameter should be
            `None`.

            For protocols which do use paths, this parameter should be
            specified to avoid any ambiguity, though if left unspecified,
            the root path will be used.

            If a non-root path is used, the path given here will be
            prepended to the path in the interaction. For example, if the
            path is `/api`, and the interaction path is `/users`, the
            request will be made to `/api/users`.

        scheme:
            The provider scheme, if applicable to the protocol.

            This is typically only used for the `http` protocol, where this
            value can either be `http` (the default) or `https`.
    """
    if url and any(x is not None for x in (protocol, port, path, scheme)):
        msg = "The `url` parameter is mutually exclusive with other parameters"
        raise ValueError(msg)

    if url:
        url = URL(url)
        if url.host != self._host:
            msg = f"Host mismatch: {url.host} != {self._host}"
            raise ValueError(msg)
        protocol = url.scheme
        if protocol == "https":
            protocol = "http"
        port = url.port
        path = url.path
        scheme = url.scheme
        return self.add_transport(
            protocol=protocol,
            port=port,
            path=path,
            scheme=scheme,
        )

    if not protocol:
        msg = "A protocol must be specified"
        raise ValueError(msg)

    if port is None and scheme:
        if scheme.lower() == "http":
            port = 80
        elif scheme.lower() == "https":
            port = 443

    logger.debug(
        "Adding transport to verifier",
        extra={
            "protocol": protocol,
            "port": port,
            "path": path,
            "scheme": scheme,
        },
    )
    self._transports.append(
        _ProviderTransport(
            transport=protocol,
            port=port,
            path=path,
            scheme=scheme,
        )
    )

    return self

broker_source(url: str | URL, *, username: str | None = None, password: str | None = None, token: str | None = None, selector: bool = False) -> BrokerSelectorBuilder | Self

broker_source(
    url: str | URL,
    *,
    username: str | None = None,
    password: str | None = None,
    selector: Literal[False] = False,
) -> Self

broker_source(
    url: str | URL,
    *,
    token: str | None = None,
    selector: Literal[False] = False,
) -> Self

broker_source(
    url: str | URL,
    *,
    username: str | None = None,
    password: str | None = None,
    selector: Literal[True],
) -> BrokerSelectorBuilder

broker_source(
    url: str | URL,
    *,
    token: str | None = None,
    selector: Literal[True],
) -> BrokerSelectorBuilder

Adds a broker source to the verifier.

PARAMETER	DESCRIPTION
url	The broker URL. TThe URL may contain a username and password for basic HTTP authentication. TYPE: str | URL
username	The username to use for basic HTTP authentication. If the source is a URL containing a username, this parameter must be None. TYPE: str | None DEFAULT: None
password	The password to use for basic HTTP authentication. If the source is a URL containing a password, this parameter must be None. TYPE: str | None DEFAULT: None
token	The token to use for bearer token authentication. This is mutually exclusive with username and password (whether they be specified through arguments, or embedded in the URL). TYPE: str | None DEFAULT: None
selector	Whether to return a BrokerSelectorBuilder instance. TYPE: bool DEFAULT: False

Source code in src/pact/v3/verifier.py

def broker_source(
    self,
    url: str | URL,
    *,
    username: str | None = None,
    password: str | None = None,
    token: str | None = None,
    selector: bool = False,
) -> BrokerSelectorBuilder | Self:
    """
    Adds a broker source to the verifier.

    Args:
        url:
            The broker URL. TThe URL may contain a username and password for
            basic HTTP authentication.

        username:
            The username to use for basic HTTP authentication. If the source
            is a URL containing a username, this parameter must be `None`.

        password:
            The password to use for basic HTTP authentication. If the source
            is a URL containing a password, this parameter must be `None`.

        token:
            The token to use for bearer token authentication. This is
            mutually exclusive with `username` and `password` (whether they
            be specified through arguments, or embedded in the URL).

        selector:
            Whether to return a BrokerSelectorBuilder instance.
    """
    url = URL(url)

    if url.user and username:
        msg = "Cannot specify both `username` and a username in the URL"
        raise ValueError(msg)
    username = url.user or username

    if url.password and password:
        msg = "Cannot specify both `password` and a password in the URL"
        raise ValueError(msg)
    password = url.password or password

    if token and (username or password):
        msg = "Cannot specify both `token` and `username`/`password`"
        raise ValueError(msg)

    if selector:
        return BrokerSelectorBuilder(
            self,
            str(url.with_user(None).with_password(None)),
            username,
            password,
            token,
        )
    pact.v3.ffi.verifier_broker_source(
        self._handle,
        str(url.with_user(None).with_password(None)),
        username,
        password,
        token,
    )
    return self

disable_ssl_verification() -> Self

Disable SSL verification.

Source code in src/pact/v3/verifier.py

def disable_ssl_verification(self) -> Self:
    """
    Disable SSL verification.
    """
    self._disable_ssl_verification = True
    pact.v3.ffi.verifier_set_verification_options(
        self._handle,
        disable_ssl_verification=self._disable_ssl_verification,
        request_timeout=self._request_timeout,
    )
    return self

filter(description: str | None = None, *, state: str | None = None, no_state: bool = False) -> Self

Set the filter for the interactions.

This method can be used to filter interactions based on their description and state. Repeated calls to this method will replace the previous filter.

PARAMETER	DESCRIPTION
description	The interaction description. This should be a regular expression. If unspecified, no filtering will be done based on the description. TYPE: str | None DEFAULT: None
state	The interaction state. This should be a regular expression. If unspecified, no filtering will be done based on the state. TYPE: str | None DEFAULT: None
no_state	Whether to include interactions with no state. TYPE: bool DEFAULT: False

Source code in src/pact/v3/verifier.py

def filter(
    self,
    description: str | None = None,
    *,
    state: str | None = None,
    no_state: bool = False,
) -> Self:
    """
    Set the filter for the interactions.

    This method can be used to filter interactions based on their
    description and state. Repeated calls to this method will replace the
    previous filter.

    Args:
        description:
            The interaction description. This should be a regular
            expression. If unspecified, no filtering will be done based on
            the description.

        state:
            The interaction state. This should be a regular expression. If
            unspecified, no filtering will be done based on the state.

        no_state:
            Whether to include interactions with no state.
    """
    logger.debug(
        "Setting filter for verifier",
        extra={
            "description": description,
            "state": state,
            "no_state": no_state,
        },
    )
    pact.v3.ffi.verifier_set_filter_info(
        self._handle,
        description,
        state,
        filter_no_state=no_state,
    )
    return self

filter_consumers(*filters: str) -> Self

Filter the consumers.

PARAMETER	DESCRIPTION
filters	Filters to apply to the consumers. TYPE: str DEFAULT: ()

Source code in src/pact/v3/verifier.py

def filter_consumers(self, *filters: str) -> Self:
    """
    Filter the consumers.

    Args:
        filters:
            Filters to apply to the consumers.
    """
    pact.v3.ffi.verifier_set_consumer_filters(self._handle, filters)
    return self

logs_for_provider(provider: str) -> str classmethod

Get the logs for a provider.

Source code in src/pact/v3/verifier.py

@classmethod
def logs_for_provider(cls, provider: str) -> str:
    """
    Get the logs for a provider.
    """
    return pact.v3.ffi.verifier_logs_for_provider(provider)

message_handler(handler: MessageProducerFull | dict[str, MessageProducerNoName | Message]) -> Self

message_handler(handler: MessageProducerFull) -> Self

message_handler(
    handler: dict[str, MessageProducerNoName | Message],
) -> Self

Set the message handler.

This method sets a custom message handler for the verifier. The handler can be called to produce a specific message to send to the provider.

This can be provided in one of two ways:

1. A fully fledged function that will be called for all messages. The function must take two arguments: the name of the message (as a string), and optional parameters (as a dictionary). This then returns the message as bytes.

   This is the most powerful option as it allows for full control over the message generation.

2. A dictionary mapping message names to producer functions, or bytes. In this case, the producer function must take optional parameters (as a dictionary) and return the message as bytes.

   If the message to be produced is static, the bytes can be provided directly.

Implementation

There are a large number of ways to send messages, and the specifics of the transport methods are not specifically relevant to Pact. As such, Pact abstracts the transport layer away and uses a lightweight HTTP server to handle messages.

Pact Python is capable of setting up this server and handling the messages internally using user-provided handlers. It is possible to use your own HTTP server to handle messages by using the add_transport method. It is not possible to use both this method and add_transport to handle messages.

PARAMETER	DESCRIPTION
handler	The message handler. This should be a callable that takes no arguments: the TYPE: MessageProducerFull | dict[str, MessageProducerNoName | Message]

Source code in src/pact/v3/verifier.py

def message_handler(
    self,
    handler: MessageProducerFull | dict[str, MessageProducerNoName | Message],
) -> Self:
    """
    Set the message handler.

    This method sets a custom message handler for the verifier. The handler
    can be called to produce a specific message to send to the provider.

    This can be provided in one of two ways:

    1.  A fully fledged function that will be called for all messages. The
        function must take two arguments: the name of the message (as a
        string), and optional parameters (as a dictionary). This then
        returns the message as bytes.

        This is the most powerful option as it allows for full control over
        the message generation.

    2.  A dictionary mapping message names to producer functions, or bytes.
        In this case, the producer function must take optional parameters
        (as a dictionary) and return the message as bytes.

        If the message to be produced is static, the bytes can be provided
        directly.

    ## Implementation

    There are a large number of ways to send messages, and the specifics of
    the transport methods are not specifically relevant to Pact. As such,
    Pact abstracts the transport layer away and uses a lightweight HTTP
    server to handle messages.

    Pact Python is capable of setting up this server and handling the
    messages internally using user-provided handlers. It is possible to use
    your own HTTP server to handle messages by using the `add_transport`
    method. It is not possible to use both this method and `add_transport`
    to handle messages.

    Args:
        handler:
            The message handler. This should be a callable that takes no
            arguments: the
    """
    logger.debug(
        "Setting message handler for verifier",
        extra={
            "path": "/_pact/message",
        },
    )

    if callable(handler):
        if len(inspect.signature(handler).parameters) != 2:  # noqa: PLR2004
            msg = "The function must take two arguments: name and parameters"
            raise TypeError(msg)

        self._message_producer = MessageProducer(handler)
        self.add_transport(
            protocol="message",
            port=self._message_producer.port,
            path=self._message_producer.path,
        )

    if isinstance(handler, dict):
        # Check that all values are either callable with one argument, or
        # bytes.
        for value in handler.values():
            if callable(value) and len(inspect.signature(value).parameters) != 1:
                msg = "All functions must take one argument: parameters"
                raise TypeError(msg)
            if not callable(value) and not isinstance(value, dict):
                msg = "All values must be callable or dictionaries"
                raise TypeError(msg)

        def _handler(name: str, parameters: dict[str, Any] | None) -> Message:
            logger.info("Internal handler called")
            val = handler[name]
            if callable(val):
                return val(parameters)
            return val

        self._message_producer = MessageProducer(_handler)
        self.add_transport(
            protocol="message",
            port=self._message_producer.port,
            path=self._message_producer.path,
        )

    return self

output(*, strip_ansi: bool = False) -> str

Get the output.

Source code in src/pact/v3/verifier.py

def output(self, *, strip_ansi: bool = False) -> str:
    """
    Get the output.
    """
    return pact.v3.ffi.verifier_output(self._handle, strip_ansi=strip_ansi)

set_coloured_output(*, enabled: bool = True) -> Self

Toggle coloured output.

Source code in src/pact/v3/verifier.py

def set_coloured_output(self, *, enabled: bool = True) -> Self:
    """
    Toggle coloured output.
    """
    pact.v3.ffi.verifier_set_coloured_output(self._handle, enabled=enabled)
    return self

set_error_on_empty_pact(*, enabled: bool = True) -> Self

Toggle error on empty pact.

If enabled, a Pact file with no interactions will cause the verifier to return an error. If disabled, a Pact file with no interactions will be ignored.

Source code in src/pact/v3/verifier.py

def set_error_on_empty_pact(self, *, enabled: bool = True) -> Self:
    """
    Toggle error on empty pact.

    If enabled, a Pact file with no interactions will cause the verifier to
    return an error. If disabled, a Pact file with no interactions will be
    ignored.
    """
    pact.v3.ffi.verifier_set_no_pacts_is_error(self._handle, enabled=enabled)
    return self

set_publish_options(version: str, url: str | None = None, branch: str | None = None, tags: list[str] | None = None) -> Self

Set options used when publishing results to the Broker.

PARAMETER	DESCRIPTION
version	The provider version. TYPE: str
url	URL to the build which ran the verification. TYPE: str | None DEFAULT: None
tags	Collection of tags for the provider. TYPE: list[str] | None DEFAULT: None
branch	Name of the branch used for verification. TYPE: str | None DEFAULT: None

Source code in src/pact/v3/verifier.py

def set_publish_options(
    self,
    version: str,
    url: str | None = None,
    branch: str | None = None,
    tags: list[str] | None = None,
) -> Self:
    """
    Set options used when publishing results to the Broker.

    Args:
        version:
            The provider version.

        url:
            URL to the build which ran the verification.

        tags:
            Collection of tags for the provider.

        branch:
            Name of the branch used for verification.
    """
    pact.v3.ffi.verifier_set_publish_options(
        self._handle,
        version,
        url,
        tags or [],
        branch,
    )
    return self

set_request_timeout(timeout: int) -> Self

Set the request timeout.

PARAMETER	DESCRIPTION
timeout	The request timeout in milliseconds. TYPE: int

Source code in src/pact/v3/verifier.py

def set_request_timeout(self, timeout: int) -> Self:
    """
    Set the request timeout.

    Args:
        timeout:
            The request timeout in milliseconds.
    """
    if timeout < 0:
        msg = "Request timeout must be a positive integer"
        raise ValueError(msg)

    self._request_timeout = timeout
    pact.v3.ffi.verifier_set_verification_options(
        self._handle,
        disable_ssl_verification=self._disable_ssl_verification,
        request_timeout=self._request_timeout,
    )
    return self

state_handler(handler: StateHandlerFull | StateHandlerNoAction | dict[str, StateHandlerNoState] | dict[str, StateHandlerNoActionNoState] | StateHandlerUrl, *, teardown: bool = False, body: bool | None = None) -> Self

state_handler(
    handler: StateHandlerFull,
    *,
    teardown: Literal[True],
    body: None = None,
) -> Self

state_handler(
    handler: StateHandlerNoAction,
    *,
    teardown: Literal[False] = False,
    body: None = None,
) -> Self

state_handler(
    handler: dict[str, StateHandlerNoState],
    *,
    teardown: Literal[True],
    body: None = None,
) -> Self

state_handler(
    handler: dict[str, StateHandlerNoActionNoState],
    *,
    teardown: Literal[False] = False,
    body: None = None,
) -> Self

state_handler(
    handler: StateHandlerUrl,
    *,
    teardown: bool = False,
    body: bool,
) -> Self

Set the state handler.

In many interactions, the consumer will assume that the provider is in a certain state. For example, a consumer requesting information about a user with ID 123 will have specified given("user with ID 123 exists").

The state handler is responsible for changing the provider's internal state to match the expected state before the interaction is replayed.

This can be done in one of three ways:

1. By providing a single function that will be called for all state changes.
2. By providing a mapping of state names to functions.
3. By providing the URL endpoint to which the request should be made.

The first two options are most straightforward to use.

When providing a function, the arguments should be:

1. The state name, as a string.
2. The action (either setup or teardown), as a string.
3. A dictionary of parameters, or None if no parameters are provided.

Note that these arguments will change in the following ways:

1. If a dictionary mapping is used, the state name is not provided to the function.
2. If teardown is False thereby indicating that the function is only called for setup, the action argument is not provided.

This means that in the case of a dictionary mapping of function with teardown=False, the function should take only one argument: the dictionary of parameters (which itself may be None, albeit still an argument).

PARAMETER	DESCRIPTION
handler	The handler for the state changes. This can be one of the following: A single function that will be called for all state changes. A dictionary mapping state names to functions. A URL endpoint to which the request should be made. See above for more information on the function signature. TYPE: StateHandlerFull | StateHandlerNoAction | dict[str, StateHandlerNoState] | dict[str, StateHandlerNoActionNoState] | StateHandlerUrl
teardown	Whether to teardown the provider state after an interaction is validated. TYPE: bool DEFAULT: False
body	Whether to include the state change request in the body (True) or in the query string (False). This must be left as None if providing one or more handler functions; and it must be set to a boolean if providing a URL. TYPE: bool | None DEFAULT: None

Source code in src/pact/v3/verifier.py

def state_handler(
    self,
    handler: StateHandlerFull
    | StateHandlerNoAction
    | dict[str, StateHandlerNoState]
    | dict[str, StateHandlerNoActionNoState]
    | StateHandlerUrl,
    *,
    teardown: bool = False,
    body: bool | None = None,
) -> Self:
    """
    Set the state handler.

    In many interactions, the consumer will assume that the provider is in a
    certain state. For example, a consumer requesting information about a
    user with ID `123` will have specified `given("user with ID 123
    exists")`.

    The state handler is responsible for changing the provider's internal
    state to match the expected state before the interaction is replayed.

    This can be done in one of three ways:

    1.  By providing a single function that will be called for all state
        changes.
    2.  By providing a mapping of state names to functions.
    3.  By providing the URL endpoint to which the request should be made.

    The first two options are most straightforward to use.

    When providing a function, the arguments should be:

    1.  The state name, as a string.
    2.  The action (either `setup` or `teardown`), as a string.
    3.  A dictionary of parameters, or `None` if no parameters are provided.

    Note that these arguments will change in the following ways:

    1.  If a dictionary mapping is used, the state name is _not_ provided to
        the function.
    2.  If `teardown` is `False` thereby indicating that the function is
        only called for setup, the `action` argument is not provided.

    This means that in the case of a dictionary mapping of function with
    `teardown=False`, the function should take only one argument: the
    dictionary of parameters (which itself may be `None`, albeit still an
    argument).

    Args:
        handler:
            The handler for the state changes. This can be one of the
            following:

            -   A single function that will be called for all state changes.
            -   A dictionary mapping state names to functions.
            -   A URL endpoint to which the request should be made.

            See above for more information on the function signature.

        teardown:
            Whether to teardown the provider state after an interaction is
            validated.

        body:
            Whether to include the state change request in the body (`True`)
            or in the query string (`False`). This must be left as `None` if
            providing one or more handler functions; and it must be set to
            a boolean if providing a URL.
    """
    # A tuple is required instead of `StateHandlerUrl` for support for
    # Python 3.9. This should be changed to `StateHandlerUrl` in the future.
    if isinstance(handler, (str, URL)):
        if body is None:
            msg = "The `body` parameter must be a boolean when providing a URL"
            raise ValueError(msg)
        return self._state_handler_url(handler, teardown=teardown, body=body)

    if isinstance(handler, dict):
        if body is not None:
            msg = "The `body` parameter must be `None` when providing a dictionary"
            raise ValueError(msg)
        return self._state_handler_dict(handler, teardown=teardown)

    if callable(handler):
        if body is not None:
            msg = "The `body` parameter must be `None` when providing a function"
            raise ValueError(msg)
        return self._set_function_state_handler(handler, teardown=teardown)

    msg = "Invalid handler type"
    raise TypeError(msg)

verify() -> Self

Verify the interactions.

RETURNS	DESCRIPTION
Self	Whether the interactions were verified successfully.

Source code in src/pact/v3/verifier.py

def verify(self) -> Self:
    """
    Verify the interactions.

    Returns:
        Whether the interactions were verified successfully.
    """
    if not self._transports:
        msg = "No transports have been set"
        raise RuntimeError(msg)

    first, *rest = self._transports

    pact.v3.ffi.verifier_set_provider_info(
        self._handle,
        self._name,
        first["scheme"],
        self._host,
        first["port"],
        first["path"],
    )

    for transport in rest:
        pact.v3.ffi.verifier_add_provider_transport(
            self._handle,
            transport["transport"],
            transport["port"] or 0,
            transport["path"],
            transport["scheme"],
        )

    with self._message_producer, self._state_handler:
        pact.v3.ffi.verifier_execute(self._handle)
        logger.debug("Verifier executed")

    return self