Merge pull request #3268 from vyos/mergify/bp/sagitta/pr-3263

ipoe: T6205: error in migration script logic while renaming mac-address to mac node (backport #3263)

3 files changed, 66 insertions, 108 deletions

diff --git a/src/conf_mode/service_ipoe-server.py b/src/conf_mode/service_ipoe-server.py
index 852b714eb..11e950782 100755
--- a/src/conf_mode/service_ipoe-server.py
+++ b/src/conf_mode/service_ipoe-server.py
@@ -68,8 +68,8 @@ def verify(ipoe):
     for interface, iface_config in ipoe['interface'].items():
         verify_interface_exists(interface)
         if 'client_subnet' in iface_config and 'vlan' in iface_config:
-            raise ConfigError('Option "client-subnet" incompatible with "vlan"!'
-                              'Use "ipoe client-ip-pool" instead.')
+            raise ConfigError('Option "client-subnet" and "vlan" are mutually exclusive, '
+                              'use "client-ip-pool" instead!')
 
     verify_accel_ppp_authentication(ipoe, local_users=False)
     verify_accel_ppp_ip_pool(ipoe)
diff --git a/src/migration-scripts/ipoe-server/0-to-1 b/src/migration-scripts/ipoe-server/0-to-1
deleted file mode 100755
index a6dd46ac1..000000000
--- a/src/migration-scripts/ipoe-server/0-to-1
+++ /dev/null
@@ -1,71 +0,0 @@
-#!/usr/bin/env python3
-#
-# Copyright (C) 2022-2024 VyOS maintainers and contributors
-#
-# 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,
-# 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.
-#
-# You should have received a copy of the GNU General Public License
-# along with this program.  If not, see <http://www.gnu.org/licenses/>.
-
-# - T4703: merge vlan-id and vlan-range to vlan CLI node
-
-# L2|L3 -> l2|l3
-# mac-address -> mac
-# network-mode -> mode
-
-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)
-base = ['service', 'ipoe-server']
-if not config.exists(base):
-    # Nothing to do
-    exit(0)
-
-if config.exists(base + ['authentication', 'interface']):
-    for interface in config.list_nodes(base + ['authentication', 'interface']):
-        config.rename(base + ['authentication', 'interface', interface, 'mac-address'], 'mac')
-
-        mac_base = base + ['authentication', 'interface', interface, 'mac']
-        for mac in config.list_nodes(mac_base):
-            vlan_config = mac_base + [mac, 'vlan-id']
-            if config.exists(vlan_config):
-                config.rename(vlan_config, 'vlan')
-
-for interface in config.list_nodes(base + ['interface']):
-    base_path = base + ['interface', interface]
-    for vlan in ['vlan-id', 'vlan-range']:
-        if config.exists(base_path + [vlan]):
-            print(interface, vlan)
-            for tmp in config.return_values(base_path + [vlan]):
-                config.set(base_path + ['vlan'], value=tmp, replace=False)
-            config.delete(base_path + [vlan])
-
-    if config.exists(base_path + ['network-mode']):
-        tmp = config.return_value(base_path + ['network-mode'])
-        config.delete(base_path + ['network-mode'])
-        # Change L2|L3 to lower case l2|l3
-        config.set(base_path + ['mode'], value=tmp.lower())
-
-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)
diff --git a/src/migration-scripts/ipoe-server/1-to-2 b/src/migration-scripts/ipoe-server/1-to-2
index 378702693..6a7111541 100755
--- a/src/migration-scripts/ipoe-server/1-to-2
+++ b/src/migration-scripts/ipoe-server/1-to-2
@@ -1,6 +1,6 @@
 #!/usr/bin/env python3
 #
-# Copyright (C) 2023 VyOS maintainers and contributors
+# Copyright (C) 2023-2024 VyOS maintainers and contributors
 #
 # 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
@@ -14,6 +14,11 @@
 # You should have received a copy of the GNU General Public License
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
+# - T4703: merge vlan-id and vlan-range to vlan CLI node
+# L2|L3 -> l2|l3
+# mac-address -> mac
+# network-mode -> mode
+
 # - changed cli of all named pools
 # - moved gateway-address from pool to global configuration with / netmask
 #   gateway can exist without pool if radius is used
@@ -39,43 +44,67 @@ with open(file_name, 'r') as f:
 
 config = ConfigTree(config_file)
 base = ['service', 'ipoe-server']
-pool_base = base + ['client-ip-pool']
+
 if not config.exists(base):
     exit(0)
 
-if not config.exists(pool_base):
-    exit(0)
-default_pool = ''
-gateway = ''
-
-#named pool migration
-namedpools_base = pool_base + ['name']
-
-for pool_name in config.list_nodes(namedpools_base):
-    pool_path = namedpools_base + [pool_name]
-    if config.exists(pool_path + ['subnet']):
-        subnet = config.return_value(pool_path + ['subnet'])
-        config.set(pool_base + [pool_name, 'range'], value=subnet, replace=False)
-        # Get netmask from subnet
-        mask = subnet.split("/")[1]
-    if config.exists(pool_path + ['next-pool']):
-        next_pool = config.return_value(pool_path + ['next-pool'])
-        config.set(pool_base + [pool_name, 'next-pool'], value=next_pool)
-        if not default_pool:
-            default_pool = pool_name
-    if config.exists(pool_path + ['gateway-address']) and mask:
-        gateway = f'{config.return_value(pool_path + ["gateway-address"])}/{mask}'
-        config.set(base + ['gateway-address'], value=gateway, replace=False)
-
-if not default_pool and config.list_nodes(namedpools_base):
-    default_pool = config.list_nodes(namedpools_base)[0]
-
-config.delete(namedpools_base)
-
-if default_pool:
-    config.set(base + ['default-pool'], value=default_pool)
-# format as tag node
-config.set_tag(pool_base)
+if config.exists(base + ['authentication', 'interface']):
+    for interface in config.list_nodes(base + ['authentication', 'interface']):
+        config.rename(base + ['authentication', 'interface', interface, 'mac-address'], 'mac')
+
+        mac_base = base + ['authentication', 'interface', interface, 'mac']
+        for mac in config.list_nodes(mac_base):
+            vlan_config = mac_base + [mac, 'vlan-id']
+            if config.exists(vlan_config):
+                config.rename(vlan_config, 'vlan')
+
+for interface in config.list_nodes(base + ['interface']):
+    base_path = base + ['interface', interface]
+    for vlan in ['vlan-id', 'vlan-range']:
+        if config.exists(base_path + [vlan]):
+            for tmp in config.return_values(base_path + [vlan]):
+                config.set(base_path + ['vlan'], value=tmp, replace=False)
+            config.delete(base_path + [vlan])
+
+    if config.exists(base_path + ['network-mode']):
+        tmp = config.return_value(base_path + ['network-mode'])
+        config.delete(base_path + ['network-mode'])
+        # Change L2|L3 to lower case l2|l3
+        config.set(base_path + ['mode'], value=tmp.lower())
+
+pool_base = base + ['client-ip-pool']
+if config.exists(pool_base):
+    default_pool = ''
+    gateway = ''
+
+    #named pool migration
+    namedpools_base = pool_base + ['name']
+
+    for pool_name in config.list_nodes(namedpools_base):
+        pool_path = namedpools_base + [pool_name]
+        if config.exists(pool_path + ['subnet']):
+            subnet = config.return_value(pool_path + ['subnet'])
+            config.set(pool_base + [pool_name, 'range'], value=subnet, replace=False)
+            # Get netmask from subnet
+            mask = subnet.split("/")[1]
+        if config.exists(pool_path + ['next-pool']):
+            next_pool = config.return_value(pool_path + ['next-pool'])
+            config.set(pool_base + [pool_name, 'next-pool'], value=next_pool)
+            if not default_pool:
+                default_pool = pool_name
+        if config.exists(pool_path + ['gateway-address']) and mask:
+            gateway = f'{config.return_value(pool_path + ["gateway-address"])}/{mask}'
+            config.set(base + ['gateway-address'], value=gateway, replace=False)
+
+    if not default_pool and config.list_nodes(namedpools_base):
+        default_pool = config.list_nodes(namedpools_base)[0]
+
+    config.delete(namedpools_base)
+
+    if default_pool:
+        config.set(base + ['default-pool'], value=default_pool)
+    # format as tag node
+    config.set_tag(pool_base)
 
 try:
     with open(file_name, 'w') as f: