Port AnsibleModule deprecate and warning tests to pytest (#33162)

test/units/module_utils/basic/test_deprecate_warn.py

@@ -17,73 +17,96 @@
 
 import json
 import sys
+from collections import MutableMapping
+from io import BytesIO
 
-from ansible.compat.tests import unittest
+import pytest
-from units.mock.procenv import swap_stdin_and_argv, swap_stdout
 
 import ansible.module_utils.basic
+from ansible.module_utils.six import PY3, string_types
+from ansible.module_utils._text import to_bytes
 
 
-class TestAnsibleModuleWarnDeprecate(unittest.TestCase):
+@pytest.fixture
-    """Test the AnsibleModule Warn Method"""
+def stdin(mocker, request):
-
+    if isinstance(request.param, string_types):
-    def test_warn(self):
+        args = request.param
-        args = json.dumps(dict(ANSIBLE_MODULE_ARGS={}))
+    elif isinstance(request.param, MutableMapping):
-        with swap_stdin_and_argv(stdin_data=args):
+        if 'ANSIBLE_MODULE_ARGS' not in request.param:
-            with swap_stdout():
+            request.param = {'ANSIBLE_MODULE_ARGS': request.param}
-
+        args = json.dumps(request.param)
-                ansible.module_utils.basic._ANSIBLE_ARGS = None
+    else:
-                am = ansible.module_utils.basic.AnsibleModule(
+        raise Exception('Malformed data to the stdin pytest fixture')
-                    argument_spec=dict(),
+
-                )
+    real_stdin = sys.stdin
-                am._name = 'unittest'
+    fake_stdin = BytesIO(to_bytes(args, errors='surrogate_or_strict'))
-
+    if PY3:
-                am.warn('warning1')
+        sys.stdin = mocker.MagicMock()
-
+        sys.stdin.buffer = fake_stdin
-                with self.assertRaises(SystemExit):
+    else:
-                    am.exit_json(warnings=['warning2'])
+        sys.stdin = fake_stdin
-                self.assertEquals(json.loads(sys.stdout.getvalue())['warnings'], ['warning1', 'warning2'])
+
-
+    yield fake_stdin
-    def test_deprecate(self):
+
-        args = json.dumps(dict(ANSIBLE_MODULE_ARGS={}))
+    sys.stdin = real_stdin
-        with swap_stdin_and_argv(stdin_data=args):
+
-            with swap_stdout():
+
-
+@pytest.fixture
-                ansible.module_utils.basic._ANSIBLE_ARGS = None
+def am(stdin, request):
-                am = ansible.module_utils.basic.AnsibleModule(
+    old_args = ansible.module_utils.basic._ANSIBLE_ARGS
-                    argument_spec=dict(),
+    ansible.module_utils.basic._ANSIBLE_ARGS = None
-                )
+    old_argv = sys.argv
-                am._name = 'unittest'
+    sys.argv = ['ansible_unittest']
-
+
-                am.deprecate('deprecation1')
+    am = ansible.module_utils.basic.AnsibleModule(
-                am.deprecate('deprecation2', '2.3')
+        argument_spec=dict(),
-
+    )
-                with self.assertRaises(SystemExit):
+    am._name = 'ansible_unittest'
-                    am.exit_json(deprecations=['deprecation3', ('deprecation4', '2.4')])
+
-                output = json.loads(sys.stdout.getvalue())
+    yield am
-                self.assertTrue('warnings' not in output or output['warnings'] == [])
+
-                self.assertEquals(output['deprecations'], [
+    ansible.module_utils.basic._ANSIBLE_ARGS = old_args
-                    {u'msg': u'deprecation1', u'version': None},
+    sys.argv = old_argv
-                    {u'msg': u'deprecation2', u'version': '2.3'},
+
-                    {u'msg': u'deprecation3', u'version': None},
+
-                    {u'msg': u'deprecation4', u'version': '2.4'},
+@pytest.mark.parametrize('stdin', [{}], indirect=True)
-                ])
+def test_warn(am, capfd):
-
+
-    def test_deprecate_without_list(self):
+    am.warn('warning1')
-        args = json.dumps(dict(ANSIBLE_MODULE_ARGS={}))
+
-        with swap_stdin_and_argv(stdin_data=args):
+    with pytest.raises(SystemExit):
-            with swap_stdout():
+        am.exit_json(warnings=['warning2'])
-
+    out, err = capfd.readouterr()
-                ansible.module_utils.basic._ANSIBLE_ARGS = None
+    assert json.loads(out)['warnings'] == ['warning1', 'warning2']
-                am = ansible.module_utils.basic.AnsibleModule(
+
-                    argument_spec=dict(),
+
-                )
+@pytest.mark.parametrize('stdin', [{}], indirect=True)
-                am._name = 'unittest'
+def test_deprecate(am, capfd):
-
+    am.deprecate('deprecation1')
-                with self.assertRaises(SystemExit):
+    am.deprecate('deprecation2', '2.3')
-                    am.exit_json(deprecations='Simple deprecation warning')
+
-                output = json.loads(sys.stdout.getvalue())
+    with pytest.raises(SystemExit):
-                self.assertTrue('warnings' not in output or output['warnings'] == [])
+        am.exit_json(deprecations=['deprecation3', ('deprecation4', '2.4')])
-                self.assertEquals(output['deprecations'], [
+
-                    {u'msg': u'Simple deprecation warning', u'version': None},
+    out, err = capfd.readouterr()
-                ])
+    output = json.loads(out)
+    assert ('warnings' not in output or output['warnings'] == [])
+    assert output['deprecations'] == [
+        {u'msg': u'deprecation1', u'version': None},
+        {u'msg': u'deprecation2', u'version': '2.3'},
+        {u'msg': u'deprecation3', u'version': None},
+        {u'msg': u'deprecation4', u'version': '2.4'},
+    ]
+
+
+@pytest.mark.parametrize('stdin', [{}], indirect=True)
+def test_deprecate_without_list(am, capfd):
+    with pytest.raises(SystemExit):
+        am.exit_json(deprecations='Simple deprecation warning')
+
+    out, err = capfd.readouterr()
+    output = json.loads(out)
+    assert ('warnings' not in output or output['warnings'] == [])
+    assert output['deprecations'] == [
+        {u'msg': u'Simple deprecation warning', u'version': None},
+    ]