migration: T6007: convert all migration scripts to load as module

1 files changed, 34 insertions, 52 deletions

diff --git a/src/migration-scripts/pim/0-to-1 b/src/migration-scripts/pim/0-to-1
index bf8af733c..ce24b23ba 100755..100644
--- a/src/migration-scripts/pim/0-to-1
+++ b/src/migration-scripts/pim/0-to-1
@@ -1,72 +1,54 @@
-#!/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/>.
+# 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/>.
 
 # T5736: igmp: migrate "protocols igmp" to "protocols pim"
 
-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 = ['protocols', 'igmp']
 pim_base = ['protocols', 'pim']
-if not config.exists(base):
-    # Nothing to do
-    sys.exit(0)
 
-for interface in config.list_nodes(base + ['interface']):
-    base_igmp_iface = base + ['interface', interface]
-    pim_base_iface = pim_base + ['interface', interface]
+def migrate(config: ConfigTree) -> None:
+    if not config.exists(base):
+        # Nothing to do
+        return
 
-    # Create IGMP note under PIM interface
-    if not config.exists(pim_base_iface + ['igmp']):
-        config.set(pim_base_iface + ['igmp'])
+    for interface in config.list_nodes(base + ['interface']):
+        base_igmp_iface = base + ['interface', interface]
+        pim_base_iface = pim_base + ['interface', interface]
 
-    if config.exists(base_igmp_iface + ['join']):
-        config.copy(base_igmp_iface + ['join'], pim_base_iface + ['igmp', 'join'])
-        config.set_tag(pim_base_iface + ['igmp', 'join'])
+        # Create IGMP note under PIM interface
+        if not config.exists(pim_base_iface + ['igmp']):
+            config.set(pim_base_iface + ['igmp'])
 
-        new_join_base = pim_base_iface + ['igmp', 'join']
-        for address in config.list_nodes(new_join_base):
-            if config.exists(new_join_base + [address, 'source']):
-                config.rename(new_join_base + [address, 'source'], 'source-address')
+        if config.exists(base_igmp_iface + ['join']):
+            config.copy(base_igmp_iface + ['join'], pim_base_iface + ['igmp', 'join'])
+            config.set_tag(pim_base_iface + ['igmp', 'join'])
 
-    if config.exists(base_igmp_iface + ['query-interval']):
-        config.copy(base_igmp_iface + ['query-interval'], pim_base_iface + ['igmp', 'query-interval'])
+            new_join_base = pim_base_iface + ['igmp', 'join']
+            for address in config.list_nodes(new_join_base):
+                if config.exists(new_join_base + [address, 'source']):
+                    config.rename(new_join_base + [address, 'source'], 'source-address')
 
-    if config.exists(base_igmp_iface + ['query-max-response-time']):
-        config.copy(base_igmp_iface + ['query-max-response-time'], pim_base_iface + ['igmp', 'query-max-response-time'])
+        if config.exists(base_igmp_iface + ['query-interval']):
+            config.copy(base_igmp_iface + ['query-interval'], pim_base_iface + ['igmp', 'query-interval'])
 
-    if config.exists(base_igmp_iface + ['version']):
-        config.copy(base_igmp_iface + ['version'], pim_base_iface + ['igmp', 'version'])
+        if config.exists(base_igmp_iface + ['query-max-response-time']):
+            config.copy(base_igmp_iface + ['query-max-response-time'], pim_base_iface + ['igmp', 'query-max-response-time'])
 
-config.delete(base)
+        if config.exists(base_igmp_iface + ['version']):
+            config.copy(base_igmp_iface + ['version'], pim_base_iface + ['igmp', 'version'])
 
-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)
+    config.delete(base)