cli: Modify configuration via CLI

In the past, only a few configuration parameters could be
modified via --test-params CLI argument and it was not easy
to find out their complete list.
This patch adds support for generic modification of any
configuration parameter via CLI argument --test-params
or by "Parameters" section of testcase definition.
Thus it is possible to customize a vsperf configuration
environment per testcase or for each vsperf execution.
Old CLI parameters duration, pkt_sizes, rfc2544_tests
and rfc2889_trials were renamed to TRAFFICGEN_DURATION,
TRAFFICGEN_PKT_SIZES, TRAFFICGEN_RFC2544_TESTS and
TRAFFICGEN_RFC2889_TRIALS to be consistent with
other configuration parameters.

JIRA: VSPERF-375

Change-Id: I50a1f4ff7250d754aa8af0295a9c7c1be8151175
Signed-off-by: Martin Klozik <martinx.klozik@intel.com>
Reviewed-by: Al Morton <acmorton@att.com>
Reviewed-by: Christian Trautman <ctrautma@redhat.com>
Reviewed-by: Bill Michalowski <bmichalo@redhat.com>
Reviewed-by: Antonio Fischetti <antonio.fischetti@intel.com>
Reviewed-by: <sridhar.rao@spirent.com>

1 files changed, 65 insertions, 13 deletions

diff --git a/conf/__init__.py b/conf/__init__.py
index 4d6f57fe..2448d390 100644
--- a/conf/__init__.py
+++ b/conf/__init__.py
@@ -29,6 +29,10 @@ 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']
+
 # regex to parse configuration macros from 04_vnf.conf
 # it will select all patterns starting with # sign
 # and returns macro parameters and step
@@ -49,7 +53,13 @@ class Settings(object):
         """Return a settings item value
         """
         if attr in self.__dict__:
-            return getattr(self, attr)
+            if attr == 'TEST_PARAMS':
+                return getattr(self, attr)
+            else:
+                master_value = getattr(self, attr)
+                # Check if parameter value was overridden by CLI option
+                cli_value = get_test_param(attr, None)
+                return cli_value if cli_value else master_value
         else:
             raise AttributeError("%r object has no attribute %r" %
                                  (self.__class__, attr))
@@ -136,6 +146,24 @@ class Settings(object):
         for key in os.environ:
             setattr(self, key, os.environ[key])
 
+    def check_test_params(self):
+        """
+        Check all parameters defined inside TEST_PARAMS for their
+        existence. In case that non existing vsperf parmeter name
+        is detected, then VSPER will raise a runtime error.
+        """
+        unknown_keys = []
+        for key in settings.getValue('TEST_PARAMS'):
+            if key == 'TEST_PARAMS':
+                raise RuntimeError('It is not allowed to define TEST_PARAMS '
+                                   'as a test parameter')
+            if key not in self.__dict__ and key not in _EXTRA_TEST_PARAMS:
+                unknown_keys.append(key)
+
+        if len(unknown_keys):
+            raise RuntimeError('Test parameters contain unknown configuration '
+                               'parameter(s): {}'.format(', '.join(unknown_keys)))
+
     def check_vm_settings(self, vm_number):
         """
         Check all VM related settings starting with GUEST_ prefix.
@@ -145,15 +173,12 @@ class Settings(object):
         """
         for key in self.__dict__:
             if key.startswith('GUEST_'):
-                if (isinstance(self.__dict__[key], str) and
-                        self.__dict__[key].find('#') >= 0):
-                    self.__dict__[key] = [self.__dict__[key]]
+                value = self.getValue(key)
+                if isinstance(value, str) and value.find('#') >= 0:
                     self._expand_vm_settings(key, 1)
-                    self.__dict__[key] = self.__dict__[key][0]
 
-                if isinstance(self.__dict__[key], list):
-                    if (len(self.__dict__[key]) < vm_number or
-                            str(self.__dict__[key][0]).find('#') >= 0):
+                if isinstance(value, list):
+                    if len(value) < vm_number or str(value[0]).find('#') >= 0:
                         # expand configuration for all VMs
                         self._expand_vm_settings(key, vm_number)
 
@@ -161,7 +186,15 @@ class Settings(object):
         """
         Expand VM option with given key for given number of VMs
         """
-        master_value = self.__dict__[key][0]
+        tmp_value = self.getValue(key)
+        if isinstance(tmp_value, str):
+            scalar = True
+            master_value = tmp_value
+            tmp_value = [tmp_value]
+        else:
+            scalar = False
+            master_value = tmp_value[0]
+
         master_value_str = str(master_value)
         if master_value_str.find('#') >= 0:
             self.__dict__[key] = []
@@ -190,9 +223,12 @@ class Settings(object):
                     value = ast.literal_eval(value)
                 self.__dict__[key].append(value)
         else:
-            for vmindex in range(len(self.__dict__[key]), vm_number):
+            for vmindex in range(len(tmp_value), vm_number):
                 self.__dict__[key].append(master_value)
 
+        if scalar:
+            self.__dict__[key] = self.__dict__[key][0]
+
         _LOGGER.debug("Expanding option: %s = %s", key, self.__dict__[key])
 
     def __str__(self):
@@ -203,7 +239,11 @@ class Settings(object):
         Returns:
             A human-readable string.
         """
-        return pprint.pformat(self.__dict__)
+        tmp_dict = {}
+        for key in self.__dict__:
+            tmp_dict[key] = self.getValue(key)
+
+        return pprint.pformat(tmp_dict)
 
     #
     # validation methods used by step driven testcases
@@ -222,7 +262,6 @@ class Settings(object):
 
 settings = Settings()
 
-
 def get_test_param(key, default=None):
     """Retrieve value for test param ``key`` if available.
 
@@ -232,4 +271,17 @@ def get_test_param(key, default=None):
     :returns: Value for ``key`` if found, else ``default``.
     """
     test_params = settings.getValue('TEST_PARAMS')
-    return test_params.get(key, default) if test_params else default
+    if key in test_params:
+        if not isinstance(test_params.get(key), str):
+            return test_params.get(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