docs/userguide/apexlake_framework/apexlake_api.rst

   1 =================================
   2 Apexlake API Interface Definition
   3 =================================
   4
   5 The API interface provided by the framework to enable the execution of test cases is defined as follows.
   6
   7
   8 init
   9 ----
  10
  11 **static init()**
  12
  13     Initializes the Framework
  14
  15     **Returns** None
  16
  17
  18 execute_framework
  19 -----------------
  20
  21 **static execute_framework** (test_cases,
  22
  23                                 iterations,
  24
  25                                 heat_template,
  26
  27                                 heat_template_parameters,
  28
  29                                 deployment_configuration,
  30
  31                                 openstack_credentials)
  32
  33     Executes the framework according the specified inputs
  34
  35     **Parameters**
  36
  37         - **test_cases**
  38
  39             Test cases to be run with the workload (dict() of dict())
  40
  41             Example:
  42                 test_case = dict()
  43
  44                 test_case[’name’] = ‘module.Class’
  45
  46                 test_case[’params’] = dict()
  47
  48                 test_case[’params’][’throughput’] = ‘1’
  49
  50                 test_case[’params’][’vlan_sender’] = ‘1000’
  51
  52                 test_case[’params’][’vlan_receiver’] = ‘1001’
  53
  54                 test_cases = [test_case]
  55
  56         - **iterations**
  57             Number of test cycles to be executed (int)
  58
  59         - **heat_template**
  60             (string) File name of the heat template corresponding to the workload to be deployed.
  61             It contains the parameters to be evaluated in the form of #parameter_name.
  62             (See heat_templates/vTC.yaml as example).
  63
  64         - **heat_template_parameters**
  65             (dict) Parameters to be provided as input to the
  66             heat template. See http://docs.openstack.org/developer/heat/ template_guide/hot_guide.html
  67             section “Template input parameters” for further info.
  68
  69         - **deployment_configuration**
  70             ( dict[string] = list(strings) ) ) Dictionary of parameters
  71             representing the deployment configuration of the workload.
  72
  73             The key is a string corresponding to the name of the parameter,
  74             the value is a list of strings representing the value to be
  75             assumed by a specific param. The parameters are user defined:
  76             they have to correspond to the place holders (#parameter_name)
  77             specified in the heat template.
  78
  79         **Returns** dict() containing results