cmueller/ansible
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

Remove with statement for pytest-mock unit tests

Browse source 
As per:
https://github.com/pytest-dev/pytest-mock#note-about-usage-as-context-manager
pytest-mock is not meant to be used within a `with` context or as a
decorator. Instead, pytest-mock will automatically unpatch the mocked
methods when each test is complete.

In newer pytest-mock, this use actually throws an exception and causes
the tests to fail.

This hasn't been hit in Ansible's CI yet, because the docker image
that the tests run in uses an older version of pytest-mock. However,
there is no constraint on the upper bound of pytest-mock in
test/lib/ansible_test/_data/requirements/constraints.txt which means
that when running the tests locally, outside of that docker image, the
tests never pass.

This patch removes the `with` context in each such case.

Signed-off-by: Rick Elrod <rick@elrod.me>
This commit is contained in:
Rick Elrod 2020-01-26 03:16:16 -06:00 committed by Matt Clay
parent 1156962cde
commit e2a57414f4
3 changed files with 20 additions and 20 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
test/units/module_utils/facts/hardware/test_sunos_get_uptime_facts.py
View file

@ -11,7 +11,7 @@ def test_sunos_get_uptime_facts(mocker):
inst = sunos.SunOSHardware(module)
with mocker.patch('time.time', return_value=1567052602.5089788):
expected = int(time.time()) - 1548249689
result = inst.get_uptime_facts()
assert expected == result['uptime_seconds']
mocker.patch('time.time', return_value=1567052602.5089788)
expected = int(time.time()) - 1548249689
result = inst.get_uptime_facts()
assert expected == result['uptime_seconds']

8
test/units/plugins/lookup/test_aws_secret.py
View file

@ -70,8 +70,8 @@ def test_lookup_variable(mocker, dummy_credentials):
boto3_double.Session.return_value.client.return_value.get_secret_value.return_value = simple_variable_success_response
boto3_client_double = boto3_double.Session.return_value.client
with mocker.patch.object(boto3, 'session', boto3_double):
retval = lookup.run(["simple_variable"], None, **dummy_credentials)
mocker.patch.object(boto3, 'session', boto3_double)
retval = lookup.run(["simple_variable"], None, **dummy_credentials)
assert(retval[0] == '{"secret":"simplesecret"}')
boto3_client_double.assert_called_with('secretsmanager', 'eu-west-1', aws_access_key_id='notakey',
aws_secret_access_key="notasecret", aws_session_token=None)
@ -86,5 +86,5 @@ def test_warn_denied_variable(mocker, dummy_credentials):
boto3_double.Session.return_value.client.return_value.get_secret_value.side_effect = ClientError(error_response, operation_name)
with pytest.raises(AnsibleError):
with mocker.patch.object(boto3, 'session', boto3_double):
lookup_loader.get('aws_secret').run(["denied_variable"], None, **dummy_credentials)
mocker.patch.object(boto3, 'session', boto3_double)
lookup_loader.get('aws_secret').run(["denied_variable"], None, **dummy_credentials)

24
test/units/plugins/lookup/test_aws_ssm.py
View file

@ -90,8 +90,8 @@ def test_lookup_variable(mocker):
boto3_double.Session.return_value.client.return_value.get_parameters.return_value = simple_variable_success_response
boto3_client_double = boto3_double.Session.return_value.client
with mocker.patch.object(boto3, 'session', boto3_double):
retval = lookup.run(["simple_variable"], {}, **dummy_credentials)
mocker.patch.object(boto3, 'session', boto3_double)
retval = lookup.run(["simple_variable"], {}, **dummy_credentials)
assert(retval[0] == "simplevalue")
boto3_client_double.assert_called_with('ssm', 'eu-west-1', aws_access_key_id='notakey',
aws_secret_access_key="notasecret", aws_session_token=None)
@ -106,10 +106,10 @@ def test_path_lookup_variable(mocker):
get_path_fn.return_value = path_success_response
boto3_client_double = boto3_double.Session.return_value.client
with mocker.patch.object(boto3, 'session', boto3_double):
args = copy(dummy_credentials)
args["bypath"] = 'true'
retval = lookup.run(["/testpath"], {}, **args)
mocker.patch.object(boto3, 'session', boto3_double)
args = copy(dummy_credentials)
args["bypath"] = 'true'
retval = lookup.run(["/testpath"], {}, **args)
assert(retval[0]["/testpath/won"] == "simple_value_won")
assert(retval[0]["/testpath/too"] == "simple_value_too")
boto3_client_double.assert_called_with('ssm', 'eu-west-1', aws_access_key_id='notakey',
@ -129,8 +129,8 @@ def test_return_none_for_missing_variable(mocker):
boto3_double = mocker.MagicMock()
boto3_double.Session.return_value.client.return_value.get_parameters.return_value = missing_variable_response
with mocker.patch.object(boto3, 'session', boto3_double):
retval = lookup.run(["missing_variable"], {}, **dummy_credentials)
mocker.patch.object(boto3, 'session', boto3_double)
retval = lookup.run(["missing_variable"], {}, **dummy_credentials)
assert(retval[0] is None)
@ -145,8 +145,8 @@ def test_match_retvals_to_call_params_even_with_some_missing_variables(mocker):
boto3_double = mocker.MagicMock()
boto3_double.Session.return_value.client.return_value.get_parameters.return_value = some_missing_variable_response
with mocker.patch.object(boto3, 'session', boto3_double):
retval = lookup.run(["simple", "missing_variable", "/testpath/won", "simple"], {}, **dummy_credentials)
mocker.patch.object(boto3, 'session', boto3_double)
retval = lookup.run(["simple", "missing_variable", "/testpath/won", "simple"], {}, **dummy_credentials)
assert(retval == ["simple_value", None, "simple_value_won", "simple_value"])
@ -162,5 +162,5 @@ def test_warn_denied_variable(mocker):
boto3_double.Session.return_value.client.return_value.get_parameters.side_effect = ClientError(error_response, operation_name)
with pytest.raises(AnsibleError):
with mocker.patch.object(boto3, 'session', boto3_double):
lookup.run(["denied_variable"], {}, **dummy_credentials)
mocker.patch.object(boto3, 'session', boto3_double)
lookup.run(["denied_variable"], {}, **dummy_credentials)