From bd7f0141947f090c45f1e31e5e26dec270a0a26f Mon Sep 17 00:00:00 2001
From: Karel van Klink <karel.vanklink@geant.org>
Date: Thu, 21 Mar 2024 11:15:35 +0100
Subject: [PATCH] Harmonize the use of [DRY RUN] and [FOR REAL] in LSO
interaction step names
---
gso/utils/workflow_steps.py | 4 ++--
gso/workflows/iptrunk/create_iptrunk.py | 8 ++++----
gso/workflows/iptrunk/migrate_iptrunk.py | 10 +++++-----
gso/workflows/iptrunk/modify_isis_metric.py | 4 ++--
gso/workflows/iptrunk/modify_trunk_interface.py | 4 ++--
gso/workflows/iptrunk/terminate_iptrunk.py | 4 ++--
6 files changed, 17 insertions(+), 17 deletions(-)
diff --git a/gso/utils/workflow_steps.py b/gso/utils/workflow_steps.py
index 522ceaf5..7b3b5cc9 100644
--- a/gso/utils/workflow_steps.py
+++ b/gso/utils/workflow_steps.py
@@ -63,7 +63,7 @@ def deploy_base_config_real(
return {"subscription": subscription}
-@step("[COMMIT] Set ISIS metric to very high value")
+@step("[FOR REAL] Set ISIS metric to very high value")
def set_isis_to_max(subscription: Iptrunk, process_id: UUIDstr, callback_route: str, tt_number: str) -> State:
"""Workflow step for setting the :term:`ISIS` metric to an arbitrarily high value to drain a link."""
old_isis_metric = subscription.iptrunk.iptrunk_isis_metric
@@ -92,7 +92,7 @@ def set_isis_to_max(subscription: Iptrunk, process_id: UUIDstr, callback_route:
}
-@step("[CHECK] Run show commands after base config install")
+@step("Run show commands after base config install")
def run_checks_after_base_config(subscription: dict[str, Any], callback_route: str) -> None:
"""Workflow step for running show commands after installing base config."""
execute_playbook(
diff --git a/gso/workflows/iptrunk/create_iptrunk.py b/gso/workflows/iptrunk/create_iptrunk.py
index 481ca078..378f32b0 100644
--- a/gso/workflows/iptrunk/create_iptrunk.py
+++ b/gso/workflows/iptrunk/create_iptrunk.py
@@ -253,7 +253,7 @@ def initialize_subscription(
return {"subscription": subscription}
-@step("Provision IP trunk interface [DRY RUN]")
+@step("[DRY RUN] Provision IP trunk interface")
def provision_ip_trunk_iface_dry(
subscription: IptrunkInactive,
callback_route: str,
@@ -281,7 +281,7 @@ def provision_ip_trunk_iface_dry(
return {"subscription": subscription}
-@step("Provision IP trunk interface [FOR REAL]")
+@step("[FOR REAL] Provision IP trunk interface")
def provision_ip_trunk_iface_real(
subscription: IptrunkInactive,
callback_route: str,
@@ -327,7 +327,7 @@ def check_ip_trunk_connectivity(
return {"subscription": subscription}
-@step("Provision IP trunk ISIS interface [DRY RUN]")
+@step("[DRY RUN] Provision IP trunk ISIS interface")
def provision_ip_trunk_isis_iface_dry(
subscription: IptrunkInactive,
callback_route: str,
@@ -355,7 +355,7 @@ def provision_ip_trunk_isis_iface_dry(
return {"subscription": subscription}
-@step("Provision IP trunk ISIS interface [FOR REAL]")
+@step("[FOR REAL] Provision IP trunk ISIS interface")
def provision_ip_trunk_isis_iface_real(
subscription: IptrunkInactive,
callback_route: str,
diff --git a/gso/workflows/iptrunk/migrate_iptrunk.py b/gso/workflows/iptrunk/migrate_iptrunk.py
index 3ee509cb..add6d5f0 100644
--- a/gso/workflows/iptrunk/migrate_iptrunk.py
+++ b/gso/workflows/iptrunk/migrate_iptrunk.py
@@ -276,7 +276,7 @@ def disable_old_config_dry(
return {"subscription": subscription}
-@step("[REAL] Disable configuration on old router")
+@step("[FOR REAL] Disable configuration on old router")
def disable_old_config_real(
subscription: Iptrunk,
callback_route: str,
@@ -352,7 +352,7 @@ def deploy_new_config_dry(
return {"subscription": subscription}
-@step("Deploy configuration on new router")
+@step("[FOR REAL] Deploy configuration on new router")
def deploy_new_config_real(
subscription: Iptrunk,
callback_route: str,
@@ -423,7 +423,7 @@ def check_ip_trunk_connectivity(
return {"subscription": subscription}
-@step("Deploy ISIS configuration on new router")
+@step("[FOR REAL] Deploy ISIS configuration on new router")
def deploy_new_isis(
subscription: Iptrunk,
callback_route: str,
@@ -494,7 +494,7 @@ def confirm_continue_restore_isis() -> FormGenerator:
return {}
-@step("Restore ISIS metric to original value")
+@step("[FOR REAL] Restore ISIS metric to original value")
def restore_isis_metric(
subscription: Iptrunk,
process_id: UUIDstr,
@@ -561,7 +561,7 @@ def delete_old_config_dry(
return {"subscription": subscription}
-@step("Delete configuration on old router")
+@step("[FOR REAL] Delete configuration on old router")
def delete_old_config_real(
subscription: Iptrunk,
callback_route: str,
diff --git a/gso/workflows/iptrunk/modify_isis_metric.py b/gso/workflows/iptrunk/modify_isis_metric.py
index 55fea705..b9e0a549 100644
--- a/gso/workflows/iptrunk/modify_isis_metric.py
+++ b/gso/workflows/iptrunk/modify_isis_metric.py
@@ -35,7 +35,7 @@ def modify_iptrunk_subscription(subscription: Iptrunk, isis_metric: int) -> Stat
return {"subscription": subscription}
-@step("Provision IP trunk ISIS interface [DRY RUN]")
+@step("[DRY RUN] Provision IP trunk ISIS interface")
def provision_ip_trunk_isis_iface_dry(
subscription: Iptrunk,
process_id: UUIDstr,
@@ -63,7 +63,7 @@ def provision_ip_trunk_isis_iface_dry(
return {"subscription": subscription}
-@step("Provision IP trunk ISIS interface [FOR REAL]")
+@step("[FOR REAL] Provision IP trunk ISIS interface")
def provision_ip_trunk_isis_iface_real(
subscription: Iptrunk,
process_id: UUIDstr,
diff --git a/gso/workflows/iptrunk/modify_trunk_interface.py b/gso/workflows/iptrunk/modify_trunk_interface.py
index 86b43eb5..329d84aa 100644
--- a/gso/workflows/iptrunk/modify_trunk_interface.py
+++ b/gso/workflows/iptrunk/modify_trunk_interface.py
@@ -214,7 +214,7 @@ def modify_iptrunk_subscription(
}
-@step("Provision IP trunk interface [DRY RUN]")
+@step("[DRY RUN] Provision IP trunk interface")
def provision_ip_trunk_iface_dry(
subscription: Iptrunk,
process_id: UUIDstr,
@@ -244,7 +244,7 @@ def provision_ip_trunk_iface_dry(
return {"subscription": subscription}
-@step("Provision IP trunk interface [FOR REAL]")
+@step("[FOR REAL] Provision IP trunk interface")
def provision_ip_trunk_iface_real(
subscription: Iptrunk,
process_id: UUIDstr,
diff --git a/gso/workflows/iptrunk/terminate_iptrunk.py b/gso/workflows/iptrunk/terminate_iptrunk.py
index 469491eb..7a2afe6c 100644
--- a/gso/workflows/iptrunk/terminate_iptrunk.py
+++ b/gso/workflows/iptrunk/terminate_iptrunk.py
@@ -49,7 +49,7 @@ def initial_input_form_generator() -> FormGenerator:
return user_input.dict()
-@step("Deprovision IP trunk [DRY RUN]")
+@step("[DRY RUN] Deprovision IP trunk")
def deprovision_ip_trunk_dry(subscription: Iptrunk, process_id: UUIDstr, callback_route: str, tt_number: str) -> State:
"""Perform a dry run of deleting configuration from the routers."""
extra_vars = {
@@ -72,7 +72,7 @@ def deprovision_ip_trunk_dry(subscription: Iptrunk, process_id: UUIDstr, callbac
return {"subscription": subscription}
-@step("Deprovision IP trunk [FOR REAL]")
+@step("[FOR REAL] Deprovision IP trunk")
def deprovision_ip_trunk_real(subscription: Iptrunk, process_id: UUIDstr, callback_route: str, tt_number: str) -> State:
"""Delete configuration from the routers."""
extra_vars = {
--
GitLab