diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/testing/user/userguide/teststeps.rst | 14 | ||||
| -rw-r--r-- | docs/testing/user/userguide/testusage.rst | 26 |
2 files changed, 38 insertions, 2 deletions
diff --git a/docs/testing/user/userguide/teststeps.rst b/docs/testing/user/userguide/teststeps.rst index 870c3d80..71f19714 100644 --- a/docs/testing/user/userguide/teststeps.rst +++ b/docs/testing/user/userguide/teststeps.rst @@ -192,14 +192,16 @@ of supported objects and their most common functions follows: in case that condition is not ``True`` * ``Eval expression`` - evaluates given expression as a python code and returns its result - * ``Exec command [regex]`` - executes a shell command and filters its output by + * ``Exec_Shell command [regex]`` - executes a shell command and filters its output by (optional) regular expression + * ``Exec_Python code`` - executes a python code + Examples: .. code-block:: python - ['tools', 'exec', 'numactl -H', 'available: ([0-9]+)'] + ['tools', 'exec_shell', 'numactl -H', 'available: ([0-9]+)'] ['tools', 'assert', '#STEP[-1][0]>1'] * ``wait`` - is used for test case interruption. This object doesn't have @@ -213,6 +215,14 @@ of supported objects and their most common functions follows: ['wait'] + * ``sleep`` - is used to pause testcase execution for defined number of seconds. + + Examples: + + .. code-block:: python + + ['sleep', '60'] + Test Macros ----------- diff --git a/docs/testing/user/userguide/testusage.rst b/docs/testing/user/userguide/testusage.rst index f8490768..b6939e57 100644 --- a/docs/testing/user/userguide/testusage.rst +++ b/docs/testing/user/userguide/testusage.rst @@ -112,6 +112,32 @@ of options with ``GUEST_`` prefix could be found at :ref:`design document .. _overriding-parameters-documentation: +Referencing parameter values +^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +It is possible to use a special macro ``#PARAM()`` to refer to the value of +another configuration parameter. This reference is evaluated during +access of the parameter value (by ``settings.getValue()`` call), so it +can refer to parameters created during VSPERF runtime, e.g. NICS dictionary. +It can be used to reflect DUT HW details in the testcase definition. + +Example: + +.. code:: python + + { + ... + "Name": "testcase", + "Parameters" : { + "TRAFFIC" : { + 'l2': { + # set destination MAC to the MAC of the first + # interface from WHITELIST_NICS list + 'dstmac' : '#PARAM(NICS[0]["mac"])', + }, + }, + ... + Overriding values defined in configuration files ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ |