tidy tunnel_group code and tests

Author: richbibby

plugins/modules/netbox_tunnel.py

@@ -47,7 +47,7 @@
       encapsulation:
         description:
           - The encapsulation protocol or technique employed to effect the tunnel
-        required: false
+        required: true
         type: raw
       ipsec_profile:
         description:
@@ -101,7 +101,6 @@
         netbox_token: thisIsMyToken
         data:
           name: Test Tunnel
-          status: active
           encapsulation: ipsec-tunnel
         state: present
 
@@ -111,6 +110,7 @@
         netbox_token: thisIsMyToken
         data:
           name: Test Tunnel
+          encapsulation: ipsec-tunnel
         state: absent
 
     - name: Create tunnel with all information
@@ -127,7 +127,7 @@
           tenant: Test Tenant
           tunnel_id: 200
           tags:
-            - test
+            - Schnozzberry
         state: present
 """
 
@@ -167,7 +167,16 @@ def main():
                     name=dict(required=True, type="str"),
                     status=dict(required=False, type="raw"),
                     tunnel_group=dict(required=False, type="raw"),
-                    encapsulation=dict(required=False, type="raw"),
+                    encapsulation=dict(
+                        required=True, 
+                        type="str",
+                        choices=[
+                            "ipsec-transport",
+                            "ipsec-tunnel",
+                            "ip-ip",
+                            "gre",
+                        ],
+                    ),
                     ipsec_profile=dict(required=False, type="raw"),
                     tenant=dict(required=False, type="raw"),
                     tunnel_id=dict(required=False, type="int"),
@@ -180,7 +189,9 @@ def main():
         )
     )
 
-    required_if = [("state", "present", ["name"]), ("state", "absent", ["name"])]
+    required_if = [("state", "present", ["name", "encapsulation"]),
+                  ("state", "absent", ["name", "encapsulation"]),
+    ]
 
     module = NetboxAnsibleModule(
         argument_spec=argument_spec, supports_check_mode=True, required_if=required_if

plugins/modules/netbox_tunnel_group.py

@@ -12,7 +12,7 @@
 module: netbox_tunnel_group
 short_description: Create, update or delete tunnel groups within NetBox
 description:
-  - Creates, updates or deletes tunnel groups from NetBox
+  - Creates, updates or deletes tunnel groups within NetBox
 notes:
   - Tags should be defined as a YAML list
   - This should be ran with connection C(local) and hosts C(localhost)
@@ -35,6 +35,12 @@
           - The name of the tunnel group
         required: true
         type: str
+      slug:
+        description:
+          - The slugified version of the name or custom slug.
+          - This is auto-generated following NetBox rules if not provided
+        required: false
+        type: str
       description:
         description:
           - The description of the tunnel group
@@ -65,15 +71,15 @@
         netbox_url: http://netbox.local
         netbox_token: thisIsMyToken
         data:
-          name: Test Cluster Group
+          name: Test Tunnel Group
         state: present
 
     - name: Delete tunnel group within netbox
       netbox.netbox.netbox_tunnel_group:
         netbox_url: http://netbox.local
         netbox_token: thisIsMyToken
         data:
-          name: Test Cluster Group
+          name: Test Tunnel Group
         state: absent
 """
 
@@ -111,6 +117,7 @@ def main():
                 required=True,
                 options=dict(
                     name=dict(required=True, type="str"),
+                    slug=dict(required=False, type="str"),
                     description=dict(required=False, type="str"),
                     tags=dict(required=False, type="list", elements="raw"),
                     custom_fields=dict(required=False, type="dict"),

tests/integration/targets/v3.7/tasks/netbox_tunnel.yml

@@ -52,6 +52,7 @@
     netbox_token: "0123456789abcdef0123456789abcdef01234567"
     data:
       name: Test Tunnel
+      encapsulation: ipsec-tunnel
       description: Test Description
       tenant: Test Tenant
       tunnel_id: 200
@@ -73,6 +74,7 @@
       - test_three['tunnel']['tunnel_id'] == 200
       - test_three['tunnel']['description'] == "Test Description"
       - test_three['tunnel']['tags'][0] == 4
+      - test_three['tunnel']['encapsulation'] == "ipsec-tunnel"
       - test_three['msg'] == "tunnel Test Tunnel updated"
 
 - name: "TUNNEL 4: Delete"
@@ -81,6 +83,7 @@
     netbox_token: "0123456789abcdef0123456789abcdef01234567"
     data:
       name: Test Tunnel
+      encapsulation: ipsec-tunnel
     state: absent
   register: test_four
 

tests/integration/targets/v3.7/tasks/netbox_tunnel_group.yml

@@ -7,7 +7,7 @@
 - name: "TUNNEL_GROUP 1: Necessary info creation"
   netbox.netbox.netbox_tunnel_group:
     netbox_url: http://localhost:32768
-    netbox_token: "6bd1da4f7657a0748667f64b5786710383627d9a"
+    netbox_token: "0123456789abcdef0123456789abcdef01234567"
     data:
       name: Test Tunnel Group
     state: present
@@ -26,7 +26,7 @@
 - name: "TUNNEL_GROUP 2: Create duplicate"
   netbox.netbox.netbox_tunnel_group:
     netbox_url: http://localhost:32768
-    netbox_token: "6bd1da4f7657a0748667f64b5786710383627d9a"
+    netbox_token: "0123456789abcdef0123456789abcdef01234567"
     data:
       name: Test Tunnel Group
     state: present
@@ -43,7 +43,7 @@
 - name: "TUNNEL_GROUP 3: Update Existing"
   netbox.netbox.netbox_tunnel_group:
     netbox_url: http://localhost:32768
-    netbox_token: "6bd1da4f7657a0748667f64b5786710383627d9a"
+    netbox_token: "0123456789abcdef0123456789abcdef01234567"
     data:
       name: Test Tunnel Group
       description: Test Description
@@ -59,14 +59,15 @@
       - test_three['diff']['after']['description'] == "Test Description"
       - test_three['diff']['after']['tags'][0] == 4
       - test_three['tunnel_group']['name'] == "Test Tunnel Group"
+      - test_three['tunnel_group']['slug'] == "test-tunnel-group"
       - test_three['tunnel_group']['description'] == "Test Description"
       - test_three['tunnel_group']['tags'][0] == 4
       - test_three['msg'] == "tunnel_group Test Tunnel Group updated"
 
 - name: "TUNNEL_GROUP 4: Delete"
   netbox.netbox.netbox_tunnel_group:
     netbox_url: http://localhost:32768
-    netbox_token: "6bd1da4f7657a0748667f64b5786710383627d9a"
+    netbox_token: "0123456789abcdef0123456789abcdef01234567"
     data:
       name: Test Tunnel Group
     state: absent

tests/integration/targets/v4.0/tasks/netbox_tunnel.yml

@@ -52,6 +52,7 @@
     netbox_token: "0123456789abcdef0123456789abcdef01234567"
     data:
       name: Test Tunnel
+      encapsulation: ipsec-tunnel
       description: Test Description
       tenant: Test Tenant
       tunnel_id: 200
@@ -73,6 +74,7 @@
       - test_three['tunnel']['tunnel_id'] == 200
       - test_three['tunnel']['description'] == "Test Description"
       - test_three['tunnel']['tags'][0] == 4
+      - test_three['tunnel']['encapsulation'] == "ipsec-tunnel"
       - test_three['msg'] == "tunnel Test Tunnel updated"
 
 - name: "TUNNEL 4: Delete"
@@ -81,6 +83,7 @@
     netbox_token: "0123456789abcdef0123456789abcdef01234567"
     data:
       name: Test Tunnel
+      encapsulation: ipsec-tunnel
     state: absent
   register: test_four
 

tests/integration/targets/v4.0/tasks/netbox_tunnel_group.yml

@@ -7,7 +7,7 @@
 - name: "TUNNEL_GROUP 1: Necessary info creation"
   netbox.netbox.netbox_tunnel_group:
     netbox_url: http://localhost:32768
-    netbox_token: "6bd1da4f7657a0748667f64b5786710383627d9a"
+    netbox_token: "0123456789abcdef0123456789abcdef01234567"
     data:
       name: Test Tunnel Group
     state: present
@@ -26,7 +26,7 @@
 - name: "TUNNEL_GROUP 2: Create duplicate"
   netbox.netbox.netbox_tunnel_group:
     netbox_url: http://localhost:32768
-    netbox_token: "6bd1da4f7657a0748667f64b5786710383627d9a"
+    netbox_token: "0123456789abcdef0123456789abcdef01234567"
     data:
       name: Test Tunnel Group
     state: present
@@ -43,7 +43,7 @@
 - name: "TUNNEL_GROUP 3: Update Existing"
   netbox.netbox.netbox_tunnel_group:
     netbox_url: http://localhost:32768
-    netbox_token: "6bd1da4f7657a0748667f64b5786710383627d9a"
+    netbox_token: "0123456789abcdef0123456789abcdef01234567"
     data:
       name: Test Tunnel Group
       description: Test Description
@@ -66,7 +66,7 @@
 - name: "TUNNEL_GROUP 4: Delete"
   netbox.netbox.netbox_tunnel_group:
     netbox_url: http://localhost:32768
-    netbox_token: "6bd1da4f7657a0748667f64b5786710383627d9a"
+    netbox_token: "0123456789abcdef0123456789abcdef01234567"
     data:
       name: Test Tunnel Group
     state: absent