Merge pull request #42 from Kalimaha/development

Development

.coveragerc

@@ -0,0 +1,3 @@
+[run]
+omit = pact_test/utils/logger.py
+

.gitignore

@@ -2,12 +2,19 @@
 .cache/
 .idea/
 build/
-pypact.egg-info/
+pact_test.egg-info/
 tests/__pycache__/
 .eggs/
 .coverage
 *.log
 *.egg
 *.iml
+pact_test.egg-info/
+pact_test/__pycache__
+__pycache__
+.DS_Store
 pytest_pact.egg-info/
-pytest_pact/__pycache__
+dist/
+.tox
+.idea/
+*.iml

.travis.yml

@@ -1,16 +1,17 @@
 language: python
+
+sudo: false
+
 python:
   - 2.7
   - 3.3
   - 3.4
   - 3.5
   - 3.6
+
 install:
-  - "pip install -r requirements.txt"
-  - "pip install pytest pytest-cov pytest-sugar"
-  - "pip install coveralls"
-  - "pip install -e ."
-script:
-  - py.test --cov pytest_pact --cov-report term-missing
-after_success:
-  - coveralls
+  - pip install -e .
+  - pip install -r requirements.txt
+
+script: pytest
+

README.rst

@@ -0,0 +1,228 @@
+.. image:: https://img.shields.io/badge/license-MIT-brightgreen.svg
+    :target: https://github.com/Kalimaha/pact-test/blob/master/LICENSE
+.. image:: https://img.shields.io/badge/python-2.7,%203.3,%203.4,%203.5,%203.6-brightgreen.svg
+    :target: https://travis-ci.org/Kalimaha/pact-test
+.. image:: https://img.shields.io/badge/pypi-0.1.1-brightgreen.svg
+    :target: https://pypi.python.org/pypi?:action=display&name=pact-test&version=0.1.1
+.. image:: https://img.shields.io/pypi/wheel/Django.svg
+    :target: https://pypi.python.org/pypi?:action=display&name=pact-test&version=0.1.1
+.. image:: https://travis-ci.org/Kalimaha/pact-test.svg?branch=master
+    :target: https://travis-ci.org/Kalimaha/pact-test
+.. image:: https://coveralls.io/repos/github/Kalimaha/pact-test/badge.svg?branch=development
+    :target: https://coveralls.io/github/Kalimaha/pact-test?branch=development
+.. image:: https://img.shields.io/badge/Say%20Thanks-!-1EAEDB.svg
+    :target: https://saythanks.io/to/Kalimaha
+
+Pact Test for Python
+====================
+
+This repository contains a Python implementation for `Pact <http://pact.io/>`_. Pact is a specification for
+Consumer Driven Contracts Testing. For further information about Pact project, contracts testing, pros and cons and
+useful resources please refer to the `Pact website <http://pact.io/>`_.
+
+There are two phases in Consumer Driven Contracts Testing: a Consumer sets up a contract (*it's consumer driven
+after all!*), and a Provider honours it. But, before that...
+
+Installation
+~~~~~~~~~~~~
+
+Pact Test is distributed through `PyPi <https://pypi.python.org/pypi/pact-test>`_ so it can be easily included in the
+:code:`requirements.txt` file or normally installed with :code:`pip`:
+
+.. code:: bash
+
+  $ pip install pact-test
+
+Providers Tests (*Set the Contracts*)
+-------------------------------------
+
+.. image:: https://img.shields.io/badge/Pact-1.0-brightgreen.svg
+    :target: https://github.com/pact-foundation/pact-specification/tree/version-1
+.. image:: https://img.shields.io/badge/Pact-1.1-red.svg
+    :target: https://github.com/pact-foundation/pact-specification/tree/version-1.1
+.. image:: https://img.shields.io/badge/Pact-2.0-red.svg
+    :target: https://github.com/pact-foundation/pact-specification/tree/version-2
+.. image:: https://img.shields.io/badge/Pact-3.0-red.svg
+    :target: https://github.com/pact-foundation/pact-specification/tree/version-3
+.. image:: https://img.shields.io/badge/Pact-4.0-red.svg
+    :target: https://github.com/pact-foundation/pact-specification/tree/version-4
+
+Consumers run Provider Tests to create pacts and establish a contract between
+them and service providers. An example of a Python client using pact test is
+available at `here <https://github.com/Kalimaha/PythonEats>`_. Consumers define
+all the interactions with their providers in the following way:
+
+.. code:: python
+
+    @service_consumer('PythonEats')
+    @has_pact_with('PyzzaHut')
+    class PyzzaHutTest(ServiceProviderTest):
+
+        @given('some pizzas exist')
+        @upon_receiving('a request for a pepperoni pizza')
+        @with_request({'method': 'get', 'path': '/pizzas/pepperoni/'})
+        @will_respond_with({'status': 200, 'body': {'id': 42, 'type': 'pepperoni'}})
+        def test_get_pepperoni_pizza(self):
+            pizza = get_pizza('pepperoni')
+            assert pizza['id'] == 42
+            assert pizza['type'] == 'pepperoni'
+
+This test verifies, against a mock server, the expected interaction and creates
+a JSON file (*the pact*) that will be stored locally and also sent to the
+Pact Broker, if available. It is possible to define multiple tests for the same
+state in order to verify all the scenarios of interest, For example, we can
+test an unhappy :code:`404` situation:
+
+.. code:: python
+
+    @given('some pizzas exist')
+    @upon_receiving('a request for an hawaiian pizza')
+    @with_request({'method': 'get', 'path': '/pizzas/hawaiian/'})
+    @will_respond_with({'status': 404, 'body': {'message': 'we do not serve pineapple with pizza'}})
+    def test_get_hawaiian_pizza(self):
+        pizza = get_pizza('hawaiian')
+        assert pizza.status_code == 404
+        assert pizza.json()['message'] == 'we do not serve pineapple with pizza'
+
+Consumers Tests (*Honour Your Contracts*)
+-----------------------------------------
+
+.. image:: https://img.shields.io/badge/Pact-1.0-brightgreen.svg
+    :target: https://github.com/pact-foundation/pact-specification/tree/version-1
+.. image:: https://img.shields.io/badge/Pact-1.1-red.svg
+    :target: https://github.com/pact-foundation/pact-specification/tree/version-1.1
+.. image:: https://img.shields.io/badge/Pact-2.0-red.svg
+    :target: https://github.com/pact-foundation/pact-specification/tree/version-2
+.. image:: https://img.shields.io/badge/Pact-3.0-red.svg
+    :target: https://github.com/pact-foundation/pact-specification/tree/version-3
+.. image:: https://img.shields.io/badge/Pact-4.0-red.svg
+    :target: https://github.com/pact-foundation/pact-specification/tree/version-4
+
+Providers run Consumer Tests to verify that they are honouring their pacts with the consumers. There are few examples
+of an hypothetical restaurant service implemented with the most popular Python web frameworks:
+
+* Djanjo (*TODO*)
+* `Flask <https://github.com/Kalimaha/restaurant-service-flask>`_
+* `Pyramid <https://github.com/Kalimaha/restaurant-service-pyramid>`_
+
+There are few things required to setup and run consumer tests.
+
+Pact Helper
+~~~~~~~~~~~
+
+This helper class is used by Pact Test to start and stop the web-app before and after the test. It also defines the
+ports and endpoint to be used by the test. The following is an example of Pact Helper:
+
+.. code:: python
+
+    class RestaurantPactHelper(PactHelper):
+        process = None
+
+        def setup(self):
+            self.process = subprocess.Popen('gunicorn start:app -w 3 -b :8080 --log-level error', shell=True)
+
+        def tear_down(self):
+            self.process.kill()
+
+There are few rules for the helper:
+
+* it **must** extend :code:`PactHelper` class from :code:`pact_test`
+* it **must** define a :code:`setup` method
+* it **must** define a :code:`tear_down` method
+
+It is also possible to override default url (*localhost*) and port (*9999*):
+
+.. code:: python
+
+    class RestaurantPactHelper(PactHelper):
+        test_url = '0.0.0.0'
+        test_port = 5000
+
+
+States
+~~~~~~
+
+When a consumer sets a pact, it defines certain states. States are basically pre-requisites to your test. Before
+honouring the pacts, a provider needs to define such states. For example:
+
+.. code:: python
+
+    @honours_pact_with('UberEats')
+    @pact_uri('http://Kalimaha.github.io/src/pacts/pact.json')
+    class UberEats(ServiceConsumerTest):
+
+        @state('some menu items exist')
+        def test_get_menu_items(self):
+            DB.save(MenuItem('spam'))
+            DB.save(MenuItem('eggs'))
+
+In this example, the provider stores some test data in its DB in order to make the system ready to receive mock calls
+from the consumer and therefore verify the pact.
+
+Configuration
+-------------
+
+The default configuration of Pact Test assumes the following values:
+
+* **consumer_tests_path:** :code:`tests/service_consumers`
+* **provider_tests_path:** :code:`tests/service_providers`
+* **pact_broker_uri:** :code:`None`
+
+It is possible to override such values by creating a file named :code:`.pact.json` in the project's root. The following
+is an example of a valid configuration file:
+
+.. code:: json
+
+  {
+    "consumer_tests_path": "mypath/mytests",
+    "provider_tests_path": "mypath/mytests",
+    "pact_broker_uri": "http://example.com/"
+  }
+
+All fields are optional: only specified fields will override default configuration values.
+
+Development
+===========
+
+Setup
+~~~~~
+
+.. code:: bash
+
+  python3 setup.py install
+
+Test
+~~~~
+
+It is possible to run the tests locally with Docker through the following command:
+
+.. code:: bash
+
+  $ ./bin/test
+
+By default this command tests the library against Python 3.6. It is possible to specify the Python version as follows:
+
+.. code:: bash
+
+  $ ./bin/test <ENV>
+
+Available values for `ENV` are: :code:`py27`, :code:`py33`, :code:`py34`, :code:`py35` and :code:`py36`. It is also
+possible to test all the versions at once with:
+
+.. code:: bash
+
+  $ ./bin/test all
+
+Upload New Version
+~~~~~~~~~~~~~~~~~~
+
+.. code:: bash
+
+  $ python3 setup.py sdist upload
+
+With `Python Wheels <http://pythonwheels.com/>`_:
+
+.. code:: bash
+
+  $ python3 setup.py sdist bdist_wheel
+  $ twine upload dist/*

bin/pact-test

@@ -0,0 +1,38 @@
+#!/usr/bin/env python
+import os
+import sys
+sys.path.append(os.path.join(os.path.dirname(__file__), '..'))
+from pact_test.runners.pact_tests_runner import verify
+
+
+def print_help():
+    print('                                                        ')
+    print('========================================================')
+    print('            Welcome to Pact Test for Python!            ')
+    print('--------------------------------------------------------')
+    print('                   Available Commands                   ')
+    print('                                                        ')
+    print('help..............................Display this help page')
+    print('verify.............................Verify all Pact tests')
+    print('verify consumers..............Verify Consumer Pact tests')
+    print('verify providers..............Verify Provider Pact tests')
+    print('========================================================')
+    print('                                                        ')
+
+
+if len(sys.argv) is 1:
+    print_help()
+else:
+    if sys.argv[1].lower() == 'verify':
+        if len(sys.argv) is 2:
+            verify(verify_consumers=True, verify_providers=True)
+        elif sys.argv[2].lower() == 'consumers':
+            verify(verify_consumers=True, verify_providers=False)
+        elif sys.argv[2].lower() == 'providers':
+            verify(verify_consumers=False, verify_providers=True)
+        else:
+            print_help()
+    elif sys.argv[1].lower() == 'help':
+        print_help()
+    else:
+        print_help()

docker-compose.yml

@@ -0,0 +1,43 @@
+version: '2.1'
+
+services:
+
+  py27:
+    command: sh -c "find . -name '*.pyc' -delete && python setup.py test"
+    volumes:
+      - .:/app
+    build:
+      context: .
+      dockerfile: '/environments/Dockerfilepy27'
+
+  py33:
+    command: sh -c "find . -name '*.pyc' -delete && python setup.py test"
+    volumes:
+      - .:/app
+    build:
+      context: .
+      dockerfile: '/environments/Dockerfilepy33'
+
+  py34:
+    command: sh -c "find . -name '*.pyc' -delete && python setup.py test"
+    volumes:
+      - .:/app
+    build:
+      context: .
+      dockerfile: '/environments/Dockerfilepy34'
+
+  py35:
+    command: sh -c "find . -name '*.pyc' -delete && python setup.py test"
+    volumes:
+      - .:/app
+    build:
+      context: .
+      dockerfile: '/environments/Dockerfilepy35'
+
+  py36:
+    command: sh -c "find . -name '*.pyc' -delete && python setup.py test"
+    volumes:
+      - .:/app
+    build:
+      context: .
+      dockerfile: '/environments/Dockerfilepy36'

environments/Dockerfilepy27

@@ -0,0 +1,7 @@
+FROM python:2.7.13-alpine
+
+RUN mkdir -p /app
+WORKDIR /app
+ADD requirements.txt /app
+RUN pip install -r requirements.txt
+ADD . /app

environments/Dockerfilepy33

@@ -0,0 +1,7 @@
+FROM python:3.3.6-alpine
+
+RUN mkdir -p /app
+WORKDIR /app
+ADD requirements.txt /app
+RUN pip install -r requirements.txt
+ADD . /app

environments/Dockerfilepy34

@@ -0,0 +1,7 @@
+FROM python:3.4.6-alpine
+
+RUN mkdir -p /app
+WORKDIR /app
+ADD requirements.txt /app
+RUN pip install -r requirements.txt
+ADD . /app