Remove OrchestratorVlanRanges and use VlanRanges

tjeerddie · tjeerddie · commit a4fa6f3b2654 · 2025-10-28T14:17:09.000+01:00
diff --git a/docker-compose.yml b/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
diff --git a/docker/orchestrator-ui/orchestrator-ui.env b/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
diff --git a/products/product_blocks/sap.py b/products/product_blocks/sap.py
@@ -17,18 +17,18 @@
 from pydantic import computed_field
 
 from products.product_blocks.port import PortBlock, PortBlockInactive, PortBlockProvisioning
-from workflows.nsistp.shared.shared import OrchestratorVlanRanges
+from nwastdlib.vlans import VlanRanges
 
 
 class SAPBlockInactive(ProductBlockModel, product_block_name="SAP"):
     port: PortBlockInactive | None = None
-    vlan: OrchestratorVlanRanges | None = None
+    vlan: VlanRanges | None = None
     ims_id: int | None = None
 
 
 class SAPBlockProvisioning(SAPBlockInactive, lifecycle=[SubscriptionLifecycle.PROVISIONING]):
     port: PortBlockProvisioning
-    vlan: OrchestratorVlanRanges
+    vlan: VlanRanges
     ims_id: int | None = None
 
     @computed_field  # type: ignore[misc]
@@ -39,5 +39,5 @@ def title(self) -> str:
 
 class SAPBlock(SAPBlockProvisioning, lifecycle=[SubscriptionLifecycle.ACTIVE]):
     port: PortBlock
-    vlan: OrchestratorVlanRanges
+    vlan: VlanRanges
     ims_id: int
diff --git a/products/product_types/nsistp.py b/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 OrchestratorVlanRanges
+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) -> OrchestratorVlanRanges:
+    def vlan_range(self) -> VlanRanges:
         return self.nsistp.sap.vlan
diff --git a/products/services/netbox/payload/port.py b/products/services/netbox/payload/port.py
@@ -44,7 +44,6 @@ def build_port_payload(model: PortBlockProvisioning, subscription: SubscriptionM
     Returns: :class:`netbox.InterfacePayload`
 
     """
-    print(model.vlan_group_ims_ids)
     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,
diff --git a/products/services/netbox/payload/sap.py b/products/services/netbox/payload/sap.py
@@ -44,7 +44,7 @@ def build_sap_vlans_payload(model: SAPBlockProvisioning, subscription: Subscript
 
 
 def build_sap_vlan_group_payload(model: SAPBlockProvisioning, subscription: SubscriptionModel) -> netbox.VlanGroupPayload:
-    """Create and return a list of Netbox :class:`VlanGroupPayload` for a :class:`~products.product_blocks.sap.SAPBlockProvisioning`.
+    """Create and return a Netbox VlanGroupPayload object for a :class:`~products.product_blocks.sap.SAPBlockProvisioning`.
 
     Example payload::
 
diff --git a/services/netbox.py b/services/netbox.py
@@ -25,7 +25,6 @@
 
 from settings import settings
 from utils.singledispatch import single_dispatch_base
-from workflows.nsistp.shared.shared import OrchestratorVlanRanges
 
 logger = structlog.get_logger(__name__)
 
diff --git a/workflows/l2vpn/create_l2vpn.py b/workflows/l2vpn/create_l2vpn.py
@@ -35,8 +35,8 @@
 from products.services.netbox.payload.sap import build_sap_vlan_group_payload
 from services import netbox
 from workflows.l2vpn.shared.forms import ports_selector
-from workflows.nsistp.shared.shared import OrchestratorVlanRanges
 from workflows.shared import AllowedNumberOfL2vpnPorts
+from nwastdlib.vlans import VlanRanges
 
 
 def initial_input_form_generator(product_name: str) -> FormGenerator:
@@ -57,7 +57,7 @@ class SelectPortsForm(FormPage):
         model_config = ConfigDict(title=product_name)
 
         ports: PortsChoiceList
-        vlan: OrchestratorVlanRanges
+        vlan: VlanRanges
 
     select_ports = yield SelectPortsForm
     select_ports_dict = select_ports.model_dump()
@@ -73,7 +73,7 @@ def construct_l2vpn_model(
     ports: list[UUIDstr],
     speed: int,
     speed_policer: bool,
-    vlan: OrchestratorVlanRanges,
+    vlan: VlanRanges,
 ) -> State:
     subscription = L2vpnInactive.from_product_id(
         product_id=product,
@@ -110,7 +110,7 @@ def ims_create_vlans(subscription: L2vpnProvisioning) -> State:
         group_payload = build_sap_vlan_group_payload(sap, subscription)
         sap.ims_id = netbox.create(group_payload)
         group_payloads += [group_payload]
-        vlan_payloads += build_payload(sap, subscription)
+        vlan_payloads += [build_payload(sap, subscription)]
 
     for payload in vlan_payloads:
         netbox.create(payload)
diff --git a/workflows/nsistp/create_nsistp.py b/workflows/nsistp/create_nsistp.py
@@ -42,9 +42,9 @@
     port_selector,
     validate_both_aliases_empty_or_not,
 )
-from workflows.nsistp.shared.shared import OrchestratorVlanRanges
 from workflows.nsistp.shared.vlan import validate_vlan, validate_vlan_not_in_use
 from workflows.shared import create_summary_form
+from nwastdlib.vlans import VlanRanges
 
 logger = structlog.get_logger(__name__)
 
@@ -60,7 +60,7 @@ class CreateNsiStpForm(FormPage):
     
         port: PortChoiceList
         vlan: Annotated[
-            OrchestratorVlanRanges,
+            VlanRanges,
             AfterValidator(validate_vlan),
             AfterValidator(_validate_vlan_not_in_use),
         ]
@@ -103,7 +103,7 @@ def validate_is_alias_in_out(self) -> "CreateNsiStpForm":
 def construct_nsistp_model(
     product: UUIDstr,
     port: UUIDstr,
-    vlan: OrchestratorVlanRanges,
+    vlan: VlanRanges,
     topology: str,
     stp_id: str,
     stp_description: str | None,
diff --git a/workflows/nsistp/shared/forms.py b/workflows/nsistp/shared/forms.py
@@ -32,8 +32,9 @@
 
 from products.product_blocks.port import PortMode
 from products.product_types.nsistp import Nsistp, NsistpInactive
-from workflows.nsistp.shared.shared import MAX_SPEED_POSSIBLE, OrchestratorVlanRanges
+from workflows.nsistp.shared.shared import MAX_SPEED_POSSIBLE
 from workflows.shared import subscriptions_by_product_type_and_instance_value
+from nwastdlib.vlans import VlanRanges
 
 TOPOLOGY_REGEX = r"^[-a-z0-9+,.;=_]+$"
 STP_ID_REGEX = r"^[-a-z0-9+,.;=_:]+$"
@@ -151,7 +152,7 @@ def validate_nurn(nurn: str | None) -> str | None:
     return nurn
 
 
-def nsistp_fill_sap(subscription: NsistpInactive, subscription_id: UUIDstr, vlan: OrchestratorVlanRanges) -> None:
+def nsistp_fill_sap(subscription: NsistpInactive, subscription_id: UUIDstr, vlan: VlanRanges) -> None:
     subscription.nsistp.sap.vlan = vlan
     subscription.nsistp.sap.port = SubscriptionModel.from_subscription(subscription_id).port  # type: ignore
 
diff --git a/workflows/nsistp/shared/shared.py b/workflows/nsistp/shared/shared.py
@@ -30,18 +30,3 @@
 GetSubscriptionByIdFunc = Callable[[UUID], SubscriptionTable]
 
 MAX_SPEED_POSSIBLE = 400_000
-
-
-# Custom VlanRanges needed to avoid matching conflict with SURF orchestrator-ui components
-class OrchestratorVlanRanges(VlanRanges):
-    def __str__(self) -> str:
-        # `range` objects have an exclusive `stop`. VlanRanges is expressed using terms that use an inclusive stop,
-        # which is one less then the exclusive one we use for the internal representation. Hence the `-1`
-        return ", ".join(str(vr.start) if len(vr) == 1 else f"{vr.start}-{vr.stop - 1}" for vr in self._vlan_ranges)
-
-    @classmethod
-    def __get_pydantic_json_schema__(cls, core_schema_: CoreSchema, handler: GetJsonSchemaHandler) -> JsonSchemaValue:
-        parent_schema = super().__get_pydantic_json_schema__(core_schema_, handler)
-        parent_schema["format"] = "custom-vlan"
-
-        return parent_schema
diff --git a/workflows/nsistp/shared/vlan.py b/workflows/nsistp/shared/vlan.py
@@ -28,33 +28,33 @@
 from pydantic_core.core_schema import ValidationInfo
 from pydantic_forms.types import State, UUIDstr
 from sqlalchemy import select
+from nwastdlib.vlans import VlanRanges
 
 from products.product_blocks.port import PortMode
-from workflows.nsistp.shared.shared import OrchestratorVlanRanges
 
 logger = structlog.get_logger(__name__)
 
 
-def validate_vlan(vlan: OrchestratorVlanRanges, info: ValidationInfo) -> OrchestratorVlanRanges:
+def validate_vlan(vlan: VlanRanges, info: ValidationInfo) -> VlanRanges:
     # We assume an empty string is untagged and thus 0
     if not vlan:
-        vlan = OrchestratorVlanRanges(0)
+        vlan = VlanRanges(0)
 
     subscription_id = info.data.get("port_id")
     if not subscription_id:
         return vlan
 
     subscription = subscriptions.get_subscription(subscription_id, model=SubscriptionTable)
 
-    if vlan == OrchestratorVlanRanges(0):
+    if vlan == VlanRanges(0):
         raise ValueError(f"{subscription.product.tag} must have a vlan")
 
     return vlan
 
 
 def validate_vlan_not_in_use(
-    vlan: int | OrchestratorVlanRanges, info: ValidationInfo, port_field_name: str = "subscription_id", current: list[State] | None = None
-) -> int | OrchestratorVlanRanges:
+    vlan: int | VlanRanges, info: ValidationInfo, port_field_name: str = "subscription_id", current: list[State] | None = None
+) -> int | VlanRanges:
     """Check if vlan value is already in use by a subscription.
 
     Args:
@@ -79,18 +79,18 @@ def validate_vlan_not_in_use(
             if not current_selected_vlan:
                 current_selected_vlan = "0"
 
-            current_selected_vlan_range = OrchestratorVlanRanges(current_selected_vlan)
+            current_selected_vlan_range = VlanRanges(current_selected_vlan)
             used_vlans -= current_selected_vlan_range  # type: ignore[assignment]
             current_selected_vlan_ranges = [
                 *current_selected_vlan_ranges,
                 *list(current_selected_vlan_range),
             ]
 
-    # Handle both int and OrchestratorVlanRanges
+    # Handle both int and VlanRanges
     if isinstance(vlan, int):
         vlan_in_use = vlan in used_vlans
     else:
-        # For OrchestratorVlanRanges, check if any of its values are in used_vlans
+        # For VlanRanges, check if any of its values are in used_vlans
         vlan_in_use = any(v in used_vlans for v in vlan)
 
     if vlan_in_use:
@@ -101,7 +101,7 @@ def validate_vlan_not_in_use(
 
 def find_allocated_vlans(
     subscription_id: UUID | UUIDstr,
-) -> OrchestratorVlanRanges:
+) -> VlanRanges:
     """Find all vlans already allocated to a SAP for a given port."""
     logger.debug(
         "Finding allocated VLANs",
@@ -133,7 +133,7 @@ def find_allocated_vlans(
 
     if not used_vlan_values:
         logger.debug("No VLAN values in use found")
-        return OrchestratorVlanRanges([])
+        return VlanRanges([])
 
     logger.debug("Found used VLAN values", values=used_vlan_values)
-    return OrchestratorVlanRanges(",".join(used_vlan_values))
+    return VlanRanges(",".join(used_vlan_values))
diff --git a/wsgi.py b/wsgi.py
@@ -18,14 +18,6 @@
 from graphql_federation import CUSTOM_GRAPHQL_MODELS
 import products  # noqa: F401  Side-effects
 import workflows  # noqa: F401  Side-effects
-from orchestrator.graphql.types import SCALAR_OVERRIDES, VlanRangesType
-
-from workflows.nsistp.shared.shared import OrchestratorVlanRanges
-
-
-scalar_overrides=SCALAR_OVERRIDES | {
-    OrchestratorVlanRanges: VlanRangesType
-}
 
 app = OrchestratorCore(base_settings=AppSettings())
 app.register_graphql(graphql_models=CUSTOM_GRAPHQL_MODELS)
