Merge pull request #766 from Checkmk/feature-move-args-to-utils

Move module args to utils

Author: robin-checkmk

changelogs/fragments/utils.yml

@@ -0,0 +1,2 @@
+minor_changes:
+  - All modules - Move basic module parameters to utils. No functional changes.

plugins/module_utils/site.py

@@ -124,13 +124,7 @@ def get_api_data(self, target_api):
             return self.authentication
 
 
-# Define available arguments/parameters a user can pass to the module
-module_args = dict(
-    server_url=dict(type="str", required=True),
-    site=dict(type="str", required=True),
-    validate_certs=dict(type="bool", required=False, default=True),
-    automation_user=dict(type="str", required=True),
-    automation_secret=dict(type="str", required=True, no_log=True),
+site_argument_spec = dict(
     state=dict(
         type="str",
         default="present",

plugins/module_utils/utils.py

@@ -13,6 +13,16 @@
 from ansible_collections.checkmk.general.plugins.module_utils.types import RESULT
 
 
+def base_argument_spec():
+    return dict(
+        server_url=dict(type="str", required=True),
+        site=dict(type="str", required=True),
+        validate_certs=dict(type="bool", required=False, default=True),
+        automation_user=dict(type="str", required=True),
+        automation_secret=dict(type="str", required=True, no_log=True),
+    )
+
+
 def result_as_dict(result):
     return {
         "changed": result.changed,

plugins/modules/activation.py

@@ -100,6 +100,7 @@
 from ansible.module_utils.basic import AnsibleModule
 from ansible_collections.checkmk.general.plugins.module_utils.api import CheckmkAPI
 from ansible_collections.checkmk.general.plugins.module_utils.utils import (
+    base_argument_spec,
     result_as_dict,
 )
 
@@ -136,18 +137,14 @@ def post(self):
 
 
 def run_module():
-    # define available arguments/parameters a user can pass to the module
-    module_args = dict(
-        server_url=dict(type="str", required=True),
-        site=dict(type="str", required=True),
-        validate_certs=dict(type="bool", required=False, default=True),
-        automation_user=dict(type="str", required=True),
-        automation_secret=dict(type="str", required=True, no_log=True),
+    argument_spec = base_argument_spec()
+    argument_spec.update(
         sites=dict(type="raw", default=[]),
         force_foreign_changes=dict(type="bool", default=False),
         redirect=dict(type="bool", default=False),
     )
-    module = AnsibleModule(argument_spec=module_args, supports_check_mode=False)
+
+    module = AnsibleModule(argument_spec=argument_spec, supports_check_mode=False)
 
     activation = ActivationAPI(module)
     activation.headers["If-Match"] = "*"

plugins/modules/bakery.py

@@ -92,6 +92,7 @@
 from ansible.module_utils.basic import AnsibleModule
 from ansible_collections.checkmk.general.plugins.module_utils.api import CheckmkAPI
 from ansible_collections.checkmk.general.plugins.module_utils.utils import (
+    base_argument_spec,
     result_as_dict,
 )
 
@@ -121,12 +122,8 @@ def post(self):
 
 
 def run_module():
-    module_args = dict(
-        server_url=dict(type="str", required=True),
-        site=dict(type="str", required=True),
-        validate_certs=dict(type="bool", required=False, default=True),
-        automation_user=dict(type="str", required=True),
-        automation_secret=dict(type="str", required=True, no_log=True),
+    argument_spec = base_argument_spec()
+    argument_spec.update(
         signature_key_id=dict(type="int", required=False),
         signature_key_passphrase=dict(type="str", required=False, no_log=True),
         state=dict(
@@ -135,7 +132,8 @@ def run_module():
             required=True,
         ),
     )
-    module = AnsibleModule(argument_spec=module_args, supports_check_mode=False)
+
+    module = AnsibleModule(argument_spec=argument_spec, supports_check_mode=False)
 
     bakery = BakeryAPI(module)
     result = bakery.post()

plugins/modules/contact_group.py

@@ -136,6 +136,9 @@
 from ansible.module_utils.basic import AnsibleModule
 from ansible.module_utils.urls import fetch_url
 from ansible_collections.checkmk.general.plugins.module_utils.logger import Logger
+from ansible_collections.checkmk.general.plugins.module_utils.utils import (
+    base_argument_spec,
+)
 
 logger = Logger()
 
@@ -396,12 +399,8 @@ def delete_contact_groups(module, base_url, groups, headers):
 
 
 def run_module():
-    module_args = dict(
-        server_url=dict(type="str", required=True),
-        site=dict(type="str", required=True),
-        validate_certs=dict(type="bool", required=False, default=True),
-        automation_user=dict(type="str", required=True),
-        automation_secret=dict(type="str", required=True, no_log=True),
+    argument_spec = base_argument_spec()
+    argument_spec.update(
         name=dict(type="str", required=False),
         title=dict(type="str", required=False),
         customer=dict(type="str", required=False),
@@ -410,7 +409,7 @@ def run_module():
     )
 
     module = AnsibleModule(
-        argument_spec=module_args,
+        argument_spec=argument_spec,
         mutually_exclusive=[
             ("groups", "name"),
         ],

plugins/modules/discovery.py

@@ -166,7 +166,10 @@
 from ansible_collections.checkmk.general.plugins.module_utils.types import (
     generate_result,
 )
-from ansible_collections.checkmk.general.plugins.module_utils.utils import exit_module
+from ansible_collections.checkmk.general.plugins.module_utils.utils import (
+    base_argument_spec,
+    exit_module,
+)
 
 logger = Logger()
 
@@ -181,12 +184,8 @@
 
 
 def run_module():
-    module_args = dict(
-        server_url=dict(type="str", required=True),
-        site=dict(type="str", required=True),
-        validate_certs=dict(type="bool", required=False, default=True),
-        automation_user=dict(type="str", required=True),
-        automation_secret=dict(type="str", required=True, no_log=True),
+    argument_spec = base_argument_spec()
+    argument_spec.update(
         host_name=dict(type="str", required=False),
         hosts=dict(type="list", elements="str", required=False, default=[]),
         state=dict(
@@ -210,8 +209,9 @@ def run_module():
         wait_for_previous=dict(type="bool", default=True),
         wait_timeout=dict(type="int", default=-1),
     )
+
     module = AnsibleModule(
-        argument_spec=module_args,
+        argument_spec=argument_spec,
         mutually_exclusive=[
             ("host_name", "hosts"),
         ],

plugins/modules/downtime.py

@@ -146,6 +146,9 @@
 
 from ansible.module_utils.basic import AnsibleModule
 from ansible.module_utils.urls import fetch_url
+from ansible_collections.checkmk.general.plugins.module_utils.utils import (
+    base_argument_spec,
+)
 
 try:
     from urllib import urlencode
@@ -403,13 +406,8 @@ def remove_downtime(module, base_url, headers):
 
 
 def run_module():
-    # define available arguments/parameters a user can pass to the module
-    module_args = dict(
-        server_url=dict(type="str", required=True),
-        site=dict(type="str", required=True),
-        validate_certs=dict(type="bool", required=False, default=True),
-        automation_user=dict(type="str", required=True),
-        automation_secret=dict(type="str", required=True, no_log=True),
+    argument_spec = base_argument_spec()
+    argument_spec.update(
         host_name=dict(type="str", required=True),
         comment=dict(type="str", default="Created by Ansible"),
         duration=dict(type="int", default=0),
@@ -422,7 +420,7 @@ def run_module():
         state=dict(type="str", default="present", choices=["present", "absent"]),
     )
 
-    module = AnsibleModule(argument_spec=module_args, supports_check_mode=False)
+    module = AnsibleModule(argument_spec=argument_spec, supports_check_mode=False)
 
     # Use the parameters to initialize some common variables
     headers = {

plugins/modules/folder.py

@@ -159,6 +159,7 @@
 from ansible_collections.checkmk.general.plugins.module_utils.api import CheckmkAPI
 from ansible_collections.checkmk.general.plugins.module_utils.types import RESULT
 from ansible_collections.checkmk.general.plugins.module_utils.utils import (
+    base_argument_spec,
     result_as_dict,
 )
 from ansible_collections.checkmk.general.plugins.module_utils.version import (
@@ -474,13 +475,8 @@ def _exit_if_missing_pathlib(module):
 
 
 def run_module():
-    # define available arguments/parameters a user can pass to the module
-    module_args = dict(
-        server_url=dict(type="str", required=True),
-        site=dict(type="str", required=True),
-        validate_certs=dict(type="bool", required=False, default=True),
-        automation_user=dict(type="str", required=True),
-        automation_secret=dict(type="str", required=True, no_log=True),
+    argument_spec = base_argument_spec()
+    argument_spec.update(
         path=dict(type="str", required=True),
         name=dict(
             type="str",
@@ -496,7 +492,7 @@ def run_module():
         extended_functionality=dict(type="bool", required=False, default=True),
     )
 
-    module = AnsibleModule(argument_spec=module_args, supports_check_mode=True)
+    module = AnsibleModule(argument_spec=argument_spec, supports_check_mode=False)
 
     _exit_if_missing_pathlib(module)
 

plugins/modules/host.py

@@ -242,6 +242,7 @@
 from ansible_collections.checkmk.general.plugins.module_utils.api import CheckmkAPI
 from ansible_collections.checkmk.general.plugins.module_utils.types import RESULT
 from ansible_collections.checkmk.general.plugins.module_utils.utils import (
+    base_argument_spec,
     result_as_dict,
 )
 from ansible_collections.checkmk.general.plugins.module_utils.version import (
@@ -819,13 +820,8 @@ def delete(self):
 
 
 def run_module():
-    # define available arguments/parameters a user can pass to the module
-    module_args = dict(
-        server_url=dict(type="str", required=True),
-        site=dict(type="str", required=True),
-        validate_certs=dict(type="bool", required=False, default=True),
-        automation_user=dict(type="str", required=True),
-        automation_secret=dict(type="str", required=True, no_log=True),
+    argument_spec = base_argument_spec()
+    argument_spec.update(
         name=dict(
             type="str",
             required=True,
@@ -843,7 +839,7 @@ def run_module():
     )
 
     module = AnsibleModule(
-        argument_spec=module_args,
+        argument_spec=argument_spec,
         mutually_exclusive=[
             ("nodes", "add_nodes"),
             ("nodes", "remove_nodes"),

plugins/modules/host_group.py

@@ -132,6 +132,9 @@
 from ansible.module_utils.basic import AnsibleModule
 from ansible.module_utils.urls import fetch_url
 from ansible_collections.checkmk.general.plugins.module_utils.logger import Logger
+from ansible_collections.checkmk.general.plugins.module_utils.utils import (
+    base_argument_spec,
+)
 
 logger = Logger()
 
@@ -392,12 +395,8 @@ def delete_host_groups(module, base_url, groups, headers):
 
 
 def run_module():
-    module_args = dict(
-        server_url=dict(type="str", required=True),
-        site=dict(type="str", required=True),
-        validate_certs=dict(type="bool", required=False, default=True),
-        automation_user=dict(type="str", required=True),
-        automation_secret=dict(type="str", required=True, no_log=True),
+    argument_spec = base_argument_spec()
+    argument_spec.update(
         name=dict(
             type="str",
             required=False,
@@ -413,7 +412,7 @@ def run_module():
     )
 
     module = AnsibleModule(
-        argument_spec=module_args,
+        argument_spec=argument_spec,
         mutually_exclusive=[
             ("groups", "name"),
         ],

plugins/modules/password.py

@@ -123,6 +123,7 @@
 from ansible_collections.checkmk.general.plugins.module_utils.api import CheckmkAPI
 from ansible_collections.checkmk.general.plugins.module_utils.types import RESULT
 from ansible_collections.checkmk.general.plugins.module_utils.utils import (
+    base_argument_spec,
     result_as_dict,
 )
 from ansible_collections.checkmk.general.plugins.module_utils.version import (
@@ -211,12 +212,8 @@ def get(self):
 
 
 def run_module():
-    module_args = dict(
-        server_url=dict(type="str", required=True),
-        site=dict(type="str", required=True),
-        validate_certs=dict(type="bool", required=False, default=True),
-        automation_user=dict(type="str", required=True),
-        automation_secret=dict(type="str", required=True, no_log=True),
+    argument_spec = base_argument_spec()
+    argument_spec.update(
         name=dict(type="str", required=True),
         title=dict(type="str", required=False),
         customer=dict(type="str", required=False),
@@ -231,7 +228,8 @@ def run_module():
             required=True,
         ),
     )
-    module = AnsibleModule(argument_spec=module_args, supports_check_mode=False)
+
+    module = AnsibleModule(argument_spec=argument_spec, supports_check_mode=False)
 
     result = RESULT(
         http_code=0,

plugins/modules/rule.py

@@ -334,6 +334,9 @@
 from ansible.module_utils.common.validation import safe_eval
 from ansible_collections.checkmk.general.plugins.module_utils.api import CheckmkAPI
 from ansible_collections.checkmk.general.plugins.module_utils.types import RESULT
+from ansible_collections.checkmk.general.plugins.module_utils.utils import (
+    base_argument_spec,
+)
 from ansible_collections.checkmk.general.plugins.module_utils.version import (
     CheckmkVersion,
 )
@@ -886,13 +889,8 @@ def delete(self):
 
 
 def run_module():
-    # define available arguments/parameters a user can pass to the module
-    module_args = dict(
-        server_url=dict(type="str", required=True),
-        site=dict(type="str", required=True),
-        validate_certs=dict(type="bool", required=False, default=True),
-        automation_user=dict(type="str", required=True),
-        automation_secret=dict(type="str", required=True, no_log=True),
+    argument_spec = base_argument_spec()
+    argument_spec.update(
         ruleset=dict(type="str", required=True),
         rule=dict(
             type="dict",
@@ -931,7 +929,7 @@ def run_module():
         state=dict(type="str", default="present", choices=["present", "absent"]),
     )
 
-    module = AnsibleModule(argument_spec=module_args, supports_check_mode=True)
+    module = AnsibleModule(argument_spec=argument_spec, supports_check_mode=False)
 
     # Create an API object that contains the current and desired state
     current_rule = RuleAPI(module)