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

T6007: revise migration system

3 files changed, 92 insertions, 129 deletions

diff --git a/src/migration-scripts/nat66/0-to-1 b/src/migration-scripts/nat66/0-to-1
index 444b2315f..b3c6bf4cc 100755..100644
--- a/src/migration-scripts/nat66/0-to-1
+++ b/src/migration-scripts/nat66/0-to-1
@@ -1,33 +1,20 @@
-#!/usr/bin/env python3
+# Copyright 2020-2024 VyOS maintainers and contributors <maintainers@vyos.io>
 #
-# Copyright (C) 2020 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/>.
 
-from sys import argv,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()
-
-config = ConfigTree(config_file)
-
 def merge_npt(config,base,rule):
     merge_base = ['nat66','source','rule',rule]
     # Configure migration functions
@@ -51,21 +38,15 @@ def merge_npt(config,base,rule):
         tmp = config.return_value(base + ['translation','prefix'])
         config.set(merge_base + ['translation','address'],value=tmp)
 
-if not config.exists(['nat', 'nptv6']):
-    # Nothing to do
-    exit(0)
-
-for rule in config.list_nodes(['nat', 'nptv6', 'rule']):
-    base = ['nat', 'nptv6', 'rule', rule]
-    # Merge 'nat nptv6' to 'nat66 source'
-    merge_npt(config,base,rule)
+def migrate(config: ConfigTree) -> None:
+    if not config.exists(['nat', 'nptv6']):
+        # Nothing to do
+        return
 
-# Delete the original NPT configuration
-config.delete(['nat','nptv6']);
+    for rule in config.list_nodes(['nat', 'nptv6', 'rule']):
+        base = ['nat', 'nptv6', 'rule', rule]
+        # Merge 'nat nptv6' to 'nat66 source'
+        merge_npt(config,base,rule)
 
-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)
+    # Delete the original NPT configuration
+    config.delete(['nat','nptv6']);
diff --git a/src/migration-scripts/nat66/1-to-2 b/src/migration-scripts/nat66/1-to-2
index b7d4e3f6b..f49940ae0 100755..100644
--- a/src/migration-scripts/nat66/1-to-2
+++ b/src/migration-scripts/nat66/1-to-2
@@ -14,50 +14,48 @@
 # You should have received a copy of the GNU General Public License
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
+# Copyright 2023-2024 VyOS maintainers and contributors <maintainers@vyos.io>
+#
+# 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 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
+# Lesser General Public License for more details.
+#
+# 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/>.
+
 # T5681: Firewall re-writing. Simplify cli when mathcing interface
 # From
 #   'set nat66 [source|destination] rule X [inbound-interface|outbound interface] <iface>'
 # to
 #   'set nat66 [source|destination] rule X [inbound-interface|outbound interface] name <iface>'
 
-from sys import argv,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()
-
-config = ConfigTree(config_file)
-if not config.exists(['nat66']):
-    # Nothing to do
-    exit(0)
-
-for direction in ['source', 'destination']:
-    # If a node doesn't exist, we obviously have nothing to do.
-    if not config.exists(['nat66', direction]):
-        continue
-
-    # However, we also need to handle the case when a 'source' or 'destination' sub-node does exist,
-    # but there are no rules under it.
-    if not config.list_nodes(['nat66', direction]):
-        continue
-
-    for rule in config.list_nodes(['nat66', direction, 'rule']):
-        base = ['nat66', direction, 'rule', rule]
-        for iface in ['inbound-interface','outbound-interface']:
-            if config.exists(base + [iface]):
-                tmp = config.return_value(base + [iface])
-                config.delete(base + [iface])
-                config.set(base + [iface, 'name'], value=tmp)
-
-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(['nat66']):
+        # Nothing to do
+        return
+
+    for direction in ['source', 'destination']:
+        # If a node doesn't exist, we obviously have nothing to do.
+        if not config.exists(['nat66', direction]):
+            continue
+
+        # However, we also need to handle the case when a 'source' or 'destination' sub-node does exist,
+        # but there are no rules under it.
+        if not config.list_nodes(['nat66', direction]):
+            continue
+
+        for rule in config.list_nodes(['nat66', direction, 'rule']):
+            base = ['nat66', direction, 'rule', rule]
+            for iface in ['inbound-interface','outbound-interface']:
+                if config.exists(base + [iface]):
+                    tmp = config.return_value(base + [iface])
+                    config.delete(base + [iface])
+                    config.set(base + [iface, 'name'], value=tmp)
diff --git a/src/migration-scripts/nat66/2-to-3 b/src/migration-scripts/nat66/2-to-3
index f34f170b3..55d5f4b2b 100755..100644
--- a/src/migration-scripts/nat66/2-to-3
+++ b/src/migration-scripts/nat66/2-to-3
@@ -1,61 +1,45 @@
-#!/usr/bin/env python3
+# Copyright 2023-2024 VyOS maintainers and contributors <maintainers@vyos.io>
 #
-# Copyright (C) 2023 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/>.
-
-from sys import argv,exit
-from vyos.configtree import ConfigTree
+# 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/>.
 
-if len(argv) < 2:
-    print("Must specify file name!")
-    exit(1)
+# T2898: add ndp-proxy service
 
-file_name = argv[1]
-
-with open(file_name, 'r') as f:
-    config_file = f.read()
+from vyos.configtree import ConfigTree
 
 base = ['nat66', 'source']
 new_base = ['service', 'ndp-proxy', 'interface']
 
-config = ConfigTree(config_file)
-if not config.exists(base):
-    # Nothing to do
-    exit(0)
-
-for rule in config.list_nodes(base + ['rule']):
-    base_rule = base + ['rule', rule]
-
-    interface = None
-    if config.exists(base_rule + ['outbound-interface', 'name']):
-        interface = config.return_value(base_rule + ['outbound-interface', 'name'])
-    else:
-        continue
-
-    prefix_base = base_rule + ['source', 'prefix']
-    if config.exists(prefix_base):
-        prefix = config.return_value(prefix_base)
-        config.set(new_base + [interface, 'prefix', prefix, 'mode'], value='static')
-        config.set_tag(new_base)
-        config.set_tag(new_base + [interface, 'prefix'])
-
-        if config.exists(base_rule + ['disable']):
-            config.set(new_base + [interface, 'prefix', prefix, 'disable'])
-
-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 rule in config.list_nodes(base + ['rule']):
+        base_rule = base + ['rule', rule]
+
+        interface = None
+        if config.exists(base_rule + ['outbound-interface', 'name']):
+            interface = config.return_value(base_rule + ['outbound-interface', 'name'])
+        else:
+            continue
+
+        prefix_base = base_rule + ['source', 'prefix']
+        if config.exists(prefix_base):
+            prefix = config.return_value(prefix_base)
+            config.set(new_base + [interface, 'prefix', prefix, 'mode'], value='static')
+            config.set_tag(new_base)
+            config.set_tag(new_base + [interface, 'prefix'])
+
+            if config.exists(base_rule + ['disable']):
+                config.set(new_base + [interface, 'prefix', prefix, 'disable'])