T4765: normalize dict fields in op mode ouputs

2 files changed, 85 insertions, 0 deletions

diff --git a/python/vyos/opmode.py b/python/vyos/opmode.py
index 7e3545c87..ac9c0c353 100644
--- a/python/vyos/opmode.py
+++ b/python/vyos/opmode.py
@@ -44,6 +44,13 @@ class PermissionDenied(Error):
     """
     pass
 
+class InternalError(Error):
+    """ Any situation when VyOS detects that it could not perform
+        an operation correctly due to logic errors in its own code
+        or errors in underlying software.
+    """
+    pass
+
 
 def _is_op_mode_function_name(name):
     if re.match(r"^(show|clear|reset|restart)", name):
@@ -93,6 +100,39 @@ def _get_arg_type(t):
     else:
         return t
 
+def _normalize_field_name(name):
+    # Replace all separators with underscores
+    name = re.sub(r'(\s|[\(\)\[\]\{\}\-\.\,:\"\'\`])+', '_', name)
+
+    # Replace specific characters with textual descriptions
+    name = re.sub(r'@', '_at_', name)
+    name = re.sub(r'%', '_percentage_', name)
+    name = re.sub(r'~', '_tilde_', name)
+
+    # Force all letters to lowercase
+    name = name.lower()
+
+    # Remove leading and trailing underscores, if any
+    name = re.sub(r'(^(_+)(?=[^_])|_+$)', '', name)
+
+    # Ensure there are only single underscores
+    name = re.sub(r'_+', '_', name)
+
+    return name
+
+def _normalize_field_names(old_dict):
+    new_dict = {}
+
+    for key in old_dict:
+        new_key = _normalize_field_name(key)
+        new_dict[new_key] = old_dict[key]
+
+    # Sanity check
+    if len(old_dict) != len(new_dict):
+        raise InternalError("Dictionary fields do not allow unique normalization")
+    else:
+        return new_dict
+
 def run(module):
     from argparse import ArgumentParser
 
@@ -145,6 +185,7 @@ def run(module):
         # they may return human-formatted output
         # or a raw dict that we need to serialize in JSON for printing
         res = func(**args)
+        res = _normalize_field_names(res)
         if not args["raw"]:
             return res
         else:
diff --git a/src/tests/test_op_mode.py b/src/tests/test_op_mode.py
new file mode 100644
index 000000000..4786357c5
--- /dev/null
+++ b/src/tests/test_op_mode.py
@@ -0,0 +1,44 @@
+#!/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/>.
+
+from unittest import TestCase
+
+import vyos.opmode
+
+class TestVyOSOpMode(TestCase):
+    def test_field_name_normalization(self):
+        from vyos.opmode import _normalize_field_name
+
+        self.assertEqual(_normalize_field_name(" foo bar "), "foo_bar")
+        self.assertEqual(_normalize_field_name("foo-bar"), "foo_bar")
+        self.assertEqual(_normalize_field_name("foo (bar) baz"), "foo_bar_baz")
+        self.assertEqual(_normalize_field_name("load%"), "load_percentage")
+
+    def test_dict_fields_normalization_non_unique(self):
+        from vyos.opmode import _normalize_field_names
+
+        # Space and dot are both replaced by an underscore,
+        # so dicts like this cannor be normalized uniquely
+        data = {"foo bar": True, "foo.bar": False}
+
+        with self.assertRaises(vyos.opmode.InternalError):
+            _normalize_field_names(data)
+
+    def test_dict_fields_normalization(self):
+        from vyos.opmode import _normalize_field_names
+
+        data = {"foo bar": True, "bar-baz": False}
+        self.assertEqual(_normalize_field_names(data), {"foo_bar": True, "bar_baz": False})