mirror of https://github.com/ansible/ansible.git
Porting tests to pytest (#33387)
* Porting tests to pytest * Achievement Get: No longer need mock/generator.py * Now done via pytest's parametrization * Port safe_eval to pytest * Port text tests to pytest * Port test_set_mode_if_different to pytest * Change conftest AnsibleModule fixtures to be more flexible * Move the AnsibleModules fixtures to module_utils/conftest.py for sharing * Testing the argspec code requires: * injecting both the argspec and the arguments. * Patching the arguments into sys.stdin at a different level * More porting to obsolete mock/procenv.py * Port run_command to pytest * Port known_hosts tests to pytest * Port safe_eval to pytest * Port test_distribution_version.py to pytest * Port test_log to pytest * Port test__log_invocation to pytest * Remove unneeded import of procenv in test_postgresql * Port test_pip to pytest style * As part of this, create a pytest ansiblemodule fixture in modules/conftest.py. This is slightly different than the approach taken in module_utils because here we need to override the AnsibleModule that the modules will inherit from instead of one that we're instantiating ourselves. * Fixup usage of parametrization in test_deprecate_warn * Check that the pip module failed in our testpull/33698/head
parent
ed376abe42
commit
cd36164239
@ -1,72 +0,0 @@
|
||||
# Copyright 2016 Toshio Kuratomi <tkuratomi@ansible.com>
|
||||
#
|
||||
# This file is part of Ansible
|
||||
#
|
||||
# Ansible is free software: you can redistribute it and/or modify
|
||||
# it under the terms of the GNU General Public License as published by
|
||||
# the Free Software Foundation, either version 3 of the License, or
|
||||
# (at your option) any later version.
|
||||
#
|
||||
# Ansible is distributed in the hope that it will be useful,
|
||||
# but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
# GNU General Public License for more details.
|
||||
#
|
||||
# You should have received a copy of the GNU General Public License
|
||||
# along with Ansible. If not, see <http://www.gnu.org/licenses/>.
|
||||
|
||||
# Make coding more python3-ish
|
||||
from __future__ import (absolute_import, division, print_function)
|
||||
__metaclass__ = type
|
||||
|
||||
from collections import Mapping
|
||||
|
||||
|
||||
def make_method(func, args, kwargs):
|
||||
|
||||
def test_method(self):
|
||||
func(self, *args, **kwargs)
|
||||
|
||||
# Format the argument string
|
||||
arg_string = ', '.join(repr(a) for a in args)
|
||||
kwarg_string = ', '.join('{0}={1}'.format(item[0], repr(item[1])) for item in kwargs.items())
|
||||
arg_list = []
|
||||
if arg_string:
|
||||
arg_list.append(arg_string)
|
||||
if kwarg_string:
|
||||
arg_list.append(kwarg_string)
|
||||
|
||||
test_method.__name__ = 'test_{0}({1})'.format(func.__name__, ', '.join(arg_list))
|
||||
return test_method
|
||||
|
||||
|
||||
def add_method(func, *combined_args):
|
||||
"""
|
||||
Add a test case via a class decorator.
|
||||
|
||||
nose uses generators for this but doesn't work with unittest.TestCase
|
||||
subclasses. So we have to write our own.
|
||||
|
||||
The first argument to this decorator is a test function. All subsequent
|
||||
arguments are the arguments to create each generated test function with in
|
||||
the following format:
|
||||
|
||||
Each set of arguments is a two-tuple. The first element is an iterable of
|
||||
positional arguments. the second is a dict representing the kwargs.
|
||||
"""
|
||||
def wrapper(cls):
|
||||
for combined_arg in combined_args:
|
||||
if len(combined_arg) == 2:
|
||||
args = combined_arg[0]
|
||||
kwargs = combined_arg[1]
|
||||
elif isinstance(combined_arg[0], Mapping):
|
||||
args = []
|
||||
kwargs = combined_arg[0]
|
||||
else:
|
||||
args = combined_arg[0]
|
||||
kwargs = {}
|
||||
test_method = make_method(func, args, kwargs)
|
||||
setattr(cls, test_method.__name__, test_method)
|
||||
return cls
|
||||
|
||||
return wrapper
|
@ -1,99 +1,70 @@
|
||||
# -*- coding: utf-8 -*-
|
||||
# (c) 2015-2016, Toshio Kuratomi <tkuratomi@ansible.com>
|
||||
#
|
||||
# This file is part of Ansible
|
||||
#
|
||||
# Ansible is free software: you can redistribute it and/or modify
|
||||
# it under the terms of the GNU General Public License as published by
|
||||
# the Free Software Foundation, either version 3 of the License, or
|
||||
# (at your option) any later version.
|
||||
#
|
||||
# Ansible is distributed in the hope that it will be useful,
|
||||
# but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
# GNU General Public License for more details.
|
||||
#
|
||||
# You should have received a copy of the GNU General Public License
|
||||
# along with Ansible. If not, see <http://www.gnu.org/licenses/>.
|
||||
# (c) 2015-2017, Toshio Kuratomi <tkuratomi@ansible.com>
|
||||
# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
|
||||
|
||||
# Make coding more python3-ish
|
||||
from __future__ import (absolute_import, division)
|
||||
__metaclass__ = type
|
||||
|
||||
import sys
|
||||
import json
|
||||
|
||||
from ansible.compat.tests import unittest
|
||||
from units.mock.procenv import ModuleTestCase
|
||||
from units.mock.generator import add_method
|
||||
from itertools import chain
|
||||
import pytest
|
||||
|
||||
|
||||
# Strings that should be converted into a typed value
|
||||
VALID_STRINGS = (
|
||||
[("'a'", 'a')],
|
||||
[("'1'", '1')],
|
||||
[("1", 1)],
|
||||
[("True", True)],
|
||||
[("False", False)],
|
||||
[("{}", {})],
|
||||
("'a'", 'a'),
|
||||
("'1'", '1'),
|
||||
("1", 1),
|
||||
("True", True),
|
||||
("False", False),
|
||||
("{}", {}),
|
||||
)
|
||||
|
||||
# Passing things that aren't strings should just return the object
|
||||
NONSTRINGS = (
|
||||
[({'a': 1}, {'a': 1})],
|
||||
({'a': 1}, {'a': 1}),
|
||||
)
|
||||
|
||||
# These strings are not basic types. For security, these should not be
|
||||
# executed. We return the same string and get an exception for some
|
||||
INVALID_STRINGS = (
|
||||
[("a=1", "a=1", SyntaxError)],
|
||||
[("a.foo()", "a.foo()", None)],
|
||||
[("import foo", "import foo", None)],
|
||||
[("__import__('foo')", "__import__('foo')", ValueError)],
|
||||
("a=1", "a=1", SyntaxError),
|
||||
("a.foo()", "a.foo()", None),
|
||||
("import foo", "import foo", None),
|
||||
("__import__('foo')", "__import__('foo')", ValueError),
|
||||
)
|
||||
|
||||
|
||||
def _check_simple_types(self, code, expected):
|
||||
@pytest.mark.parametrize('code, expected, stdin',
|
||||
((c, e, {}) for c, e in chain(VALID_STRINGS, NONSTRINGS)),
|
||||
indirect=['stdin'])
|
||||
def test_simple_types(am, code, expected):
|
||||
# test some basic usage for various types
|
||||
self.assertEqual(self.am.safe_eval(code), expected)
|
||||
assert am.safe_eval(code) == expected
|
||||
|
||||
|
||||
def _check_simple_types_with_exceptions(self, code, expected):
|
||||
@pytest.mark.parametrize('code, expected, stdin',
|
||||
((c, e, {}) for c, e in chain(VALID_STRINGS, NONSTRINGS)),
|
||||
indirect=['stdin'])
|
||||
def test_simple_types_with_exceptions(am, code, expected):
|
||||
# Test simple types with exceptions requested
|
||||
self.assertEqual(self.am.safe_eval(code, include_exceptions=True), (expected, None))
|
||||
|
||||
|
||||
def _check_invalid_strings(self, code, expected):
|
||||
self.assertEqual(self.am.safe_eval(code), expected)
|
||||
|
||||
|
||||
def _check_invalid_strings_with_exceptions(self, code, expected, exception):
|
||||
res = self.am.safe_eval("a=1", include_exceptions=True)
|
||||
self.assertEqual(res[0], "a=1")
|
||||
self.assertEqual(type(res[1]), SyntaxError)
|
||||
|
||||
|
||||
@add_method(_check_simple_types, *VALID_STRINGS)
|
||||
@add_method(_check_simple_types, *NONSTRINGS)
|
||||
@add_method(_check_simple_types_with_exceptions, *VALID_STRINGS)
|
||||
@add_method(_check_simple_types_with_exceptions, *NONSTRINGS)
|
||||
@add_method(_check_invalid_strings, *[[i[0][0:-1]] for i in INVALID_STRINGS])
|
||||
@add_method(_check_invalid_strings_with_exceptions, *INVALID_STRINGS)
|
||||
class TestSafeEval(ModuleTestCase):
|
||||
|
||||
def setUp(self):
|
||||
super(TestSafeEval, self).setUp()
|
||||
|
||||
from ansible.module_utils import basic
|
||||
self.old_ansible_args = basic._ANSIBLE_ARGS
|
||||
|
||||
basic._ANSIBLE_ARGS = None
|
||||
self.am = basic.AnsibleModule(
|
||||
argument_spec=dict(),
|
||||
)
|
||||
|
||||
def tearDown(self):
|
||||
super(TestSafeEval, self).tearDown()
|
||||
|
||||
from ansible.module_utils import basic
|
||||
basic._ANSIBLE_ARGS = self.old_ansible_args
|
||||
assert am.safe_eval(code, include_exceptions=True), (expected, None)
|
||||
|
||||
|
||||
@pytest.mark.parametrize('code, expected, stdin',
|
||||
((c, e, {}) for c, e, dummy in INVALID_STRINGS),
|
||||
indirect=['stdin'])
|
||||
def test_invalid_strings(am, code, expected):
|
||||
assert am.safe_eval(code) == expected
|
||||
|
||||
|
||||
@pytest.mark.parametrize('code, expected, exception, stdin',
|
||||
((c, e, ex, {}) for c, e, ex in INVALID_STRINGS),
|
||||
indirect=['stdin'])
|
||||
def test_invalid_strings_with_exceptions(am, code, expected, exception):
|
||||
res = am.safe_eval(code, include_exceptions=True)
|
||||
assert res[0] == expected
|
||||
if exception is None:
|
||||
assert res[1] == exception
|
||||
else:
|
||||
assert type(res[1]) == exception
|
||||
|
@ -0,0 +1,65 @@
|
||||
# Copyright (c) 2017 Ansible Project
|
||||
# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
|
||||
|
||||
import json
|
||||
import sys
|
||||
from collections import MutableMapping
|
||||
from io import BytesIO
|
||||
|
||||
import pytest
|
||||
|
||||
import ansible.module_utils.basic
|
||||
from ansible.module_utils.six import PY3, string_types
|
||||
from ansible.module_utils._text import to_bytes
|
||||
|
||||
|
||||
@pytest.fixture
|
||||
def stdin(mocker, request):
|
||||
old_args = ansible.module_utils.basic._ANSIBLE_ARGS
|
||||
ansible.module_utils.basic._ANSIBLE_ARGS = None
|
||||
old_argv = sys.argv
|
||||
sys.argv = ['ansible_unittest']
|
||||
|
||||
if isinstance(request.param, string_types):
|
||||
args = request.param
|
||||
elif isinstance(request.param, MutableMapping):
|
||||
if 'ANSIBLE_MODULE_ARGS' not in request.param:
|
||||
request.param = {'ANSIBLE_MODULE_ARGS': request.param}
|
||||
args = json.dumps(request.param)
|
||||
else:
|
||||
raise Exception('Malformed data to the stdin pytest fixture')
|
||||
|
||||
fake_stdin = BytesIO(to_bytes(args, errors='surrogate_or_strict'))
|
||||
if PY3:
|
||||
mocker.patch('ansible.module_utils.basic.sys.stdin', mocker.MagicMock())
|
||||
mocker.patch('ansible.module_utils.basic.sys.stdin.buffer', fake_stdin)
|
||||
else:
|
||||
mocker.patch('ansible.module_utils.basic.sys.stdin', fake_stdin)
|
||||
|
||||
yield fake_stdin
|
||||
|
||||
ansible.module_utils.basic._ANSIBLE_ARGS = old_args
|
||||
sys.argv = old_argv
|
||||
|
||||
|
||||
@pytest.fixture
|
||||
def am(stdin, request):
|
||||
old_args = ansible.module_utils.basic._ANSIBLE_ARGS
|
||||
ansible.module_utils.basic._ANSIBLE_ARGS = None
|
||||
old_argv = sys.argv
|
||||
sys.argv = ['ansible_unittest']
|
||||
|
||||
argspec = {}
|
||||
if hasattr(request, 'param'):
|
||||
if isinstance(request.param, dict):
|
||||
argspec = request.param
|
||||
|
||||
am = ansible.module_utils.basic.AnsibleModule(
|
||||
argument_spec=argspec,
|
||||
)
|
||||
am._name = 'ansible_unittest'
|
||||
|
||||
yield am
|
||||
|
||||
ansible.module_utils.basic._ANSIBLE_ARGS = old_args
|
||||
sys.argv = old_argv
|
@ -0,0 +1,24 @@
|
||||
# Copyright (c) 2017 Ansible Project
|
||||
# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
|
||||
|
||||
import json
|
||||
from collections import MutableMapping
|
||||
|
||||
import pytest
|
||||
|
||||
from ansible.module_utils.six import string_types
|
||||
from ansible.module_utils._text import to_bytes
|
||||
|
||||
|
||||
@pytest.fixture
|
||||
def patch_ansible_module(request, mocker):
|
||||
if isinstance(request.param, string_types):
|
||||
args = request.param
|
||||
elif isinstance(request.param, MutableMapping):
|
||||
if 'ANSIBLE_MODULE_ARGS' not in request.param:
|
||||
request.param = {'ANSIBLE_MODULE_ARGS': request.param}
|
||||
args = json.dumps(request.param)
|
||||
else:
|
||||
raise Exception('Malformed data to the patch_ansible_module pytest fixture')
|
||||
|
||||
mocker.patch('ansible.module_utils.basic._ANSIBLE_ARGS', to_bytes(args))
|
@ -1,23 +1,24 @@
|
||||
# Copyright (c) 2017 Ansible Project
|
||||
# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
|
||||
import json
|
||||
|
||||
from ansible.compat.tests import unittest
|
||||
from ansible.compat.tests.mock import patch
|
||||
from ansible.module_utils import basic
|
||||
import pytest
|
||||
|
||||
from ansible.modules.packaging.language import pip
|
||||
|
||||
from units.modules.utils import set_module_args, AnsibleFailJson, ModuleTestCase
|
||||
|
||||
pytestmark = pytest.mark.usefixtures('patch_ansible_module')
|
||||
|
||||
class TestPip(ModuleTestCase):
|
||||
def setUp(self):
|
||||
super(TestPip, self).setUp()
|
||||
|
||||
@patch.object(basic.AnsibleModule, 'get_bin_path')
|
||||
def test_failure_when_pip_absent(self, mock_get_bin_path):
|
||||
@pytest.mark.parametrize('patch_ansible_module', [{'name': 'six'}], indirect=['patch_ansible_module'])
|
||||
def test_failure_when_pip_absent(mocker, capfd):
|
||||
get_bin_path = mocker.patch('ansible.module_utils.basic.AnsibleModule.get_bin_path')
|
||||
get_bin_path.return_value = None
|
||||
|
||||
mock_get_bin_path.return_value = None
|
||||
|
||||
with self.assertRaises(AnsibleFailJson):
|
||||
set_module_args({'name': 'six'})
|
||||
with pytest.raises(SystemExit):
|
||||
pip.main()
|
||||
|
||||
out, err = capfd.readouterr()
|
||||
results = json.loads(out)
|
||||
assert results['failed']
|
||||
assert 'pip needs to be installed' in results['msg']
|
||||
|
Loading…
Reference in New Issue