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

T6007: revise migration system

1 files changed, 34 insertions, 53 deletions

diff --git a/src/migration-scripts/dns-dynamic/3-to-4 b/src/migration-scripts/dns-dynamic/3-to-4
index b888a3b6b..c8e1ffeee 100755..100644
--- a/src/migration-scripts/dns-dynamic/3-to-4
+++ b/src/migration-scripts/dns-dynamic/3-to-4
@@ -1,18 +1,17 @@
-#!/usr/bin/env python3
-
-# Copyright (C) 2024 VyOS maintainers and contributors
+# Copyright 2024 VyOS maintainers and contributors <maintainers@vyos.io>
 #
-# 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 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 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/>.
 
 # T5966:
 # - migrate "service dns dynamic name <service> address <interface>"
@@ -22,55 +21,37 @@
 #        to "service dns dynamic name <service> address web ..."
 #      when <interface> == 'web'
 
-import sys
 from vyos.configtree import ConfigTree
 
-if len(sys.argv) < 2:
-    print("Must specify file name!")
-    sys.exit(1)
-
-file_name = sys.argv[1]
-
-with open(file_name, 'r') as f:
-    config_file = f.read()
-
-config = ConfigTree(config_file)
-
 base_path = ['service', 'dns', 'dynamic', 'name']
 
-if not config.exists(base_path):
-    # Nothing to do
-    sys.exit(0)
-
-for service in config.list_nodes(base_path):
+def migrate(config: ConfigTree) -> None:
+    if not config.exists(base_path):
+        # Nothing to do
+        return
 
-    service_path = base_path + [service]
+    for service in config.list_nodes(base_path):
 
-    if config.exists(service_path + ['address']):
-        address = config.return_value(service_path + ['address'])
-        # 'address' is not a leaf node anymore, delete it first
-        config.delete(service_path + ['address'])
+        service_path = base_path + [service]
 
-        # When address is an interface (not 'web'), move it to 'address interface'
-        if address != 'web':
-            config.set(service_path + ['address', 'interface'], address)
+        if config.exists(service_path + ['address']):
+            address = config.return_value(service_path + ['address'])
+            # 'address' is not a leaf node anymore, delete it first
+            config.delete(service_path + ['address'])
 
-        else: # address == 'web'
-            # Relocate optional 'web-options' directly under 'address web'
-            if config.exists(service_path + ['web-options']):
-                # config.copy does not recursively create a path, so initialize it
-                config.set(service_path + ['address'])
-                config.copy(service_path + ['web-options'],
-                            service_path + ['address', 'web'])
-                config.delete(service_path + ['web-options'])
+            # When address is an interface (not 'web'), move it to 'address interface'
+            if address != 'web':
+                config.set(service_path + ['address', 'interface'], address)
 
-            # ensure that valueless 'address web' still exists even if there are no 'web-options'
-            if not config.exists(service_path + ['address', 'web']):
-                config.set(service_path + ['address', 'web'])
+            else: # address == 'web'
+                # Relocate optional 'web-options' directly under 'address web'
+                if config.exists(service_path + ['web-options']):
+                    # config.copy does not recursively create a path, so initialize it
+                    config.set(service_path + ['address'])
+                    config.copy(service_path + ['web-options'],
+                                service_path + ['address', 'web'])
+                    config.delete(service_path + ['web-options'])
 
-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))
-    sys.exit(1)
+                # ensure that valueless 'address web' still exists even if there are no 'web-options'
+                if not config.exists(service_path + ['address', 'web']):
+                    config.set(service_path + ['address', 'web'])