Unit tests: share common code (#31456)

* move set_module_args to units.modules.utils
* unit tests: reuse set_module_args
* unit tests: mock exit/fail_json in module.utils.ModuleTestCase
* unit tests: use module.utils.ModuleTestCase
* unit tests: fix 'import shadowed by loop variable'

test/units/modules/packaging/language/test_pip.py

@@ -6,15 +6,12 @@ from ansible.module_utils import basic
 
 from ansible.modules.packaging.language import pip
 
-from ..utils import (set_module_args, AnsibleFailJson, exit_json, fail_json)
+from units.modules.utils import set_module_args, AnsibleFailJson, ModuleTestCase
 
 
-class TestPip(unittest.TestCase):
-
+class TestPip(ModuleTestCase):
     def setUp(self):
-        self.mock_ansible_module = patch.multiple(basic.AnsibleModule, exit_json=exit_json, fail_json=fail_json)
-        self.mock_ansible_module.start()
-        self.addCleanup(self.mock_ansible_module.stop)
+        super(TestPip, self).setUp()
 
     @patch.object(basic.AnsibleModule, 'get_bin_path')
     def test_failure_when_pip_absent(self, mock_get_bin_path):

test/units/modules/packaging/os/test_rhn_channel.py

@@ -1,29 +1,19 @@
 import json
 
-from ansible.compat.tests import unittest
-from ansible.compat.tests.mock import patch
-from ansible.module_utils import basic
-from ansible.module_utils.six.moves import xmlrpc_client
-from ansible.module_utils._text import to_bytes
 from ansible.modules.packaging.os import rhn_channel
 
-from ..utils import (set_module_args, AnsibleExitJson, AnsibleFailJson,
-                     exit_json, fail_json, get_method_name, mock_request)
+from units.modules.packaging.utils import mock_request
+from units.modules.utils import set_module_args, AnsibleExitJson, AnsibleFailJson, ModuleTestCase
 
 
-class TestRhnChannel(unittest.TestCase):
+class TestRhnChannel(ModuleTestCase):
 
     def setUp(self):
+        super(TestRhnChannel, self).setUp()
+
         self.module = rhn_channel
         self.module.HAS_UP2DATE_CLIENT = True
 
-        self.mock_exit_fail = patch.multiple(basic.AnsibleModule, exit_json=exit_json, fail_json=fail_json)
-        self.mock_exit_fail.start()
-        self.addCleanup(self.mock_exit_fail.stop)
-
-    def tearDown(self):
-        pass
-
     def test_without_required_parameters(self):
         """Failure must occurs when all parameters are missing"""
         with self.assertRaises(AnsibleFailJson):

test/units/modules/packaging/os/test_rhn_register.py

@@ -7,8 +7,8 @@ from ansible.module_utils._text import to_native
 from ansible.module_utils.six.moves import xmlrpc_client
 from ansible.modules.packaging.os import rhn_register
 
-from ..utils import (set_module_args, AnsibleExitJson, AnsibleFailJson,
-                     exit_json, fail_json, get_method_name, mock_request)
+from units.modules.packaging.utils import mock_request
+from units.modules.utils import set_module_args, AnsibleExitJson, AnsibleFailJson, ModuleTestCase
 
 
 SYSTEMID = """<?xml version="1.0"?>
@@ -37,9 +37,11 @@ def skipWhenAllModulesMissing(modules):
     return unittest.skip("{0}: none are available".format(', '.join(modules)))
 
 
-class TestRhnRegister(unittest.TestCase):
+class TestRhnRegister(ModuleTestCase):
 
     def setUp(self):
+        super(TestRhnRegister, self).setUp()
+
         self.module = rhn_register
         self.module.HAS_UP2DATE_CLIENT = True
 
@@ -51,17 +53,10 @@ class TestRhnRegister(unittest.TestCase):
         self.mock_load_config.start()
         self.addCleanup(self.mock_load_config.stop)
 
-        self.mock_exit_fail = patch.multiple(basic.AnsibleModule, exit_json=exit_json, fail_json=fail_json)
-        self.mock_exit_fail.start()
-        self.addCleanup(self.mock_exit_fail.stop)
-
         enable_patcher = patch.object(rhn_register.Rhn, 'enable')
         self.mock_enable = enable_patcher.start()
         self.addCleanup(enable_patcher.stop)
 
-    def tearDown(self):
-        pass
-
 #    This one fails, module needs to be fixed.
 #    @patch('os.path.isfile')
 #    def test_systemid_requirements_missing(self, mock_isfile):

test/units/modules/packaging/utils.py

@@ -6,30 +6,6 @@ from ansible.module_utils.six.moves import xmlrpc_client
 from ansible.module_utils._text import to_bytes
 
 
-def set_module_args(args):
-    args = json.dumps({'ANSIBLE_MODULE_ARGS': args})
-    basic._ANSIBLE_ARGS = to_bytes(args)
-
-
-class AnsibleExitJson(Exception):
-    pass
-
-
-class AnsibleFailJson(Exception):
-    pass
-
-
-def exit_json(*args, **kwargs):
-    if 'changed' not in kwargs:
-        kwargs['changed'] = False
-    raise AnsibleExitJson(kwargs)
-
-
-def fail_json(*args, **kwargs):
-    kwargs['failed'] = True
-    raise AnsibleFailJson(kwargs)
-
-
 def get_method_name(request_body):
     return xmlrpc_client.loads(request_body)[1]