Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: remove reference to v3 pact in provider-states-setup-url #70

Merged
merged 1 commit into from
Jan 20, 2018
Merged

docs: remove reference to v3 pact in provider-states-setup-url #70

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 8 additions & 8 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ class GetUserInfoContract(unittest.TestCase):
'id': 123,
'groups': ['Editors']
}

(pact
.given('UserA exists and is not an administrator')
.upon_receiving('a request for UserA')
Expand All @@ -73,7 +73,7 @@ class GetUserInfoContract(unittest.TestCase):

with pact:
result = user('UserA')

self.assertEqual(result, expected)

```
Expand All @@ -88,7 +88,7 @@ This does a few important things:
Using the Pact object as a [context manager], we call our method under test
which will then communicate with the Pact mock service. The mock service will respond with
the items we defined, allowing us to assert that the method processed the response and
returned the expected value. If you want more control over when the mock service is
returned the expected value. If you want more control over when the mock service is
configured and the interactions verified, use the `setup` and `verify` methods, respectively:

```python
Expand Down Expand Up @@ -264,7 +264,7 @@ There are several options for configuring how the Pacts are verified:

###### --provider-base-url

Required. Defines the URL of the server to make requests to when verifying the Pacts.
Required. Defines the URL of the server to make requests to when verifying the Pacts.

###### --pact-url

Expand All @@ -289,16 +289,16 @@ requests.

###### --provider-states-setup-url

The URL which should be called to setup a specific provider state before a Pact is verified. This URL will be called with a POST request, and the JSON body `{consumer: 'Consumer name', states: ['a thing exists']}`. Note that the current pact specification version (v2) only supports a single provider state, however, v3 will support multiple states, and the set-up call is designed to be forwards compatible with the planned change.
The URL which should be called to setup a specific provider state before a Pact is verified. This URL will be called with a POST request, and the JSON body `{consumer: 'Consumer name', state: 'a thing exists'}`.

###### --pact-broker-username

The username to use when contacting the Pact Broker.

###### --pact-broker-password

The password to use when contacting the Pact Broker. You can also specify this value
as the environment variable `PACT_BROKER_PASSWORD`.
as the environment variable `PACT_BROKER_PASSWORD`.

### Provider States
In many cases, your contracts will need very specific data to exist on the provider
Expand All @@ -323,7 +323,7 @@ Please read [CONTRIBUTING.md](CONTRIBUTING.md)

To setup a development environment:

1. If you want to run tests for all Python versions, install 2.7, 3.3, 3.4, 3.5, and 3.6 from source or using a tool like [pyenv]
1. If you want to run tests for all Python versions, install 2.7, 3.3, 3.4, 3.5, and 3.6 from source or using a tool like [pyenv]
2. Its recommended to create a Python [virtualenv] for the project

The setup the environment, run tests, and package the application, run:
Expand Down