NFVBENCH-153 Add support for python3

[nfvbench.git] / nfvbench / config.py

diff --git a/nfvbench/config.py b/nfvbench/config.py
index df91454..4cc9c86 100644 (file)
--- a/nfvbench/config.py
+++ b/nfvbench/config.py
@@ -14,11 +14,11 @@
 #
 
 from attrdict import AttrDict
-from log import LOG
 import yaml
 
+from .log import LOG
 
-def config_load(file_name, from_cfg=None):
+def config_load(file_name, from_cfg=None, whitelist_keys=None):
     """Load a yaml file into a config dict, merge with from_cfg if not None
     The config file content taking precedence in case of duplicate
     """
@@ -31,46 +31,58 @@ def config_load(file_name, from_cfg=None):
                         .format(file_name))
 
     if from_cfg:
-        _validate_config(cfg, from_cfg)
+        if not whitelist_keys:
+            whitelist_keys = []
+        _validate_config(cfg, from_cfg, whitelist_keys)
         cfg = from_cfg + cfg
 
     return cfg
 
 
-def config_loads(cfg_text, from_cfg=None):
+def config_loads(cfg_text, from_cfg=None, whitelist_keys=None):
     """Same as config_load but load from a string
     """
     try:
-        cfg = AttrDict(yaml.load(cfg_text))
+        cfg = AttrDict(yaml.safe_load(cfg_text))
     except TypeError:
         # empty string
         cfg = AttrDict()
+    except ValueError as e:
+        # In case of wrong path or file not readable or string not well formatted
+        LOG.error("String %s is not well formatted. Please verify your yaml/json string. "
+                  "If string is a file path, file was not found. Please use correct path and "
+                  "verify it is visible to container if you run nfvbench in container.", cfg_text)
+        raise Exception(e)
     if from_cfg:
-        _validate_config(cfg, from_cfg)
+        if not whitelist_keys:
+            whitelist_keys = []
+        _validate_config(cfg, from_cfg, whitelist_keys)
         return from_cfg + cfg
     return cfg
 
 
-def _get_err_config(subset, superset):
-    result = {}
-    for k, v in subset.items():
-        if k not in superset:
-            result.update({k: v})
-        elif v is not None and superset[k] is not None:
-            if not isinstance(v, type(superset[k])):
-                result.update({k: v})
-                continue
-        if isinstance(v, dict):
-            res = _get_err_config(v, superset[k])
-            if res:
-                result.update({k: res})
-    if not result:
-        return None
-    return result
+def _validate_config(subset, superset, whitelist_keys):
+    def get_err_config(subset, superset):
+        result = {}
+        for k, v in list(subset.items()):
+            if k not in whitelist_keys:
+                if k not in superset:
+                    result.update({k: v})
+                elif v is not None and superset[k] is not None:
+                    if not isinstance(v, type(superset[k])):
+                        result.update({k: v})
+                        continue
+                if isinstance(v, dict):
+                    res = get_err_config(v, superset[k])
+                    if res:
+                        result.update({k: res})
+        if not result:
+            return None
+        return result
 
-def _validate_config(subset, superset):
-    err_cfg = _get_err_config(subset, superset)
+    err_cfg = get_err_config(subset, superset)
     if err_cfg:
-        err_msg = 'Unknown options found in config file/string: ' + str(err_cfg)
+        err_msg = 'The provided configuration has unknown options or values with invalid type: '\
+                  + str(err_cfg)
         LOG.error(err_msg)
         raise Exception(err_msg)