Merge pull request #206 from pact-foundation/chore/use-testcontainers

chore: use testcontainers

Author: elliottmurray

Makefile

@@ -36,7 +36,6 @@ define E2E
   pip install -r requirements.txt
   pip install -e ../../
   ./run_pytest.sh 
-  ./verify_pact.sh
 endef
 export E2E
 

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/requirements.txt

@@ -1,3 +1,4 @@
 Flask==1.1.1
 pytest==5.4.1
-requests==2.23.0
+requests==2.23.0
+testcontainers==3.3.0

examples/e2e/run_pytest.sh

@@ -1,23 +1,19 @@
 #!/bin/bash
 set -o pipefail
 
+FLASK_APP=pact_provider.py python -m flask run -p 5001 & &>/dev/null
 
-
-FLASK_APP=pact_provider.py python -m flask run -p 1235 & &>/dev/null
-
-# python pact_provider.py & &>/dev/null
 FLASK_PID=$!
 
-function teardown {
-  echo "Tearing down Flask server ${FLASK_PID}"
-
-  kill -9 $FLASK_PID
-}
+teardown() {
+  echo "Tearing down Flask server ${FLASK_PID}";
+  kill -9 $FLASK_PID;
+};
 trap teardown EXIT
 
 sleep 3
 
-pytest
+pytest --publish-pact 1
 
-teardown()
+teardown
 

examples/e2e/tests/conftest.py

@@ -1,4 +1,8 @@
 
+from testcontainers.compose import DockerCompose
+
+import pytest
+
 def pytest_addoption(parser):
     parser.addoption(
         "--publish-pact", type=str, action="store",
@@ -9,3 +13,27 @@ def pytest_addoption(parser):
         "--provider-url", type=str, action="store",
         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')
+    publish = True if version else False
+
+    # yield
+    if not publish:
+        yield
+        return
+
+    print('Starting broker')
+    with DockerCompose("../broker",
+                       compose_file_name=["docker-compose.yml"],
+                       pull=True) as compose:
+
+        stdout, stderr = compose.get_logs()
+        if stderr:
+            print("Errors\\n:{}".format(stderr))
+        print(stdout)
+        yield

examples/e2e/tests/consumer/test_user_consumer.py

@@ -2,7 +2,6 @@
 
 import logging
 import os
-import atexit
 
 import pytest
 from pact import Consumer, Like, Provider, Term, Format
@@ -31,7 +30,7 @@ def consumer():
     )
 
 
-@pytest.fixture(scope='session')
+@pytest.fixture(scope='class')
 def pact(request):
     version = request.config.getoption('--publish-pact')
     publish = True if version else False
@@ -43,13 +42,12 @@ def pact(request):
 
     print('start service')
     pact.start_service()
-    atexit.register(pact.stop_service)
 
     yield pact
     print('stop service')
     pact.stop_service()
 
-def test_get_user_non_admin(pact, consumer):
+def test_get_user_non_admin(broker, pact, consumer):
     expected = {
         'name': 'UserA',
         'id': Format().uuid,
@@ -72,7 +70,7 @@ def test_get_user_non_admin(pact, consumer):
         assert user.name == 'UserA'
 
 
-def test_get_non_existing_user(pact, consumer):
+def test_get_non_existing_user(broker, pact, consumer):
     (pact
      .given('UserA does not exist')
      .upon_receiving('a request for UserA')
@@ -82,4 +80,4 @@ def test_get_non_existing_user(pact, consumer):
     with pact:
         user = consumer.get_user('UserA')
         assert user is None
-    # pact.verify()
+        pact.verify()

examples/e2e/tests/consumer/userserviceclient-userservice.json

@@ -6,43 +6,6 @@
     "name": "UserService"
   },
   "interactions": [
-    {
-      "description": "a request for UserA",
-      "providerState": "UserA exists and is not an administrator",
-      "request": {
-        "method": "get",
-        "path": "/users/UserA"
-      },
-      "response": {
-        "status": 200,
-        "headers": {
-        },
-        "body": {
-          "name": "UserA",
-          "id": "fc763eba-0905-41c5-a27f-3934ab26786c",
-          "created_on": "2016-12-15T20:16:01",
-          "ip_address": "127.0.0.1",
-          "admin": false
-        },
-        "matchingRules": {
-          "$.body": {
-            "match": "type"
-          },
-          "$.body.id": {
-            "match": "regex",
-            "regex": "[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}"
-          },
-          "$.body.created_on": {
-            "match": "regex",
-            "regex": "\\d+-\\d+-\\d+T\\d+:\\d+:\\d+"
-          },
-          "$.body.ip_address": {
-            "match": "regex",
-            "regex": "(\\d{1,3}\\.)+\\d{1,3}"
-          }
-        }
-      }
-    },
     {
       "description": "a request for UserA",
       "providerState": "UserA does not exist",

examples/e2e/tests/provider/test_provider.py

@@ -4,6 +4,7 @@
 import os
 
 from pact import Verifier
+import pytest
 
 log = logging.getLogger(__name__)
 logging.basicConfig(level=logging.INFO)
@@ -19,17 +20,25 @@
 PACT_BROKER_PASSWORD = "pactbroker"
 
 PACT_MOCK_HOST = 'localhost'
-PACT_MOCK_PORT = 1235
+PACT_MOCK_PORT = 5001
 PACT_URL = "http://{}:{}".format(PACT_MOCK_HOST, PACT_MOCK_PORT)
 PACT_DIR = os.path.dirname(os.path.realpath(__file__))
 
+@pytest.fixture
+def default_opts():
+    return {
+        'broker_username': PACT_BROKER_USERNAME,
+        'broker_password': PACT_BROKER_PASSWORD,
+        'broker_url': PACT_BROKER_URL
+    }
 
-def test_get_user_non_admin():
+
+def test_get_user_non_admin(default_opts):
     verifier = Verifier(provider='UserService',
                         provider_base_url=PACT_URL)
 
-    output, logs = verifier.verify_pacts('./userserviceclient-userservice.json',
-                                         verbose=False,
-                                         provider_states_setup_url="{}/_pact/provider_states".format(PACT_URL))
+    output, logs = verifier.verify_with_broker(**default_opts,
+                                               verbose=True,
+                                               provider_states_setup_url="{}/_pact/provider_states".format(PACT_URL))
 
     assert (output == 0)