docs/userguide/06-apexlake_api.rst

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