pppoe-server: T4703: combine vlan-id and vlan-range into single CLI node

The initial Accel-PPP PPPoE implementation used:

set service pppoe-server interface <name> vlan-id <id>
set service pppoe-server interface <name> vlan-range <start-stop>

This is actually a duplicated CLI node.

2 files changed, 60 insertions, 17 deletions

diff --git a/src/conf_mode/service_pppoe-server.py b/src/conf_mode/service_pppoe-server.py
index 6086ef859..dfe73094f 100755
--- a/src/conf_mode/service_pppoe-server.py
+++ b/src/conf_mode/service_pppoe-server.py
@@ -1,6 +1,6 @@
 #!/usr/bin/env python3
 #
-# Copyright (C) 2018-2020 VyOS maintainers and contributors
+# Copyright (C) 2018-2022 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
@@ -21,13 +21,12 @@ from sys import exit
 from vyos.config import Config
 from vyos.configdict import get_accel_dict
 from vyos.configverify import verify_accel_ppp_base_service
+from vyos.configverify import verify_interface_exists
 from vyos.template import render
 from vyos.util import call
 from vyos.util import dict_search
-from vyos.util import get_interface_config
 from vyos import ConfigError
 from vyos import airbag
-from vyos.range_regex import range_to_regex
 
 airbag.enable()
 
@@ -54,15 +53,14 @@ def verify(pppoe):
     verify_accel_ppp_base_service(pppoe)
 
     if 'wins_server' in pppoe and len(pppoe['wins_server']) > 2:
-        raise ConfigError('Not more then two IPv4 WINS name-servers can be configured')
+        raise ConfigError('Not more then two WINS name-servers can be configured')
 
     if 'interface' not in pppoe:
         raise ConfigError('At least one listen interface must be defined!')
 
     # Check is interface exists in the system
-    for iface in pppoe['interface']:
-        if not get_interface_config(iface):
-            raise ConfigError(f'Interface {iface} does not exist!')
+    for interface in pppoe['interface']:
+        verify_interface_exists(interface)
 
     # local ippool and gateway settings config checks
     if not (dict_search('client_ip_pool.subnet', pppoe) or
@@ -81,13 +79,6 @@ def generate(pppoe):
     if not pppoe:
         return None
 
-    # Generate special regex for dynamic interfaces
-    for iface in pppoe['interface']:
-        if 'vlan_range' in pppoe['interface'][iface]:
-            pppoe['interface'][iface]['regex'] = []
-            for vlan_range in pppoe['interface'][iface]['vlan_range']:
-                pppoe['interface'][iface]['regex'].append(range_to_regex(vlan_range))
-
     render(pppoe_conf, 'accel-ppp/pppoe.config.j2', pppoe)
 
     if dict_search('authentication.mode', pppoe) == 'local':
@@ -101,15 +92,15 @@ def generate(pppoe):
 
 
 def apply(pppoe):
+    systemd_service = 'accel-ppp@pppoe.service'
     if not pppoe:
-        call('systemctl stop accel-ppp@pppoe.service')
+        call(f'systemctl stop {systemd_service}')
         for file in [pppoe_conf, pppoe_chap_secrets]:
             if os.path.exists(file):
                 os.unlink(file)
-
         return None
 
-    call('systemctl restart accel-ppp@pppoe.service')
+    call(f'systemctl reload-or-restart {systemd_service}')
 
 if __name__ == '__main__':
     try:
diff --git a/src/migration-scripts/pppoe-server/5-to-6 b/src/migration-scripts/pppoe-server/5-to-6
new file mode 100755
index 000000000..e4888f4db
--- /dev/null
+++ b/src/migration-scripts/pppoe-server/5-to-6
@@ -0,0 +1,52 @@
+#!/usr/bin/env python3
+#
+# Copyright (C) 2022 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
+
+from vyos.configtree import ConfigTree
+from sys import argv
+from sys import exit
+
+if (len(argv) < 1):
+    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_path = ['service', 'pppoe-server', 'interface']
+if not config.exists(base_path):
+    # Nothing to do
+    exit(0)
+
+for interface in config.list_nodes(base_path):
+    for vlan in ['vlan-id', 'vlan-range']:
+        if config.exists(base_path + [interface, vlan]):
+            print(interface, vlan)
+            for tmp in config.return_values(base_path + [interface, vlan]):
+                config.set(base_path + [interface, 'vlan'], value=tmp, replace=False)
+            config.delete(base_path + [interface, vlan])
+
+try:
+    with open(file_name, 'w') as f:
+        f.write(config.to_string())
+except OSError as e:
+    print(f'Failed to save the modified config: {e}')
+    exit(1)
+