Skip to content

Latest commit

 

History

History
49 lines (44 loc) · 3.12 KB

2-2_TESTCASE_PARAMETERS.md

File metadata and controls

49 lines (44 loc) · 3.12 KB
Raw

TestCase parameters. Standard and Custom experiment.

In order to control how each TestCase is handled by the 5GENESIS Portal and when using the Open APIs, several keys can be added to the yaml description. These keys are:

  • Standard: Boolean. Indicates whether the TestCase is selectable from the list of Standard test cases. If not specified, this value defaults to 'False' if the Custom key is defined, 'True' otherwise.
  • Custom: List of strings. Indicates that the TestCase is a Custom test case and may accept parameters. If this value is set to an empty list ('[]') the test case is considered public and will appear on the list of Custom experiments for all users of the Portal. If the list contains one or more email addresses, the test case will be visible only to the users with matching emails.
  • KPIs: Optional dictionary that can be used for defining a sub-set of results, from all of the generated by the TestCase, that can be considered of interest. The following is an example of the format:
"KPIs":
 ping:  # Each key refers to a 'measurement' (table)
   - Success  # Each key contains a list of 'kpi' (table columns)
   - Delay
 iPerf:
   - Throughput

These values (as (measurement, kpi) pairs) can be retrieved, per experiment execution, by using the execution/<id>/kpis endpoint. When multiple TestCases are included as part of an experiment the union of all KPIs (duplicates removed) are returned.

  • Parameters: Dictionary of dictionaries, where each entry is defined as follows:
"<Parameter Name>":
   Type: "String, used to guide the user as to what is the expected format"
   Description: "String, textual description of the parameter"

Parameters can be used to customize the execution of test cases. For example, a Test Case may be implemented using a TAP test plan, that accepts an external parameter called 'Interval'. Using variable expansion the value of this external parameter can be linked with the value of an 'Interval' (or a different name) parameter contained in the experiment descriptor.

It is also possible to define default values during variable expansion, which means that a Test Case can be defined as 'Standard', where it will use the default values for all parameters, and 'Custom', where some values can be replaced by the experimenter.

For more information see 'Variable expansion' (Variable Expansion and Execution Verdict).

Parameters with the equal names from different test cases are considered to be the same: They will appear only once in the Portal when the user selects multiple test cases and will have the same value at run time. For example, if two different test cases define an 'Interval' parameter and are both included in the same experiment they will share the same value.

  • If it's necessary to configure these values separately please use different names.
  • If a parameter is defined in multiple test cases with different Type or Description a warning will be displayed on the ELCM interface. The information displayed on the Portal will correspond to one (any one) of the definitions.