Skip to content
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

Jump to bottom

feat: Support pending Pacts #171

Merged
merged 8 commits into from Sep 9, 2020
Merged

feat: Support pending Pacts #171

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
fbbd5fa
ci(pre-commit): add commitizen to pre-commit configuration
Sep 3, 2020
fc6c365
fix(verifier): remove superfluous option from verify CLI command
Sep 3, 2020
39de1f3
feat(verifier): add enable_pending argument handling in verify wrapper
Sep 3, 2020
d51c88d
test: bump mock to 3.0.5
m-aciek Sep 3, 2020
2b57446
feat(verifier): pass enable_pending flag in Verifier's methods
Sep 3, 2020
e6c9ed0
feat(verifier): support --enable-pending flag in CLI
Sep 3, 2020
c64bec1
refactor(verifier): add enable_pending to signature of verify methods
Sep 5, 2020
e840587
fix(verifier): remove superfluous verbose mentions
Sep 5, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
6 changes: 6 additions & 0 deletions .pre-commit-config.yaml
View file
Open in desktop
@@ -0,0 +1,6 @@
repos:
- repo: https://github.com/commitizen-tools/commitizen
rev: master
hooks:
- id: commitizen
stages: [commit-msg]
16 changes: 10 additions & 6 deletions pact/cli/verify.py
View file
Open in desktop
Expand Up @@ -104,20 +104,23 @@
'--verbose/--no-verbose',
default=False,
help='Toggle verbose logging, defaults to False.')
@click.option(
'--verbose/--no-verbose',
default=False,
help='Toggle verbose logging, defaults to False.')
@click.option(
'log_dir', '--log-dir',
help='The directory for the pact.log file.')
@click.option(
'log_level', '--log-level',
help='The logging level.')
@click.option(
'enable_pending', '--enable-pending',
default=False,
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)
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):
provider_app_version, publish_verification_results, verbose, log_dir,
log_level, enable_pending):
"""
Verify one or more contracts against a provider service.

Expand Down Expand Up @@ -172,7 +175,7 @@ def main(pacts, base_url, pact_url, pact_urls, states_url, states_setup_url,
'consumer_tags': list(consumer_version_tag),
'consumer_selectors': list(consumer_version_selector),
'provider_tags': list(provider_version_tag),
'provider_states_setup_url': states_setup_url
'provider_states_setup_url': states_setup_url,
}

options = dict(filter(lambda item: item[1] is not None, options.items()))
Expand All @@ -182,6 +185,7 @@ def main(pacts, base_url, pact_url, pact_urls, states_url, states_setup_url,
success, logs = VerifyWrapper().call_verify(*all_pact_urls,
provider=provider,
provider_base_url=base_url,
enable_pending=enable_pending,
**options)
sys.exit(success)

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

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

Returns:
Expand All @@ -53,17 +53,19 @@ def verify_pacts(self, *pacts, **kwargs):
success, logs = VerifyWrapper().call_verify(*pacts,
provider=self.provider,
provider_base_url=self.provider_base_url,
enable_pending=enable_pending,
**options)

return success, logs

def verify_with_broker(self, **kwargs):
def verify_with_broker(self, enable_pending=False, **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])

"""
broker_username = kwargs.get('broker_username', None)
Expand All @@ -81,6 +83,7 @@ def verify_with_broker(self, **kwargs):

success, logs = VerifyWrapper().call_verify(provider=self.provider,
provider_base_url=self.provider_base_url,
enable_pending=enable_pending,
**options)
return success, logs

Expand All @@ -91,7 +94,6 @@ def extract_params(self, **kwargs):
provider_app_version = kwargs.get('provider_app_version', None)
headers = kwargs.get('headers', [])
timeout = kwargs.get('timeout', None)
verbose = kwargs.get('verbose', None)
consumer_tags = kwargs.get('consumer_tags', [])
provider_tags = kwargs.get('provider_tags', [])
states_setup_url = kwargs.get('provider_states_setup_url', None)
Expand All @@ -104,12 +106,11 @@ def extract_params(self, **kwargs):
'provider_app_version': provider_app_version,
'custom_provider_header': list(headers),
'timeout': timeout,
'verbose': verbose,
'consumer_tags': list(consumer_tags),
'provider_tags': list(provider_tags),
'provider_states_setup_url': states_setup_url,
'verbose': verbose,
'publish_version': publish_version
'publish_version': publish_version,
}
return self.filter_empty_options(**options)

Expand Down
6 changes: 5 additions & 1 deletion pact/verify_wrapper.py
View file
Open in desktop
Expand Up @@ -133,7 +133,9 @@ def _broker_present(self, **kwargs):

return True

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

Expand Down Expand Up @@ -169,6 +171,8 @@ def call_verify(self, *pacts, provider_base_url, provider, **kwargs):

if(kwargs.get('verbose', False) is True):
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

command.extend(self. _get_boolean_flag('verbose'))

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There is no such a flag as --no-verbose, and for just one case I think it is a premature optimisation.

command.extend(['--verbose'])
if enable_pending:
command.append('--enable-pending')

headers = kwargs.get('custom_provider_headers', [])
for header in headers:
Expand Down
2 changes: 1 addition & 1 deletion requirements_dev.txt
View file
Open in desktop
Expand Up @@ -4,7 +4,7 @@ configparser==3.5.0
codecov==2.0.5
coverage==4.3.4
flake8==3.8.3
mock==2.0.0
mock==3.0.5
nose==1.3.7
psutil==5.7.0
pycodestyle==2.6.0
Expand Down
28 changes: 19 additions & 9 deletions tests/cli/test_verify.py
View file
Open in desktop
Expand Up @@ -110,7 +110,8 @@ def test_successful_verification(self, mock_isfile, mock_wrapper):
provider='provider',
provider_base_url='http://localhost',
timeout=30,
verbose=True)
verbose=True,
enable_pending=False)

@patch("pact.verify_wrapper.VerifyWrapper.call_verify")
@patch("pact.verify_wrapper.isfile", return_value=True)
Expand All @@ -137,7 +138,9 @@ def test_pact_url_param_supported(self, mock_isfile, mock_wrapper):
provider='provider',
provider_base_url='http://localhost',
timeout=30,
verbose=False)
verbose=False,
enable_pending=False,
)
self.assertEqual(result.exit_code, 0)

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

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

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

@patch("pact.verify_wrapper.VerifyWrapper.call_verify")
@patch("pact.verify_wrapper.isfile", return_value=True)
Expand All @@ -228,7 +234,8 @@ def test_all_url_options(self, mock_isfile, mock_wrapper):
'--log-dir=tmp/logs/pact.test.log',
'--log-level=INFO',
'--timeout=60',
'--verbose'
'--verbose',
'--enable-pending',
])
self.assertEqual(result.exit_code, 0, result.output)

Expand All @@ -250,7 +257,8 @@ def test_all_url_options(self, mock_isfile, mock_wrapper):
log_dir='tmp/logs/pact.test.log',
log_level='INFO',
timeout=60,
verbose=True)
verbose=True,
enable_pending=True)

@patch("pact.verify_wrapper.VerifyWrapper.call_verify")
def test_all_broker_options(self, mock_wrapper):
Expand All @@ -273,7 +281,8 @@ def test_all_broker_options(self, mock_wrapper):
'--provider-app-version=1.2.3',
'--timeout=60',
'--publish-verification-results',
'--verbose'
'--verbose',
'--enable-pending'
])

self.assertEqual(result.exit_code, 0, result.output)
Expand All @@ -293,7 +302,8 @@ def test_all_broker_options(self, mock_wrapper):
# custom_provider_header=['Authorization: Basic cGFj', 'CustomHeader: somevalue'],
provider_states_setup_url='http://localhost/provider-states/set',
timeout=60,
verbose=True)
verbose=True,
enable_pending=True)

@patch("pact.verify_wrapper.isfile", return_value=True)
def test_publishing_missing_version(self, mock_isfile):
Expand Down
34 changes: 30 additions & 4 deletions tests/test_verifier.py
View file
Open in desktop
Expand Up @@ -36,7 +36,8 @@ def test_verifier_with_provider_and_files(self, mock_path_exists, mock_wrapper):
provider='test_provider',
provider_base_url='http://localhost:8888',
log_level='INFO',
verbose=False)
verbose=False,
enable_pending=False)

def test_validate_on_publish_results(self):
self.assertRaises(Exception, self.verifier.verify_pacts, 'path/to/pact1', publish=True)
Expand All @@ -54,7 +55,8 @@ def test_publish_on_success(self, mock_path_exists, mock_wrapper):
provider_base_url='http://localhost:8888',
log_level='INFO',
verbose=False,
publish_version='1.0.0')
publish_version='1.0.0',
enable_pending=False)

@patch('pact.verifier.path_exists', return_value=False)
def test_raises_error_on_missing_pact_files(self, mock_path_exists):
Expand All @@ -73,6 +75,17 @@ def test_expand_directories_called_for_pacts(self, mock_path_exists, mock_expand

mock_expand_dir.assert_called_once()

@patch('pact.verify_wrapper.VerifyWrapper.call_verify', return_value=(0, None))
def test_passes_enable_pending_flag_value(self, mock_wrapper):
for value in (True, False):
with self.subTest(value=value):
with patch('pact.verifier.path_exists'):
self.verifier.verify_pacts('any.json', enable_pending=value)
self.assertTrue(
('enable_pending', value) in mock_wrapper.call_args.kwargs.items(),
mock_wrapper.call_args.kwargs,
)


class VerifierBrokerTestCase(TestCase):

Expand Down Expand Up @@ -111,7 +124,8 @@ def test_verifier_with_broker(self, mock_wrapper):
broker_token='token',
broker_url=self.broker_url,
log_level='INFO',
verbose=False)
verbose=False,
enable_pending=False)

@patch("pact.verify_wrapper.VerifyWrapper.call_verify")
@patch('pact.verifier.path_exists', return_value=True)
Expand All @@ -129,4 +143,16 @@ def test_publish_on_success(self, mock_path_exists, mock_wrapper):
broker_url=self.broker_url,
log_level='INFO',
verbose=False,
publish_version='1.0.0')
publish_version='1.0.0',
enable_pending=False)

@patch('pact.verify_wrapper.VerifyWrapper.call_verify', return_value=(0, None))
def test_passes_enable_pending_flag_value(self, mock_wrapper):
for value in (True, False):
with self.subTest(value=value):
with patch('pact.verifier.path_exists'):
self.verifier.verify_with_broker(enable_pending=value)
self.assertTrue(
('enable_pending', value) in mock_wrapper.call_args.kwargs.items(),
mock_wrapper.call_args.kwargs,
)
7 changes: 5 additions & 2 deletions tests/test_verify_wrapper.py
View file
Open in desktop
Expand Up @@ -108,7 +108,8 @@ def test_all_url_options(self, mock_isfile):
log_dir='tmp/logs/pact.test.log',
log_level='INFO',
timeout=60,
verbose=True)
verbose=True,
enable_pending=True)

self.assertEqual(result, 0)
self.mock_Popen.return_value.wait.assert_called_once_with()
Expand All @@ -125,7 +126,9 @@ def test_all_url_options(self, mock_isfile):
'--provider-app-version', '1.2.3',
'--log-dir=tmp/logs/pact.test.log',
'--log-level=INFO',
'--verbose')
'--verbose',
'--enable-pending',
)

def test_uses_broker_if_no_pacts_and_provider_required(self):
self.mock_Popen.return_value.returncode = 0
Expand Down