Bugfix: Build rear_port and front_port to dictionary including provided device (#267)

Author: toerb

plugins/module_utils/netbox_dcim.py

@@ -52,6 +52,23 @@
 
 class NetboxDcimModule(NetboxModule):
     def __init__(self, module, endpoint):
+        # Front ports can only be connected to rear ports of the same device
+        # This will prepare the rear port dict if only a string is given
+        if endpoint == "front_ports":
+            if isinstance(module.params.get("data").get("rear_port"), str):
+                rear_port = {
+                    "device": module.params.get("data").get("device"),
+                    "name": module.params.get("data").get("rear_port"),
+                }
+                module.params["data"].update({"rear_port": rear_port})
+        elif endpoint == "front_port_templates":
+            if isinstance(module.params.get("data").get("rear_port_template"), str):
+                rear_port_template = {
+                    "device_type": module.params.get("data").get("device_type"),
+                    "name": module.params.get("data").get("rear_port_template"),
+                }
+                module.params["data"].update({"rear_port_template": rear_port_template})
+
         super().__init__(module, endpoint)
 
     def run(self):

plugins/module_utils/netbox_utils.py

@@ -114,6 +114,7 @@
     rack_group="slug",
     rack_role="slug",
     rear_port="name",
+    rear_port_template="name",
     region="slug",
     rir="slug",
     slug="slug",
@@ -173,6 +174,7 @@
     "rack_role": "rack_roles",
     "region": "regions",
     "rear_port": "rear_ports",
+    "rear_port_template": "rear_port_templates",
     "rir": "rirs",
     "services": "services",
     "site": "sites",
@@ -372,6 +374,8 @@
     "prefix_role": "role",
     "rack_group": "group",
     "rack_role": "role",
+    "rear_port_template": "rear_port",
+    "rear_port_template_position": "rear_port_position",
     "tenant_group": "group",
     "termination_a": "termination_a_id",
     "termination_b": "termination_b_id",

plugins/modules/netbox_front_port_template.py

@@ -57,7 +57,7 @@
         type: str
       type:
         description:
-          - The type of the front port
+          - The type of the front port template
         choices:
           - 8p8c
           - 110-punch
@@ -75,14 +75,14 @@
           - st
         required: true
         type: str
-      rear_port:
+      rear_port_template:
         description:
-          - The rear_port the front port is attached to
+          - The rear_port_template the front port template is attached to
         required: true
         type: raw        
-      rear_port_position:
+      rear_port_template_position:
         description:
-          - The position of the rear port this front port is connected to
+          - The position of the rear port template this front port template is connected to
         required: false
         type: int
   state:
@@ -120,7 +120,7 @@
           name: Test Front Port Template
           device_type: Test Device Type
           type: bnc
-          rear_port: Test Rear Port
+          rear_port_template: Test Rear Port Template
         state: present
 
     - name: Update front port template with other fields
@@ -131,8 +131,8 @@
           name: Test Front Port Template
           device_type: Test Device Type
           type: bnc
-          rear_port: Test Rear Port
-          rear_port_position: 5
+          rear_port_template: Test Rear Port Template
+          rear_port_template_position: 5
         state: present
 
     - name: Delete front port template within netbox
@@ -143,7 +143,7 @@
           name: Test Front Port Template
           device_type: Test Device Type
           type: bnc
-          rear_port: Test Rear Port
+          rear_port_template: Test Rear Port Template
         state: absent
 """
 
@@ -202,16 +202,16 @@ def main():
                         ],
                         type="str",
                     ),
-                    rear_port=dict(required=True, type="raw"),
-                    rear_port_position=dict(required=False, type="int"),
+                    rear_port_template=dict(required=True, type="raw"),
+                    rear_port_template_position=dict(required=False, type="int"),
                 ),
             ),
         )
     )
 
     required_if = [
-        ("state", "present", ["device_type", "name", "type", "rear_port"]),
-        ("state", "absent", ["device_type", "name", "type", "rear_port"]),
+        ("state", "present", ["device_type", "name", "type", "rear_port_template"]),
+        ("state", "absent", ["device_type", "name", "type", "rear_port_template"]),
     ]
 
     module = NetboxAnsibleModule(

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

@@ -124,3 +124,27 @@
       - test_five['diff']['before']['state'] == "present"
       - test_five['diff']['after']['state'] == "absent"
       - test_five['msg'] == "front_port Front Port 2 deleted"
+
+- name: "FRONT_PORT 6: Create duplicate with rear_port dictionary"
+  netbox.netbox.netbox_front_port:
+    netbox_url: http://localhost:32768
+    netbox_token: 0123456789abcdef0123456789abcdef01234567
+    data:
+      name: Front Port
+      device: test100
+      type: bnc
+      rear_port:
+        device: test100
+        name: Rear Port
+    state: present
+  register: test_six
+
+- name: "FRONT_PORT 6: ASSERT - Create duplicate with rear_port dictionary"
+  assert:
+    that:
+      - not test_six['changed']
+      - test_six['front_port']['name'] == "Front Port"
+      - test_six['front_port']['device'] == 1
+      - test_six['front_port']['type'] == "bnc"
+      - test_six['front_port']['rear_port'] == 1
+      - test_six['msg'] == "front_port Front Port already exists"

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

@@ -15,7 +15,7 @@
       name: Front Port Template
       device_type: Cisco Test
       type: bnc
-      rear_port: Rear Port
+      rear_port_template: Rear Port Template
     state: present
   register: test_one
 
@@ -39,7 +39,7 @@
       name: Front Port Template
       device_type: Cisco Test
       type: bnc
-      rear_port: Rear Port
+      rear_port_template: Rear Port Template
     state: present
   register: test_two
 
@@ -61,8 +61,8 @@
       name: Front Port Template
       device_type: Cisco Test
       type: bnc
-      rear_port: Rear Port
-      rear_port_position: 5
+      rear_port_template: Rear Port Template
+      rear_port_template_position: 5
     state: present
   register: test_three
 
@@ -86,7 +86,7 @@
       name: Front Port Template 2
       device_type: Cisco Test
       type: bnc
-      rear_port: Rear Port
+      rear_port_template: Rear Port Template
     state: present
   register: test_four
 
@@ -110,7 +110,7 @@
       name: Front Port Template 2
       device_type: Cisco Test
       type: bnc
-      rear_port: Rear Port
+      rear_port_template: Rear Port Template
     state: absent
   register: test_five
 
@@ -121,3 +121,27 @@
       - test_five['diff']['before']['state'] == "present"
       - test_five['diff']['after']['state'] == "absent"
       - test_five['msg'] == "front_port_template Front Port Template 2 deleted"
+
+- name: "FRONT_PORT 6: Create duplicate with rear_port_template dictionary"
+  netbox.netbox.netbox_front_port_template:
+    netbox_url: http://localhost:32768
+    netbox_token: 0123456789abcdef0123456789abcdef01234567
+    data:
+      name: Front Port Template
+      device_type: Cisco Test
+      type: bnc
+      rear_port_template:
+        device: Cisco Test
+        name: Rear Port Template
+    state: present
+  register: test_six
+
+- name: "FRONT_PORT 6: ASSERT - Create duplicate with rear_port_template dictionary"
+  assert:
+    that:
+      - not test_six['changed']
+      - test_six['front_port_template']['name'] == "Front Port Template"
+      - test_six['front_port_template']['device_type'] == 1
+      - test_six['front_port_template']['type'] == "bnc"
+      - test_six['front_port_template']['rear_port'] == 1
+      - test_six['msg'] == "front_port_template Front Port Template already exists"

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

@@ -115,3 +115,25 @@
       - test_five['diff']['before']['state'] == "present"
       - test_five['diff']['after']['state'] == "absent"
       - test_five['msg'] == "rear_port Rear Port 2 deleted"
+
+- name: "REAR_PORT 6: Create second Rear Port"
+  netbox.netbox.netbox_rear_port:
+    netbox_url: http://localhost:32768
+    netbox_token: 0123456789abcdef0123456789abcdef01234567
+    data:
+      name: Rear Port
+      device: Test Nexus One
+      type: bnc
+    state: present
+  register: test_six
+
+- name: "REAR_PORT 6: ASSERT - Create second Rear Port"
+  assert:
+    that:
+      - test_six is changed
+      - test_six['diff']['before']['state'] == "absent"
+      - test_six['diff']['after']['state'] == "present"
+      - test_six['rear_port']['name'] == "Rear Port"
+      - test_six['rear_port']['device'] == 4
+      - test_six['rear_port']['type'] == "bnc"
+      - test_six['msg'] == "rear_port Rear Port created"

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

@@ -112,3 +112,25 @@
       - test_five['diff']['before']['state'] == "present"
       - test_five['diff']['after']['state'] == "absent"
       - test_five['msg'] == "rear_port_template Rear Port Template 2 deleted"
+
+- name: "REAR_PORT_TEMPLATE 6: Create second Rear Port Template"
+  netbox.netbox.netbox_rear_port_template:
+    netbox_url: http://localhost:32768
+    netbox_token: 0123456789abcdef0123456789abcdef01234567
+    data:
+      name: Rear Port Template 2
+      device_type: Arista Test
+      type: bnc
+    state: present
+  register: test_six
+
+- name: "REAR_PORT_TEMPLATE 6: ASSERT - Create second Rear Port Template"
+  assert:
+    that:
+      - test_six is changed
+      - test_six['diff']['before']['state'] == "absent"
+      - test_six['diff']['after']['state'] == "present"
+      - test_six['rear_port_template']['name'] == "Rear Port Template 2"
+      - test_six['rear_port_template']['device_type'] == 2
+      - test_six['rear_port_template']['type'] == "bnc"
+      - test_six['msg'] == "rear_port_template Rear Port Template 2 created"