1 files changed, 94 insertions, 9 deletions

diff --git a/python/vyos/opmode.py b/python/vyos/opmode.py
index 7e3545c87..d02ad4de6 100644
--- a/python/vyos/opmode.py
+++ b/python/vyos/opmode.py
@@ -1,4 +1,4 @@
-# Copyright 2022 VyOS maintainers and contributors <maintainers@vyos.io>
+# Copyright 2022-2023 VyOS maintainers and contributors <maintainers@vyos.io>
 #
 # This library is free software; you can redistribute it and/or
 # modify it under the terms of the GNU Lesser General Public
@@ -16,11 +16,16 @@
 import re
 import sys
 import typing
+from humps import decamelize
 
 
 class Error(Exception):
     """ Any error that makes requested operation impossible to complete
         for reasons unrelated to the user input or script logic.
+
+        This is the base class, scripts should not use it directly
+        and should raise more specific errors instead,
+        whenever possible.
     """
     pass
 
@@ -44,15 +49,45 @@ class PermissionDenied(Error):
     """
     pass
 
+class InsufficientResources(Error):
+    """ Requested operation and its arguments are valid but the system
+        does not have enough resources (such as drive space or memory)
+        to complete it.
+    """
+    pass
+
+class UnsupportedOperation(Error):
+    """ Requested operation is technically valid but is not implemented yet. """
+    pass
+
+class IncorrectValue(Error):
+    """ Requested operation is valid, but an argument provided has an
+        incorrect value, preventing successful completion.
+    """
+    pass
+
+class CommitInProgress(Error):
+    """ Requested operation is valid, but not possible at the time due
+    to a commit being in progress.
+    """
+    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):
+    if re.match(r"^(show|clear|reset|restart|add|delete|generate|set)", name):
         return True
     else:
         return False
 
-def _is_show(name):
-    if re.match(r"^show", name):
+def _capture_output(name):
+    if re.match(r"^(show|generate)", name):
         return True
     else:
         return False
@@ -93,6 +128,51 @@ def _get_arg_type(t):
     else:
         return t
 
+def _normalize_field_name(name):
+    # Convert the name to string if it is not
+    # (in some cases they may be numbers)
+    name = str(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_dict_field_names(old_dict):
+    new_dict = {}
+
+    for key in old_dict:
+        new_key = _normalize_field_name(key)
+        new_dict[new_key] = _normalize_field_names(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 _normalize_field_names(value):
+    if isinstance(value, dict):
+        return _normalize_dict_field_names(value)
+    elif isinstance(value, list):
+        return list(map(lambda v: _normalize_field_names(v), value))
+    else:
+        return value
+
 def run(module):
     from argparse import ArgumentParser
 
@@ -134,20 +214,25 @@ def run(module):
     # it would cause an extra argument error when we pass the dict to a function
     del args["subcommand"]
 
-    # Show commands must always get the "raw" argument,
-    # but other commands (clear/reset/restart) should not,
+    # Show and generate commands must always get the "raw" argument,
+    # but other commands (clear/reset/restart/add/delete) should not,
     # because they produce no output and it makes no sense for them.
-    if ("raw" not in args) and _is_show(function_name):
+    if ("raw" not in args) and _capture_output(function_name):
         args["raw"] = False
 
-    if re.match(r"^show", function_name):
-        # Show commands are slightly special:
+    if _capture_output(function_name):
+        # Show and generate commands are slightly special:
         # they may return human-formatted output
         # or a raw dict that we need to serialize in JSON for printing
         res = func(**args)
         if not args["raw"]:
             return res
         else:
+            if not isinstance(res, dict) and not isinstance(res, list):
+                raise InternalError(f"Bare literal is not an acceptable raw output, must be a list or an object.\
+                  The output was:{res}")
+            res = decamelize(res)
+            res = _normalize_field_names(res)
             from json import dumps
             return dumps(res, indent=4)
     else: