Bugfix: Add required_one_of to netbox_service to allow device or virtual_machine (#326)

Author: FragmentedPacket

plugins/module_utils/netbox_utils.py

@@ -979,7 +979,7 @@ def __init__(
             no_log=False,
             mutually_exclusive=None,
             required_together=None,
-            required_one_of=None,
+            required_one_of=required_one_of,
             add_file_common_args=False,
             supports_check_mode=supports_check_mode,
             required_if=required_if,
@@ -1047,6 +1047,47 @@ def check_required_if(self, requirements, module_parameters):
 
         return results
 
+    def _check_required_one_of(self, spec, param=None):
+        if spec is None:
+            return
+
+        if param is None:
+            param = self.params
+
+        try:
+            self.check_required_one_of(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_one_of(self, terms, module_parameters):
+        """Check each list of terms to ensure at least one exists in the given module
+        parameters
+        Accepts a list of lists or tuples
+        :arg terms: List of lists of terms to check. For each list of terms, at
+            least one is required.
+        :arg module_parameters: Dictionary of module parameters
+        :returns: Empty list or raises TypeError if the check fails.
+        """
+
+        results = []
+        if terms is None:
+            return results
+
+        for term in terms:
+            count = self.count_terms(term, module_parameters["data"])
+            if count == 0:
+                results.append(term)
+
+        if results:
+            for term in results:
+                msg = "one of the following is required: %s" % ", ".join(term)
+                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

plugins/modules/netbox_service.py

@@ -45,7 +45,7 @@
       device:
         description:
           - Specifies on which device the service is running
-        required: true
+        required: false
         type: raw
       virtual_machine:
         description:
@@ -170,7 +170,7 @@ def main():
                 type="dict",
                 required=True,
                 options=dict(
-                    device=dict(required=True, type="raw"),
+                    device=dict(required=False, type="raw"),
                     virtual_machine=dict(required=False, type="raw"),
                     name=dict(required=True, type="str"),
                     port=dict(required=True, type="int"),
@@ -185,9 +185,13 @@ def main():
     )
 
     required_if = [("state", "present", ["name"]), ("state", "absent", ["name"])]
+    required_one_of = [["device", "virtual_machine"]]
 
     module = NetboxAnsibleModule(
-        argument_spec=argument_spec, supports_check_mode=True, required_if=required_if
+        argument_spec=argument_spec,
+        supports_check_mode=True,
+        required_if=required_if,
+        required_one_of=required_one_of,
     )
 
     netbox_service = NetboxIpamModule(module, NB_SERVICES)

tests/integration/targets/latest/tasks/netbox_service.yml

@@ -148,3 +148,46 @@
       - test_service_ip_addresses['services']['protocol'] == "udp"
       - test_service_ip_addresses['services']['ipaddresses'] is defined
       - test_service_ip_addresses['msg'] == "services node-exporter created"
+
+- name: "NETBOX_SERVICE: Missing both device & virtual_machine options - Tests required_one_of"
+  netbox.netbox.netbox_service:
+    netbox_url: "http://localhost:32768"
+    netbox_token: "0123456789abcdef0123456789abcdef01234567"
+    data:
+      name: "node-exporter"
+      port: 9100
+      protocol: UDP
+      ipaddresses:
+        - address: "172.16.180.1/24"
+    state: present
+  ignore_errors: yes
+  register: test_service_required_one_of
+
+- name: "NETBOX_SERVICE ASSERT - Failed due to missing arguments"
+  assert:
+    that:
+      - test_service_required_one_of is failed
+      - 'test_service_required_one_of["msg"] == "one of the following is required: device, virtual_machine"'
+
+- name: "NETBOX_SERVICE: Create new service on virtual_machine"
+  netbox.netbox.netbox_service:
+    netbox_url: "http://localhost:32768"
+    netbox_token: "0123456789abcdef0123456789abcdef01234567"
+    data:
+      virtual_machine: "test100-vm"
+      name: "node-exporter"
+      port: 9100
+      protocol: TCP
+    state: present
+  register: test_service_create_vm
+
+- name: "NETBOX_SERVICE ASSERT - Create"
+  assert:
+    that:
+      - test_service_create_vm is changed
+      - test_service_create_vm['services']['name'] == "node-exporter"
+      - test_service_create_vm['services']['port'] == 9100
+      - test_service_create_vm['services']['protocol'] == "tcp"
+      - test_service_create_vm['diff']['after']['state'] == "present"
+      - test_service_create_vm['diff']['before']['state'] == "absent"
+      - test_service_create_vm['msg'] == "services node-exporter created"