Add demo stuff for pact broker

Author: bsquizz

broker/docker-compose.yml

@@ -0,0 +1,38 @@
+version: '3'
+
+services:
+
+  postgres:
+    image: postgres
+    healthcheck:
+      test: psql postgres --command "select 1" -U postgres
+    ports:
+      - "5432:5432"
+    environment:
+      POSTGRES_USER: postgres
+      POSTGRES_PASSWORD: password
+      POSTGRES_DB: postgres
+
+  broker_app:
+    image: dius/pact-broker
+    ports:
+      - "80:80"
+    links:
+      - postgres
+    environment:
+      PACT_BROKER_DATABASE_USERNAME: postgres
+      PACT_BROKER_DATABASE_PASSWORD: password
+      PACT_BROKER_DATABASE_HOST: postgres
+      PACT_BROKER_DATABASE_NAME: postgres
+      PACT_BROKER_BASIC_AUTH_USERNAME: pactbroker
+      PACT_BROKER_BASIC_AUTH_PASSWORD: pactbroker
+
+  nginx:
+    image: nginx:alpine
+    links:
+      - broker_app:broker
+    volumes:
+      - ./ssl/nginx.conf:/etc/nginx/conf.d/default.conf:ro
+      - ./ssl:/etc/nginx/ssl
+    ports:
+      - "8443:443"

broker/ssl/nginx-selfsigned.crt

@@ -0,0 +1,22 @@
+-----BEGIN CERTIFICATE-----
+MIIDtTCCAp2gAwIBAgIJAPVSxq8aUpd1MA0GCSqGSIb3DQEBBQUAMEUxCzAJBgNV
+BAYTAkFVMRMwEQYDVQQIEwpTb21lLVN0YXRlMSEwHwYDVQQKExhJbnRlcm5ldCBX
+aWRnaXRzIFB0eSBMdGQwHhcNMTgwMTE4MjMzMjMzWhcNMTkwMTE4MjMzMjMzWjBF
+MQswCQYDVQQGEwJBVTETMBEGA1UECBMKU29tZS1TdGF0ZTEhMB8GA1UEChMYSW50
+ZXJuZXQgV2lkZ2l0cyBQdHkgTHRkMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIB
+CgKCAQEA5vwTFJLlWmMC456Kv7uHxSqARkj5dwsb0lFoc5bGjOYvlJUu2S8F8QMc
+PlW2vXM7UsmBzbNgQsQh1FgRXgfNfHF80F21dILpzM/aA8a/GkJsKUZCHccQb5mq
+i25OrI4+XE6kSt/fwTbWRJGZgEADoIJ3wewcfzkJoeGonU+g8rYwPLq9xaHwFVFV
+x30KIZv5CToanHVy+aQUKg9m4VGuij22U7HzphS4IGZoaj2Uo0vpXqhWoKYrLFv2
+h0spP93Pr4VzoRGwlHgl2s+7qfwzRf9DhxePq9lGnqJ8TMQv1+jRITWB8jT8qW3Q
+t/+fWaGtkqbtgS8vGaAoXtXUZIWarQIDAQABo4GnMIGkMB0GA1UdDgQWBBSQCcqt
+DxAYpPkMWvMmU+DMT21RuDB1BgNVHSMEbjBsgBSQCcqtDxAYpPkMWvMmU+DMT21R
+uKFJpEcwRTELMAkGA1UEBhMCQVUxEzARBgNVBAgTClNvbWUtU3RhdGUxITAfBgNV
+BAoTGEludGVybmV0IFdpZGdpdHMgUHR5IEx0ZIIJAPVSxq8aUpd1MAwGA1UdEwQF
+MAMBAf8wDQYJKoZIhvcNAQEFBQADggEBAE+ryTcny4NfIhdAwFbGjfZSsOHf0Ivt
+5lW0hHA7SZVcPysgAlM8sk+aZDQdNEP6eoUfpuwLvAio/kpvr9pFI0THvBm9W9MS
+zWmKkGrsuk8MXM0SsPi+BSz49YwAtsLFku7fsr/GNAD6+Vw+fyF+ySvUYJ2FwOEF
+4lYfzy1X0BA6l4RVmnO1Rv8Mn6LkzrBMe4kW0VARaBsS3hO/FW2nHMSDSkRCFjKi
+4qeX6RcJhHzfsZnQi2gqbVQXUvYiSjZL561UZdaybNJdSU+uOKgK2NTU1Pv6Prkh
+HS9Gm+yEtgSvTx/JoLkiKx31Q4GH2hoommCT0viCcnKz1eHKGYUhMP0=
+-----END CERTIFICATE-----

broker/ssl/nginx-selfsigned.key

@@ -0,0 +1,27 @@
+-----BEGIN RSA PRIVATE KEY-----
+MIIEpQIBAAKCAQEA5vwTFJLlWmMC456Kv7uHxSqARkj5dwsb0lFoc5bGjOYvlJUu
+2S8F8QMcPlW2vXM7UsmBzbNgQsQh1FgRXgfNfHF80F21dILpzM/aA8a/GkJsKUZC
+HccQb5mqi25OrI4+XE6kSt/fwTbWRJGZgEADoIJ3wewcfzkJoeGonU+g8rYwPLq9
+xaHwFVFVx30KIZv5CToanHVy+aQUKg9m4VGuij22U7HzphS4IGZoaj2Uo0vpXqhW
+oKYrLFv2h0spP93Pr4VzoRGwlHgl2s+7qfwzRf9DhxePq9lGnqJ8TMQv1+jRITWB
+8jT8qW3Qt/+fWaGtkqbtgS8vGaAoXtXUZIWarQIDAQABAoIBAQC3r5woz0yO3ZAN
+nSWvpZ0pwUuzGRMxhOcCEPUkfrG0mNUbrqtL0WZDLHsIYzdoXzu88TxFbbFORxSz
+/bkJ8uCJZuKf/PVxCy6MTnqMaD/OzSWgiRvI/GXoqeYC7ZypApE67NsgI/qXd1lb
+vAG7CK0ZtscvsulSjvRHBOIG/6z5dUAKnLJjr7uKydMHSIKNafKAEA6HGDCvIu4d
+J9EQzLfmpjLTkeB1DNZrv1mtNjf/kG/M/UX5a1RtOJTGvHQn/oZSUKng3DVUNBtq
+dEO6Pi5n88xWuxH6YAWqqDjCfqyey1Jc1rQxfnx6vRPL7+IaXRugAKFMFm8Xbp9/
+/9eEDCyNAoGBAPZEjYH9u2856KYUTyky8gD1TOE9gf4x4zFjK6SzBT8v1y1RdSwQ
+tf7ozj94OV/b9bAE3k/z2a09xYty5VBXs6MCluQTS67KgRaO9sSFtRmnupyBNk2z
+r3QEYuVDmJ6Dk/3ovItXqFaW8IbOZMf6Acu5aEDx4UKmb2tzGGJ7DxF/AoGBAPAc
+57p1yRWIG+hJMdkudXhBz+L3t2NbESWom33hi1mDMIKp3dwJmhA4kq+Uyqfl32uF
+Iy3z+3xr2V1BdGg1RnicfcyjHaQ4/89YB+nkOHB8muV2R57tYahOgWn6rXXxTOBs
+X2Vjd7ByAEFimrVfDH33inrYuIiI/cku4Xyj71HTAoGBAJeyrsBuPfFL6KW1SPYF
+7dDtSchNjS+6J0sa3Z18sTS1EYVW8iiMuq8lVTb/pcgIxJUCyrbRbTssG+3EfsE4
+5Oz7AVvJDwvCrjXpJtTz0BTXnzoc1giTMPb0ZL75HqA2SQlVPh9PheCg5dUEekw9
+ErIdqbynwqy9vVCg+1pel2+dAoGAR1C+fsIHFG8VottCg/fpies6HHZosIjWwfGf
+JTc9FTwCx3w+WeE8Mf8rihzOSCndPukPNtHVavH5YFpVgbH5GU+ZiZMU9ba8O9Aw
+oYZYQQixVN/Zi9mDfOK8S0baCELAC5QEjW+KmAx0CPeJbb8qTaudJLmDrYHKpttW
+u5dROGMCgYEAlgTZNiEeBAPQZD30CSvFUlZVCOOyu5crP9hCPA9um5FsvD9minSz
+yJqeMj7zapZsatAzYwHrGG6nHnTKWEBNaimR7kjTpKdKzXQaA9XeVLmeFAZ3Exad
+JDKTPI+asF+097sHUcVuloMOZXbD1uAZnvLWIwfsaHxs41AkF+0lmM4=
+-----END RSA PRIVATE KEY-----

broker/ssl/nginx.conf

@@ -0,0 +1,21 @@
+server {
+  listen      443 ssl default_server;
+  server_name localhost;
+  ssl_certificate /etc/nginx/ssl/nginx-selfsigned.crt;
+  ssl_certificate_key /etc/nginx/ssl/nginx-selfsigned.key;
+  ssl_protocols TLSv1 TLSv1.1 TLSv1.2;
+  ssl_prefer_server_ciphers on;
+  ssl_ecdh_curve secp384r1;
+  ssl_session_cache shared:SSL:10m;
+  ssl_stapling on;
+  ssl_stapling_verify on;
+
+  location / {
+      proxy_pass http://broker:80;
+      proxy_set_header Host $host;
+      proxy_set_header X-Forwarded-Scheme "https";
+      proxy_set_header X-Forwarded-Port "443";
+      proxy_set_header X-Forwarded-Ssl "on";
+      proxy_set_header X-Real-IP $remote_addr;
+  }
+}

client-test.py

@@ -0,0 +1,6 @@
+
+def pytest_addoption(parser):
+    parser.addoption(
+        "--publish-pact-ver", type=str, action="store",
+        help="Upload generated pact file to pact broker with version"
+    )

__init__.py pact_python_demo/__init__.py

@@ -0,0 +1,109 @@
+"""pact test for user service client"""
+
+import json
+import logging
+import os
+import sys
+
+import pytest
+import requests
+from requests.auth import HTTPBasicAuth
+
+from pact_python_demo.client import UserClient
+from pact import Consumer, Like, Provider, Term
+
+log = logging.getLogger(__name__)
+logging.basicConfig(level=logging.INFO)
+
+
+PACT_UPLOAD_URL = (
+    "http://127.0.0.1/pacts/provider/UserService/consumer"
+    "/UserServiceClient/version"
+)
+PACT_FILE = "userserviceclient-userservice.json"
+PACT_BROKER_USERNAME = "pactbroker"
+PACT_BROKER_PASSWORD = "pactbroker"
+
+PACT_MOCK_HOST = 'localhost'
+PACT_MOCK_PORT = 1234
+PACT_DIR = os.path.dirname(os.path.realpath(__file__))
+
+@pytest.fixture
+def client():
+    return UserClient(
+        'http://{host}:{port}'
+        .format(host=PACT_MOCK_HOST, port=PACT_MOCK_PORT)
+    )
+
+
+def push_to_broker(version):
+    """TODO: see if we can dynamically learn the pact file name, version, etc."""
+    with open(os.path.join(PACT_DIR, PACT_FILE), 'rb') as pact_file:
+        pact_file_json = json.load(pact_file)
+
+    basic_auth = HTTPBasicAuth(PACT_BROKER_USERNAME, PACT_BROKER_PASSWORD)
+
+    log.info("Uploading pact file to pact broker...")
+
+    r = requests.put(
+        "{}/{}".format(PACT_UPLOAD_URL, version),
+        auth=basic_auth,
+        json=pact_file_json
+    )
+    if not r.ok:
+        log.error("Error uploading: %s", r.content)
+        r.raise_for_status()
+
+
+@pytest.fixture(scope='session')
+def pact(request):
+    pact = Consumer('UserServiceClient').has_pact_with(
+        Provider('UserService'), host_name=PACT_MOCK_HOST, port=PACT_MOCK_PORT,
+        pact_dir=PACT_DIR)
+    pact.start_service()
+    yield pact
+    pact.stop_service()
+
+    version = request.config.getoption('--publish-pact-ver')
+    if not request.node.testsfailed and version:
+        push_to_broker(version)
+
+
+def test_get_user_non_admin(pact, client):
+    expected = {
+        'name': 'UserA',
+        'id': Term(
+            r'^[a-f0-9]{8}-?[a-f0-9]{4}-?4[a-f0-9]{3}-?[89ab][a-f0-9]{3}-?[a-f0-9]{12}\Z',
+            '00000000-0000-4000-a000-000000000000'
+        ),
+        'created_on': Term(
+            r'\d+-\d+-\d+T\d+:\d+:\d+',
+            '2016-12-15T20:16:01'
+        ),
+        'admin': False
+    }
+
+    (pact
+     .given('UserA exists and is not an administrator')
+     .upon_receiving('a request for UserA')
+     .with_request('get', '/users/UserA')
+     .will_respond_with(200, body=Like(expected)))
+
+    with pact:
+        result = client.get_user('UserA')
+
+    # assert something with the result, for ex, did I process 'result' properly?
+    # or was I able to deserialize correctly? etc.
+
+
+def test_get_non_existing_user(pact, client):
+    (pact
+     .given('UserA does not exist')
+     .upon_receiving('a request for UserA')
+     .with_request('get', '/users/UserA')
+     .will_respond_with(404))
+
+    with pact:
+        result = client.get_user('UserA')
+
+    assert result is None

client.py pact_python_demo/client.py

@@ -0,0 +1,14 @@
+#!/bin/bash
+VERSION=$1
+if [ -x $VERSION ]; then
+    echo "ERROR: You must specify a provider version"
+    exit
+fi
+
+pipenv run pact-verifier --provider-base-url=http://localhost:5001 \
+  --pact-url="http://127.0.0.1/pacts/provider/UserService/consumer/UserServiceClient/latest" \
+  --provider-states-setup-url=http://localhost:5001/_pact/provider_states \
+  --provider-app-version $VERSION \
+  --pact-broker-username pactbroker \
+  --pact-broker-password pactbroker \
+  --publish-verification-results