Merge pull request #161 from pact-foundation/docs/verifier_docs_examples

docs: Improve examples for verify

Author: elliottmurray

.gitignore

@@ -102,7 +102,3 @@ ENV/
 
 .noseids
 
-
-# ignore local test pact files
-**/userserviceclient-userservice.json
-

Makefile

@@ -35,7 +35,7 @@ define E2E
 	cd examples/e2e
   pip install -r requirements.txt
   pip install -e ../../
-  pytest tests/test_user_consumer.py
+  pytest 
   ./verify_pact.sh
 endef
 export E2E
@@ -44,21 +44,8 @@ export E2E
 e2e:
 	bash -c "$$E2E"
 
-define verifier
-	echo "verifier make"
-	cd examples/verifier
-  pip install -r requirements.txt
-  pip install -e ../../
-  pytest
-endef
-export verifier
-
-.PHONY: verifier
-verifier:
-	bash -c "$$verifier"
-
 .PHONY: examples
-examples: verifier e2e
+examples: e2e
 
 
 

README.md

@@ -293,7 +293,11 @@ For more information see [Matching](https://docs.pact.io/getting_started/matchin
 ## Verifying Pacts Against a Service
 
 In addition to writing Pacts for Python consumers, you can also verify those Pacts
-against a provider of any language. After installing pact-python a `pact-verifier`
+against a provider of any language. There are two ways to do this. 
+
+### CLI
+
+After installing pact-python a `pact-verifier`
 application should be available. To get details about its use you can call it with the
 help argument:
 
@@ -357,6 +361,18 @@ as the environment variable `PACT_BROKER_PASSWORD`.
 The bearer token to use when contacting the Pact Broker. You can also specify this value
 as the environment variable `PACT_BROKER_TOKEN`.
 
+### Python API
+You can use the Verifier class. This has all the same parameters as the cli tool but allows you to write native python code and the test framework of your choice. 
+
+```python
+verifier = Verifier(provider='UserService',
+                    provider_base_url=PACT_URL)
+
+output, logs = verifier.verify_pacts('./userserviceclient-userservice.json')
+
+```
+You can see more details in the [e2e examples](https://github.com/pact-foundation/pact-python/tree/master/examples/e2e/tests/provider/test_provider.py). 
+
 ### Provider States
 In many cases, your contracts will need very specific data to exist on the provider
 to pass successfully. If you are fetching a user profile, that user needs to exist,

examples/verifier/.flake8 renamed to examples/e2e/.flake8

@@ -1,23 +1,24 @@
 # Introduction
 
-This is an e2e example using flask to help as a guide to getting started with Pact for Python. For the provider it imports the app into a wrapper (pact_provider.py) so as to decorate extra functions we can use to test our app.
+This is an e2e example to show the provider verification working for both cli and python api.
 
 ## Setup
 
 Create your own virtualenv for this. Run
 
 ```bash
 pip install -r requirements.txt
-pip install pact-python
+pip install ../../
 ```
 
-TODO: Make this so you can point to the parent install to help with development.
-
-Create the local broker (for demo purposes only) To do this separately clone this repo:
-* https://github.com/pact-foundation/pact-broker-docker
+ pip install pipenv
+$ pipenv install
+pipenv shell
+pytest
 
-Then from where this is install run in it's own terminal
+This should provide you with a relative path to pact install relatively (2 dirs up)
 
+Create the local broker (for demo purposes only) Open a separate terminal in the examples/broker folder and run:
 ```bash
 docker-compose up
 ```
@@ -37,47 +38,3 @@ Or you can run individual tests like:
 ```bash
 pytest tests/test_user_consumer.py::test_get_non_existing_user
 ```
-
-If you want to publish this to the pact broker add the '--publish-pact' option like:
-
-```bash
-pytest  --publish-pact=XX
-```
-
-XX is the version number of the pact and is for you to manage in your deployment process.
-
-Sometimes you may get the mock server in a hung state. You can kill it via (untested):
-
-```bash
-pkill -f pact-mock-service.rb
-```
-
-## Provider States
-
-Run the script (placeholder version number for pact broker)
-
-```bash
-./verify_pact.sh 1
-```
-
-This will import the provider.py file which is the actual app and then decorate it with extra urls. It then puts this into the background and runs the pact-verifier tool against it.
-
-To test what this looks like when failing change one of these values.
-
-```python
-def setup_user_a_nonadmin():
-
-    id = '00000000-0000-4000-a000-000000000000'
-    some_date = '2016-12-15T20:16:01'
-
-```
-
-### Provider debugging
-
-To manually trigger one of the 2 manual states you can run:
-
-```bash
-curl -X POST -H "Content-Type: application/json"  --data "{\"state\": \"UserA exists and is not an administrator\"}" http://127.0.0.1:5000/_pact/provider_states
-```
-
-Changing the json content to match the state you want.

examples/e2e/.vscode/settings.json

@@ -1,24 +1,3 @@
-attrs==19.3.0
-certifi==2019.11.28
-chardet==3.0.4
-click==7.1.1
-enum34==1.1.10
 Flask==1.1.1
-idna==2.9
-importlib-metadata==1.6.0
-itsdangerous==1.1.0
-Jinja2==2.11.1
-MarkupSafe==1.1.1
-more-itertools==8.2.0
-packaging==20.3
-pluggy==0.13.1
-psutil==5.7.0
-py==1.8.1
-pyparsing==2.4.6
 pytest==5.4.1
-requests==2.23.0
-six==1.14.0
-urllib3==1.25.8
-wcwidth==0.1.9
-Werkzeug==1.0.1
-zipp==3.1.0
+requests==2.23.0

examples/verifier/Pipfile renamed to examples/e2e/Pipfile

@@ -1,5 +1,11 @@
+
 def pytest_addoption(parser):
     parser.addoption(
         "--publish-pact", type=str, action="store",
         help="Upload generated pact file to pact broker with version"
     )
+
+    parser.addoption(
+        "--provider-url", type=str, action="store",
+        help="The url to our provider."
+    )