Simple server to provide an endpoint used by pact to generate a provider state
Project description
> Simple server to provide an endpoint used by pact to generate a provider state
Usage
Installation
Install the package:
pip install pact_state_provider
Client
Entrypoint pact-state-provider
:
Usage: pact-state-provider [OPTIONS] Start the state provider server on the specified host and port. Options: --base-module TEXT Module containing the state providers. --host TEXT Host for the endpoint. --port INTEGER Port for the endpoint. --help Show this message and exit.
TL;DR
Example:
pact-state-provider --base-module my_provider.states # pact requests a state: # GET http://127.0.0.1:1235 {'consumer': 'TestConsumer', 'state': 'user exists'} -> function "my_provider.states.user_exists('TestConsumer')" is executed
Not Long Enough;Will Read
When verifying contracts with Pact a
state provider is called for the particular consumer with the state requested. A consumer
TestConsumer
with a contract starting with given('user exists')
requests the
configured endpoint with the payload:
{ 'consumer': 'TestConsumer', 'state': 'user exists' }
In order to execute the specific provider functions without having to implement a dedicated
endpoint on the provider or a dedicated application with provider specific code
pact-state-provider
provides a simple http server endpoint which calls an existing
module function based on the request payload.
In the given example a function called user_exists
(invalid characters are translated to
underscores) will be executed on the specified base module (--base-module
parameter).
This gives the user to maintain the state provider code in the actual provider codebase, but easily have an endpoint to use with pact.
Development
Makefile
This project uses a Makefile for various tasks. Some of the available tasks are listed below.
make clean - Clean build artifacts out of your project
make test - Run Tests
make plain-test - Run Tests without rebuilding the project
make sdist - Build a Python source distribution
make docs - Build the Sphinx documentation
make lint - Get a codestyle report about your code
make plain-lint - Get a codestyle report without rebuilding the project
make - Equivalent to make test lint docs sdist
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Hashes for pact_state_provider-1.0.7.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3a9ea8735580f5ab8f8e4f59bdff562a4684af43f4e789f8f7f92a6858fa4abb |
|
MD5 | d76c1e1c774e497f5b5eefc3b5942a71 |
|
BLAKE2b-256 | 670231168f430376323794aed6585f2c28692353facf27da60c785a7c111698a |