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

T6007: revise migration system

3 files changed, 198 insertions, 255 deletions

diff --git a/src/migration-scripts/vrf/0-to-1 b/src/migration-scripts/vrf/0-to-1
index 8187138d9..70abae2a8 100755..100644
--- a/src/migration-scripts/vrf/0-to-1
+++ b/src/migration-scripts/vrf/0-to-1
@@ -1,132 +1,113 @@
-#!/usr/bin/env python3
+# Copyright 2021-2024 VyOS maintainers and contributors <maintainers@vyos.io>
 #
-# Copyright (C) 2021 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/>.
 
 # - T2450: drop interface-route and interface-route6 from "protocols vrf"
 
-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()
-
 base = ['protocols', 'vrf']
-config = ConfigTree(config_file)
-
-if not config.exists(base):
-    # Nothing to do
-    exit(0)
-
-for vrf in config.list_nodes(base):
-    static_base = base + [vrf, 'static']
-    if not config.exists(static_base):
-        continue
-
-    #
-    # Migrate interface-route into route
-    #
-    interface_route_path = static_base + ['interface-route']
-    if config.exists(interface_route_path):
-        for route in config.list_nodes(interface_route_path):
-            interface = config.list_nodes(interface_route_path + [route, 'next-hop-interface'])
-
-            tmp = interface_route_path + [route, 'next-hop-interface']
-            for interface in config.list_nodes(tmp):
-                new_base = static_base + ['route', route, 'interface']
-                config.set(new_base)
-                config.set_tag(new_base)
-                config.copy(tmp + [interface], new_base + [interface])
-
-        config.delete(interface_route_path)
-
-    #
-    # Migrate interface-route6 into route6
-    #
-    interface_route_path = static_base + ['interface-route6']
-    if config.exists(interface_route_path):
-        for route in config.list_nodes(interface_route_path):
-            interface = config.list_nodes(interface_route_path + [route, 'next-hop-interface'])
-
-            tmp = interface_route_path + [route, 'next-hop-interface']
-            for interface in config.list_nodes(tmp):
-                new_base = static_base + ['route6', route, 'interface']
-                config.set(new_base)
-                config.set_tag(new_base)
-                config.copy(tmp + [interface], new_base + [interface])
-
-        config.delete(interface_route_path)
-
-    #
-    # Cleanup nodes inside route
-    #
-    route_path = static_base + ['route']
-    if config.exists(route_path):
-        for route in config.list_nodes(route_path):
-            next_hop = route_path + [route, 'next-hop']
-            if config.exists(next_hop):
-                for gateway in config.list_nodes(next_hop):
-                    interface_path = next_hop + [gateway, 'next-hop-interface']
-                    if config.exists(interface_path):
-                        config.rename(interface_path, 'interface')
-                    vrf_path = next_hop + [gateway, 'next-hop-vrf']
-                    if config.exists(vrf_path):
-                        config.rename(vrf_path, 'vrf')
-
-            next_hop = route_path + [route, 'interface']
-            if config.exists(next_hop):
-                for interface in config.list_nodes(next_hop):
-                    interface_path = next_hop + [interface, 'next-hop-interface']
-                    if config.exists(interface_path):
-                        config.rename(interface_path, 'interface')
-                    vrf_path = next_hop + [interface, 'next-hop-vrf']
-                    if config.exists(vrf_path):
-                        config.rename(vrf_path, 'vrf')
-
-    #
-    # Cleanup nodes inside route6
-    #
-    route_path = static_base + ['route6']
-    if config.exists(route_path):
-        for route in config.list_nodes(route_path):
-            next_hop = route_path + [route, 'next-hop']
-            if config.exists(next_hop):
-                for gateway in config.list_nodes(next_hop):
-                    vrf_path = next_hop + [gateway, 'next-hop-vrf']
-                    if config.exists(vrf_path):
-                        config.rename(vrf_path, 'vrf')
-
-            next_hop = route_path + [route, 'interface']
-            if config.exists(next_hop):
-                for interface in config.list_nodes(next_hop):
-                    interface_path = next_hop + [interface, 'next-hop-interface']
-                    if config.exists(interface_path):
-                        config.rename(interface_path, 'interface')
-                    vrf_path = next_hop + [interface, 'next-hop-vrf']
-                    if config.exists(vrf_path):
-                        config.rename(vrf_path, 'vrf')
 
-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)
+def migrate(config: ConfigTree) -> None:
+    if not config.exists(base):
+        # Nothing to do
+        return
+
+    for vrf in config.list_nodes(base):
+        static_base = base + [vrf, 'static']
+        if not config.exists(static_base):
+            continue
+
+        #
+        # Migrate interface-route into route
+        #
+        interface_route_path = static_base + ['interface-route']
+        if config.exists(interface_route_path):
+            for route in config.list_nodes(interface_route_path):
+                interface = config.list_nodes(interface_route_path + [route, 'next-hop-interface'])
+
+                tmp = interface_route_path + [route, 'next-hop-interface']
+                for interface in config.list_nodes(tmp):
+                    new_base = static_base + ['route', route, 'interface']
+                    config.set(new_base)
+                    config.set_tag(new_base)
+                    config.copy(tmp + [interface], new_base + [interface])
+
+            config.delete(interface_route_path)
+
+        #
+        # Migrate interface-route6 into route6
+        #
+        interface_route_path = static_base + ['interface-route6']
+        if config.exists(interface_route_path):
+            for route in config.list_nodes(interface_route_path):
+                interface = config.list_nodes(interface_route_path + [route, 'next-hop-interface'])
+
+                tmp = interface_route_path + [route, 'next-hop-interface']
+                for interface in config.list_nodes(tmp):
+                    new_base = static_base + ['route6', route, 'interface']
+                    config.set(new_base)
+                    config.set_tag(new_base)
+                    config.copy(tmp + [interface], new_base + [interface])
+
+            config.delete(interface_route_path)
+
+        #
+        # Cleanup nodes inside route
+        #
+        route_path = static_base + ['route']
+        if config.exists(route_path):
+            for route in config.list_nodes(route_path):
+                next_hop = route_path + [route, 'next-hop']
+                if config.exists(next_hop):
+                    for gateway in config.list_nodes(next_hop):
+                        interface_path = next_hop + [gateway, 'next-hop-interface']
+                        if config.exists(interface_path):
+                            config.rename(interface_path, 'interface')
+                        vrf_path = next_hop + [gateway, 'next-hop-vrf']
+                        if config.exists(vrf_path):
+                            config.rename(vrf_path, 'vrf')
+
+                next_hop = route_path + [route, 'interface']
+                if config.exists(next_hop):
+                    for interface in config.list_nodes(next_hop):
+                        interface_path = next_hop + [interface, 'next-hop-interface']
+                        if config.exists(interface_path):
+                            config.rename(interface_path, 'interface')
+                        vrf_path = next_hop + [interface, 'next-hop-vrf']
+                        if config.exists(vrf_path):
+                            config.rename(vrf_path, 'vrf')
+
+        #
+        # Cleanup nodes inside route6
+        #
+        route_path = static_base + ['route6']
+        if config.exists(route_path):
+            for route in config.list_nodes(route_path):
+                next_hop = route_path + [route, 'next-hop']
+                if config.exists(next_hop):
+                    for gateway in config.list_nodes(next_hop):
+                        vrf_path = next_hop + [gateway, 'next-hop-vrf']
+                        if config.exists(vrf_path):
+                            config.rename(vrf_path, 'vrf')
+
+                next_hop = route_path + [route, 'interface']
+                if config.exists(next_hop):
+                    for interface in config.list_nodes(next_hop):
+                        interface_path = next_hop + [interface, 'next-hop-interface']
+                        if config.exists(interface_path):
+                            config.rename(interface_path, 'interface')
+                        vrf_path = next_hop + [interface, 'next-hop-vrf']
+                        if config.exists(vrf_path):
+                            config.rename(vrf_path, 'vrf')
diff --git a/src/migration-scripts/vrf/1-to-2 b/src/migration-scripts/vrf/1-to-2
index 52d4c2c7b..557a9ec58 100755..100644
--- a/src/migration-scripts/vrf/1-to-2
+++ b/src/migration-scripts/vrf/1-to-2
@@ -1,62 +1,43 @@
-#!/usr/bin/env python3
+# Copyright 2021-2024 VyOS maintainers and contributors <maintainers@vyos.io>
 #
-# Copyright (C) 2021 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/>.
 
 # - T3344: migrate routing options from "protocols vrf" to "vrf <name> protocols"
 
-from sys import argv
-from sys import exit
 from vyos.configtree import ConfigTree
 
-if len(argv) < 2:
-    print("Must specify file name!")
-    exit(1)
+base = ['protocols', 'vrf']
 
-file_name = argv[1]
+def migrate(config: ConfigTree) -> None:
+    if not config.exists(base):
+        # Nothing to do
+        return
 
-with open(file_name, 'r') as f:
-    config_file = f.read()
+    vrf_base = ['vrf', 'name']
+    config.set(vrf_base)
+    config.set_tag(vrf_base)
 
-base = ['protocols', 'vrf']
-config = ConfigTree(config_file)
-
-if not config.exists(base):
-    # Nothing to do
-    exit(0)
-
-vrf_base = ['vrf', 'name']
-config.set(vrf_base)
-config.set_tag(vrf_base)
-
-# Copy all existing static routes to the new base node under "vrf name <name> protocols static"
-for vrf in config.list_nodes(base):
-    static_base = base + [vrf, 'static']
-    if not config.exists(static_base):
-        continue
-
-    new_static_base = vrf_base + [vrf, 'protocols']
-    config.set(new_static_base)
-    config.copy(static_base, new_static_base + ['static'])
-    config.set_tag(new_static_base + ['static', 'route'])
-
-# Now delete the old configuration
-config.delete(base)
-
-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)
+    # Copy all existing static routes to the new base node under "vrf name <name> protocols static"
+    for vrf in config.list_nodes(base):
+        static_base = base + [vrf, 'static']
+        if not config.exists(static_base):
+            continue
+
+        new_static_base = vrf_base + [vrf, 'protocols']
+        config.set(new_static_base)
+        config.copy(static_base, new_static_base + ['static'])
+        config.set_tag(new_static_base + ['static', 'route'])
+
+    # Now delete the old configuration
+    config.delete(base)
diff --git a/src/migration-scripts/vrf/2-to-3 b/src/migration-scripts/vrf/2-to-3
index d45b185ee..acacffb41 100755..100644
--- a/src/migration-scripts/vrf/2-to-3
+++ b/src/migration-scripts/vrf/2-to-3
@@ -1,26 +1,23 @@
-#!/usr/bin/env python3
+# Copyright 2021-2024 VyOS maintainers and contributors <maintainers@vyos.io>
 #
-# Copyright (C) 2021 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/>.
 
 # Since connection tracking zones are int16, VRFs tables maximum value must
 # be limited to 65535
 # Also, interface names in nftables cannot start from numbers,
 # so VRF name should not start from a number
 
-from sys import argv
-from sys import exit
 from random import randrange
 from random import choice
 from string import ascii_lowercase
@@ -69,76 +66,60 @@ def _search_tables(config_commands, table_num):
     return table_items
 
 
-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()
-
 base = ['vrf', 'name']
-config = ConfigTree(config_file)
-
-if not config.exists(base):
-    # Nothing to do
-    exit(0)
-
-# Get a list of all currently used VRFs and tables
-vrfs_current = {}
-for vrf in config.list_nodes(base):
-    vrfs_current[vrf] = int(config.return_value(base + [vrf, 'table']))
-
-# Check VRF names and table numbers
-name_regex = re.compile(r'^\d.*$')
-for vrf_name, vrf_table in vrfs_current.items():
-    # Check table number
-    if vrf_table > 65535:
-        # Find new unused table number
-        vrfs_current[vrf_name] = None
-        while not vrfs_current[vrf_name]:
-            table_random = randrange(100, 65535)
-            if table_random not in vrfs_current.values():
-                vrfs_current[vrf_name] = table_random
-        # Update number to a new one
-        config.set(['vrf', 'name', vrf_name, 'table'],
-                   vrfs_current[vrf_name],
-                   replace=True)
-        # Check config items with old table number and replace to new one
-        config_commands = config.to_commands().split('\n')
-        table_config_lines = _search_tables(config_commands, vrf_table)
-        # Rename table nodes
-        if table_config_lines.get('table_tags'):
-            for table_config_path in table_config_lines.get('table_tags'):
-                config.rename(table_config_path, f'{vrfs_current[vrf_name]}')
-        # Replace table values
-        if table_config_lines.get('table_values'):
-            for table_config_path in table_config_lines.get('table_values'):
-                config.set(table_config_path,
-                           f'{vrfs_current[vrf_name]}',
-                           replace=True)
-
-    # Check VRF name
-    if name_regex.match(vrf_name):
-        vrf_name_new = None
-        while not vrf_name_new:
-            vrf_name_rand = f'{choice(ascii_lowercase)}{vrf_name}'[:15]
-            if vrf_name_rand not in vrfs_current:
-                vrf_name_new = vrf_name_rand
-        # Update VRF name to a new one
-        config.rename(['vrf', 'name', vrf_name], vrf_name_new)
-        # Check config items with old VRF name and replace to new one
-        config_commands = config.to_commands().split('\n')
-        vrf_config_lines = _search_vrfs(config_commands, vrf_name)
-        # Rename VRF to a new name
-        if vrf_config_lines:
-            for vrf_value_path in vrf_config_lines:
-                config.set(vrf_value_path, vrf_name_new, replace=True)
 
-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)
+def migrate(config: ConfigTree) -> None:
+    if not config.exists(base):
+        # Nothing to do
+        return
+
+    # Get a list of all currently used VRFs and tables
+    vrfs_current = {}
+    for vrf in config.list_nodes(base):
+        vrfs_current[vrf] = int(config.return_value(base + [vrf, 'table']))
+
+    # Check VRF names and table numbers
+    name_regex = re.compile(r'^\d.*$')
+    for vrf_name, vrf_table in vrfs_current.items():
+        # Check table number
+        if vrf_table > 65535:
+            # Find new unused table number
+            vrfs_current[vrf_name] = None
+            while not vrfs_current[vrf_name]:
+                table_random = randrange(100, 65535)
+                if table_random not in vrfs_current.values():
+                    vrfs_current[vrf_name] = table_random
+            # Update number to a new one
+            config.set(['vrf', 'name', vrf_name, 'table'],
+                       vrfs_current[vrf_name],
+                       replace=True)
+            # Check config items with old table number and replace to new one
+            config_commands = config.to_commands().split('\n')
+            table_config_lines = _search_tables(config_commands, vrf_table)
+            # Rename table nodes
+            if table_config_lines.get('table_tags'):
+                for table_config_path in table_config_lines.get('table_tags'):
+                    config.rename(table_config_path, f'{vrfs_current[vrf_name]}')
+            # Replace table values
+            if table_config_lines.get('table_values'):
+                for table_config_path in table_config_lines.get('table_values'):
+                    config.set(table_config_path,
+                               f'{vrfs_current[vrf_name]}',
+                               replace=True)
+
+        # Check VRF name
+        if name_regex.match(vrf_name):
+            vrf_name_new = None
+            while not vrf_name_new:
+                vrf_name_rand = f'{choice(ascii_lowercase)}{vrf_name}'[:15]
+                if vrf_name_rand not in vrfs_current:
+                    vrf_name_new = vrf_name_rand
+            # Update VRF name to a new one
+            config.rename(['vrf', 'name', vrf_name], vrf_name_new)
+            # Check config items with old VRF name and replace to new one
+            config_commands = config.to_commands().split('\n')
+            vrf_config_lines = _search_vrfs(config_commands, vrf_name)
+            # Rename VRF to a new name
+            if vrf_config_lines:
+                for vrf_value_path in vrf_config_lines:
+                    config.set(vrf_value_path, vrf_name_new, replace=True)