implement a more consistent use of ensure_provisioning_status decorator

Author: hanstrompert

products/services/description.py

@@ -65,7 +65,7 @@ def _(core_link: CoreLinkProvisioning) -> str:
         f"{core_link.core_link.ports[0].node.node_name} {core_link.core_link.ports[0].port_name}"
         " <-> "
         f"{core_link.core_link.ports[1].port_name} {core_link.core_link.ports[1].node.node_name}"
-    )
+    ) + (" (maintenance)" if core_link.core_link.under_maintenance else "")
 
 
 @description.register
@@ -79,7 +79,7 @@ def _(l2vpn: L2vpnProvisioning) -> str:
         f"{l2vpn.product.tag} "
         f"{l2vpn.virtual_circuit.speed} Mbit/s "
         f"({'-'.join(sorted(list(set([sap.port.node.node_name for sap in l2vpn.virtual_circuit.saps]))))})"
-    )
+    ) + (" (policer active)" if l2vpn.virtual_circuit.speed_policer else "")
 
 
 @description.register

translations/en-GB.json

@@ -39,7 +39,8 @@
       "type_id_info": "Hardware make and model",
       "under_maintenance": "Maintenance",
       "under_maintenance_info": "Enable maintenance mode?",
-      "vlan": "VLAN"
+      "vlan": "VLAN ID(s)",
+      "vlan_info": "VLAN ID or range(s) of IDs"
     }
   },
   "workflow": {

workflows/core_link/modify_core_link.py

@@ -13,10 +13,8 @@
 
 
 from pydantic_forms.types import UUIDstr
-from orchestrator.types import SubscriptionLifecycle
 from orchestrator.workflow import StepList, begin, step
-from orchestrator.workflows.steps import set_status
-from orchestrator.workflows.utils import modify_workflow
+from orchestrator.workflows.utils import modify_workflow, ensure_provisioning_status
 from pydantic_forms.core import FormPage
 from pydantic_forms.types import FormGenerator, State
 
@@ -43,21 +41,17 @@ class ModifyCoreLinkForm(FormPage):
     return user_input_dict | {"subscription": subscription}
 
 
+@ensure_provisioning_status
 @step("Update subscription")
 def update_subscription(subscription: CoreLinkProvisioning, under_maintenance: bool) -> State:
     subscription.core_link.under_maintenance = under_maintenance
-
-    return {"subscription": subscription}
-
-
-@step("Update subscription description")
-def update_subscription_description(subscription: CoreLink) -> State:
     subscription.description = description(subscription)
+
     return {"subscription": subscription}
 
 
 @step("Update core link in NRM")
-def update_core_link_in_nrm(subscription: CoreLinkProvisioning) -> State:
+def update_core_link_in_nrm(subscription: CoreLink) -> State:
     """Dummy step, replace with actual call to NRM."""
     return {"subscription": subscription}
 
@@ -66,9 +60,6 @@ def update_core_link_in_nrm(subscription: CoreLinkProvisioning) -> State:
 def modify_core_link() -> StepList:
     return (
         begin
-        >> set_status(SubscriptionLifecycle.PROVISIONING)
         >> update_subscription
-        >> update_subscription_description
         >> update_core_link_in_nrm
-        >> set_status(SubscriptionLifecycle.ACTIVE)
     )

workflows/l2vpn/create_l2vpn.py

@@ -20,15 +20,15 @@
 from orchestrator.targets import Target
 from orchestrator.types import SubscriptionLifecycle
 from orchestrator.workflow import StepList, begin, step
-from orchestrator.workflows.steps import set_status, store_process_subscription
+from orchestrator.workflows.steps import store_process_subscription
 from orchestrator.workflows.utils import create_workflow
 from pydantic import ConfigDict
 from pydantic_forms.core import FormPage
 from pydantic_forms.types import FormGenerator, State, UUIDstr
 from pydantic_forms.validators import Choice
 
 from products.product_blocks.sap import SAPBlockInactive
-from products.product_types.l2vpn import L2vpn, L2vpnInactive, L2vpnProvisioning
+from products.product_types.l2vpn import L2vpnInactive, L2vpnProvisioning
 from products.product_types.port import Port
 from products.services.description import description
 from products.services.netbox.netbox import build_payload
@@ -142,7 +142,7 @@ def create_sap_payloads(sap) -> list[netbox.L2vpnTerminationPayload]:
 
 
 @step("Update VLANs on connected ports in IMS")
-def update_vlans_on_ports(subscription: L2vpn) -> State:
+def update_vlans_on_ports(subscription: L2vpnProvisioning) -> State:
     """By re-provisioning the connected ports,
     the VLANs from active SAPs will be provisioned in IMS or removed otherwise.
     """
@@ -173,6 +173,5 @@ def create_l2vpn() -> StepList:
         >> ims_create_l2vpn
         >> ims_create_l2vpn_terminations
         >> provision_l2vpn_in_nrm
-        >> set_status(SubscriptionLifecycle.ACTIVE)
         >> update_vlans_on_ports
     )

workflows/l2vpn/modify_l2vpn.py

@@ -12,10 +12,8 @@
 # limitations under the License.
 
 
-from orchestrator.types import SubscriptionLifecycle
 from orchestrator.workflow import StepList, begin, step
-from orchestrator.workflows.steps import set_status
-from orchestrator.workflows.utils import modify_workflow, reconcile_workflow
+from orchestrator.workflows.utils import modify_workflow, reconcile_workflow, ensure_provisioning_status
 from pydantic_forms.core import FormPage
 from pydantic_forms.types import FormGenerator, State, UUIDstr
 
@@ -43,6 +41,7 @@ class ModifyL2vpnForm(FormPage):
     return user_input_dict | {"subscription": subscription}
 
 
+@ensure_provisioning_status
 @step("Update subscription")
 def update_subscription(
     subscription: L2vpnProvisioning,
@@ -51,18 +50,13 @@ def update_subscription(
 ) -> State:
     subscription.virtual_circuit.speed = speed
     subscription.virtual_circuit.speed_policer = speed_policer
-
-    return {"subscription": subscription}
-
-
-@step("Update subscription description")
-def update_subscription_description(subscription: L2vpn) -> State:
     subscription.description = description(subscription)
+
     return {"subscription": subscription}
 
 
 @step("Update L2VPN in NRM")
-def update_l2vpn_in_nrm(subscription: L2vpnProvisioning) -> State:
+def update_l2vpn_in_nrm(subscription: L2vpn) -> State:
     """Dummy step, replace with actual call to NRM."""
     return {"subscription": subscription}
 
@@ -75,10 +69,7 @@ def update_l2vpn_in_nrm(subscription: L2vpnProvisioning) -> State:
 def modify_l2vpn() -> StepList:
     return (
         begin
-        >> set_status(SubscriptionLifecycle.PROVISIONING)
         >> update_subscription
-        >> update_subscription_description
-        >> set_status(SubscriptionLifecycle.ACTIVE)
         >> update_l2vpn_in_external_systems
     )
 

workflows/node/create_node.py

@@ -156,6 +156,6 @@ def create_node() -> StepList:
         >> create_node_in_ims
         >> reserve_loopback_addresses
         >> lso_interaction(provision_node)
-        >> update_node_in_ims
         >> provision_node_in_nrm
+        >> update_node_in_ims
     )

workflows/node/modify_node.py

@@ -10,15 +10,14 @@
 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 # See the License for the specific language governing permissions and
 # limitations under the License.
-from pydantic_forms.types import UUIDstr
 from typing import TypeAlias, cast
 
 import structlog
 from orchestrator.services.products import get_product_by_id
 from orchestrator.workflow import StepList, begin, step
-from orchestrator.workflows.utils import modify_workflow, ensure_provisioning_status
+from orchestrator.workflows.utils import ensure_provisioning_status, modify_workflow
 from pydantic_forms.core import FormPage
-from pydantic_forms.types import FormGenerator, State
+from pydantic_forms.types import FormGenerator, State, UUIDstr
 from pydantic_forms.validators import Choice, Label
 
 from products.product_blocks.shared.types import NodeStatus
@@ -83,16 +82,11 @@ def update_subscription(
 
 
 @step("Update node in NRM")
-def update_node_in_nrm(subscription: NodeProvisioning) -> State:
+def update_node_in_nrm(subscription: Node) -> State:
     """Dummy step, replace with actual call to NRM."""
     return {"subscription": subscription}
 
 
 @modify_workflow("Modify node", initial_input_form=initial_input_form_generator)
 def modify_node() -> StepList:
-    return (
-        begin
-        >> update_subscription
-        >> update_node_in_ims
-        >> update_node_in_nrm
-    )
+    return begin >> update_subscription >> update_node_in_ims >> update_node_in_nrm

workflows/node/modify_sync_ports.py

@@ -21,7 +21,7 @@
 from orchestrator.workflows.steps import set_status
 from orchestrator.workflows.utils import modify_initial_input_form_generator, modify_workflow
 
-from products.product_types.node import NodeProvisioning
+from products.product_types.node import Node
 from services import netbox
 
 logger = structlog.get_logger(__name__)
@@ -43,7 +43,7 @@ def get_node_interface_list(node_name: str) -> List[Tuple[str, str, int]]:
 
 @step("Update interfaces")
 def update_interfaces(
-    subscription: NodeProvisioning,
+    subscription: Node,
 ) -> State:
     node_interfaces = set(get_node_interface_list(subscription.node.node_name))
     device = netbox.get_device(name=subscription.node.node_name)

workflows/node/shared/steps.py

@@ -15,13 +15,13 @@
 from pydantic_forms.types import State
 from orchestrator.workflow import step
 
-from products.product_types.node import NodeProvisioning
+from products.product_types.node import Node
 from products.services.netbox.netbox import build_payload
 from services import netbox
 
 
 @step("Update node in IMS")
-def update_node_in_ims(subscription: NodeProvisioning) -> State:
+def update_node_in_ims(subscription: Node) -> State:
     """Update node in IMDB"""
     payload = build_payload(subscription.node, subscription)
     netbox.update(payload, id=subscription.node.ims_id)

workflows/nsistp/modify_nsistp.py

@@ -15,10 +15,8 @@
 import structlog
 from orchestrator.forms import FormPage
 from orchestrator.forms.validators import Divider
-from orchestrator.types import SubscriptionLifecycle
 from orchestrator.workflow import StepList, begin, step
-from orchestrator.workflows.steps import set_status
-from orchestrator.workflows.utils import modify_workflow
+from orchestrator.workflows.utils import modify_workflow, ensure_provisioning_status
 from pydantic_forms.types import FormGenerator, State, UUIDstr
 from pydantic_forms.validators import read_only_field
 
@@ -62,7 +60,7 @@ class ModifyNsistpForm(FormPage):
 
     return user_input_dict | {"subscription": subscription}
 
-
+@ensure_provisioning_status
 @step("Update subscription")
 def update_subscription(
     subscription: NsistpProvisioning,
@@ -79,22 +77,14 @@ def update_subscription(
     subscription.nsistp.is_alias_out = is_alias_out
     subscription.nsistp.expose_in_topology = expose_in_topology
     subscription.nsistp.bandwidth = bandwidth
-
-    return {"subscription": subscription}
-
-
-@step("Update subscription description")
-def update_subscription_description(subscription: Nsistp) -> State:
     subscription.description = description(subscription)
+
     return {"subscription": subscription}
 
 
 @modify_workflow("Modify nsistp", initial_input_form=initial_input_form_generator)
 def modify_nsistp() -> StepList:
     return (
         begin
-        >> set_status(SubscriptionLifecycle.PROVISIONING)
         >> update_subscription
-        >> update_subscription_description
-        >> set_status(SubscriptionLifecycle.ACTIVE)
     )