Merge pull request #4050 from jestabro/revise-migration-circinus

T6007: revise migration system

1 files changed, 43 insertions, 72 deletions

diff --git a/src/migration-scripts/policy/4-to-5 b/src/migration-scripts/policy/4-to-5
index 738850f67..0ecfdfd5e 100755..100644
--- a/src/migration-scripts/policy/4-to-5
+++ b/src/migration-scripts/policy/4-to-5
@@ -1,39 +1,24 @@
-#!/usr/bin/env python3
+# Copyright 2022-2024 VyOS maintainers and contributors <maintainers@vyos.io>
 #
-# Copyright (C) 2022-2024 VyOS maintainers and contributors
+# This library is free software; you can redistribute it and/or
+# modify it under the terms of the GNU Lesser General Public
+# License as published by the Free Software Foundation; either
+# version 2.1 of the License, or (at your option) any later version.
 #
-# This program is free software; you can redistribute it and/or modify
-# it under the terms of the GNU General Public License version 2 or later as
-# published by the Free Software Foundation.
-#
-# This program is distributed in the hope that it will be useful,
+# This library is distributed in the hope that it will be useful,
 # but WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
-# GNU General Public License for more details.
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+# Lesser General Public License for more details.
 #
-# You should have received a copy of the GNU General Public License
-# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+# You should have received a copy of the GNU Lesser General Public License
+# along with this library.  If not, see <http://www.gnu.org/licenses/>.
 
 # T2199: Migrate interface policy nodes to policy route <name> interface <ifname>
 
-from sys import argv
-from sys import exit
-
 from vyos.configtree import ConfigTree
 
-if len(argv) < 2:
-    print("Must specify file name!")
-    exit(1)
-
-file_name = argv[1]
-
-with open(file_name, 'r') as f:
-    config_file = f.read()
-
 base4 = ['policy', 'route']
 base6 = ['policy', 'route6']
-config = ConfigTree(config_file)
-
 
 def delete_orphaned_interface_policy(config, iftype, ifname, vif=None, vifs=None, vifc=None):
     """Delete unexpected policy on interfaces in cases when
@@ -55,35 +40,6 @@ def delete_orphaned_interface_policy(config, iftype, ifname, vif=None, vifs=None
 
     config.delete(if_path + ['policy'])
 
-
-if not config.exists(base4) and not config.exists(base6):
-    # Delete orphaned nodes on interfaces T5941
-    for iftype in config.list_nodes(['interfaces']):
-        for ifname in config.list_nodes(['interfaces', iftype]):
-            delete_orphaned_interface_policy(config, iftype, ifname)
-
-            if config.exists(['interfaces', iftype, ifname, 'vif']):
-                for vif in config.list_nodes(['interfaces', iftype, ifname, 'vif']):
-                    delete_orphaned_interface_policy(config, iftype, ifname, vif=vif)
-
-            if config.exists(['interfaces', iftype, ifname, 'vif-s']):
-                for vifs in config.list_nodes(['interfaces', iftype, ifname, 'vif-s']):
-                    delete_orphaned_interface_policy(config, iftype, ifname, vifs=vifs)
-
-                    if config.exists(['interfaces', iftype, ifname, 'vif-s', vifs, 'vif-c']):
-                        for vifc in config.list_nodes(['interfaces', iftype, ifname, 'vif-s', vifs, 'vif-c']):
-                            delete_orphaned_interface_policy(config, iftype, ifname, vifs=vifs, vifc=vifc)
-
-    try:
-        with open(file_name, 'w') as f:
-            f.write(config.to_string())
-    except OSError as e:
-        print("Failed to save the modified config: {}".format(e))
-        exit(1)
-
-    # Nothing to do
-    exit(0)
-
 def migrate_interface(config, iftype, ifname, vif=None, vifs=None, vifc=None):
     if_path = ['interfaces', iftype, ifname]
     ifname_full = ifname
@@ -111,25 +67,40 @@ def migrate_interface(config, iftype, ifname, vif=None, vifs=None, vifc=None):
 
     config.delete(if_path + ['policy'])
 
-for iftype in config.list_nodes(['interfaces']):
-    for ifname in config.list_nodes(['interfaces', iftype]):
-        migrate_interface(config, iftype, ifname)
+def migrate(config: ConfigTree) -> None:
+    if not config.exists(base4) and not config.exists(base6):
+        # Delete orphaned nodes on interfaces T5941
+        for iftype in config.list_nodes(['interfaces']):
+            for ifname in config.list_nodes(['interfaces', iftype]):
+                delete_orphaned_interface_policy(config, iftype, ifname)
+
+                if config.exists(['interfaces', iftype, ifname, 'vif']):
+                    for vif in config.list_nodes(['interfaces', iftype, ifname, 'vif']):
+                        delete_orphaned_interface_policy(config, iftype, ifname, vif=vif)
 
-        if config.exists(['interfaces', iftype, ifname, 'vif']):
-            for vif in config.list_nodes(['interfaces', iftype, ifname, 'vif']):
-                migrate_interface(config, iftype, ifname, vif=vif)
+                if config.exists(['interfaces', iftype, ifname, 'vif-s']):
+                    for vifs in config.list_nodes(['interfaces', iftype, ifname, 'vif-s']):
+                        delete_orphaned_interface_policy(config, iftype, ifname, vifs=vifs)
 
-        if config.exists(['interfaces', iftype, ifname, 'vif-s']):
-            for vifs in config.list_nodes(['interfaces', iftype, ifname, 'vif-s']):
-                migrate_interface(config, iftype, ifname, vifs=vifs)
+                        if config.exists(['interfaces', iftype, ifname, 'vif-s', vifs, 'vif-c']):
+                            for vifc in config.list_nodes(['interfaces', iftype, ifname, 'vif-s', vifs, 'vif-c']):
+                                delete_orphaned_interface_policy(config, iftype, ifname, vifs=vifs, vifc=vifc)
 
-                if config.exists(['interfaces', iftype, ifname, 'vif-s', vifs, 'vif-c']):
-                    for vifc in config.list_nodes(['interfaces', iftype, ifname, 'vif-s', vifs, 'vif-c']):
-                        migrate_interface(config, iftype, ifname, vifs=vifs, vifc=vifc)
+        # Nothing to do
+        return
+
+    for iftype in config.list_nodes(['interfaces']):
+        for ifname in config.list_nodes(['interfaces', iftype]):
+            migrate_interface(config, iftype, ifname)
 
-try:
-    with open(file_name, 'w') as f:
-        f.write(config.to_string())
-except OSError as e:
-    print("Failed to save the modified config: {}".format(e))
-    exit(1)
+            if config.exists(['interfaces', iftype, ifname, 'vif']):
+                for vif in config.list_nodes(['interfaces', iftype, ifname, 'vif']):
+                    migrate_interface(config, iftype, ifname, vif=vif)
+
+            if config.exists(['interfaces', iftype, ifname, 'vif-s']):
+                for vifs in config.list_nodes(['interfaces', iftype, ifname, 'vif-s']):
+                    migrate_interface(config, iftype, ifname, vifs=vifs)
+
+                    if config.exists(['interfaces', iftype, ifname, 'vif-s', vifs, 'vif-c']):
+                        for vifc in config.list_nodes(['interfaces', iftype, ifname, 'vif-s', vifs, 'vif-c']):
+                            migrate_interface(config, iftype, ifname, vifs=vifs, vifc=vifc)