Python implementation for Pact (http://pact.io/)
Project description
Pact Test for Python
This repository contains a Python implementation for Pact. Pact is a specification for Consumer Driven Contracts Testing. For further information about Pact project, contracts testing, pros and cons and useful resources please refer to the Pact website.
There are two phases in Consumer Driven Contracts Testing: a Consumer sets up a contract (it’s consumer driven after all!), and a Provider honours it.
Providers Tests (Set the Contracts)
TBD.
Consumers Tests (Honour Your Contracts)
Providers run Consumer Tests to verify that they are honouring their pacts with the consumers. There are few examples of an hypothetical restaurant service implemented with the most popular Python web frameworks:
There are few things required to setup and run consumer tests.
Installation
Pact Test is distributed through PyPi so it can be easily included in the
requirements.txt
file or normally installed with pip
:
$ pip install pact-test
Pact Helper
This helper class is used by Pact Test to start and stop the web-app before and after the test. It also defines the ports and endpoint to be used by the test. The following is an example of Pact Helper:
class RestaurantPactHelper(PactHelper):
process = None
def setup(self):
self.process = subprocess.Popen('gunicorn start:app -w 3 -b :8080 --log-level error', shell=True)
def tear_down(self):
self.process.kill()
There are few rules for the helper:
it must extend
PactHelper
class frompact_test
it must define a
setup
methodit must define a
tear_down
method
It is also possible to override default url (localhost) and port (9999):
class RestaurantPactHelper(PactHelper):
test_url = '0.0.0.0'
test_port = 5000
States
When a consumer sets a pact, it defines certain states. States are basically pre-requisites to your test. Before honouring the pacts, a provider needs to define such states. For example:
@honours_pact_with('UberEats')
@pact_uri('http://Kalimaha.github.io/src/pacts/pact.json')
class UberEats(ServiceConsumerTest):
@state('some menu items exist')
def test_get_menu_items(self):
DB.save(MenuItem('spam'))
DB.save(MenuItem('eggs'))
In this example, the provider stores some test data in its DB in order to make the system ready to receive mock calls from the consumer and therefore verify the pact.
Configuration
The default configuration of Pact Test assumes the following values:
consumer_tests_path:
tests/service_consumers
provider_tests_path:
tests/service_providers
pact_broker_uri:
None
It is possible to override such values by creating a file named .pact.json
in the project’s root. The following
is an example of a valid configuration file:
{
"consumer_tests_path": "mypath/mytests",
"provider_tests_path": "mypath/mytests",
"pact_broker_uri": "http://example.com/"
}
All fields are optional: only specified fields will override default configuration values.
Development
Setup
python3 setup.py install
Test
It is possible to run the tests locally with Docker through the following command:
$ ./bin/test
By default this command tests the library against Python 3.6. It is possible to specify the Python version as follows:
$ ./bin/test <ENV>
Available values for ENV are: py27
, py33
, py34
, py35
and py36
. It is also
possible to test all the versions at once with:
$ ./bin/test all
Upload New Version
$ python3 setup.py sdist upload
With Python Wheels:
$ python3 setup.py sdist bdist_wheel
$ twine upload dist/*
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for pact_test-0.3.43-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9d6a1fbed079ff35ade249e1b854f48c46e2f0268f118735dedbd8a7731c6d36 |
|
MD5 | f5ac521acc0f185982f7168063444557 |
|
BLAKE2b-256 | d5a11b1e892075dbea7c4048200578b3741dce34b33181b70b4aba1108072afe |