Bugfix: netbox_utils - If query_dict is None, fail and provide meaningful error message (#419)

Author: FragmentedPacket

plugins/module_utils/netbox_ipam.py

@@ -185,15 +185,15 @@ def run(self):
         else:
             first_available = False
 
-        object_query_params = self._build_query_params(
-            endpoint_name, data, user_query_params
-        )
         if data.get("prefix") and self.endpoint == "ip_addresses":
             object_query_params = self._build_query_params("prefix", data)
             self.nb_object = self._nb_endpoint_get(
                 nb_app.prefixes, object_query_params, name
             )
         else:
+            object_query_params = self._build_query_params(
+                endpoint_name, data, user_query_params
+            )
             self.nb_object = self._nb_endpoint_get(
                 nb_endpoint, object_query_params, name
             )

plugins/module_utils/netbox_utils.py

@@ -741,6 +741,15 @@ def _build_query_params(
             if query_dict.get("device_type"):
                 query_dict["devicetype_id"] = query_dict.pop("device_type")
 
+        if not query_dict:
+            provided_kwargs = child.keys() if child else module_data.keys()
+            acceptable_query_params = (
+                user_query_params if user_query_params else query_params
+            )
+            self._handle_errors(
+                f"One or more of the kwargs provided are invalid for {parent}, provided kwargs: {', '.join(sorted(provided_kwargs))}. Acceptable kwargs: {', '.join(sorted(acceptable_query_params))}"
+            )
+
         query_dict = self._convert_identical_keys(query_dict)
         return query_dict
 

tests/integration/targets/regression-latest/tasks/main.yml

@@ -195,3 +195,24 @@
           - query_params_372['diff']['after']['assigned_object'] == 3
           - query_params_372['diff']['after']['assigned_object_id'] == 3
           - query_params_372['diff']['after']['assigned_object_type'] == 'dcim.interface'
+
+    - name: "Validate failure due to invalid child params provided by user"
+      netbox.netbox.netbox_cable:
+        netbox_url: "http://localhost:32768"
+        netbox_token: "0123456789abcdef0123456789abcdef01234567"
+        data:
+          termination_a_type: "dcim.interface"
+          termination_a:
+            device: "test100"
+            name: "GigabitEthernet1"
+          termination_b_type: "circuits.circuittermination"
+          termination_b:
+            name: "XYZ987"
+      ignore_errors: "yes"
+      register: "test_results"
+
+    - name: "Issue #415 - Assert failure message shows the allowed params and what the user provided"
+      assert:
+        that:
+          - test_results is failed
+          - 'test_results["msg"] == "One or more of the kwargs provided are invalid for circuits.circuittermination, provided kwargs: name. Acceptable kwargs: circuit, term_side"'

tests/integration/targets/regression-v2.9/tasks/main.yml

@@ -195,3 +195,24 @@
           - query_params_372['diff']['after']['assigned_object'] == 3
           - query_params_372['diff']['after']['assigned_object_id'] == 3
           - query_params_372['diff']['after']['assigned_object_type'] == 'dcim.interface'
+
+    - name: "Validate failure due to invalid child params provided by user"
+      netbox.netbox.netbox_cable:
+        netbox_url: "http://localhost:32768"
+        netbox_token: "0123456789abcdef0123456789abcdef01234567"
+        data:
+          termination_a_type: "dcim.interface"
+          termination_a:
+            device: "test100"
+            name: "GigabitEthernet1"
+          termination_b_type: "circuits.circuittermination"
+          termination_b:
+            name: "XYZ987"
+      ignore_errors: "yes"
+      register: "test_results"
+
+    - name: "Issue #415 - Assert failure message shows the allowed params and what the user provided"
+      assert:
+        that:
+          - test_results is failed
+          - 'test_results["msg"] == "One or more of the kwargs provided are invalid for circuits.circuittermination, provided kwargs: name. Acceptable kwargs: circuit, term_side"'