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

T6007: revise migration system

1 files changed, 42 insertions, 62 deletions

diff --git a/src/migration-scripts/firewall/9-to-10 b/src/migration-scripts/firewall/9-to-10
index ce509a731..306a53a86 100755..100644
--- a/src/migration-scripts/firewall/9-to-10
+++ b/src/migration-scripts/firewall/9-to-10
@@ -1,18 +1,17 @@
-#!/usr/bin/env python3
+# Copyright 2023-2024 VyOS maintainers and contributors <maintainers@vyos.io>
 #
-# Copyright (C) 2023-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/>.
 
 # T5050: Log options
 #  cli changes from:
@@ -20,58 +19,39 @@
 #  To
 #  set firewall [name | ipv6-name] <name> rule <number> log-options level <log_level>
 
-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 = ['firewall']
-config = ConfigTree(config_file)
-
-if not config.exists(base):
-    # Nothing to do
-    exit(0)
-
-if config.exists(base + ['name']):
-    for name in config.list_nodes(base + ['name']):
-        if not config.exists(base + ['name', name, 'rule']):
-            continue
-
-        for rule in config.list_nodes(base + ['name', name, 'rule']):
-            log_options_base = base + ['name', name, 'rule', rule, 'log-options']
-            rule_log_level = base + ['name', name, 'rule', rule, 'log-level']
-
-            if config.exists(rule_log_level):
-                tmp = config.return_value(rule_log_level)
-                config.delete(rule_log_level)
-                config.set(log_options_base + ['level'], value=tmp)
-
-if config.exists(base + ['ipv6-name']):
-    for name in config.list_nodes(base + ['ipv6-name']):
-        if not config.exists(base + ['ipv6-name', name, 'rule']):
-            continue
-
-        for rule in config.list_nodes(base + ['ipv6-name', name, 'rule']):
-            log_options_base = base + ['ipv6-name', name, 'rule', rule, 'log-options']
-            rule_log_level = base + ['ipv6-name', name, 'rule', rule, 'log-level']
-
-            if config.exists(rule_log_level):
-                tmp = config.return_value(rule_log_level)
-                config.delete(rule_log_level)
-                config.set(log_options_base + ['level'], 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(base):
+        # Nothing to do
+        return
+
+    if config.exists(base + ['name']):
+        for name in config.list_nodes(base + ['name']):
+            if not config.exists(base + ['name', name, 'rule']):
+                continue
+
+            for rule in config.list_nodes(base + ['name', name, 'rule']):
+                log_options_base = base + ['name', name, 'rule', rule, 'log-options']
+                rule_log_level = base + ['name', name, 'rule', rule, 'log-level']
+
+                if config.exists(rule_log_level):
+                    tmp = config.return_value(rule_log_level)
+                    config.delete(rule_log_level)
+                    config.set(log_options_base + ['level'], value=tmp)
+
+    if config.exists(base + ['ipv6-name']):
+        for name in config.list_nodes(base + ['ipv6-name']):
+            if not config.exists(base + ['ipv6-name', name, 'rule']):
+                continue
+
+            for rule in config.list_nodes(base + ['ipv6-name', name, 'rule']):
+                log_options_base = base + ['ipv6-name', name, 'rule', rule, 'log-options']
+                rule_log_level = base + ['ipv6-name', name, 'rule', rule, 'log-level']
+
+                if config.exists(rule_log_level):
+                    tmp = config.return_value(rule_log_level)
+                    config.delete(rule_log_level)
+                    config.set(log_options_base + ['level'], value=tmp)