chore: added some docs about how to use the e2e example

Author: elliottmurray

examples/e2e/README.md

@@ -1,28 +1,31 @@
 # Introduction
 
-This is an e2e example to show the provider verification working for both cli and python api.
+This is an e2e example to show the provider verification working for both cli and python api. 
+
+Note in this example we are within conftest we are creating a Broker instance. This is purely to help demonstrate using Pact Broker in the code and you are strongly advised to set up a persistent Broker or use Pactflow
 
 ## Setup
 
 Create your own virtualenv for this. Run
 
 ```bash
 pip install -r requirements.txt
-pip install ../../
-pytest
+pip install -e ../../
+./run_pytest.sh
 ```
 
-This should provide you with a relative path to pact install relatively (2 dirs up)
+This should provide you with a relative path to pact install relatively (2 dirs up) You can look at the Makefile in the root folder for more details.
+
 
-Create the local broker (for demo purposes only) Open a separate terminal in the examples/broker folder and run:
+# Running
+This example runs broker as part of it's tests. However, if you did wish to create the local broker open a separate terminal in the examples/broker folder and run:
 ```bash
 docker-compose up
 ```
 
-If you can open a browser to http://localhost and see the broker you have succeeded.
+If you can open a browser to http://localhost and see the broker you have succeeded. You will have to remove the fixture in conftest.py to get this for the consumer to work, however.
 
 ## Consumer
-
 From the root directory run:
 
 ```bash
@@ -40,9 +43,7 @@ To get the consumer to publish a pact to broker you will need to run (2 is an ar
 pytest tests/consumer/test_user_consumer.py --publish-pact 2
 ```
 
-And then you can run:
+This example is using the python verifier code. There is an example script of how you could run the verifier cli which would be invoked like:
 ```bash
 ./verify_pact.sh 2
-```
-
-To verify the pact
+```

examples/e2e/tests/conftest.py

@@ -14,7 +14,9 @@ def pytest_addoption(parser):
         help="The url to our provider."
     )
 
-
+# This fixture is to simulate a managed Pact Broker or Pactflow account
+# Do not do this yourself but setup one of the above
+# https://github.com/pact-foundation/pact_broker
 @pytest.fixture(scope='session', autouse=True)
 def broker(request):
     version = request.config.getoption('--publish-pact')

examples/e2e/tests/consumer/test_user_consumer.py

@@ -42,7 +42,6 @@ def pact(request):
 
     print('start service')
     pact.start_service()
-    # atexit.register(pact.stop_service)
 
     yield pact
     print('stop service')