Consumer

Classes and methods to describe contract Consumers.

Classes

Consumer(name, service_cls=Pact, tags=None, tag_with_git_branch=False, version='0.0.0', branch=None, build_url=None, auto_detect_version_properties=False)

Bases: object

A Pact consumer.

Use this class to describe the service making requests to the provider and then use has_pact_with to create a contract with a specific service:

from pact import Consumer, Provider consumer = Consumer('my-web-front-end') consumer.has_pact_with(Provider('my-backend-service'))

:param name: The name of this Consumer. This will be shown in the Pact when it is published. :type name: str :param service_cls: Pact, or a sub-class of it, to use when creating the contracts. This is useful when you have a custom URL or port for your mock service and want to use the same value on all of your contracts. :type service_cls: pact.Pact :param tags: A list of strings to use as tags to use when publishing to a pact broker. Defaults to None. :type tags: list :param tag_with_git_branch: A flag to determine whether to automatically tag a pact with the current git branch name. Defaults to False. :type tag_with_git_branch: bool :param version: The version of this Consumer. This will be used when publishing pacts to a pact broker. Defaults to '0.0.0' :param branch: The branch of this Consumer. :type branch: str :param build_url: The build URL that created the pact. :type build_url: str :param auto_detect_version_properties: Automatically detect the repository branch from known CI, environment variables or git CLI. Supports Buildkite, Circle CI, Travis CI, GitHub Actions, Jenkins, Hudson, AppVeyor, GitLab, CodeShip, Bitbucket and Azure DevOps.'. Defaults to False. :type auto_detect_version_properties: bool

Source code in src/pact/consumer.py

def __init__(self, name, service_cls=Pact, tags=None,
             tag_with_git_branch=False, version='0.0.0', branch=None, build_url=None, auto_detect_version_properties=False):
    """
    Create the Consumer class.

    :param name: The name of this Consumer. This will be shown in the Pact
        when it is published.
    :type name: str
    :param service_cls: Pact, or a sub-class of it, to use when creating
        the contracts. This is useful when you have a custom URL or port
        for your mock service and want to use the same value on all of
        your contracts.
    :type service_cls: pact.Pact
    :param tags: A list of strings to use as tags to use when publishing
        to a pact broker. Defaults to None.
    :type tags: list
    :param tag_with_git_branch: A flag to determine whether to
        automatically tag a pact with the current git branch name.
        Defaults to False.
    :type tag_with_git_branch: bool
    :param version: The version of this Consumer. This will be used when
        publishing pacts to a pact broker. Defaults to '0.0.0'
    :param branch: The branch of this Consumer.
    :type branch: str
    :param build_url: The build URL that created the pact.
    :type build_url: str
    :param auto_detect_version_properties: Automatically detect the repository branch from known CI,
        environment variables or git CLI. Supports Buildkite, Circle CI, Travis CI, GitHub Actions,
        Jenkins, Hudson, AppVeyor, GitLab, CodeShip, Bitbucket and Azure DevOps.'.
        Defaults to False.
    :type auto_detect_version_properties: bool
    """
    warnings.warn(
        "This class will be deprecated Pact Python v3 "
        "(see pact-foundation/pact-python#396)",
        PendingDeprecationWarning,
        stacklevel=2,
    )
    self.name = name
    self.service_cls = service_cls
    self.tags = tags
    self.tag_with_git_branch = tag_with_git_branch
    self.version = version
    self.branch = branch
    self.build_url = build_url
    self.auto_detect_version_properties = auto_detect_version_properties

Attributes

auto_detect_version_properties = auto_detect_version_properties instance-attribute

branch = branch instance-attribute

build_url = build_url instance-attribute

name = name instance-attribute

service_cls = service_cls instance-attribute

tag_with_git_branch = tag_with_git_branch instance-attribute

tags = tags instance-attribute

version = version instance-attribute

Functions

has_pact_with(provider, host_name='localhost', port=1234, log_dir=None, ssl=False, sslcert=None, sslkey=None, cors=False, publish_to_broker=False, broker_base_url=None, broker_username=None, broker_password=None, broker_token=None, pact_dir=None, specification_version='2.0.0', file_write_mode='overwrite')

Create a contract between the provider and this consumer.

If you are running the Pact mock service in a non-default location, you can provide the host name and port here:

from pact import Consumer, Provider consumer = Consumer('my-web-front-end') consumer.has_pact_with( ... Provider('my-backend-service'), ... host_name='192.168.1.1', ... port=8000)

:param provider: The provider service for this contract. :type provider: pact.Provider :param host_name: An optional host name to use when contacting the Pact mock service. This will need to be the same host name used by your code under test to contact the mock service. It defaults to: localhost. :type host_name: str :param port: The TCP port to use when contacting the Pact mock service. This will need to be the same port used by your code under test to contact the mock service. It defaults to: 1234 :type port: int :param log_dir: The directory where logs should be written. Defaults to the current directory. :type log_dir: str :param ssl: Flag to control the use of a self-signed SSL cert to run the server over HTTPS , defaults to False. :type ssl: bool :param sslcert: Path to a custom self-signed SSL cert file, 'ssl' option must be set to True to use this option. Defaults to None. :type sslcert: str :param sslkey: Path to a custom key and self-signed SSL cert key file, 'ssl' option must be set to True to use this option. Defaults to None. :type sslkey: str :param cors: Allow CORS OPTION requests to be accepted, defaults to False. :type cors: bool :param publish_to_broker: Flag to control automatic publishing of pacts to a pact broker. Defaults to False. :type publish_to_broker: bool :param broker_base_url: URL of the pact broker that pacts will be published to. Defaults to None. :type broker_base_url: str :param broker_username: Username to use when connecting to the pact broker if authentication is required. Defaults to None. :type broker_username: str :param broker_password: Password to use when connecting to the pact broker if authentication is required. Defaults to None. :type broker_password: str :param broker_token: Authentication token to use when connecting to the pact broker. Defaults to None. :type broker_token: str :param pact_dir: Directory where the resulting pact files will be written. Defaults to the current directory. :type pact_dir: str :param specification_version: The Pact Specification version to use. Defaults to '2.0.0'. :type version: str :param file_write_mode: How the mock service should apply multiple calls to .verify(). Pass 'overwrite' to overwrite the generated JSON file on every call to .verify() or pass 'merge' to merge all interactions into the same JSON file. When using 'merge', make sure to delete any existing JSON file before calling .verify() for the first time. Defaults to 'overwrite'. :type version: str :return: A Pact object which you can use to define the specific interactions your code will have with the provider. :rtype: pact.Pact

Source code in src/pact/consumer.py

def has_pact_with(self, provider, host_name='localhost', port=1234,
                  log_dir=None, ssl=False, sslcert=None, sslkey=None,
                  cors=False, publish_to_broker=False,
                  broker_base_url=None, broker_username=None,
                  broker_password=None, broker_token=None, pact_dir=None,
                  specification_version='2.0.0',
                  file_write_mode='overwrite'):
    """
    Create a contract between the `provider` and this consumer.

    If you are running the Pact mock service in a non-default location,
    you can provide the host name and port here:

    >>> from pact import Consumer, Provider
    >>> consumer = Consumer('my-web-front-end')
    >>> consumer.has_pact_with(
    ...   Provider('my-backend-service'),
    ...   host_name='192.168.1.1',
    ...   port=8000)

    :param provider: The provider service for this contract.
    :type provider: pact.Provider
    :param host_name: An optional host name to use when contacting the
        Pact mock service. This will need to be the same host name used by
        your code under test to contact the mock service. It defaults to:
        `localhost`.
    :type host_name: str
    :param port: The TCP port to use when contacting the Pact mock service.
        This will need to be the same port used by your code under test
        to contact the mock service. It defaults to: 1234
    :type port: int
    :param log_dir: The directory where logs should be written. Defaults to
        the current directory.
    :type log_dir: str
    :param ssl: Flag to control the use of a self-signed SSL cert to run
        the server over HTTPS , defaults to False.
    :type ssl: bool
    :param sslcert: Path to a custom self-signed SSL cert file, 'ssl'
        option must be set to True to use this option. Defaults to None.
    :type sslcert: str
    :param sslkey: Path to a custom key and self-signed SSL cert key file,
        'ssl' option must be set to True to use this option.
        Defaults to None.
    :type sslkey: str
    :param cors: Allow CORS OPTION requests to be accepted,
        defaults to False.
    :type cors: bool
    :param publish_to_broker: Flag to control automatic publishing of
        pacts to a pact broker. Defaults to False.
    :type publish_to_broker: bool
    :param broker_base_url: URL of the pact broker that pacts will be
        published to. Defaults to None.
    :type broker_base_url: str
    :param broker_username: Username to use when connecting to the pact
        broker if authentication is required. Defaults to None.
    :type broker_username: str
    :param broker_password: Password to use when connecting to the pact
        broker if authentication is required. Defaults to None.
    :type broker_password: str
    :param broker_token: Authentication token to use when connecting to
        the pact broker. Defaults to None.
    :type broker_token: str
    :param pact_dir: Directory where the resulting pact files will be
        written. Defaults to the current directory.
    :type pact_dir: str
    :param specification_version: The Pact Specification version to use.
        Defaults to '2.0.0'.
    :type version: str
    :param file_write_mode: How the mock service should apply multiple
        calls to .verify(). Pass 'overwrite' to overwrite the generated
        JSON file on every call to .verify() or pass 'merge' to merge all
        interactions into the same JSON file. When using 'merge', make
        sure to delete any existing JSON file before calling .verify()
        for the first time. Defaults to 'overwrite'.
    :type version: str
    :return: A Pact object which you can use to define the specific
        interactions your code will have with the provider.
    :rtype: pact.Pact
    """
    if not isinstance(provider, (Provider,)):
        raise ValueError(
            'provider must be an instance of the Provider class.')

    return self.service_cls(
        broker_base_url=broker_base_url,
        broker_username=broker_username,
        broker_password=broker_password,
        broker_token=broker_token,
        consumer=self,
        provider=provider,
        host_name=host_name,
        port=port,
        log_dir=log_dir,
        ssl=ssl,
        sslcert=sslcert,
        sslkey=sslkey,
        cors=cors,
        pact_dir=pact_dir,
        publish_to_broker=publish_to_broker,
        specification_version=specification_version,
        file_write_mode=file_write_mode)