Merge pull request #203 from pact-foundation/fix/version_confusion

fix: introduced and renamed specification version

Author: elliottmurray

pact/consumer.py

@@ -49,7 +49,8 @@ def has_pact_with(self, provider, host_name='localhost', port=1234,
                       cors=False, publish_to_broker=False,
                       broker_base_url=None, broker_username=None,
                       broker_password=None, broker_token=None, pact_dir=None,
-                      version='2.0.0', file_write_mode='overwrite'):
+                      specification_version='2.0.0',
+                      file_write_mode='overwrite'):
         """
         Create a contract between the `provider` and this consumer.
 
@@ -108,8 +109,8 @@ def has_pact_with(self, provider, host_name='localhost', port=1234,
         :param pact_dir: Directory where the resulting pact files will be
             written. Defaults to the current directory.
         :type pact_dir: str
-        :param version: The Pact Specification version to use, defaults to
-            '2.0.0'.
+        :param specification_version: The Pact Specification version to use.
+            Defaults to '2.0.0'.
         :type version: str
         :param file_write_mode: How the mock service should apply multiple
             calls to .verify(). Pass 'overwrite' to overwrite the generated
@@ -142,5 +143,5 @@ def has_pact_with(self, provider, host_name='localhost', port=1234,
             cors=cors,
             pact_dir=pact_dir,
             publish_to_broker=publish_to_broker,
-            version=version,
+            specification_version=specification_version,
             file_write_mode=file_write_mode)

pact/pact.py

@@ -58,7 +58,7 @@ def __init__(
         broker_password=None,
         broker_token=None,
         pact_dir=None,
-        version='2.0.0',
+        specification_version='2.0.0',
         file_write_mode='overwrite',
     ):
         """
@@ -112,9 +112,9 @@ def __init__(
         :param pact_dir: Directory where the resulting pact files will be
             written. Defaults to the current directory.
         :type pact_dir: str
-        :param version: The Pact Specification version to use, defaults to
+        :param specification_version: The Pact Specification version to use, defaults to
             '2.0.0'.
-        :type version: str
+        :type version: str of the consumer version.
         :param file_write_mode: `overwrite` or `merge`. Use `merge` when
             running multiple mock service instances in parallel for the same
             consumer/provider pair. Ensure the pact file is deleted before
@@ -142,7 +142,7 @@ def __init__(
         self.ssl = ssl
         self.sslcert = sslcert
         self.sslkey = sslkey
-        self.version = version
+        self.specification_version = specification_version
         self._interactions = []
         self._process = None
 
@@ -196,7 +196,7 @@ def start_service(self):
             "--log", f"{self.log_dir}/pact-mock-service.log",
             "--pact-dir", self.pact_dir,
             "--pact-file-write-mode", self.file_write_mode,
-            f"--pact-specification-version={self.version}",
+            f"--pact-specification-version={self.specification_version}",
             "--consumer", self.consumer.name,
             "--provider", self.provider.name,
         ]
@@ -235,7 +235,7 @@ def stop_service(self):
         if self.publish_to_broker:
             self.publish(
                 self.consumer.name,
-                self.version,
+                self.consumer.version,
                 tag_with_git_branch=self.consumer.tag_with_git_branch,
                 consumer_tags=self.consumer.tags,
             )

tests/test_consumer.py

@@ -26,7 +26,7 @@ def test_has_pact_with(self):
             consumer=self.consumer, provider=self.provider,
             host_name='localhost', port=1234,
             log_dir=None, ssl=False, sslcert=None, sslkey=None,
-            cors=False, pact_dir=None, version='2.0.0',
+            cors=False, pact_dir=None, specification_version='2.0.0',
             broker_base_url=None, publish_to_broker=False,
             broker_username=None, broker_password=None,
             broker_token=None, file_write_mode='overwrite')
@@ -35,15 +35,15 @@ def test_has_pact_with_customer_all_options(self):
         result = self.consumer.has_pact_with(
             self.provider, host_name='example.com', port=1111,
             log_dir='/logs', ssl=True, sslcert='/ssl.cert', sslkey='ssl.pem',
-            cors=True, pact_dir='/pacts', version='3.0.0',
+            cors=True, pact_dir='/pacts', specification_version='3.0.0',
             file_write_mode='merge')
 
         self.assertIs(result, self.mock_service.return_value)
         self.mock_service.assert_called_once_with(
             consumer=self.consumer, provider=self.provider,
             host_name='example.com', port=1111,
             log_dir='/logs', ssl=True, sslcert='/ssl.cert', sslkey='ssl.pem',
-            cors=True, pact_dir='/pacts', version='3.0.0',
+            cors=True, pact_dir='/pacts', specification_version='3.0.0',
             broker_base_url=None, publish_to_broker=False,
             broker_username=None, broker_password=None, broker_token=None,
             file_write_mode='merge')

tests/test_pact.py

@@ -35,14 +35,14 @@ def test_init_defaults(self):
         self.assertIsNone(target.sslcert)
         self.assertIsNone(target.sslkey)
         self.assertEqual(target.uri, 'http://localhost:1234')
-        self.assertEqual(target.version, '2.0.0')
+        self.assertEqual(target.specification_version, '2.0.0')
         self.assertEqual(len(target._interactions), 0)
 
     def test_init_custom_mock_service(self):
         target = Pact(
             self.consumer, self.provider, host_name='192.168.1.1', port=8000,
             log_dir='/logs', ssl=True, sslcert='/ssl.cert', sslkey='/ssl.pem',
-            cors=True, pact_dir='/pacts', version='3.0.0',
+            cors=True, pact_dir='/pacts', specification_version='3.0.0',
             file_write_mode='merge')
 
         self.assertIs(target.consumer, self.consumer)
@@ -56,7 +56,7 @@ def test_init_custom_mock_service(self):
         self.assertEqual(target.sslcert, '/ssl.cert')
         self.assertEqual(target.sslkey, '/ssl.pem')
         self.assertEqual(target.uri, 'https://192.168.1.1:8000')
-        self.assertEqual(target.version, '3.0.0')
+        self.assertEqual(target.specification_version, '3.0.0')
         self.assertEqual(target.file_write_mode, 'merge')
         self.assertEqual(len(target._interactions), 0)
 
@@ -371,7 +371,7 @@ def test_stop_windows(self):
         ruby_exe = Mock(spec=Process)
         self.mock_Process.return_value.children.return_value = [ruby_exe]
         self.mock_Pid_exists.return_value = False
-        pact = Pact(Consumer('consumer'), Provider('provider'), publish_to_broker=True)
+        pact = Pact(Consumer('consumer', version='abc'), Provider('provider'), publish_to_broker=True)
         pact._process = Mock(spec=Popen, pid=999)
         pact.stop_service()
 
@@ -383,7 +383,8 @@ def test_stop_windows(self):
         ruby_exe.terminate.assert_called_once_with()
         self.mock_Process.return_value.wait.assert_called_once_with()
         self.mock_Pid_exists.assert_called_once_with(999)
-        self.mock_publish.assert_called_once()
+        self.mock_publish.assert_called_once_with(
+            pact, 'consumer', 'abc', consumer_tags=None, tag_with_git_branch=False)
 
     def test_stop_fails_posix(self):
         self.mock_platform.return_value = 'Linux'