Bugfix: Fix netbox_service to use protocol for allowed_query_params (#175)

Author: FragmentedPacket

plugins/module_utils/netbox_utils.py

@@ -215,7 +215,7 @@
     "region": set(["slug"]),
     "rir": set(["slug"]),
     "role": set(["slug"]),
-    "services": set(["device", "virtual_machine", "name", "port"]),
+    "services": set(["device", "virtual_machine", "name", "port", "protocol"]),
     "site": set(["slug"]),
     "tagged_vlans": set(["name", "site", "vlan_group", "tenant"]),
     "tenant": set(["slug"]),

tests/integration/v2.6/tasks/netbox_service.yml

@@ -58,6 +58,7 @@
       - test_service_idempotence['services']['port'] == 9100
       - test_service_idempotence['services']['protocol'] == 6
       - test_service_idempotence['msg'] == "services node-exporter already exists"
+
 - name: "NETBOX_SERVICE: Test update"
   netbox_service:
     netbox_url: "http://localhost:32768"
@@ -66,19 +67,19 @@
       device: "FOR_SERVICE"
       name: "node-exporter"
       port: 9100
-      protocol: UDP
+      description: "Service updated"
+      protocol: TCP
     state: present
   register: test_service_update
 
 - name: "NETBOX_SERVICE ASSERT - Service has been updated"
   assert:
     that:
       - test_service_update is changed
-      - test_service_update['diff']['before']['protocol'] == 6
-      - test_service_update['diff']['after']['protocol'] == 17
+      - test_service_update['diff']['after']['description'] == "Service updated"
       - test_service_update['msg'] == "services node-exporter updated"
 
-- name: "NETBOX_SERVICE: Test service deletion"
+- name: "NETBOX_SERVICE: Test same details, but different protocol - Create"
   netbox_service:
     netbox_url: "http://localhost:32768"
     netbox_token: "0123456789abcdef0123456789abcdef01234567"
@@ -87,6 +88,29 @@
       name: "node-exporter"
       port: 9100
       protocol: UDP
+    state: present
+  register: test_service_protocol
+
+- name: "NETBOX_SERVICE ASSERT - Different protocol - Create"
+  assert:
+    that:
+      - test_service_protocol is changed
+      - test_service_protocol['diff']['after']['state'] == "present"
+      - test_service_protocol['diff']['before']['state'] == "absent"
+      - test_service_protocol['services']['name'] == "node-exporter"
+      - test_service_protocol['services']['port'] == 9100
+      - test_service_protocol['services']['protocol'] == 17
+      - test_service_protocol['msg'] == "services node-exporter created"
+
+- name: "NETBOX_SERVICE: Test service deletion"
+  netbox_service:
+    netbox_url: "http://localhost:32768"
+    netbox_token: "0123456789abcdef0123456789abcdef01234567"
+    data:
+      device: "FOR_SERVICE"
+      name: "node-exporter"
+      port: 9100
+      protocol: TCP
     state: absent
   register: test_service_delete
 

tests/integration/v2.7/tasks/netbox_service.yml

@@ -67,7 +67,7 @@
       device: "FOR_SERVICE"
       name: "node-exporter"
       port: 9100
-      protocol: UDP
+      protocol: TCP
       tags:
         - "Schnozzberry"
     state: present
@@ -77,11 +77,32 @@
   assert:
     that:
       - test_service_update is changed
-      - test_service_update['diff']['before']['protocol'] == "tcp"
-      - test_service_update['diff']['after']['protocol'] == "udp"
       - test_service_update['diff']['after']['tags'][0] == "Schnozzberry"
       - test_service_update['msg'] == "services node-exporter updated"
 
+- name: "NETBOX_SERVICE: Test same details, but different protocol - Create"
+  netbox_service:
+    netbox_url: "http://localhost:32768"
+    netbox_token: "0123456789abcdef0123456789abcdef01234567"
+    data:
+      device: "FOR_SERVICE"
+      name: "node-exporter"
+      port: 9100
+      protocol: UDP
+    state: present
+  register: test_service_protocol
+
+- name: "NETBOX_SERVICE ASSERT - Different protocol - Create"
+  assert:
+    that:
+      - test_service_protocol is changed
+      - test_service_protocol['diff']['after']['state'] == "present"
+      - test_service_protocol['diff']['before']['state'] == "absent"
+      - test_service_protocol['services']['name'] == "node-exporter"
+      - test_service_protocol['services']['port'] == 9100
+      - test_service_protocol['services']['protocol'] == "udp"
+      - test_service_protocol['msg'] == "services node-exporter created"
+
 - name: "NETBOX_SERVICE: Test service deletion"
   netbox_service:
     netbox_url: "http://localhost:32768"

tests/integration/v2.8/tasks/netbox_service.yml

@@ -67,7 +67,7 @@
       device: "FOR_SERVICE"
       name: "node-exporter"
       port: 9100
-      protocol: UDP
+      protocol: TCP
       tags:
         - "Schnozzberry"
     state: present
@@ -77,11 +77,32 @@
   assert:
     that:
       - test_service_update is changed
-      - test_service_update['diff']['before']['protocol'] == "tcp"
-      - test_service_update['diff']['after']['protocol'] == "udp"
       - test_service_update['diff']['after']['tags'][0] == "Schnozzberry"
       - test_service_update['msg'] == "services node-exporter updated"
 
+- name: "NETBOX_SERVICE: Test same details, but different protocol - Create"
+  netbox_service:
+    netbox_url: "http://localhost:32768"
+    netbox_token: "0123456789abcdef0123456789abcdef01234567"
+    data:
+      device: "FOR_SERVICE"
+      name: "node-exporter"
+      port: 9100
+      protocol: UDP
+    state: present
+  register: test_service_protocol
+
+- name: "NETBOX_SERVICE ASSERT - Different protocol - Create"
+  assert:
+    that:
+      - test_service_protocol is changed
+      - test_service_protocol['diff']['after']['state'] == "present"
+      - test_service_protocol['diff']['before']['state'] == "absent"
+      - test_service_protocol['services']['name'] == "node-exporter"
+      - test_service_protocol['services']['port'] == 9100
+      - test_service_protocol['services']['protocol'] == "udp"
+      - test_service_protocol['msg'] == "services node-exporter created"
+
 - name: "NETBOX_SERVICE: Test service deletion"
   netbox_service:
     netbox_url: "http://localhost:32768"