[PR #11235/fb2f34ba backport][stable-12] Stop re-defining the argument spec in unit tests (#11239)

Stop re-defining the argument spec in unit tests (#11235)

* Stop re-defining the argument spec in unit tests.

* Shut up linter.

(cherry picked from commit fb2f34b)

Co-authored-by: Felix Fontein <[email protected]>

Author: patchback[bot]

plugins/modules/archive.py

@@ -589,7 +589,7 @@ def get_archive(module):
         return TarArchive(module)
 
 
-def main():
+def create_module() -> AnsibleModule:
     module = AnsibleModule(
         argument_spec=dict(
             path=dict(type="list", elements="path", required=True),
@@ -603,6 +603,11 @@ def main():
         add_file_common_args=True,
         supports_check_mode=True,
     )
+    return module
+
+
+def main():
+    module = create_module()
 
     check_mode = module.check_mode
 

plugins/modules/java_keystore.py

@@ -510,7 +510,7 @@ def create_file(content):
     return tmpfile
 
 
-def main():
+def create_module() -> AnsibleModule:
     choose_between = (["certificate", "certificate_path"], ["private_key", "private_key_path"])
 
     module = AnsibleModule(
@@ -533,6 +533,11 @@ def main():
         add_file_common_args=True,
     )
     module.run_command_environ_update = dict(LANG="C", LC_ALL="C", LC_MESSAGES="C")
+    return module
+
+
+def main():
+    module = create_module()
 
     result = dict()
     jks = JavaKeystore(module)

plugins/modules/nmcli.py

@@ -2675,8 +2675,7 @@ def is_connection_changed(self):
         return self._compare_conn_params(self.show_connection(), options)
 
 
-def main():
-    # Parsing argument file
+def create_module() -> AnsibleModule:
     module = AnsibleModule(
         argument_spec=dict(
             ignore_unsupported_suboptions=dict(type="bool", default=False),
@@ -2870,6 +2869,12 @@ def main():
         supports_check_mode=True,
     )
     module.run_command_environ_update = dict(LANG="C", LC_ALL="C", LC_MESSAGES="C", LC_CTYPE="C")
+    return module
+
+
+def main():
+    # Parsing argument file
+    module = create_module()
 
     nmcli = Nmcli(module)
 

tests/unit/plugins/modules/test_archive.py

@@ -7,12 +7,11 @@
 import pytest
 from unittest.mock import Mock, patch
 
-from ansible.module_utils.basic import AnsibleModule
 from ansible_collections.community.internal_test_tools.tests.unit.plugins.modules.utils import (
     ModuleTestCase,
     set_module_args,
 )
-from ansible_collections.community.general.plugins.modules.archive import get_archive, common_path
+from ansible_collections.community.general.plugins.modules.archive import get_archive, common_path, create_module
 
 
 class TestArchive(ModuleTestCase):
@@ -27,19 +26,7 @@ def tearDown(self):
 
     def test_archive_removal_safety(self):
         with set_module_args(dict(path=["/foo", "/bar", "/baz"], dest="/foo/destination.tgz", remove=True)):
-            module = AnsibleModule(
-                argument_spec=dict(
-                    path=dict(type="list", elements="path", required=True),
-                    format=dict(type="str", default="gz", choices=["bz2", "gz", "tar", "xz", "zip"]),
-                    dest=dict(type="path"),
-                    exclude_path=dict(type="list", elements="path", default=[]),
-                    exclusion_patterns=dict(type="list", elements="path"),
-                    force_archive=dict(type="bool", default=False),
-                    remove=dict(type="bool", default=False),
-                ),
-                add_file_common_args=True,
-                supports_check_mode=True,
-            )
+            module = create_module()
 
         self.os_path_isdir.side_effect = [True, False, False, True]
 

tests/unit/plugins/modules/test_java_keystore.py

@@ -13,25 +13,8 @@
     ModuleTestCase,
     set_module_args,
 )
-from ansible.module_utils.basic import AnsibleModule
-from ansible_collections.community.general.plugins.modules.java_keystore import JavaKeystore
-
-
-module_argument_spec = dict(
-    name=dict(type="str", required=True),
-    dest=dict(type="path", required=True),
-    certificate=dict(type="str", no_log=True),
-    certificate_path=dict(type="path"),
-    private_key=dict(type="str", no_log=True),
-    private_key_path=dict(type="path", no_log=False),
-    private_key_passphrase=dict(type="str", no_log=True),
-    password=dict(type="str", required=True, no_log=True),
-    ssl_backend=dict(type="str", default="openssl", choices=["openssl", "cryptography"]),
-    keystore_type=dict(type="str", choices=["jks", "pkcs12"]),
-    force=dict(type="bool", default=False),
-)
-module_supports_check_mode = True
-module_choose_between = (["certificate", "certificate_path"], ["private_key", "private_key_path"])
+from ansible.module_utils.basic import AnsibleModule  # noqa: F401 # pylint: disable=unused-import
+from ansible_collections.community.general.plugins.modules.java_keystore import JavaKeystore, create_module
 
 
 class TestCreateJavaKeystore(ModuleTestCase):
@@ -96,12 +79,7 @@ def test_create_jks_success(self):
                 password="changeit",
             )
         ):
-            module = AnsibleModule(
-                argument_spec=module_argument_spec,
-                supports_check_mode=module_supports_check_mode,
-                mutually_exclusive=module_choose_between,
-                required_one_of=module_choose_between,
-            )
+            module = create_module()
 
         with patch("os.remove", return_value=True):
             self.create_path.side_effect = ["/tmp/tmpgrzm2ah7"]
@@ -139,12 +117,7 @@ def test_create_jks_keypass_fail_export_pkcs12(self):
                 password="changeit",
             )
         ):
-            module = AnsibleModule(
-                argument_spec=module_argument_spec,
-                supports_check_mode=module_supports_check_mode,
-                mutually_exclusive=module_choose_between,
-                required_one_of=module_choose_between,
-            )
+            module = create_module()
 
         module.exit_json = Mock()
         module.fail_json = Mock()
@@ -189,12 +162,7 @@ def test_create_jks_fail_export_pkcs12(self):
                 password="changeit",
             )
         ):
-            module = AnsibleModule(
-                argument_spec=module_argument_spec,
-                supports_check_mode=module_supports_check_mode,
-                mutually_exclusive=module_choose_between,
-                required_one_of=module_choose_between,
-            )
+            module = create_module()
 
         module.exit_json = Mock()
         module.fail_json = Mock()
@@ -237,12 +205,7 @@ def test_create_jks_fail_import_key(self):
                 password="changeit",
             )
         ):
-            module = AnsibleModule(
-                argument_spec=module_argument_spec,
-                supports_check_mode=module_supports_check_mode,
-                mutually_exclusive=module_choose_between,
-                required_one_of=module_choose_between,
-            )
+            module = create_module()
 
         module.exit_json = Mock()
         module.fail_json = Mock()
@@ -315,12 +278,7 @@ def test_cert_unchanged_same_fingerprint(self):
                 password="changeit",
             )
         ):
-            module = AnsibleModule(
-                argument_spec=module_argument_spec,
-                supports_check_mode=module_supports_check_mode,
-                mutually_exclusive=module_choose_between,
-                required_one_of=module_choose_between,
-            )
+            module = create_module()
 
         with patch("os.remove", return_value=True):
             self.create_file.side_effect = ["/tmp/placeholder", ""]
@@ -341,12 +299,7 @@ def test_cert_changed_fingerprint_mismatch(self):
                 password="changeit",
             )
         ):
-            module = AnsibleModule(
-                argument_spec=module_argument_spec,
-                supports_check_mode=module_supports_check_mode,
-                mutually_exclusive=module_choose_between,
-                required_one_of=module_choose_between,
-            )
+            module = create_module()
 
         with patch("os.remove", return_value=True):
             self.create_file.side_effect = ["/tmp/placeholder", ""]
@@ -367,12 +320,7 @@ def test_cert_changed_alias_does_not_exist(self):
                 password="changeit",
             )
         ):
-            module = AnsibleModule(
-                argument_spec=module_argument_spec,
-                supports_check_mode=module_supports_check_mode,
-                mutually_exclusive=module_choose_between,
-                required_one_of=module_choose_between,
-            )
+            module = create_module()
 
         with patch("os.remove", return_value=True):
             self.create_file.side_effect = ["/tmp/placeholder", ""]
@@ -395,12 +343,7 @@ def test_cert_changed_password_mismatch(self):
                 password="changeit",
             )
         ):
-            module = AnsibleModule(
-                argument_spec=module_argument_spec,
-                supports_check_mode=module_supports_check_mode,
-                mutually_exclusive=module_choose_between,
-                required_one_of=module_choose_between,
-            )
+            module = create_module()
 
         with patch("os.remove", return_value=True):
             self.create_file.side_effect = ["/tmp/placeholder", ""]
@@ -423,12 +366,7 @@ def test_cert_changed_fail_read_cert(self):
                 password="changeit",
             )
         ):
-            module = AnsibleModule(
-                argument_spec=module_argument_spec,
-                supports_check_mode=module_supports_check_mode,
-                mutually_exclusive=module_choose_between,
-                required_one_of=module_choose_between,
-            )
+            module = create_module()
 
         module.exit_json = Mock()
         module.fail_json = Mock()
@@ -457,12 +395,7 @@ def test_cert_changed_fail_read_keystore(self):
                 password="changeit",
             )
         ):
-            module = AnsibleModule(
-                argument_spec=module_argument_spec,
-                supports_check_mode=module_supports_check_mode,
-                mutually_exclusive=module_choose_between,
-                required_one_of=module_choose_between,
-            )
+            module = create_module()
 
         module.exit_json = Mock()
         module.fail_json = Mock(return_value=True)