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

(cherry picked from commit 26740a8d583f64dc0a27b59dd4ae303056972c0b)

1 files changed, 31 insertions, 50 deletions

diff --git a/src/migration-scripts/snmp/1-to-2 b/src/migration-scripts/snmp/1-to-2
index e02cd1aa1..0120f8acb 100755..100644
--- a/src/migration-scripts/snmp/1-to-2
+++ b/src/migration-scripts/snmp/1-to-2
@@ -1,22 +1,25 @@
-#!/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
 
+# We no longer support hashed values prefixed with '0x' to unclutter
+# CLI and also calculate the hases in advance instead of retrieving
+# them after service startup - which was always a bad idea
+prefix = '0x'
+
 def migrate_keys(config, path):
     # authentication: rename node 'encrypted-key' -> 'encrypted-password'
     config_path_auth = path + ['auth', 'encrypted-key']
@@ -42,48 +45,26 @@ def migrate_keys(config, path):
             tmp = tmp.replace(prefix, '')
             config.set(config_path_priv, value=tmp)
 
-if __name__ == '__main__':
-    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 migrate(config: ConfigTree) -> None:
     config_base = ['service', 'snmp', 'v3']
 
     if not config.exists(config_base):
         # Nothing to do
-        exit(0)
-    else:
-        # We no longer support hashed values prefixed with '0x' to unclutter
-        # CLI and also calculate the hases in advance instead of retrieving
-        # them after service startup - which was always a bad idea
-        prefix = '0x'
-
-        config_engineid = config_base + ['engineid']
-        if config.exists(config_engineid):
-            tmp = config.return_value(config_engineid)
-            if tmp.startswith(prefix):
-                tmp = tmp.replace(prefix, '')
-                config.set(config_engineid, value=tmp)
+        return
 
-        config_user = config_base + ['user']
-        if config.exists(config_user):
-            for user in config.list_nodes(config_user):
-                migrate_keys(config, config_user + [user])
+    config_engineid = config_base + ['engineid']
+    if config.exists(config_engineid):
+        tmp = config.return_value(config_engineid)
+        if tmp.startswith(prefix):
+            tmp = tmp.replace(prefix, '')
+            config.set(config_engineid, value=tmp)
 
-        config_trap = config_base + ['trap-target']
-        if config.exists(config_trap):
-            for trap in config.list_nodes(config_trap):
-                migrate_keys(config, config_trap + [trap])
+    config_user = config_base + ['user']
+    if config.exists(config_user):
+        for user in config.list_nodes(config_user):
+            migrate_keys(config, config_user + [user])
 
-        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)
+    config_trap = config_base + ['trap-target']
+    if config.exists(config_trap):
+        for trap in config.list_nodes(config_trap):
+            migrate_keys(config, config_trap + [trap])