Bugfix: Make validate_args as generic utility function (#101)

Bugfix: Make validate_args as generic utility function

SUMMARY

fixes: #100

ISSUE TYPE


Bugfix Pull Request

COMPONENT NAME

ADDITIONAL INFORMATION

Reviewed-by: Nilashish Chakraborty <nilashishchakraborty8@gmail.com>
Reviewed-by: None <None>

changelogs/fragments/bugfix_100.yaml

@@ -0,0 +1,3 @@
+---
+trivial:
+        - Make "_validate_arg" method as generic utility function.

plugins/filter/usable_range.py

@@ -11,10 +11,12 @@ from __future__ import absolute_import, division, print_function
 from ipaddress import IPv4Network, IPv6Network
 
 from ansible_collections.ansible.utils.plugins.plugin_utils.base.ipaddress_utils import (
-    _validate_args,
     ip_network,
     _need_ipaddress,
 )
+from ansible_collections.ansible.utils.plugins.plugin_utils.base.utils import (
+    _validate_args,
+)
 
 __metaclass__ = type
 

plugins/plugin_utils/base/utils.py

@@ -0,0 +1,34 @@
+# -*- coding: utf-8 -*-
+# Copyright 2021 Red Hat
+# GNU General Public License v3.0+
+# (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
+
+"""
+The utils file for all netaddr tests
+"""
+
+from __future__ import absolute_import, division, print_function
+
+__metaclass__ = type
+
+from ansible.errors import AnsibleError
+from ansible_collections.ansible.utils.plugins.module_utils.common.argspec_validate import (
+    check_argspec,
+)
+
+
+def _validate_args(plugin, doc, params):
+    """ argspec validator utility function
+    """
+
+    valid, argspec_result, updated_params = check_argspec(
+        doc, plugin + " test", **params
+    )
+
+    if not valid:
+        raise AnsibleError(
+            "{argspec_result} with errors: {argspec_errors}".format(
+                argspec_result=argspec_result.get("msg"),
+                argspec_errors=argspec_result.get("errors"),
+            )
+        )

plugins/test/in_any_network.py

@@ -11,7 +11,7 @@ from __future__ import absolute_import, division, print_function
 from ansible_collections.ansible.utils.plugins.test.in_network import (
     _in_network,
 )
-from ansible_collections.ansible.utils.plugins.plugin_utils.base.ipaddress_utils import (
+from ansible_collections.ansible.utils.plugins.plugin_utils.base.utils import (
     _validate_args,
 )
 

plugins/test/in_network.py

@@ -13,7 +13,7 @@ from ansible_collections.ansible.utils.plugins.plugin_utils.base.ipaddress_utils
     _is_subnet_of,
     _need_ipaddress,
 )
-from ansible_collections.ansible.utils.plugins.plugin_utils.base.ipaddress_utils import (
+from ansible_collections.ansible.utils.plugins.plugin_utils.base.utils import (
     _validate_args,
 )
 

plugins/test/ip.py

@@ -11,6 +11,8 @@ from __future__ import absolute_import, division, print_function
 from ansible_collections.ansible.utils.plugins.plugin_utils.base.ipaddress_utils import (
     ip_network,
     _need_ipaddress,
+)
+from ansible_collections.ansible.utils.plugins.plugin_utils.base.utils import (
     _validate_args,
 )
 

plugins/test/ip_address.py

@@ -11,9 +11,12 @@ from __future__ import absolute_import, division, print_function
 from ansible_collections.ansible.utils.plugins.plugin_utils.base.ipaddress_utils import (
     ip_address,
     _need_ipaddress,
+)
+from ansible_collections.ansible.utils.plugins.plugin_utils.base.utils import (
     _validate_args,
 )
 
+
 __metaclass__ = type
 
 DOCUMENTATION = """

plugins/test/ipv4_address.py

@@ -11,6 +11,8 @@ from __future__ import absolute_import, division, print_function
 from ansible_collections.ansible.utils.plugins.plugin_utils.base.ipaddress_utils import (
     ip_address,
     _need_ipaddress,
+)
+from ansible_collections.ansible.utils.plugins.plugin_utils.base.utils import (
     _validate_args,
 )
 

plugins/test/ipv4_hostmask.py

@@ -11,6 +11,8 @@ from __future__ import absolute_import, division, print_function
 from ansible_collections.ansible.utils.plugins.plugin_utils.base.ipaddress_utils import (
     ip_network,
     _need_ipaddress,
+)
+from ansible_collections.ansible.utils.plugins.plugin_utils.base.utils import (
     _validate_args,
 )
 

plugins/test/ipv4_netmask.py

@@ -11,6 +11,8 @@ from __future__ import absolute_import, division, print_function
 from ansible_collections.ansible.utils.plugins.plugin_utils.base.ipaddress_utils import (
     ip_network,
     _need_ipaddress,
+)
+from ansible_collections.ansible.utils.plugins.plugin_utils.base.utils import (
     _validate_args,
 )
 

plugins/test/ipv6.py

@@ -11,6 +11,8 @@ from __future__ import absolute_import, division, print_function
 from ansible_collections.ansible.utils.plugins.plugin_utils.base.ipaddress_utils import (
     ip_network,
     _need_ipaddress,
+)
+from ansible_collections.ansible.utils.plugins.plugin_utils.base.utils import (
     _validate_args,
 )
 

plugins/test/ipv6_address.py

@@ -11,6 +11,8 @@ from __future__ import absolute_import, division, print_function
 from ansible_collections.ansible.utils.plugins.plugin_utils.base.ipaddress_utils import (
     ip_address,
     _need_ipaddress,
+)
+from ansible_collections.ansible.utils.plugins.plugin_utils.base.utils import (
     _validate_args,
 )
 

plugins/test/ipv6_sixtofour.py

@@ -11,6 +11,8 @@ from __future__ import absolute_import, division, print_function
 from ansible_collections.ansible.utils.plugins.plugin_utils.base.ipaddress_utils import (
     ip_address,
     _need_ipaddress,
+)
+from ansible_collections.ansible.utils.plugins.plugin_utils.base.utils import (
     _validate_args,
 )
 

plugins/test/ipv6_teredo.py

@@ -11,6 +11,8 @@ from __future__ import absolute_import, division, print_function
 from ansible_collections.ansible.utils.plugins.plugin_utils.base.ipaddress_utils import (
     ip_address,
     _need_ipaddress,
+)
+from ansible_collections.ansible.utils.plugins.plugin_utils.base.utils import (
     _validate_args,
 )
 

plugins/test/mac.py

@@ -8,7 +8,7 @@ Test plugin file for netaddr tests: mac
 """
 
 from __future__ import absolute_import, division, print_function
-from ansible_collections.ansible.utils.plugins.plugin_utils.base.ipaddress_utils import (
+from ansible_collections.ansible.utils.plugins.plugin_utils.base.utils import (
     _validate_args,
 )
 import re

plugins/test/multicast.py

@@ -11,9 +11,12 @@ from __future__ import absolute_import, division, print_function
 from ansible_collections.ansible.utils.plugins.plugin_utils.base.ipaddress_utils import (
     ip_address,
     _need_ipaddress,
+)
+from ansible_collections.ansible.utils.plugins.plugin_utils.base.utils import (
     _validate_args,
 )
 
+
 __metaclass__ = type
 
 DOCUMENTATION = """

plugins/test/private.py

@@ -11,6 +11,8 @@ from __future__ import absolute_import, division, print_function
 from ansible_collections.ansible.utils.plugins.plugin_utils.base.ipaddress_utils import (
     ip_address,
     _need_ipaddress,
+)
+from ansible_collections.ansible.utils.plugins.plugin_utils.base.utils import (
     _validate_args,
 )
 

plugins/test/reserved.py

@@ -11,6 +11,8 @@ from __future__ import absolute_import, division, print_function
 from ansible_collections.ansible.utils.plugins.plugin_utils.base.ipaddress_utils import (
     ip_address,
     _need_ipaddress,
+)
+from ansible_collections.ansible.utils.plugins.plugin_utils.base.utils import (
     _validate_args,
 )
 

plugins/test/resolvable.py

@@ -9,6 +9,8 @@ Test plugin file for netaddr tests: resolvable
 from __future__ import absolute_import, division, print_function
 from ansible_collections.ansible.utils.plugins.plugin_utils.base.ipaddress_utils import (
     _need_ipaddress,
+)
+from ansible_collections.ansible.utils.plugins.plugin_utils.base.utils import (
     _validate_args,
 )
 

plugins/test/supernet_of.py

@@ -12,6 +12,8 @@ from ansible_collections.ansible.utils.plugins.plugin_utils.base.ipaddress_utils
     ip_network,
     _need_ipaddress,
     _is_subnet_of,
+)
+from ansible_collections.ansible.utils.plugins.plugin_utils.base.utils import (
     _validate_args,
 )