Merge pull request #156 from pact-foundation/feat/provider_verifier

feat: provider verifier

Author: elliottmurray

.flake8

@@ -0,0 +1,4 @@
+[flake8]
+ignore = E226,E302,E41,W503
+max-line-length = 160
+max-complexity = 10

Makefile

@@ -31,6 +31,7 @@ deps:
 define E2E
 	cd examples/e2e
   pip install -r requirements.txt
+  pip install -e ../../
   pytest tests/test_user_consumer.py
   ./verify_pact.sh
 endef

examples/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"

examples/broker/ssl/nginx-selfsigned.crt

@@ -0,0 +1,21 @@
+-----BEGIN CERTIFICATE-----
+MIIDiDCCAnACCQCWW6LywpPSwjANBgkqhkiG9w0BAQsFADCBhTELMAkGA1UEBhMC
+QVUxEzARBgNVBAgMClNvbWUgU3RhdGUxDzANBgNVBAcMBlN5ZG5leTENMAsGA1UE
+CgwEUGFjdDEPMA0GA1UECwwGUHl0aG9uMRIwEAYDVQQDDAlsb2NhbGhvc3QxHDAa
+BgkqhkiG9w0BCQEWDXNvbWVAbWFpbC5jb20wHhcNMjAwNjEwMTUzOTM2WhcNMjMw
+MzMxMTUzOTM2WjCBhTELMAkGA1UEBhMCQVUxEzARBgNVBAgMClNvbWUgU3RhdGUx
+DzANBgNVBAcMBlN5ZG5leTENMAsGA1UECgwEUGFjdDEPMA0GA1UECwwGUHl0aG9u
+MRIwEAYDVQQDDAlsb2NhbGhvc3QxHDAaBgkqhkiG9w0BCQEWDXNvbWVAbWFpbC5j
+b20wggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQDm/BMUkuVaYwLjnoq/
+u4fFKoBGSPl3CxvSUWhzlsaM5i+UlS7ZLwXxAxw+Vba9cztSyYHNs2BCxCHUWBFe
+B818cXzQXbV0gunMz9oDxr8aQmwpRkIdxxBvmaqLbk6sjj5cTqRK39/BNtZEkZmA
+QAOggnfB7Bx/OQmh4aidT6DytjA8ur3FofAVUVXHfQohm/kJOhqcdXL5pBQqD2bh
+Ua6KPbZTsfOmFLggZmhqPZSjS+leqFagpissW/aHSyk/3c+vhXOhEbCUeCXaz7up
+/DNF/0OHF4+r2UaeonxMxC/X6NEhNYHyNPypbdC3/59Zoa2Spu2BLy8ZoChe1dRk
+hZqtAgMBAAEwDQYJKoZIhvcNAQELBQADggEBAHpq3JmhAm5t/orY4ONFxPq1iF89
+3nKsKckfcOpDF/zjS2+6I30LVByuU88BKdTt7tsRojoWXEI01YGqYWTEwerfESr9
+M16xek5h5e7XJqp9jzyX6kswel/rWB8rF93biW0v00/KKRwwIr5IDvKb4XvugzW4
+FEG+1nhXCyjrkmKV/bbCfdkBHgavaj5TPv1LoXOX7VDRjwqoM7RP/z6JJsZkxDx3
+TkXtC8Lw4LF+tpWY8nQu3/HCqwxL7Vgy4M/IvoXRePdSI6goH8ri0zFuK9pvAREK
+IjY271t+lapu8sDqUEf9tW/98YhxpBInQYBL2bEEtMYTRXRm06fSn7o3IlM=
+-----END CERTIFICATE-----

examples/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-----

examples/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;
+  }
+}

examples/e2e/pact_provider.py

@@ -23,12 +23,12 @@ def setup_user_a_nonadmin():
     ip_address = '198.0.0.1'
 
     fakedb['UserA'] = {
-                        'name': "UserA",
-                        'id': id,
-                        'created_on': some_date,
-                        'ip_address': ip_address,
-                        'admin': False
-                      }
+        'name': "UserA",
+        'id': id,
+        'created_on': some_date,
+        'ip_address': ip_address,
+        'admin': False
+    }
 
 
 if __name__ == '__main__':

examples/e2e/tests/test_user_consumer.py

@@ -42,9 +42,11 @@ def pact(request):
         Provider('UserService'), host_name=PACT_MOCK_HOST, port=PACT_MOCK_PORT,
         pact_dir=PACT_DIR)
     try:
+        print('start service')
         pact.start_service()
         yield pact
     finally:
+        print('stop service')
         pact.stop_service()
 
     version = request.config.getoption('--publish-pact')

examples/verifier/.flake8

@@ -0,0 +1,4 @@
+[flake8]
+max-line-length = 160
+exclude = .direnv/*
+max-complexity = 10

examples/verifier/README.md

@@ -0,0 +1,38 @@
+# Introduction
+
+This is a verifier example.
+
+## Setup
+
+Create your own virtualenv for this. Run
+
+```bash
+pip install -r requirements.txt
+```
+
+This should provide you with a relative path to pact install relatively (2 dirs up)
+
+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/xxx.py::test_yyy
+```