1 .. This work is licensed under a Creative Commons Attribution 4.0 International
3 .. http://creativecommons.org/licenses/by/4.0
4 .. (c) OPNFV, Intel Corporation and others.
7 =================================
8 Apexlake API Interface Definition
9 =================================
14 The API interface provided by the framework to enable the execution of test
15 cases is defined as follows.
23 Initializes the Framework
31 **static execute_framework** (test_cases,
37 heat_template_parameters,
39 deployment_configuration,
41 openstack_credentials)
43 Executes the framework according the specified inputs
49 Test cases to be run with the workload (dict() of dict())
54 test_case[’name’] = ‘module.Class’
56 test_case[’params’] = dict()
58 test_case[’params’][’throughput’] = ‘1’
60 test_case[’params’][’vlan_sender’] = ‘1000’
62 test_case[’params’][’vlan_receiver’] = ‘1001’
64 test_cases = [test_case]
67 Number of test cycles to be executed (int)
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).
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.
79 - **deployment_configuration**
80 ( dict[string] = list(strings) ) ) Dictionary of parameters
81 representing the deployment configuration of the workload.
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.
89 **Returns** dict() containing results