console-server: T2490: move CLI parsing to get_config_dict()

For more examples on the new get_config_dict() approach migrate this
implementation as it is not yet in production use. Also this serves as proof of
concept code for further migrations.

2 files changed, 101 insertions, 117 deletions

diff --git a/src/conf_mode/service_serial-proxy.py b/src/conf_mode/service_serial-proxy.py
new file mode 100755
index 000000000..85fcfed08
--- /dev/null
+++ b/src/conf_mode/service_serial-proxy.py
@@ -0,0 +1,101 @@
+#!/usr/bin/env python3
+#
+# Copyright (C) 2018-2020 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/>.
+
+import os
+
+from sys import exit
+
+from vyos.config import Config
+from vyos.configdict import dict_merge
+from vyos.template import render
+from vyos.util import call
+from vyos import ConfigError
+
+config_file = r'/etc/conserver/conserver.cf'
+
+# Default values are necessary until the implementation of T2588 is completed
+default_values = {
+    'data_bits': '8',
+    'parity': 'none',
+    'stop_bits': '1'
+}
+
+def get_config():
+    conf = Config()
+    base = ['service', 'serial-proxy']
+
+    if not conf.exists(base):
+        return None
+
+    # Retrieve CLI representation as dictionary
+    proxy = conf.get_config_dict(base, key_mangling=('-', '_'))
+    # The retrieved dictionary will look something like this:
+    #
+    # {'device': {'usb0b2.4p1.0': {'speed': '9600'},
+    #             'usb0b2.4p1.1': {'data_bits': '8',
+    #                              'parity': 'none',
+    #                              'speed': '115200',
+    #                              'stop_bits': '2'}}}
+
+    # We have gathered the dict representation of the CLI, but there are default
+    # options which we need to update into the dictionary retrived.
+    for device in proxy['device'].keys():
+        tmp = dict_merge(default_values, proxy['device'][device])
+        proxy['device'][device] = tmp
+
+    return proxy
+
+def verify(proxy):
+    if not proxy:
+        return None
+
+    for tmp in proxy['device']:
+        device = proxy['device'][tmp]
+        if not device['speed']:
+            raise ConfigError(f'Speed must be defined!')
+
+        if device['ssh']:
+            if not device['ssh']['port']:
+                raise ConfigError(f'SSH port must be defined!')
+
+    return None
+
+def generate(proxy):
+    if not proxy:
+        return None
+
+    render(config_file, 'conserver/conserver.conf.tmpl', proxy)
+    return None
+
+def apply(proxy):
+    if not proxy:
+        call('systemctl stop conserver-server.service')
+        if os.path.isfile(config_file):
+            os.unlink(config_file)
+        return None
+
+    call('systemctl restart conserver-server.service')
+    return None
+
+if __name__ == '__main__':
+    try:
+        c = get_config()
+        verify(c)
+        generate(c)
+        apply(c)
+    except ConfigError as e:
+        print(e)
+        exit(1)
diff --git a/src/conf_mode/system_serial-proxy.py b/src/conf_mode/system_serial-proxy.py
deleted file mode 100755
index 007277918..000000000
--- a/src/conf_mode/system_serial-proxy.py
+++ /dev/null
@@ -1,117 +0,0 @@
-#!/usr/bin/env python3
-#
-# Copyright (C) 2018-2020 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/>.
-
-import os
-
-from copy import deepcopy
-from sys import exit
-
-from vyos.config import Config
-from vyos.template import render
-from vyos.util import call
-from vyos import ConfigError
-
-config_file = r'/run/ser2net/ser2net.conf'
-
-default_config_data = {
-    'devices': [],
-}
-
-def get_config():
-    proxy = deepcopy(default_config_data)
-    conf = Config()
-    base = ['service', 'serial-proxy']
-
-    if not conf.exists(base):
-        return None
-    else:
-        conf.set_level(base)
-
-    for serial_port in conf.list_nodes(['device']):
-        conf.set_level(base + ['device', serial_port])
-        serial = {
-            'data_bits': '8',
-            'parity': 'none',
-            'port': '',
-            'serial_port': '/dev/serial/by-bus/' + serial_port,
-            'speed': '',
-            'stop_bits': '1',
-            'timeout': '600'
-        }
-
-        if conf.exists(['data-bits']):
-            serial['data_bits'] = conf.return_value(['data-bits'])
-
-        if conf.exists(['stop-bits']):
-            serial['stop_bits'] = conf.return_value(['stop-bits'])
-
-        if conf.exists(['parity']):
-            serial['parity'] = conf.return_value(['parity'])
-
-        if conf.exists(['port']):
-            serial['port'] = conf.return_value(['port'])
-
-        if conf.exists(['speed']):
-            serial['speed'] = conf.return_value(['speed'])
-
-        proxy['devices'].append(serial)
-
-    return proxy
-
-def verify(proxy):
-    if not proxy:
-        return None
-
-    for device in proxy['devices']:
-        if not os.path.exists('{serial_port}'.format(**device)):
-            raise ConfigError('Serial interface "{serial_port} does not exist"'
-                              .format(**device))
-
-        if not device['port']:
-            raise ConfigError(f'Port must be defined!')
-
-        if not device['speed']:
-            raise ConfigError(f'Speed must be defined!')
-
-    return None
-
-def generate(proxy):
-    if not proxy:
-        return None
-
-    render(config_file, 'ser2net/ser2net.conf.tmpl', proxy)
-    return None
-
-def apply(proxy):
-    if not proxy:
-        call('systemctl stop ser2net.service')
-        if os.path.isfile(config_file):
-            os.unlink(config_file)
-
-        return None
-
-    call('systemctl start ser2net.service')
-    return None
-
-if __name__ == '__main__':
-    try:
-        c = get_config()
-        verify(c)
-        generate(c)
-        apply(c)
-    except ConfigError as e:
-        print(e)
-        exit(1)