fail task on errors

Author: FragmentedPacket

.travis.yml

@@ -13,9 +13,9 @@ env:
 
 matrix:
   include:
-    - name: "Python 3.6 - Netbox 2.5 - Ansible 2.9RC4"
+    - name: "Python 3.6 - Netbox 2.5 - Ansible 2.9"
       python: 3.6
-      env: PYTHON_VER=3.6 VERSION=v2.5 ANSIBLE_VER=2.9.0rc4
+      env: PYTHON_VER=3.6 VERSION=v2.5 ANSIBLE_VER=2.9.0
       install:
         - cd ..
         # Setup netbox container for integration testing
@@ -31,7 +31,7 @@ matrix:
 
     - name: "Python 3.6 - Netbox Latest - Ansible Devel"
       python: 3.6
-      env: PYTHON_VER=3.6
+      env: PYTHON_VER=3.6 VERSION=v2.6.6
       install:
         - cd ..
         # Setup netbox container for integration testing

CHANGELOG.md

@@ -6,6 +6,7 @@
 - [#9](https://github.com/FragmentedPacket/netbox_modules/issues/9) - Changed role to prefix_role in netbox_prefix.py
 - [#9](https://github.com/FragmentedPacket/netbox_modules/issues/9) - Changed group to tenant_group in netbox_tenant.py
 - [#9](https://github.com/FragmentedPacket/netbox_modules/issues/9) - Renamed netbox_interface to netbox_device_interface
+- [#24](https://github.com/FragmentedPacket/netbox_modules/issues/24) - Module failures when required fields arent provided
 
 ### New Modules / Plugins
 - [#9](https://github.com/FragmentedPacket/netbox_modules/issues/9) - Added netbox_device_role
@@ -30,4 +31,4 @@
 ### Bug Fixes
 
 ### Enhancements
-- [#10](https://github.com/FragmentedPacket/netbox_modules/issues/10) - Add primary_ip4/6 to netbox_ip_address
+- [#10](https://github.com/FragmentedPacket/netbox_modules/issues/10) - Add primary_ip4/6 to netbox_ip_address

plugins/module_utils/netbox_utils.py

@@ -9,6 +9,10 @@
 import traceback
 from ansible.module_utils.compat import ipaddress
 from ansible.module_utils._text import to_text
+
+# from ._text import to_native
+from ansible.module_utils._text import to_native
+from ansible.module_utils.common.collections import is_iterable
 from ansible.module_utils.basic import AnsibleModule, missing_required_lib
 
 PYNETBOX_IMP_ERR = None
@@ -379,7 +383,7 @@ def _handle_errors(self, msg):
         :params msg (str): Message indicating why there is no change
         """
         if msg:
-            self.module.exit_json(msg=msg, changed=False)
+            self.module.fail_json(msg=msg, changed=False)
 
     def _build_diff(self, before=None, after=None):
         """Builds diff of before and after changes"""
@@ -692,3 +696,117 @@ def run(self):
         Must be implemented in subclasses
         """
         raise NotImplementedError
+
+
+class NetboxAnsibleModule(AnsibleModule):
+    """
+    Creating this due to needing to override some functionality to provide required_together, required_if
+    and will be able to override more in the future.
+    This is due to the Netbox modules having the module arguments within a key in the argument spec, using suboptions rather than
+    having all module arguments within the regular argument spec.
+
+    Didn't want to change that functionality of the Netbox modules as its disruptive and we're required to send a specific payload
+    to the Netbox API
+    """
+
+    def __init__(
+        self,
+        argument_spec,
+        bypass_checks=False,
+        no_log=False,
+        check_invalid_arguments=None,
+        mutually_exclusive=None,
+        required_together=None,
+        required_one_of=None,
+        add_file_common_args=False,
+        supports_check_mode=False,
+        required_if=None,
+        required_by=None,
+    ):
+        super().__init__(
+            argument_spec,
+            bypass_checks,
+            no_log,
+            check_invalid_arguments,
+            mutually_exclusive,
+            required_together,
+            required_one_of,
+            add_file_common_args,
+            supports_check_mode,
+            required_if,
+            required_by,
+        )
+
+    def _check_required_if(self, spec, param=None):
+        """ ensure that parameters which conditionally required are present """
+        if spec is None:
+            return
+        if param is None:
+            param = self.params
+
+        try:
+            self.check_required_if(spec, param)
+        except TypeError as e:
+            msg = to_native(e)
+            if self._options_context:
+                msg += " found in %s" % " -> ".join(self._options_context)
+            self.fail_json(msg=msg)
+
+    def check_required_if(self, requirements, module_parameters):
+        results = []
+        if requirements is None:
+            return results
+
+        for req in requirements:
+            missing = {}
+            missing["missing"] = []
+            max_missing_count = 0
+            is_one_of = False
+            if len(req) == 4:
+                key, val, requirements, is_one_of = req
+            else:
+                key, val, requirements = req
+
+            # is_one_of is True at least one requirement should be
+            # present, else all requirements should be present.
+            if is_one_of:
+                max_missing_count = len(requirements)
+                missing["requires"] = "any"
+            else:
+                missing["requires"] = "all"
+
+            if key in module_parameters and module_parameters[key] == val:
+                for check in requirements:
+                    count = self.count_terms(check, module_parameters["data"])
+                    if count == 0:
+                        missing["missing"].append(check)
+            if len(missing["missing"]) and len(missing["missing"]) >= max_missing_count:
+                missing["parameter"] = key
+                missing["value"] = val
+                missing["requirements"] = requirements
+                results.append(missing)
+
+        if results:
+            for missing in results:
+                msg = "%s is %s but %s of the following are missing: %s" % (
+                    missing["parameter"],
+                    missing["value"],
+                    missing["requires"],
+                    ", ".join(missing["missing"]),
+                )
+                raise TypeError(to_native(msg))
+
+        return results
+
+    def count_terms(self, terms, module_parameters):
+        """Count the number of occurrences of a key in a given dictionary
+        :arg terms: String or iterable of values to check
+        :arg module_parameters: Dictionary of module parameters
+        :returns: An integer that is the number of occurrences of the terms values
+            in the provided dictionary.
+        """
+
+        if not is_iterable(terms):
+            terms = [terms]
+
+        return len(set(terms).intersection(module_parameters))

plugins/modules/netbox_aggregate.py

@@ -43,9 +43,11 @@
       prefix:
         description:
           - The aggregate prefix
+        required: true
       rir:
         description:
           - The RIR the aggregate will be assigned to
+        required:true
       date_added:
         description:
           - Date added, format: YYYY-MM-DD
@@ -120,7 +122,9 @@
   type: str
 """
 
-from ansible.module_utils.basic import AnsibleModule
+from ansible_collections.fragmentedpacket.netbox_modules.plugins.module_utils.netbox_utils import (
+    NetboxAnsibleModule,
+)
 from ansible_collections.fragmentedpacket.netbox_modules.plugins.module_utils.netbox_ipam import (
     NetboxIpamModule,
     NB_AGGREGATES,
@@ -139,7 +143,11 @@ def main():
         validate_certs=dict(type="bool", default=True),
     )
 
-    module = AnsibleModule(argument_spec=argument_spec, supports_check_mode=True)
+    required_if = [("state", "present", ["prefix"]), ("state", "absent", ["prefix"])]
+
+    module = NetboxAnsibleModule(
+        argument_spec=argument_spec, supports_check_mode=True, required_if=required_if
+    )
 
     netbox_aggregate = NetboxIpamModule(module, NB_AGGREGATES)
     netbox_aggregate.run()

plugins/modules/netbox_device.py

@@ -179,7 +179,9 @@
   type: str
 """
 
-from ansible.module_utils.basic import AnsibleModule
+from ansible_collections.fragmentedpacket.netbox_modules.plugins.module_utils.netbox_utils import (
+    NetboxAnsibleModule,
+)
 from ansible_collections.fragmentedpacket.netbox_modules.plugins.module_utils.netbox_dcim import (
     NetboxDcimModule,
     NB_DEVICES,
@@ -197,12 +199,11 @@ def main():
         state=dict(required=False, default="present", choices=["present", "absent"]),
         validate_certs=dict(type="bool", default=True),
     )
+    required_if = [("state", "present", ["name"]), ("state", "absent", ["name"])]
 
-    module = AnsibleModule(argument_spec=argument_spec, supports_check_mode=True)
-
-    # Fail if device name is not given
-    if not module.params["data"].get("name"):
-        module.fail_json(msg="missing name")
+    module = NetboxAnsibleModule(
+        argument_spec=argument_spec, supports_check_mode=True, required_if=required_if
+    )
 
     netbox_device = NetboxDcimModule(module, NB_DEVICES)
     netbox_device.run()

plugins/modules/netbox_device_bay.py

@@ -118,7 +118,9 @@
   type: str
 """
 
-from ansible.module_utils.basic import AnsibleModule
+from ansible_collections.fragmentedpacket.netbox_modules.plugins.module_utils.netbox_utils import (
+    NetboxAnsibleModule,
+)
 from ansible_collections.fragmentedpacket.netbox_modules.plugins.module_utils.netbox_dcim import (
     NetboxDcimModule,
     NB_DEVICE_BAYS,
@@ -136,12 +138,11 @@ def main():
         state=dict(required=False, default="present", choices=["present", "absent"]),
         validate_certs=dict(type="bool", default=True),
     )
+    required_if = [("state", "present", ["name"]), ("state", "absent", ["name"])]
 
-    module = AnsibleModule(argument_spec=argument_spec, supports_check_mode=True)
-
-    # Fail if device_bay name is not given
-    if not module.params["data"].get("name"):
-        module.fail_json(msg="missing name")
+    module = NetboxAnsibleModule(
+        argument_spec=argument_spec, supports_check_mode=True, required_if=required_if
+    )
 
     netbox_device_bay = NetboxDcimModule(module, NB_DEVICE_BAYS)
     netbox_device_bay.run()

plugins/modules/netbox_device_interface.py

@@ -203,7 +203,9 @@
   type: str
 """
 
-from ansible.module_utils.basic import AnsibleModule
+from ansible_collections.fragmentedpacket.netbox_modules.plugins.module_utils.netbox_utils import (
+    NetboxAnsibleModule,
+)
 from ansible_collections.fragmentedpacket.netbox_modules.plugins.module_utils.netbox_dcim import (
     NetboxDcimModule,
     NB_INTERFACES,
@@ -221,11 +223,14 @@ def main():
         state=dict(required=False, default="present", choices=["present", "absent"]),
         validate_certs=dict(type="bool", default=True),
     )
+    required_if = [
+        ("state", "present", ["device", "name"]),
+        ("state", "absent", ["device", "name"]),
+    ]
 
-    module = AnsibleModule(argument_spec=argument_spec, supports_check_mode=True)
-
-    if not module.params["data"].get("name"):
-        module.fail_json(msg="missing name")
+    module = NetboxAnsibleModule(
+        argument_spec=argument_spec, supports_check_mode=True, required_if=required_if
+    )
 
     netbox_device_interface = NetboxDcimModule(module, NB_INTERFACES)
     netbox_device_interface.run()

plugins/modules/netbox_device_role.py

@@ -101,8 +101,9 @@
   returned: always
   type: str
 """
-
-from ansible.module_utils.basic import AnsibleModule
+from ansible_collections.fragmentedpacket.netbox_modules.plugins.module_utils.netbox_utils import (
+    NetboxAnsibleModule,
+)
 from ansible_collections.fragmentedpacket.netbox_modules.plugins.module_utils.netbox_dcim import (
     NetboxDcimModule,
     NB_DEVICE_ROLES,
@@ -120,12 +121,11 @@ def main():
         state=dict(required=False, default="present", choices=["present", "absent"]),
         validate_certs=dict(type="bool", default=True),
     )
+    required_if = [("state", "present", ["name"]), ("state", "absent", ["name"])]
 
-    module = AnsibleModule(argument_spec=argument_spec, supports_check_mode=True)
-
-    # Fail if name is not given
-    if not module.params["data"].get("name"):
-        module.fail_json(msg="missing name")
+    module = NetboxAnsibleModule(
+        argument_spec=argument_spec, supports_check_mode=True, required_if=required_if
+    )
 
     netbox_device_role = NetboxDcimModule(module, NB_DEVICE_ROLES)
     netbox_device_role.run()

plugins/modules/netbox_device_type.py

@@ -142,7 +142,9 @@
   type: str
 """
 
-from ansible.module_utils.basic import AnsibleModule
+from ansible_collections.fragmentedpacket.netbox_modules.plugins.module_utils.netbox_utils import (
+    NetboxAnsibleModule,
+)
 from ansible_collections.fragmentedpacket.netbox_modules.plugins.module_utils.netbox_dcim import (
     NetboxDcimModule,
     NB_DEVICE_TYPES,
@@ -160,12 +162,11 @@ def main():
         state=dict(required=False, default="present", choices=["present", "absent"]),
         validate_certs=dict(type="bool", default=True),
     )
+    required_if = [("state", "present", ["slug"]), ("state", "absent", ["slug"])]
 
-    module = AnsibleModule(argument_spec=argument_spec, supports_check_mode=True)
-
-    # Fail if name is not given
-    if not module.params["data"].get("slug"):
-        module.fail_json(msg="Missing slug")
+    module = NetboxAnsibleModule(
+        argument_spec=argument_spec, supports_check_mode=True, required_if=required_if
+    )
 
     netbox_device_type = NetboxDcimModule(module, NB_DEVICE_TYPES)
     netbox_device_type.run()

plugins/modules/netbox_inventory_item.py

@@ -136,7 +136,9 @@
   type: str
 """
 
-from ansible.module_utils.basic import AnsibleModule
+from ansible_collections.fragmentedpacket.netbox_modules.plugins.module_utils.netbox_utils import (
+    NetboxAnsibleModule,
+)
 from ansible_collections.fragmentedpacket.netbox_modules.plugins.module_utils.netbox_dcim import (
     NetboxDcimModule,
     NB_INVENTORY_ITEMS,
@@ -154,12 +156,14 @@ def main():
         state=dict(required=False, default="present", choices=["present", "absent"]),
         validate_certs=dict(type="bool", default=True),
     )
+    required_if = [
+        ("state", "present", ["device", "name"]),
+        ("state", "absent", ["device", "name"]),
+    ]
 
-    module = AnsibleModule(argument_spec=argument_spec, supports_check_mode=True)
-
-    # Fail if name is not given
-    if not module.params["data"].get("name"):
-        module.fail_json(msg="missing name")
+    module = NetboxAnsibleModule(
+        argument_spec=argument_spec, supports_check_mode=True, required_if=required_if
+    )
 
     netbox_inventory_item = NetboxDcimModule(module, NB_INVENTORY_ITEMS)
     netbox_inventory_item.run()