teststeps: Improvements and bugfixing of teststeps
[vswitchperf.git] / conf / __init__.py
index 2448d39..a7c0ee5 100644 (file)
@@ -1,4 +1,4 @@
-# Copyright 2015-2016 Intel Corporation.
+# Copyright 2015-2017 Intel Corporation.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -20,6 +20,7 @@ and any user provided settings file.
 
 # pylint: disable=invalid-name
 
+import copy
 import os
 import re
 import logging
@@ -30,8 +31,7 @@ import netaddr
 _LOGGER = logging.getLogger(__name__)
 
 # Special test parameters which are not part of standard VSPERF configuration
-_EXTRA_TEST_PARAMS = ['bidirectional', 'traffic_type', 'iload', 'tunnel_type',
-                      'multistream', 'stream_type', 'pre-installed_flows']
+_EXTRA_TEST_PARAMS = ['TUNNEL_TYPE']
 
 # regex to parse configuration macros from 04_vnf.conf
 # it will select all patterns starting with # sign
@@ -49,6 +49,40 @@ class Settings(object):
     def __init__(self):
         pass
 
+    def _eval_param(self, param):
+        # pylint: disable=invalid-name
+        """ Helper function for expansion of references to vsperf parameters
+        """
+        if isinstance(param, str):
+            # evaluate every #PARAM reference inside parameter itself
+            macros = re.findall(r'#PARAM\((([\w\-]+)(\[[\w\[\]\-\'\"]+\])*)\)', param)
+            if macros:
+                for macro in macros:
+                    # pylint: disable=eval-used
+                    try:
+                        tmp_val = str(eval("self.getValue('{}'){}".format(macro[1], macro[2])))
+                        param = param.replace('#PARAM({})'.format(macro[0]), tmp_val)
+                    # silently ignore that option required by PARAM macro can't be evaluated;
+                    # It is possible, that referred parameter will be constructed during runtime
+                    # and re-read later.
+                    except IndexError:
+                        pass
+                    except AttributeError:
+                        pass
+            return param
+        elif isinstance(param, list) or isinstance(param, tuple):
+            tmp_list = []
+            for item in param:
+                tmp_list.append(self._eval_param(item))
+            return tmp_list
+        elif isinstance(param, dict):
+            tmp_dict = {}
+            for (key, value) in param.items():
+                tmp_dict[key] = self._eval_param(value)
+            return tmp_dict
+        else:
+            return param
+
     def getValue(self, attr):
         """Return a settings item value
         """
@@ -57,9 +91,19 @@ class Settings(object):
                 return getattr(self, attr)
             else:
                 master_value = getattr(self, attr)
-                # Check if parameter value was overridden by CLI option
+                # Check if parameter value was modified by CLI option
                 cli_value = get_test_param(attr, None)
-                return cli_value if cli_value else master_value
+                if cli_value is not None:
+                    # TRAFFIC dictionary is not overridden by CLI option
+                    # but only updated by specified values
+                    if attr == 'TRAFFIC':
+                        tmp_value = copy.deepcopy(master_value)
+                        tmp_value = merge_spec(tmp_value, cli_value)
+                        return self._eval_param(tmp_value)
+                    else:
+                        return self._eval_param(cli_value)
+                else:
+                    return self._eval_param(master_value)
         else:
             raise AttributeError("%r object has no attribute %r" %
                                  (self.__class__, attr))
@@ -104,14 +148,15 @@ class Settings(object):
 
         :returns: None
         """
-        regex = re.compile("^(?P<digit_part>[0-9]+).*.conf$")
+        regex = re.compile("^(?P<digit_part>[0-9]+)(?P<alfa_part>[a-z]?)_.*.conf$")
 
         def get_prefix(filename):
             """
             Provide a suitable function for sort's key arg
             """
             match_object = regex.search(os.path.basename(filename))
-            return int(match_object.group('digit_part'))
+            return [int(match_object.group('digit_part')),
+                    match_object.group('alfa_part')]
 
         # get full file path to all files & dirs in dir_path
         file_paths = os.listdir(dir_path)
@@ -122,7 +167,7 @@ class Settings(object):
         file_paths = [x for x in file_paths if os.path.isfile(x) and
                       regex.search(os.path.basename(x))]
 
-        # sort ascending on the leading digits
+        # sort ascending on the leading digits and afla (e.g. 03_, 05a_)
         file_paths.sort(key=get_prefix)
 
         # load settings from each file in turn
@@ -137,7 +182,24 @@ class Settings(object):
         """
         for key in conf:
             if conf[key] is not None:
-                setattr(self, key.upper(), conf[key])
+                if isinstance(conf[key], dict):
+                    # recursively update dict items, e.g. TEST_PARAMS
+                    setattr(self, key.upper(),
+                            merge_spec(getattr(self, key.upper()), conf[key]))
+                else:
+                    setattr(self, key.upper(), conf[key])
+
+    def restore_from_dict(self, conf):
+        """
+        Restore ``settings`` with values found in ``conf``.
+
+        Method will drop all configuration options and restore their
+        values from conf dictionary
+        """
+        self.__dict__.clear()
+        tmp_conf = copy.deepcopy(conf)
+        for key in tmp_conf:
+            self.setValue(key, tmp_conf[key])
 
     def load_from_env(self):
         """
@@ -174,7 +236,7 @@ class Settings(object):
         for key in self.__dict__:
             if key.startswith('GUEST_'):
                 value = self.getValue(key)
-                if isinstance(value, str) and value.find('#') >= 0:
+                if isinstance(value, str) and str(value).find('#') >= 0:
                     self._expand_vm_settings(key, 1)
 
                 if isinstance(value, list):
@@ -251,7 +313,9 @@ class Settings(object):
     def validate_getValue(self, result, attr):
         """Verifies, that correct value was returned
         """
-        assert result == self.__dict__[attr]
+        # getValue must be called to expand macros and apply
+        # values from TEST_PARAM option
+        assert result == self.getValue(attr)
         return True
 
     def validate_setValue(self, dummy_result, name, value):
@@ -271,17 +335,33 @@ def get_test_param(key, default=None):
     :returns: Value for ``key`` if found, else ``default``.
     """
     test_params = settings.getValue('TEST_PARAMS')
-    if key in test_params:
-        if not isinstance(test_params.get(key), str):
-            return test_params.get(key)
+    return test_params.get(key, default) if test_params else default
+
+def merge_spec(orig, new):
+    """Merges ``new`` dict with ``orig`` dict, and returns orig.
+
+    This takes into account nested dictionaries. Example:
+
+        >>> old = {'foo': 1, 'bar': {'foo': 2, 'bar': 3}}
+        >>> new = {'foo': 6, 'bar': {'foo': 7}}
+        >>> merge_spec(old, new)
+        {'foo': 6, 'bar': {'foo': 7, 'bar': 3}}
+
+    You'll notice that ``bar.bar`` is not removed. This is the desired result.
+    """
+    for key in orig:
+        if key not in new:
+            continue
+
+        # Not allowing derived dictionary types for now
+        # pylint: disable=unidiomatic-typecheck
+        if type(orig[key]) == dict:
+            orig[key] = merge_spec(orig[key], new[key])
         else:
-            # values are passed inside string from CLI, so we must retype them accordingly
-            try:
-                return ast.literal_eval(test_params.get(key))
-            except ValueError:
-                # for backward compatibility, we have to accept strings without quotes
-                _LOGGER.warning("Adding missing quotes around string value: %s = %s",
-                                key, str(test_params.get(key)))
-                return str(test_params.get(key))
-    else:
-        return default
+            orig[key] = new[key]
+
+    for key in new:
+        if key not in orig:
+            orig[key] = new[key]
+
+    return orig