Merge pull request #130 from elliottmurray/examples

Examples for python

Author: elliottmurray

.travis.yml

@@ -20,7 +20,7 @@ script:
   - flake8
   - pydocstyle pact
   - tox
-  - if [[ $TRAVIS_PYTHON_VERSION == "2.7" ]]; then make package && pip install ./dist/pact-python-*.tar.gz && make e2e; fi
+  - if [[ $TRAVIS_PYTHON_VERSION == "3.6" ]]; then make package && pip install ./dist/pact-python-*.tar.gz && make e2e; fi
 
 before_deploy:
   - export RELEASE_PACKAGE=$(ls dist/pact-python-*.tar.gz)

Makefile

@@ -29,42 +29,10 @@ deps:
 
 
 define E2E
-	set -ex
-	cd e2e
-	nosetests ./contracts
-	python app.py &
-	APP_PID=$$!
-	function teardown {
-		echo 'Tearing down Flask server'
-		kill $$APP_PID
-	}
-	trap teardown EXIT
-	while ! nc -z localhost 5000; do
-		sleep 0.1
-	done
-
-	set +e
-	pact-verifier \
-		--provider-base-url=http://localhost:5000 \
-		--provider-states-url=http://localhost:5000/_pact/provider-states \
-		--provider-states-setup-url=http://localhost:5000/_pact/provider-states/active \
-		./pacts/failing-consumer-provider.json
-	EXIT_CODE=$$?
-	set -e
-
-	if [ $$EXIT_CODE -eq 1 ]; then
-		echo "Failing verification exited with 1 as expected"
-	else
-		echo "Failing verification did not exit with 1 as expected"
-		exit 1
-	fi
-
-	pact-verifier \
-		--provider-base-url=http://localhost:5000 \
-		--provider-states-url=http://localhost:5000/_pact/provider-states \
-		--provider-states-setup-url=http://localhost:5000/_pact/provider-states/active \
-		./pacts/consumer-provider.json
-
+	cd examples/e2e
+  pip install -r requirements.txt
+  pytest tests/test_user_consumer.py
+  ./verify_pact.sh
 endef
 
 

README.md

@@ -19,7 +19,12 @@ test your code more efficiently, check out the [Pact documentation].
 pip install pact-python
 ```
 
+## Getting started
+
+A guide follows but if you go to the [e2e examples](examples/e2e/README.md). This has a consumer, provider and pact-broker set of tests.
+
 ## Writing a Pact
+
 Creating a complete contract is a two step process:
 
 1. Create a test on the consumer side that declares the expectations it has of the provider
@@ -236,7 +241,7 @@ EachLike({
 > Note, you do not need to specify everything that will be returned from the Provider in a
 > JSON response, any extra data that is received will be ignored and the tests will still pass.
 
-> Note, to get the generated values from an object that can contain matchers like Term, Like, EachLike, etc. 
+> Note, to get the generated values from an object that can contain matchers like Term, Like, EachLike, etc.
 > for assertion in self.assertEqual(result, expected) you may need to use get_generated_values() helper function:
 
 ```python

examples/e2e/.vscode/settings.json

@@ -0,0 +1,8 @@
+{
+  "python.testing.pytestArgs": [
+    "tests"
+  ],
+  "python.testing.unittestEnabled": false,
+  "python.testing.nosetestsEnabled": false,
+  "python.testing.pytestEnabled": true
+}

examples/e2e/README.md

@@ -0,0 +1,83 @@
+# 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.
+
+## Setup
+
+Create your own virtualenv for this. Run
+
+```bash
+pip install -r requirements.txt
+pip install pact-python
+```
+
+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
+
+Then from where this is install run in it's own terminal
+
+```bash
+docker-compose up
+```
+
+If you can open a browser to http://localhost and see the broker you have succeeded.
+
+## Consumer
+
+From the root directory run:
+
+```bash
+pytest
+```
+
+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/__init__.py

@@ -0,0 +1,33 @@
+from flask import jsonify, request
+
+from src.provider import app, fakedb
+
+
+@app.route('/_pact/provider_states', methods=['POST'])
+def provider_states():
+    mapping = {'UserA does not exist': setup_no_user_a,
+               'UserA exists and is not an administrator':
+               setup_user_a_nonadmin}
+    mapping[request.json['state']]()
+    return jsonify({'result': request.json['state']})
+
+
+def setup_no_user_a():
+    if 'UserA' in fakedb:
+        del fakedb['UserA']
+
+
+def setup_user_a_nonadmin():
+    id = '00000000-0000-4000-a000-000000000000'
+    some_date = '2016-12-15T20:16:01'
+
+    fakedb['UserA'] = {
+                        'name': "UserA",
+                        'id': id,
+                        'created_on': some_date,
+                        'admin': False
+                      }
+
+
+if __name__ == '__main__':
+    app.run(debug=True, port=5001)

examples/e2e/pact_provider.py

@@ -0,0 +1,23 @@
+attrs==19.3.0
+certifi==2019.11.28
+chardet==3.0.4
+click==7.1.1
+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

examples/e2e/requirements.txt

@@ -0,0 +1,21 @@
+import requests
+
+
+class UserConsumer(object):
+    def __init__(self, base_uri):
+        self.base_uri = base_uri
+
+    def get_user(self, user_name):
+        """Fetch a user object by user_name from the server."""
+        uri = self.base_uri + '/users/' + user_name
+        response = requests.get(uri)
+        if response.status_code == 404:
+            return None
+
+        name = response.json()['name']
+        return User(name)
+
+
+class User(object):
+    def __init__(self, name):
+        self.name = name