Skip to content

feat(verifier): Support work-in-progress pacts attribute in CLI #182

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Oct 17, 2020
Merged

feat(verifier): Support work-in-progress pacts attribute in CLI #182

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
fc3d7ae
feat(verifier): Support include-wip-pacts-since in CLI
thatguysimon Oct 17, 2020
b8c0006
style: Fix linting
thatguysimon Oct 17, 2020
5a5969d
fix: Fix command building bug
thatguysimon Oct 17, 2020
9ea14d3
refactor: Extract input validation in call_verify out into a dedicate…
thatguysimon Oct 17, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 7 additions & 1 deletion pact/cli/verify.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -116,11 +116,16 @@
help='Allow pacts which are in pending state to be verified without causing the '
'overall task to fail. For more information, see https://pact.io/pending',
is_flag=True)
@click.option(
'include_wip_pacts_since', '--include-wip-pacts-since',
default=None,
help='Automatically include the pending pacts in the verification step. '
'For more information, see https://docs.pact.io/pact_broker/advanced_topics/wip_pacts/',)
def main(pacts, base_url, pact_url, pact_urls, states_url, states_setup_url,
username, broker_base_url, consumer_version_tag, consumer_version_selector,
provider_version_tag, password, token, provider, headers, timeout,
provider_app_version, publish_verification_results, verbose, log_dir,
log_level, enable_pending):
log_level, enable_pending, include_wip_pacts_since):
"""
Verify one or more contracts against a provider service.

Expand Down Expand Up @@ -186,6 +191,7 @@ def main(pacts, base_url, pact_url, pact_urls, states_url, states_setup_url,
provider=provider,
provider_base_url=base_url,
enable_pending=enable_pending,
include_wip_pacts_since=include_wip_pacts_since,
**options)
sys.exit(success)

Expand Down
7 changes: 5 additions & 2 deletions pact/verifier.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ def validate_publish(self, **kwargs):
# do something
raise Exception()

def verify_pacts(self, *pacts, enable_pending=False, **kwargs):
def verify_pacts(self, *pacts, enable_pending=False, include_wip_pacts_since=None, **kwargs):
"""Verify our pacts from the provider.

Returns:
Expand All @@ -54,18 +54,20 @@ def verify_pacts(self, *pacts, enable_pending=False, **kwargs):
provider=self.provider,
provider_base_url=self.provider_base_url,
enable_pending=enable_pending,
include_wip_pacts_since=include_wip_pacts_since,
**options)

return success, logs

def verify_with_broker(self, enable_pending=False, **kwargs):
def verify_with_broker(self, enable_pending=False, include_wip_pacts_since=None, **kwargs):
"""Use Broker to verify.

Args:
broker_username ([String]): broker username
broker_password ([String]): broker password
broker_url ([String]): url of broker
enable_pending ([Boolean])
include_wip_pacts_since ([String])

"""
broker_username = kwargs.get('broker_username', None)
Expand All @@ -84,6 +86,7 @@ def verify_with_broker(self, enable_pending=False, **kwargs):
success, logs = VerifyWrapper().call_verify(provider=self.provider,
provider_base_url=self.provider_base_url,
enable_pending=enable_pending,
include_wip_pacts_since=include_wip_pacts_since,
**options)
return success, logs

Expand Down
13 changes: 10 additions & 3 deletions pact/verify_wrapper.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -129,14 +129,18 @@ def _broker_present(self, **kwargs):
return False
return True

def _validate_input(self, pacts, **kwargs):
if len(pacts) == 0 and not self._broker_present(**kwargs):
raise PactException('Pact urls or Pact broker required')

def call_verify(
self, *pacts, provider_base_url, provider, enable_pending=False, **kwargs
self, *pacts, provider_base_url, provider, enable_pending=False,
include_wip_pacts_since=None, **kwargs
):
"""Call verify method."""
verbose = kwargs.get('verbose', False)

if(len(pacts) == 0 and not self._broker_present(**kwargs)):
raise PactException('Pact urls or Pact broker required')
self._validate_input(pacts, **kwargs)

provider_app_version = kwargs.get('provider_app_version')
options = {
Expand Down Expand Up @@ -170,6 +174,9 @@ def call_verify(
if enable_pending:
command.append('--enable-pending')

if include_wip_pacts_since:
command.extend(['--include-wip-pacts-since={}'.format(include_wip_pacts_since)])

headers = kwargs.get('custom_provider_headers', [])
for header in headers:
command.extend(['{}={}'.format('--custom-provider-header', header)])
Expand Down
23 changes: 15 additions & 8 deletions tests/cli/test_verify.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -111,7 +111,8 @@ def test_successful_verification(self, mock_isfile, mock_wrapper):
provider_base_url='http://localhost',
timeout=30,
verbose=True,
enable_pending=False)
enable_pending=False,
include_wip_pacts_since=None)

@patch("pact.verify_wrapper.VerifyWrapper.call_verify")
@patch("pact.verify_wrapper.isfile", return_value=True)
Expand Down Expand Up @@ -140,7 +141,7 @@ def test_pact_url_param_supported(self, mock_isfile, mock_wrapper):
timeout=30,
verbose=False,
enable_pending=False,
)
include_wip_pacts_since=None)
self.assertEqual(result.exit_code, 0)

@patch("pact.verify_wrapper.VerifyWrapper.call_verify")
Expand All @@ -161,7 +162,8 @@ def test_pact_urls_param_supported(self, mock_isfile, mock_wrapper):
provider_base_url='http://localhost',
timeout=30,
verbose=False,
enable_pending=False)
enable_pending=False,
include_wip_pacts_since=None)
self.assertEqual(result.exit_code, 0)

@patch("pact.verify_wrapper.VerifyWrapper.call_verify")
Expand All @@ -186,7 +188,8 @@ def test_failed_verification(self, mock_isfile, mock_wrapper):
provider_base_url='http://localhost',
timeout=30,
verbose=False,
enable_pending=False)
enable_pending=False,
include_wip_pacts_since=None)

@patch.dict(os.environ, {'PACT_BROKER_PASSWORD': 'pwd',
'PACT_BROKER_USERNAME': 'broker_user',
Expand All @@ -208,7 +211,8 @@ def test_broker_creds_from_env_var(self, mock_isfile, mock_wrapper):
broker_url='http://broker/',
timeout=30,
verbose=False,
enable_pending=False)
enable_pending=False,
include_wip_pacts_since=None)

@patch("pact.verify_wrapper.VerifyWrapper.call_verify")
@patch("pact.verify_wrapper.isfile", return_value=True)
Expand Down Expand Up @@ -258,7 +262,8 @@ def test_all_url_options(self, mock_isfile, mock_wrapper):
log_level='INFO',
timeout=60,
verbose=True,
enable_pending=True)
enable_pending=True,
include_wip_pacts_since=None)

@patch("pact.verify_wrapper.VerifyWrapper.call_verify")
def test_all_broker_options(self, mock_wrapper):
Expand All @@ -282,7 +287,8 @@ def test_all_broker_options(self, mock_wrapper):
'--timeout=60',
'--publish-verification-results',
'--verbose',
'--enable-pending'
'--enable-pending',
'--include-wip-pacts-since=2018-01-01',
])

self.assertEqual(result.exit_code, 0, result.output)
Expand All @@ -303,7 +309,8 @@ def test_all_broker_options(self, mock_wrapper):
provider_states_setup_url='http://localhost/provider-states/set',
timeout=60,
verbose=True,
enable_pending=True)
enable_pending=True,
include_wip_pacts_since='2018-01-01')

@patch("pact.verify_wrapper.isfile", return_value=True)
def test_publishing_missing_version(self, mock_isfile):
Expand Down
29 changes: 25 additions & 4 deletions tests/test_verifier.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,8 @@ def test_verifier_with_provider_and_files(self, mock_path_exists, mock_wrapper):
provider_base_url='http://localhost:8888',
log_level='INFO',
verbose=False,
enable_pending=False)
enable_pending=False,
include_wip_pacts_since=None)

def test_validate_on_publish_results(self):
self.assertRaises(Exception, self.verifier.verify_pacts, 'path/to/pact1', publish=True)
Expand All @@ -58,7 +59,8 @@ def test_publish_on_success(self, mock_path_exists, mock_wrapper):
log_level='INFO',
verbose=False,
publish_version='1.0.0',
enable_pending=False)
enable_pending=False,
include_wip_pacts_since=None)

@patch('pact.verifier.path_exists', return_value=False)
def test_raises_error_on_missing_pact_files(self, mock_path_exists):
Expand Down Expand Up @@ -88,6 +90,14 @@ def test_passes_enable_pending_flag_value(self, mock_wrapper):
mock_wrapper.call_args.kwargs,
)

@patch('pact.verify_wrapper.VerifyWrapper.call_verify', return_value=(0, None))
@patch('pact.verifier.path_exists', return_value=True)
def test_passes_include_wip_pacts_since_value(self, mock_path_exists, mock_wrapper):
self.verifier.verify_pacts('any.json', include_wip_pacts_since='2018-01-01')
self.assertTrue(
('include_wip_pacts_since', '2018-01-01') in mock_wrapper.call_args.kwargs.items(),
mock_wrapper.call_args.kwargs,
)

class VerifierBrokerTestCase(TestCase):

Expand Down Expand Up @@ -127,7 +137,8 @@ def test_verifier_with_broker(self, mock_wrapper):
broker_url=self.broker_url,
log_level='INFO',
verbose=False,
enable_pending=False)
enable_pending=False,
include_wip_pacts_since=None)

@patch("pact.verify_wrapper.VerifyWrapper.call_verify")
@patch('pact.verifier.path_exists', return_value=True)
Expand All @@ -146,7 +157,8 @@ def test_publish_on_success(self, mock_path_exists, mock_wrapper):
log_level='INFO',
verbose=False,
publish_version='1.0.0',
enable_pending=False)
enable_pending=False,
include_wip_pacts_since=None)

@patch('pact.verify_wrapper.VerifyWrapper.call_verify', return_value=(0, None))
def test_passes_enable_pending_flag_value(self, mock_wrapper):
Expand All @@ -158,3 +170,12 @@ def test_passes_enable_pending_flag_value(self, mock_wrapper):
('enable_pending', value) in mock_wrapper.call_args.kwargs.items(),
mock_wrapper.call_args.kwargs,
)

@patch('pact.verify_wrapper.VerifyWrapper.call_verify', return_value=(0, None))
@patch('pact.verifier.path_exists', return_value=True)
def test_passes_include_wip_pacts_since_value(self, mock_path_exists, mock_wrapper):
self.verifier.verify_with_broker(include_wip_pacts_since='2018-01-01')
self.assertTrue(
('include_wip_pacts_since', '2018-01-01') in mock_wrapper.call_args.kwargs.items(),
mock_wrapper.call_args.kwargs,
)
4 changes: 3 additions & 1 deletion tests/test_verify_wrapper.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -121,7 +121,8 @@ def test_all_url_options(self, mock_isfile):
log_level='INFO',
timeout=60,
verbose=True,
enable_pending=True)
enable_pending=True,
include_wip_pacts_since='2018-01-01')

self.assertEqual(result, 0)
self.mock_Popen.return_value.wait.assert_called_once_with()
Expand All @@ -140,6 +141,7 @@ def test_all_url_options(self, mock_isfile):
'--log-level=INFO',
'--verbose',
'--enable-pending',
'--include-wip-pacts-since=2018-01-01',
)

def test_uses_broker_if_no_pacts_and_provider_required(self):
Expand Down