Merge pull request #59 from workfloworchestrator/support-vlan-range-type

Add support for VlanRanges to NSISTP and L2VPN

Author: pboers1988

docker-compose.yml

@@ -236,7 +236,6 @@ services:
       - "80:80"
     volumes:
       - "./docker/nginx/nginx.conf:/etc/nginx/nginx.conf:ro"
-    restart: always
     depends_on:
       orchestrator:
         condition: service_started

docker/orchestrator-ui/orchestrator-ui.env

@@ -21,3 +21,4 @@ OIDC_CONF_FULL_WELL_KNOWN_URL=""
 OAUTH2_ACTIVE=false
 AO_STACK_STATUS_URL=""
 ENABLE_AO_STACK_STATUS=false
+ACTIVATE_PYDANTIC_FORMS=true

products/product_blocks/nsistp.py

@@ -40,7 +40,7 @@ class NsistpBlockProvisioning(NsistpBlockInactive, lifecycle=[SubscriptionLifecy
     expose_in_topology: bool | None = None
     bandwidth: int | None = None
 
-    @computed_field
+    @computed_field  # type: ignore[prop-decorator]
     @property
     def title(self) -> str:
         return f"NSISTP {self.stp_id} on {self.sap.title}"

products/product_blocks/port.py

@@ -73,8 +73,8 @@ def vlans(self) -> List[int]:
 
     @computed_field  # type: ignore[misc]
     @property
-    def vlan_ims_ids(self) -> List[int]:
-        """Get list of active VLAN IMS IDs by looking at SAPBlock's that use this PortBlock."""
+    def vlan_group_ims_ids(self) -> List[int]:
+        """Get list of active IMS VLAN GROUP IDs by looking at SAPBlock's that use this PortBlock."""
         return [sap_block.ims_id for sap_block in self._active_sap_blocks()]
 
     @computed_field  # type: ignore[misc]

products/product_blocks/sap.py

@@ -17,17 +17,18 @@
 from pydantic import computed_field
 
 from products.product_blocks.port import PortBlock, PortBlockInactive, PortBlockProvisioning
+from nwastdlib.vlans import VlanRanges
 
 
 class SAPBlockInactive(ProductBlockModel, product_block_name="SAP"):
     port: PortBlockInactive | None = None
-    vlan: int | None = None
+    vlan: VlanRanges | None = None
     ims_id: int | None = None
 
 
 class SAPBlockProvisioning(SAPBlockInactive, lifecycle=[SubscriptionLifecycle.PROVISIONING]):
     port: PortBlockProvisioning
-    vlan: int  # TODO: refactor to CustomVlanRanges together with L2VPN product and workflow
+    vlan: VlanRanges
     ims_id: int | None = None
 
     @computed_field  # type: ignore[misc]
@@ -38,5 +39,5 @@ def title(self) -> str:
 
 class SAPBlock(SAPBlockProvisioning, lifecycle=[SubscriptionLifecycle.ACTIVE]):
     port: PortBlock
-    vlan: int  # TODO: refactor to CustomVlanRanges together with L2VPN product and workflow
+    vlan: VlanRanges
     ims_id: int

products/product_types/nsistp.py

@@ -16,7 +16,7 @@
 from orchestrator.types import SubscriptionLifecycle
 
 from products.product_blocks.nsistp import NsistpBlock, NsistpBlockInactive, NsistpBlockProvisioning
-from workflows.nsistp.shared.shared import CustomVlanRanges
+from nwastdlib.vlans import VlanRanges
 
 
 class NsistpInactive(SubscriptionModel, is_base=True):
@@ -31,5 +31,5 @@ class Nsistp(NsistpProvisioning, lifecycle=[SubscriptionLifecycle.ACTIVE]):
     nsistp: NsistpBlock
 
     @property
-    def vlan_range(self) -> CustomVlanRanges:
+    def vlan_range(self) -> VlanRanges:
         return self.nsistp.sap.vlan

products/services/netbox/netbox.py

@@ -77,7 +77,7 @@ def _(model: CoreLinkBlockProvisioning, subscription: SubscriptionModel, **kwarg
 
 
 @build_payload.register
-def _(model: SAPBlockProvisioning, subscription: SubscriptionModel, **kwargs: Any) -> netbox.VlanPayload:
+def _(model: SAPBlockProvisioning, subscription: SubscriptionModel, **kwargs: Any) -> netbox.VlansPayload:
     return build_sap_payload(model, subscription)
 
 

products/services/netbox/payload/port.py

@@ -44,11 +44,12 @@ def build_port_payload(model: PortBlockProvisioning, subscription: SubscriptionM
     Returns: :class:`netbox.InterfacePayload`
 
     """
+    vlan_ids = [vlan.id for group_id in model.vlan_group_ims_ids for vlan in netbox.get_vlans(group_id=group_id)]
     return netbox.InterfacePayload(
         device=model.node.ims_id,
         name=model.port_name,
         type=model.port_type,
-        tagged_vlans=sorted(model.vlan_ims_ids),
+        tagged_vlans=sorted(vlan_ids),
         mode="tagged" if model.port_mode == PortMode.TAGGED else "",
         description=model.port_description,
         enabled=model.enabled,

products/services/netbox/payload/sap.py

@@ -18,15 +18,63 @@
 from services import netbox
 
 
-def build_sap_payload(model: SAPBlockProvisioning, subscription: SubscriptionModel) -> netbox.VlanPayload:
+def build_sap_vlans_payload(model: SAPBlockProvisioning, subscription: SubscriptionModel) -> list[netbox.VlanPayload]:
+    """Create and return a list of Netbox :class:`VlanPayload` for a :class:`~products.product_blocks.sap.SAPBlockProvisioning`.
+
+    Example payload::
+
+       {
+          "vid": 4,
+          "name": "paris01a 0/0/1 vlan 4",
+          "status": "active",
+          "group": 1
+       }
+
+    Args:
+        model: SAPBlockProvisioning
+        subscription: The Subscription that will be provisioned
+
+    Returns: list[:class:`netbox.VlanPayload`]
+
+    """
+    assert model.ims_id
+    name = f"{model.port.node.node_name} {model.port.port_name}"
+    vlan_list = [vlan for vlan_start, vlan_end in model.vlan.to_list_of_tuples() for vlan in range(vlan_start, vlan_end+1)]
+    return [netbox.VlanPayload(vid=vlan, group=model.ims_id, name=f"{name} - {vlan}") for vlan in vlan_list]
+
+
+def build_sap_vlan_group_payload(model: SAPBlockProvisioning, subscription: SubscriptionModel) -> netbox.VlanGroupPayload:
+    """Create and return a Netbox VlanGroupPayload object for a :class:`~products.product_blocks.sap.SAPBlockProvisioning`.
+
+    Example payload::
+
+       {
+          "name": "paris01a 0/0/1 vlan 4",
+          "vid_ranges": "5, 10, 15-20",
+       }
+
+    Args:
+        model: SAPBlockProvisioning
+        subscription: The Subscription that will be provisioned
+
+    Returns: :class:`netbox.VlanGroupPayload`
+
+    """
+    name = f"{model.port.node.node_name} {model.port.port_name}"
+    slug = name.replace(" ", "-").replace("/", "-")
+    return netbox.VlanGroupPayload(name=name, slug=slug, vid_ranges=model.vlan.to_list_of_tuples())
+
+
+def build_sap_payload(model: SAPBlockProvisioning, subscription: SubscriptionModel) -> netbox.VlansPayload:
     """Create and return a Netbox payload object for a :class:`~products.product_blocks.sap.SAPBlockProvisioning`.
 
     Example payload::
 
        {
           "vid": 4,
           "name": "paris01a 0/0/1 vlan 4",
-          "status": "active"
+          "status": "active",
+          "group": 1
        }
 
     Args:
@@ -36,4 +84,5 @@ def build_sap_payload(model: SAPBlockProvisioning, subscription: SubscriptionMod
     Returns: :class:`netbox.VlanPayload`
 
     """
-    return netbox.VlanPayload(vid=int(model.vlan), name=f"{model.port.node.node_name} {model.port.port_name}")
+    vlan_payloads = build_sap_vlans_payload(model, subscription)
+    return netbox.VlansPayload(vlans=vlan_payloads)

pyproject.toml

@@ -4,7 +4,7 @@ version = "0.1.0"
 requires-python = ">=3.12,<3.14"
 dependencies = [
   "deepdiff==8.6.1",
-  "orchestrator-core==4.0.4",
+  "orchestrator-core==4.5.3",
   "pynetbox==7.4.1",
   "rich==13.9.4",
 ]