Implement component UI (#268)

Co-authored-by: mzb <marek@zbroch.com>

Author: gsnider2195

.github/workflows/ci.yml

@@ -107,7 +107,7 @@ jobs:
       fail-fast: true
       matrix:
         python-version: ["3.11"]
-        nautobot-version: ["2.4.2"]
+        nautobot-version: ["2.4.19"]
     env:
       INVOKE_NAUTOBOT_BGP_MODELS_PYTHON_VER: "${{ matrix.python-version }}"
       INVOKE_NAUTOBOT_BGP_MODELS_NAUTOBOT_VER: "${{ matrix.nautobot-version }}"
@@ -153,13 +153,13 @@ jobs:
     strategy:
       fail-fast: true
       matrix:
-        python-version: ["3.9"]  # 3.12 stable is tested in unittest_report stage.
+        python-version: ["3.10"]  # 3.12 stable is tested in unittest_report stage.
         db-backend: ["postgresql"]
         nautobot-version: ["stable"]
         include:
           - python-version: "3.11"
             db-backend: "postgresql"
-            nautobot-version: "2.4.2"
+            nautobot-version: "2.4.19"
           - python-version: "3.12"
             db-backend: "mysql"
             nautobot-version: "stable"

changes/268.changed

@@ -0,0 +1 @@
+Changed minimum Nautobot version to 2.4.19.

changes/268.housekeeping

@@ -0,0 +1 @@
+Migrated views to the UI Component Framework.

invoke.example.yml

@@ -1,6 +1,6 @@
 ---
 nautobot_bgp_models:
-  nautobot_ver: "2.4.2"
+  nautobot_ver: "2.4.19"
   python_ver: "3.11"
   # local: false
   # compose_dir: "/full/path/to/nautobot-app-bgp-models/development"

invoke.mysql.yml

@@ -1,7 +1,7 @@
 ---
 nautobot_bgp_models:
   project_name: "nautobot-bgp-models"
-  nautobot_ver: "2.4.2"
+  nautobot_ver: "2.4.19"
   local: false
   python_ver: "3.11"
   compose_dir: "development"

nautobot_bgp_models/__init__.py

@@ -19,7 +19,7 @@ class NautobotBGPModelsConfig(NautobotAppConfig):
     description = "Nautobot BGP Models App."
     base_url = "bgp"
     required_settings = []
-    min_version = "2.0.3"
+    min_version = "2.4.15"
     max_version = "2.9999"
     default_settings = {
         "default_statuses": {

nautobot_bgp_models/api/serializers.py

@@ -62,11 +62,11 @@ class ExtraAttributesSerializerMixin(serializers.Serializer):  # pylint: disable
     def to_representation(self, instance):
         """Render the model instance to a Python dict.
 
-        If `include_inherited` is specified as a request parameter, include object's get_extra_attributes().
+        If `include_inherited` is specified as a request parameter, include object's extra_attributes_inherited.
         """
         req = self.context["request"]
         if hasattr(req, "query_params") and is_truthy(req.query_params.get("include_inherited", False)):
-            setattr(instance, "extra_attributes", instance.get_extra_attributes())
+            setattr(instance, "extra_attributes", instance.extra_attributes_inherited)
         return super().to_representation(instance)
 
 

nautobot_bgp_models/models.py

@@ -98,7 +98,8 @@ def get_extra_attributes_paths(self):
 
         return [rgetattr(self, f"{x}.extra_attributes", None) for x in paths]
 
-    def get_extra_attributes(self):
+    @property
+    def extra_attributes_inherited(self):
         """Render extra attributes for an object."""
         # always manually query for extra attributes
         extra_attributes_data = [x for x in self.get_extra_attributes_paths if x]
@@ -163,8 +164,8 @@ class AutonomousSystemRange(PrimaryModel):
     """Autonomous System Range information."""
 
     name = models.CharField(max_length=255, unique=True, blank=False)
-    asn_min = ASNField(verbose_name="Start", help_text="Min value for 32-bit autonomous system number")
-    asn_max = ASNField(verbose_name="End", help_text="Max value for 32-bit autonomous system number")
+    asn_min = ASNField(verbose_name="Start ASN", help_text="Min value for 32-bit autonomous system number")
+    asn_max = ASNField(verbose_name="End ASN", help_text="Max value for 32-bit autonomous system number")
     description = models.CharField(max_length=255, blank=True)
     tenant = models.ForeignKey(to=Tenant, on_delete=models.PROTECT, blank=True, null=True)
 
@@ -192,6 +193,13 @@ def get_next_available_asn(self):
 
         return None
 
+    @property
+    def asns(self):
+        """Return the first available ASN number in the range, or None if none are available."""
+        asn_nums = AutonomousSystem.objects.filter(asn__gte=self.asn_min, asn__lte=self.asn_max)
+
+        return asn_nums
+
 
 @extras_features(
     "custom_fields",
@@ -496,7 +504,7 @@ class PeerEndpoint(PrimaryModel, InheritanceMixin, BGPExtraAttributesMixin):
         blank=True,
         null=True,
         related_name="bgp_peer_endpoints",
-        verbose_name="BGP Peer IP",
+        verbose_name="Source IP Address",
     )
 
     source_interface = models.ForeignKey(  # update source
@@ -689,6 +697,11 @@ def __str__(self):
 
         return f"{self.afi_safi} AF - {self.routing_instance.device}"
 
+    @property
+    def display(self):
+        """The string representation of the model as a model property."""
+        return str(self)
+
     def validate_unique(self, exclude=None):
         """Validate uniqueness."""
         if (

nautobot_bgp_models/tables.py

@@ -33,7 +33,7 @@ class AutonomousSystemTable(StatusTableMixin, BaseTable):
 
     pk = ToggleColumn()
     asn = tables.TemplateColumn(template_code=ASN_LINK, verbose_name="ASN")
-    provider = tables.LinkColumn()
+    provider = tables.Column(linkify=True)
     tags = TagColumn(url_name="plugins:nautobot_bgp_models:autonomoussystem_list")
     actions = ButtonsColumn(model=models.AutonomousSystem)
     asn_asdot = tables.Column(accessor=A("asn_asdot"), linkify=True, order_by=A("asn"), verbose_name="ASN ASDOT")
@@ -48,10 +48,10 @@ class AutonomousSystemRangeTable(StatusTableMixin, BaseTable):
     """Table representation of AutonomousSystem records."""
 
     pk = ToggleColumn()
-    name = tables.LinkColumn()
-    asn_min = tables.LinkColumn()
-    asn_max = tables.LinkColumn()
-    tenant = tables.LinkColumn()
+    name = tables.Column(linkify=True)
+    asn_min = tables.Column(linkify=True)
+    asn_max = tables.Column(linkify=True)
+    tenant = tables.Column(linkify=True)
     tags = TagColumn(url_name="plugins:nautobot_bgp_models:autonomoussystemrange_list")
     actions = ButtonsColumn(model=models.AutonomousSystemRange)
 
@@ -69,9 +69,9 @@ class BGPRoutingInstanceTable(StatusTableMixin, BaseTable):
         args=[A("pk")],
         text=str,
     )
-    device = tables.LinkColumn()
-    autonomous_system = tables.LinkColumn()
-    router_id = tables.LinkColumn()
+    device = tables.Column(linkify=True)
+    autonomous_system = tables.Column(linkify=True)
+    router_id = tables.Column(linkify=True)
     tags = TagColumn(url_name="plugins:nautobot_bgp_models:bgproutinginstance_list")
     actions = ButtonsColumn(model=models.BGPRoutingInstance)
 
@@ -93,16 +93,16 @@ class PeerGroupTable(BaseTable):
     """Table representation of PeerGroup records."""
 
     pk = ToggleColumn()
-    name = tables.LinkColumn()
-    peergroup_template = tables.LinkColumn()
-    routing_instance = tables.LinkColumn()
-    vrf = tables.LinkColumn()
+    name = tables.Column(linkify=True)
+    peergroup_template = tables.Column(linkify=True)
+    routing_instance = tables.Column(linkify=True)
+    vrf = tables.Column(linkify=True)
     enabled = BooleanColumn()
     role = ColoredLabelColumn()
-    autonomous_system = tables.LinkColumn()
-    secret = tables.LinkColumn()
-    source_ip = tables.LinkColumn()
-    source_interface = tables.LinkColumn()
+    autonomous_system = tables.Column(linkify=True)
+    secret = tables.Column(linkify=True)
+    source_ip = tables.Column(linkify=True)
+    source_interface = tables.Column(linkify=True)
     tags = TagColumn(url_name="plugins:nautobot_bgp_models:peergroup_list")
 
     actions = ButtonsColumn(model=models.PeerGroup)
@@ -140,11 +140,11 @@ class PeerGroupTemplateTable(BaseTable):
     """Table representation of PeerGroup records."""
 
     pk = ToggleColumn()
-    name = tables.LinkColumn()
+    name = tables.Column(linkify=True)
     enabled = BooleanColumn()
     role = ColoredLabelColumn()
-    autonomous_system = tables.LinkColumn()
-    secret = tables.LinkColumn()
+    autonomous_system = tables.Column(linkify=True)
+    secret = tables.Column(linkify=True)
     actions = ButtonsColumn(model=models.PeerGroupTemplate)
 
     class Meta(BaseTable.Meta):
@@ -172,46 +172,49 @@ class PeerEndpointTable(BaseTable):
     """Table representation of PeerEndpoint records."""
 
     pk = ToggleColumn()
-    id = tables.LinkColumn()
-    routing_instance = tables.LinkColumn()
+    id = tables.Column(linkify=True)
+    routing_instance = tables.Column(linkify=True)
     role = ColoredLabelColumn()
-    source_ip = tables.LinkColumn()
-    source_interface = tables.LinkColumn()
-    autonomous_system = tables.LinkColumn()
-    remote_autonomous_system = tables.LinkColumn()
-    peer = tables.LinkColumn()
-    peering = tables.LinkColumn()
-    vrf = tables.LinkColumn()
-    peer_group = tables.LinkColumn()
+    source_ip = tables.Column(linkify=True)
+    source_interface = tables.Column(linkify=True)
+    local_ip = tables.Column(linkify=True)
+    autonomous_system = tables.Column(linkify=True)
+    # remote_autonomous_system = tables.Column(linkify=True)
+    peer = tables.Column(linkify=True)
+    peering = tables.Column(linkify=True)
+    vrf = tables.Column(linkify=True)
+    peer_group = tables.Column(linkify=True)
     tags = TagColumn(url_name="plugins:nautobot_bgp_models:peerendpoint_list")
     # actions = ButtonsColumn(model=models.PeerEndpoint)
 
     class Meta(BaseTable.Meta):
         model = models.PeerEndpoint
         fields = (
-            "pk",
+            # "pk",
             "id",
             "routing_instance",
             "role",
             "source_ip",
             "source_interface",
+            "local_ip",
             "autonomous_system",
-            "remote_autonomous_system",
+            # "remote_autonomous_system",
             "peer",
             "peering",
             "vrf",
             "peer_group",
             "tags",
         )
         default_columns = (
-            "pk",
+            # "pk",
             "id",
             "routing_instance",
             "role",
             "source_ip",
+            "local_ip",
             "source_interface",
             "autonomous_system",
-            "remote_autonomous_system",
+            # "remote_autonomous_system",
             "peer",
             "peering",
             "vrf",
@@ -256,14 +259,10 @@ class AddressFamilyTable(BaseTable):
     """Table representation of AddressFamily records."""
 
     pk = ToggleColumn()
-    address_family = tables.LinkColumn(
-        viewname="plugins:nautobot_bgp_models:addressfamily",
-        args=[A("pk")],
-        text=str,
-    )
-    routing_instance = tables.LinkColumn()
+    address_family = tables.Column(linkify=True, accessor="display")
+    routing_instance = tables.Column(linkify=True)
     afi_safi = tables.Column()
-    vrf = tables.LinkColumn()
+    vrf = tables.Column(linkify=True)
     actions = ButtonsColumn(model=models.AddressFamily)
 
     class Meta(BaseTable.Meta):
@@ -294,7 +293,7 @@ class PeerGroupAddressFamilyTable(BaseTable):
         args=[A("pk")],
         text=str,
     )
-    peer_group = tables.LinkColumn()
+    peer_group = tables.Column(linkify=True)
     afi_safi = tables.Column()
     actions = ButtonsColumn(model=models.PeerGroupAddressFamily)
 
@@ -330,7 +329,7 @@ class PeerEndpointAddressFamilyTable(BaseTable):
         args=[A("pk")],
         text=str,
     )
-    peer_endpoint = tables.LinkColumn()
+    peer_endpoint = tables.Column(linkify=True)
     afi_safi = tables.Column()
     actions = ButtonsColumn(model=models.PeerEndpointAddressFamily)