[nautobot] add support for interface roles to the excel interfaces... interface

alextremblay · alextremblay · commit 065b71fb30ba · 2024-09-18T16:55:46.000-04:00
diff --git a/projects/nautobot/uoft_nautobot/excel.py b/projects/nautobot/uoft_nautobot/excel.py
@@ -4,10 +4,11 @@
 from django.views.generic import View
 from django.http import HttpResponse, StreamingHttpResponse
 from django.shortcuts import render
+from django.contrib.contenttypes.models import ContentType
 from tempfile import NamedTemporaryFile
 
 from nautobot.dcim.models import Interface, Device
-from nautobot.extras.models import Status, Tag
+from nautobot.extras.models import Status, Tag, Role
 from nautobot.ipam.models import VLAN, VLANGroup, IPAddress
 from nautobot.dcim.models.device_components import (
     InterfaceModeChoices,
@@ -55,8 +56,10 @@ def __init__(self, pk) -> None:
         self.interface_types_inverse = {v: k for k, v in self.interface_types.items()}
         self.statuses = InterfaceStatusChoices.as_dict().values()
         self.vlan_modes = InterfaceModeChoices.values()
+        _roles_ct = ContentType.objects.get(app_label="dcim", model="interface")
+        self.valid_roles = list(Role.objects.filter(content_types=_roles_ct))
 
-        # 
+        #
         if self.device_obj.vlan_group:
             self.vlan_group = self.device_obj.vlan_group
         else:
@@ -82,6 +85,7 @@ def _vlan_to_string(vlan):
         {
             "Name": "name",
             "Status": "status.name",
+            "Role": Coalesce("role.name", default=""),
             "Label": "label",
             "Type": ("type", lambda t: ctx.interface_types[t]),
             "Enabled": "enabled",
@@ -99,7 +103,6 @@ def _vlan_to_string(vlan):
                 "ip_addresses",
                 ([("address", str)], lambda lst: "\n".join(lst)),
             ),
-            # intf["IP Addresses"] = "\n".join([str(ip) for ip in intf["ip_addresses"]])
             "Custom Fields": (
                 "cf",
                 (
@@ -156,6 +159,9 @@ def _vlan_to_string(vlan):
     dvws["D1"] = "valid vlans"
     for i, v in enumerate(ctx.valid_vlans):
         dvws[f"D{i+2}"] = _vlan_to_string(v)
+    dvws["E1"] = "roles"
+    for i, r in enumerate(ctx.valid_roles):
+        dvws[f"E{i+2}"] = r.name
 
     # boolean columns
     bool_dv = DataValidation(type="list", formula1='"TRUE,FALSE"')
@@ -166,18 +172,14 @@ def _vlan_to_string(vlan):
         bool_dv.add(f"{col_letter}2:{col_letter}{length}")
 
     # LAG column
-    lag_dv = DataValidation(
-        type="list", formula1=f"'Interfaces'!$A$2:$A${length}", allow_blank=True
-    )
+    lag_dv = DataValidation(type="list", formula1=f"'Interfaces'!$A$2:$A${length}", allow_blank=True)
     lag_dv.hide_drop_down = False
     ws.add_data_validation(lag_dv)
     col_letter = get_column_letter(columns_by_name["LAG"])
     lag_dv.add(f"{col_letter}2:{col_letter}{length}")
 
     # status
-    status_dv = DataValidation(
-        type="list", formula1=f"'_data_validation_lists'!$A$2:$A${len(ctx.statuses)+1}"
-    )
+    status_dv = DataValidation(type="list", formula1=f"'_data_validation_lists'!$A$2:$A${len(ctx.statuses)+1}")
     status_dv.hide_drop_down = False
     ws.add_data_validation(status_dv)
     col_letter = get_column_letter(columns_by_name["Status"])
@@ -215,6 +217,17 @@ def _vlan_to_string(vlan):
     col_letter = get_column_letter(columns_by_name["Untagged VLAN"])
     vlans_dv.add(f"{col_letter}2:{col_letter}{length}")
 
+    # roles
+    roles_dv = DataValidation(
+        type="list",
+        formula1=f"'_data_validation_lists'!$E$2:$E${len(ctx.valid_roles)+1}",
+        allow_blank=True,
+    )
+    roles_dv.hide_drop_down = False
+    ws.add_data_validation(roles_dv)
+    col_letter = get_column_letter(columns_by_name["Role"])
+    roles_dv.add(f"{col_letter}2:{col_letter}{length}")
+
     with NamedTemporaryFile() as tmp:
         wb.save(tmp.name)
         tmp.seek(0)
@@ -256,9 +269,7 @@ def _parse_ipaddress_list(ips: str):
         if not ips:
             return []
         return [
-            IPAddress.objects.get_or_create(
-                address=ip, defaults=dict(status=Status.objects.get(name="Active"))
-            )[0]
+            IPAddress.objects.get_or_create(address=ip, defaults=dict(status=Status.objects.get(name="Active")))[0]
             for ip in ips.split("\n")
         ]
 
@@ -283,12 +294,11 @@ def _parse_tags(tags):
                             ),
                             "label": ("Label", lambda l: l if l else ""),
                             "type": ("Type", lambda t: ctx.interface_types_inverse[t]),
+                            "role": ("Role", lambda r: Role.objects.get(name=r) if r else None),
                             "enabled": "Enabled",
                             "lag": (
                                 "LAG",
-                                lambda l: Interface.objects.get(name=l, device_id=pk)
-                                if l
-                                else None,
+                                lambda l: Interface.objects.get(name=l, device_id=pk) if l else None,
                             ),
                             "mgmt_only": "Management Only",
                             "description": ("Description", lambda d: d if d else ""),
@@ -366,9 +376,7 @@ def excel_processing():
             # We've been sent here by the widget on the device page
             # but the data we've been sent here with failed server-side validation.
             # We need to render the form again, but with the errors from the form included
-            form_html = render(
-                request, "device_interfaces_excel.html", {"form": form, "pk": pk}
-            )
+            form_html = render(request, "device_interfaces_excel.html", {"form": form, "pk": pk})
             return form_html
             # return HttpResponse(f"<div class='alert alert-danger'>Invalid file format. Please try again and make sure you're uploading a .xlsx file</div>{form_html.content}")
 
