Enhance label handling and target retrieval in serializers (#17)

- Updated add_netbox_labels method to accept an optional target_name parameter for better label customization.
- Introduced get_configcontext_fields method to parse config context labels from query parameters.
- Modified get_labels method to conditionally use target_in_name query parameter for label generation.
- Refactored get_targets function to improve clarity and added support for 'cimc' interface type.

Author: stefanhipfel

netbox_atlas_plugin/api/labels.py

@@ -1,15 +1,19 @@
 class LabelDict(dict):
 
-    def add_netbox_labels(self, obj):
+    def add_netbox_labels(self, obj, target_name=None):
         self.__setitem__('server_id', str(obj.id))
         if getattr(obj, "status", None) is not None:
             self.__setitem__('status', obj.status)
 
         if getattr(obj, "display_name", None) is not None:
             self.__setitem__('name', obj.display_name)
+            if target_name:
+                self.__setitem__('name', f"{obj.display_name}-{target_name}")
 
         if getattr(obj, "name", None) is not None:
             self.__setitem__('name', obj.name)
+            if target_name:
+                self.__setitem__('name', f"{obj.name}-{target_name}")
 
         if getattr(obj, "device_type", None) is not None:
             self.__setitem__('manufacturer', obj.device_type.manufacturer.slug)

netbox_atlas_plugin/api/serializers.py

@@ -3,7 +3,6 @@
 from virtualization.models import VirtualMachine
 from dcim.models import Device
 from netaddr import IPNetwork
-
 from .labels import LabelDict
 
 
@@ -35,15 +34,56 @@ def get_custom_fields(self):
                 if len(label) == 2:
                     fields[label[0]] = label[1]
         return fields
+    
+    @cached_property
+    def get_configcontext_fields(self):
+        cl = self.context['request'].query_params.get('configcontext_labels', None)
+        fields = []
+        if cl:
+            fields = cl.split(';')
+        return fields
+
+    def get_url(self, dv):
+        return {
+            'url': self.context['request'].build_absolute_uri(dv.get_absolute_url())
+        }
+
+    def get_configcontext(self, dv):
+        ctx = {}
+        for pair in self.get_configcontext_fields:
+            label = pair.split('=')
+            if len(label) == 2:
+                data = dv.local_context_data
+                if data is None:
+                    return ctx
+                *path, last = label[1].split(".")
+                for bit in path:
+                    if bit.isdigit():
+                        data = data[int(bit)]
+                    else:
+                        data = data.setdefault(bit, {})
+                if last.isdigit():
+                    last= int(last)
+                try:
+                    ctx[label[0]] = data[last]
+                except KeyError as e:
+                    pass
+
+        return ctx
 
     def get_targets(self, dv):
         return get_targets(dv, self.get_target_field)
 
     def get_labels(self, dv):
         labels = LabelDict()
 
-        labels.add_netbox_labels(dv)
+        if self.context['request'].query_params.get('target_in_name', False):
+            labels.add_netbox_labels(dv, None)
+        else:
+            labels.add_netbox_labels(dv, self.get_target_field)
         labels.add_custom_labels(self.get_custom_fields)
+        labels.add_custom_labels(self.get_configcontext(dv))
+        labels.add_custom_labels(self.get_url(dv))
         labels.add_metrics_label(self.get_metrics_field)
 
         return labels
@@ -90,33 +130,38 @@ def get_labels(self, obj):
         return labels
 
 
-def get_targets(vm, target):
-    if target == "primary_ip":
-        if getattr(vm, "primary_ip", None) is not None:
-            return [str(IPNetwork(vm.primary_ip.address).ip)]
-        if getattr(vm, "primary_ip4", None) is not None:
-            return [str(IPNetwork(vm.primary_ip4.address).ip)]
-    elif target == "mgmt_only":
+def get_targets(obj, interface_name):
+    if interface_name == "primary_ip":
+        if getattr(obj, "primary_ip", None) is not None:
+            return [str(IPNetwork(obj.primary_ip.address).ip)]
+        if getattr(obj, "primary_ip4", None) is not None:
+            return [str(IPNetwork(obj.primary_ip4.address).ip)]
+    elif interface_name == "mgmt_only":
         targets = []
-        if hasattr(vm, "interfaces") and vm.interfaces is not None:
-            result = vm.interfaces.filter(mgmt_only=True)
+        if hasattr(obj, "interfaces") and obj.interfaces is not None:
+            result = obj.interfaces.filter(mgmt_only=True)
             targets = get_interface_addresses(result)
         return targets
-    elif target ==  "loopback10":
+    elif interface_name ==  "loopback10":
         targets = []
-        if hasattr(vm, "interfaces") and vm.interfaces is not None:
-            result = vm.interfaces.filter(name='Loopback10')
+        if hasattr(obj, "interfaces") and obj.interfaces is not None:
+            result = obj.interfaces.filter(name='Loopback10')
             targets = get_interface_addresses(result)
         return  targets
+    elif interface_name == "cimc":
+        targets = []
+        if hasattr(obj, "interfaces") and obj.interfaces is not None:
+            result = obj.interfaces.filter(name='cimc')
+            targets = get_interface_addresses(result)
+        return targets
     else:
-        if hasattr(vm, "primary_ip") and vm.primary_ip is not None:
-            return [str(IPNetwork(vm.primary_ip.address).ip)]
-
+        if hasattr(obj, "primary_ip") and obj.primary_ip is not None:
+            return [str(IPNetwork(obj.primary_ip.address).ip)]
 
 def get_interface_addresses(interfaces):
     interfaces = [i for i in map(map_ip_address, interfaces) if i is not None]
     return interfaces
 
 def map_ip_address(interface):
     if len(interface.ip_addresses.all()) > 0:
-        return str(IPNetwork(interface.ip_addresses.first().address).ip)
+        return str(IPNetwork(interface.ip_addresses.first().address).ip)