Remove dependency on ansible.utils and use ansible-core instead

galaxy.yml

@@ -16,8 +16,7 @@ tags:
   - collection
   - networking
   - sdn
-dependencies:
-  ansible.utils: ">=2.0.0,<6.0"
+dependencies: {}
 repository: https://github.com/CiscoISE/ansible-ise
 documentation: https://ciscoise.github.io/ansible-ise/
 homepage: https://github.com/CiscoISE/ansible-ise

plugins/action/aci_bindings_info.py

@@ -7,17 +7,7 @@
 from __future__ import absolute_import, division, print_function
 
 __metaclass__ = type
-from ansible.plugins.action import ActionBase
-
-try:
-    from ansible_collections.ansible.utils.plugins.module_utils.common.argspec_validate import (
-        AnsibleArgSpecValidator,
-    )
-except ImportError:
-    ANSIBLE_UTILS_IS_INSTALLED = False
-else:
-    ANSIBLE_UTILS_IS_INSTALLED = True
-from ansible.errors import AnsibleActionFail
+from ansible_collections.cisco.ise.plugins.plugin_utils.action import ActionModule as ActionBase
 from ansible_collections.cisco.ise.plugins.plugin_utils.ise import (
     ISESDK,
     ise_argument_spec,
@@ -44,33 +34,7 @@
 
 
 class ActionModule(ActionBase):
-    def __init__(self, *args, **kwargs):
-        if not ANSIBLE_UTILS_IS_INSTALLED:
-            raise AnsibleActionFail(
-                "ansible.utils is not installed. Execute 'ansible-galaxy collection install ansible.utils'"
-            )
-        super(ActionModule, self).__init__(*args, **kwargs)
-        self._supports_async = False
-        self._supports_check_mode = True
-        self._result = None
-
-    # Checks the supplied parameters against the argument spec for this module
-    def _check_argspec(self):
-        aav = AnsibleArgSpecValidator(
-            data=self._task.args,
-            schema=dict(argument_spec=argument_spec),
-            schema_format="argspec",
-            schema_conditionals=dict(
-                required_if=required_if,
-                required_one_of=required_one_of,
-                mutually_exclusive=mutually_exclusive,
-                required_together=required_together,
-            ),
-            name=self._task.action,
-        )
-        valid, errors, self._task.args = aav.validate()
-        if not valid:
-            raise AnsibleActionFail(errors)
+    _supports_check_mode = True
 
     def get_object(self, params):
         new_object = dict(
@@ -87,20 +51,27 @@ def run(self, tmp=None, task_vars=None):
         self._task.diff = False
         self._result = super(ActionModule, self).run(tmp, task_vars)
         self._result["changed"] = False
-        self._check_argspec()
+        _, validated_arguments = self.validate_argument_spec(
+            argument_spec=argument_spec,
+            mutually_exclusive=mutually_exclusive,
+            required_if=required_if,
+            required_one_of=required_one_of,
+            required_together=required_together,
+        )
+        params = {k: v, for k, v in validated_arguments if k in self._task.args}
 
         self._result.update(dict(ise_response=[]))
 
-        ise = ISESDK(params=self._task.args)
+        ise = ISESDK(params=params)
 
-        id = self._task.args.get("id")
-        name = self._task.args.get("name")
+        id = params.get("id")
+        name = params.get("name")
         if not name and not id:
             responses = []
             generator = ise.exec(
                 family="aci_bindings",
                 function="get_aci_bindings_generator",
-                params=self.get_object(self._task.args),
+                params=self.get_object(params),
             )
             try:
                 for item in generator:

plugins/action/aci_settings.py

@@ -7,17 +7,7 @@
 from __future__ import absolute_import, division, print_function
 
 __metaclass__ = type
-from ansible.plugins.action import ActionBase
-
-try:
-    from ansible_collections.ansible.utils.plugins.module_utils.common.argspec_validate import (
-        AnsibleArgSpecValidator,
-    )
-except ImportError:
-    ANSIBLE_UTILS_IS_INSTALLED = False
-else:
-    ANSIBLE_UTILS_IS_INSTALLED = True
-from ansible.errors import AnsibleActionFail
+from ansible_collections.cisco.ise.plugins.plugin_utils.action import ActionModule as ActionBase
 from ansible_collections.cisco.ise.plugins.plugin_utils.ise import (
     ISESDK,
     ise_argument_spec,
@@ -193,44 +183,25 @@ def update(self):
 
 
 class ActionModule(ActionBase):
-    def __init__(self, *args, **kwargs):
-        if not ANSIBLE_UTILS_IS_INSTALLED:
-            raise AnsibleActionFail(
-                "ansible.utils is not installed. Execute 'ansible-galaxy collection install ansible.utils'"
-            )
-        super(ActionModule, self).__init__(*args, **kwargs)
-        self._supports_async = False
-        self._supports_check_mode = False
-        self._result = None
-
-    # Checks the supplied parameters against the argument spec for this module
-    def _check_argspec(self):
-        aav = AnsibleArgSpecValidator(
-            data=self._task.args,
-            schema=dict(argument_spec=argument_spec),
-            schema_format="argspec",
-            schema_conditionals=dict(
-                required_if=required_if,
-                required_one_of=required_one_of,
-                mutually_exclusive=mutually_exclusive,
-                required_together=required_together,
-            ),
-            name=self._task.action,
-        )
-        valid, errors, self._task.args = aav.validate()
-        if not valid:
-            raise AnsibleActionFail(errors)
+    _supports_check_mode = False
 
     def run(self, tmp=None, task_vars=None):
         self._task.diff = False
         self._result = super(ActionModule, self).run(tmp, task_vars)
         self._result["changed"] = False
-        self._check_argspec()
+        _, validated_arguments = self.validate_argument_spec(
+            argument_spec=argument_spec,
+            mutually_exclusive=mutually_exclusive,
+            required_if=required_if,
+            required_one_of=required_one_of,
+            required_together=required_together,
+        )
+        params = {k: v, for k, v in validated_arguments if k in self._task.args}
 
-        ise = ISESDK(params=self._task.args)
-        obj = AciSettings(self._task.args, ise)
+        ise = ISESDK(params=params)
+        obj = AciSettings(params, ise)
 
-        state = self._task.args.get("state")
+        state = params.get("state")
 
         response = None
         if state == "present":

plugins/action/aci_settings_info.py

@@ -7,17 +7,7 @@
 from __future__ import absolute_import, division, print_function
 
 __metaclass__ = type
-from ansible.plugins.action import ActionBase
-
-try:
-    from ansible_collections.ansible.utils.plugins.module_utils.common.argspec_validate import (
-        AnsibleArgSpecValidator,
-    )
-except ImportError:
-    ANSIBLE_UTILS_IS_INSTALLED = False
-else:
-    ANSIBLE_UTILS_IS_INSTALLED = True
-from ansible.errors import AnsibleActionFail
+from ansible_collections.cisco.ise.plugins.plugin_utils.action import ActionModule as ActionBase
 from ansible_collections.cisco.ise.plugins.plugin_utils.ise import (
     ISESDK,
     ise_argument_spec,
@@ -35,33 +25,7 @@
 
 
 class ActionModule(ActionBase):
-    def __init__(self, *args, **kwargs):
-        if not ANSIBLE_UTILS_IS_INSTALLED:
-            raise AnsibleActionFail(
-                "ansible.utils is not installed. Execute 'ansible-galaxy collection install ansible.utils'"
-            )
-        super(ActionModule, self).__init__(*args, **kwargs)
-        self._supports_async = False
-        self._supports_check_mode = True
-        self._result = None
-
-    # Checks the supplied parameters against the argument spec for this module
-    def _check_argspec(self):
-        aav = AnsibleArgSpecValidator(
-            data=self._task.args,
-            schema=dict(argument_spec=argument_spec),
-            schema_format="argspec",
-            schema_conditionals=dict(
-                required_if=required_if,
-                required_one_of=required_one_of,
-                mutually_exclusive=mutually_exclusive,
-                required_together=required_together,
-            ),
-            name=self._task.action,
-        )
-        valid, errors, self._task.args = aav.validate()
-        if not valid:
-            raise AnsibleActionFail(errors)
+    _supports_check_mode = True
 
     def get_object(self, params):
         new_object = dict()
@@ -71,19 +35,26 @@ def run(self, tmp=None, task_vars=None):
         self._task.diff = False
         self._result = super(ActionModule, self).run(tmp, task_vars)
         self._result["changed"] = False
-        self._check_argspec()
+        _, validated_arguments = self.validate_argument_spec(
+            argument_spec=argument_spec,
+            mutually_exclusive=mutually_exclusive,
+            required_if=required_if,
+            required_one_of=required_one_of,
+            required_together=required_together,
+        )
+        params = {k: v, for k, v in validated_arguments if k in self._task.args}
 
         self._result.update(dict(ise_response={}))
 
-        ise = ISESDK(params=self._task.args)
+        ise = ISESDK(params=params)
 
-        id = self._task.args.get("id")
-        name = self._task.args.get("name")
+        id = params.get("id")
+        name = params.get("name")
         if not name and not id:
             response = ise.exec(
                 family="aci_settings",
                 function="get_aci_settings",
-                params=self.get_object(self._task.args),
+                params=self.get_object(params),
             ).response["AciSettings"]
             self._result.update(dict(ise_response=response))
             self._result.update(ise.exit_json())

plugins/action/aci_test_connectivity.py

@@ -7,17 +7,7 @@
 from __future__ import absolute_import, division, print_function
 
 __metaclass__ = type
-from ansible.plugins.action import ActionBase
-
-try:
-    from ansible_collections.ansible.utils.plugins.module_utils.common.argspec_validate import (
-        AnsibleArgSpecValidator,
-    )
-except ImportError:
-    ANSIBLE_UTILS_IS_INSTALLED = False
-else:
-    ANSIBLE_UTILS_IS_INSTALLED = True
-from ansible.errors import AnsibleActionFail
+from ansible_collections.cisco.ise.plugins.plugin_utils.action import ActionModule as ActionBase
 from ansible_collections.cisco.ise.plugins.plugin_utils.ise import (
     ISESDK,
     ise_argument_spec,
@@ -35,33 +25,7 @@
 
 
 class ActionModule(ActionBase):
-    def __init__(self, *args, **kwargs):
-        if not ANSIBLE_UTILS_IS_INSTALLED:
-            raise AnsibleActionFail(
-                "ansible.utils is not installed. Execute 'ansible-galaxy collection install ansible.utils'"
-            )
-        super(ActionModule, self).__init__(*args, **kwargs)
-        self._supports_async = False
-        self._supports_check_mode = False
-        self._result = None
-
-    # Checks the supplied parameters against the argument spec for this module
-    def _check_argspec(self):
-        aav = AnsibleArgSpecValidator(
-            data=self._task.args,
-            schema=dict(argument_spec=argument_spec),
-            schema_format="argspec",
-            schema_conditionals=dict(
-                required_if=required_if,
-                required_one_of=required_one_of,
-                mutually_exclusive=mutually_exclusive,
-                required_together=required_together,
-            ),
-            name=self._task.action,
-        )
-        valid, errors, self._task.args = aav.validate()
-        if not valid:
-            raise AnsibleActionFail(errors)
+    _supports_check_mode = False
 
     def get_object(self, params):
         new_object = dict()
@@ -71,14 +35,21 @@ def run(self, tmp=None, task_vars=None):
         self._task.diff = False
         self._result = super(ActionModule, self).run(tmp, task_vars)
         self._result["changed"] = False
-        self._check_argspec()
+        _, validated_arguments = self.validate_argument_spec(
+            argument_spec=argument_spec,
+            mutually_exclusive=mutually_exclusive,
+            required_if=required_if,
+            required_one_of=required_one_of,
+            required_together=required_together,
+        )
+        params = {k: v, for k, v in validated_arguments if k in self._task.args}
 
-        ise = ISESDK(params=self._task.args)
+        ise = ISESDK(params=params)
 
         response = ise.exec(
             family="aci_settings",
             function="test_aci_connectivity",
-            params=self.get_object(self._task.args),
+            params=self.get_object(params),
         ).response
 
         self._result.update(dict(ise_response=response))