pact-python manages the mock service for the user

- Change the API so the user can control when the mock service starts and stops
- Update the README.md to illustrate controlling the mock service
- Switch the command line arguments to the mock service to be separate items in a list so
  that they are properly quoted for the shell
- Increment the project to version 0.2.0

Author: matthewbalvanz-wf

CHANGES.txt

@@ -1 +1,2 @@
 v0.1.0, 2017-03-30 -- Basic support for authoring contracts against a separately running mock service
+v0.2.0, 2017-04-22 -- Pact Python manages the Pact mock service

Makefile

@@ -39,9 +39,6 @@ e2e:
 	sh -c '\
 		cd e2e; \
 		docker-compose pull > /dev/null; \
-		docker-compose up -d pactmockservice; \
-		while ! nc -z localhost 1234; do sleep 0.1; done; \
-		docker-compose logs --follow > ./pacts/mock-service-logs.txt & \
 		nosetests ./contracts; \
 		docker-compose down; \
 		docker-compose up -d app pactverifier; \

README.md

@@ -40,14 +40,19 @@ def user(user_name):
 Then `Consumer`'s contract test might look something like this:
 
 ```python
+import atexit
 import unittest
 
 from pact import Consumer, Provider
 
 
+pact = Consumer('Consumer').has_pact_with(Provider('Provider'))
+pact.start()
+atexit.register(pact.stop)
+
+
 class GetUserInfoContract(unittest.TestCase):
   def test_get_user(self):
-    pact = Consumer('Consumer').has_pact_with(Provider('Provider'))
     expected = {
       'username': 'UserA',
       'id': 123,
@@ -88,13 +93,12 @@ pact = Consumer('Consumer').has_pact_with(
     Provider('Provider'), host_name='mockservice', port=8080)
 ```
 
-This can be useful if you are running your tests and the mock service inside a Docker
-network, where you want to reference the service by its Docker name, instead of via
-the `localhost` interface. It is important to note that the code you are testing with
-this contract _must_ contact the mock service. So in this example, the `user` method
-could accept an argument to specify the location of the server, or retrieve it from an
-environment variable so you can change its URI during the test. Another option is to
-specify a Docker network alias so the requests that you make will go to the container.
+This can be useful if you need to run to create more than one Pact for your test
+because your code interacts with two different services. It is important to note
+that the code you are testing with this contract _must_ contact the mock service.
+So in this example, the `user` method could accept an argument to specify the
+location of the server, or retrieve it from an environment variable so you can
+change its URI during the test.
 
 The mock service offers you several important features when building your contracts:
 - It provides a real HTTP server that your code can contact during the test and provides the responses you defined.

e2e/contracts/test_e2e.py

@@ -1,3 +1,5 @@
+import atexit
+
 import requests
 import unittest
 
@@ -7,6 +9,8 @@
 
 
 pact = Consumer('consumer').has_pact_with(Provider('provider'))
+pact.start()
+atexit.register(pact.stop)
 
 
 class BaseTestCase(unittest.TestCase):

pact/__init__.py

@@ -6,4 +6,4 @@
 
 
 __all__ = ('Consumer', 'EachLike', 'Pact', 'Provider', 'SomethingLike', 'Term')
-__version__ = '0.1.0'
+__version__ = '0.2.0'

pact/pact.py

@@ -198,7 +198,6 @@ def __enter__(self):
 
         Sets up the mock service to expect the client requests.
         """
-        self.start()
         try:
             payload = {
                 'description': self._description,
@@ -217,7 +216,6 @@ def __enter__(self):
 
             assert resp.status_code == 200, resp.content
         except AssertionError:
-            self.stop()
             raise
 
     def __exit__(self, exc_type, exc_val, exc_tb):
@@ -228,24 +226,20 @@ def __exit__(self, exc_type, exc_val, exc_tb):
         expected, and has it write out the contracts to disk.
         """
         if (exc_type, exc_val, exc_tb) != (None, None, None):
-            self.stop()
             return
 
-        try:
-            resp = requests.get(
-                self.uri + '/interactions/verification',
-                headers=self.HEADERS)
-            assert resp.status_code == 200, resp.content
-            payload = {
-                'consumer': {'name': self.consumer.name},
-                'provider': {'name': self.provider.name},
-                'pact_dir': self.pact_dir
-            }
-            resp = requests.post(
-                self.uri + '/pact', headers=self.HEADERS, json=payload)
-            assert resp.status_code == 200, resp.content
-        finally:
-            self.stop()
+        resp = requests.get(
+            self.uri + '/interactions/verification',
+            headers=self.HEADERS)
+        assert resp.status_code == 200, resp.content
+        payload = {
+            'consumer': {'name': self.consumer.name},
+            'provider': {'name': self.provider.name},
+            'pact_dir': self.pact_dir
+        }
+        resp = requests.post(
+            self.uri + '/pact', headers=self.HEADERS, json=payload)
+        assert resp.status_code == 200, resp.content
 
 
 class FromTerms(object):

pact/test/test_pact.py

@@ -126,11 +126,11 @@ def test_start_fails(self):
             MOCK_SERVICE_PATH, 'start',
             '--host=localhost',
             '--port=1234',
-            '--log="/logs/pact-mock-service.log"',
-            '--pact-dir="/pacts"',
-            '--pact-specification-version="2.0.0"',
-            '--consumer="consumer"',
-            '--provider="provider"'])
+            '--log', '/logs/pact-mock-service.log',
+            '--pact-dir', '/pacts',
+            '--pact-specification-version=2.0.0',
+            '--consumer', 'consumer',
+            '--provider', 'provider'])
 
         self.mock_Popen.return_value.communicate.assert_called_once_with()
 
@@ -143,11 +143,11 @@ def test_start_no_ssl(self):
             MOCK_SERVICE_PATH, 'start',
             '--host=localhost',
             '--port=1234',
-            '--log="/logs/pact-mock-service.log"',
-            '--pact-dir="/pacts"',
-            '--pact-specification-version="2.0.0"',
-            '--consumer="consumer"',
-            '--provider="provider"'])
+            '--log', '/logs/pact-mock-service.log',
+            '--pact-dir', '/pacts',
+            '--pact-specification-version=2.0.0',
+            '--consumer', 'consumer',
+            '--provider', 'provider'])
 
         self.mock_Popen.return_value.communicate.assert_called_once_with()
 
@@ -161,14 +161,14 @@ def test_start_with_ssl(self):
             MOCK_SERVICE_PATH, 'start',
             '--host=localhost',
             '--port=1234',
-            '--log="/logs/pact-mock-service.log"',
-            '--pact-dir="/pacts"',
-            '--pact-specification-version="2.0.0"',
-            '--consumer="consumer"',
-            '--provider="provider"',
+            '--log', '/logs/pact-mock-service.log',
+            '--pact-dir', '/pacts',
+            '--pact-specification-version=2.0.0',
+            '--consumer', 'consumer',
+            '--provider', 'provider',
             '--ssl',
-            '--sslcert="/ssl.cert"',
-            '--sslkey="/ssl.key"'])
+            '--sslcert', '/ssl.cert',
+            '--sslkey', '/ssl.key'])
 
         self.mock_Popen.return_value.communicate.assert_called_once_with()
 
@@ -196,8 +196,6 @@ def setUp(self):
         super(PactContextManagerTestCase, self).setUp()
         self.addCleanup(patch.stopall)
         self.mock_requests = patch('requests.api.request').start()
-        self.mock_start = patch.object(Pact, 'start', autospec=True).start()
-        self.mock_stop = patch.object(Pact, 'stop', autospec=True).start()
         self.consumer = Consumer('TestConsumer')
         self.provider = Provider('TestProvider')
         self.target = Pact(self.consumer, self.provider)
@@ -245,8 +243,6 @@ def test_successful(self):
         self.mock_requests.assert_has_calls([
             self.delete_call, self.post_interactions_call,
             self.get_verification_call, self.post_publish_pacts_call])
-        self.mock_start.assert_called_once_with(self.target)
-        self.mock_stop.assert_called_once_with(self.target)
 
     def test_error_deleting_interactions(self):
         self.mock_requests.side_effect = iter([
@@ -258,8 +254,6 @@ def test_error_deleting_interactions(self):
         self.assertEqual(str(e.exception), 'deletion error')
         self.assertEqual(self.mock_requests.call_count, 1)
         self.mock_requests.assert_has_calls([self.delete_call])
-        self.mock_start.assert_called_once_with(self.target)
-        self.mock_stop.assert_called_once_with(self.target)
 
     def test_error_posting_interactions(self):
         self.mock_requests.side_effect = iter([
@@ -273,14 +267,11 @@ def test_error_posting_interactions(self):
         self.assertEqual(self.mock_requests.call_count, 2)
         self.mock_requests.assert_has_calls(
             [self.delete_call, self.post_interactions_call])
-        self.mock_start.assert_called_once_with(self.target)
-        self.mock_stop.assert_called_once_with(self.target)
 
     def test_error_raised(self):
         self.mock_requests.side_effect = TypeError('type error')
         self.target.__exit__(TypeError, 'type error', Mock())
         self.assertFalse(self.mock_requests.called)
-        self.mock_stop.assert_called_once_with(self.target)
 
     def test_error_verifying_interactions(self):
         self.mock_requests.side_effect = iter([
@@ -293,7 +284,6 @@ def test_error_verifying_interactions(self):
         self.assertEqual(self.mock_requests.call_count, 1)
         self.mock_requests.assert_has_calls([
             self.get_verification_call])
-        self.mock_stop.assert_called_once_with(self.target)
 
     def test_error_writing_pacts_to_file(self):
         self.mock_requests.side_effect = iter([
@@ -307,7 +297,6 @@ def test_error_writing_pacts_to_file(self):
         self.assertEqual(self.mock_requests.call_count, 2)
         self.mock_requests.assert_has_calls([
             self.get_verification_call, self.post_publish_pacts_call])
-        self.mock_stop.assert_called_once_with(self.target)
 
 
 class FromTermsTestCase(TestCase):