1 ===========================
2 OPNFV functional test guide
3 ===========================
5 Testing is a key challenge of OPNFV.
6 It shall be possible to run functional tests on any OPNFV solution.
8 The goal of this document consists in
9 * a description of functional tests for OPNFV
10 * a description of the tools needed to perform these tests
11 * the procedure to configure the tools and the scenarios associated with these tests
13 Functional tests shall be automated and collected results shall be used to improve the robustness and the reliability of the overall system.
15 Function tests may cover any domain that could lead to improve the OPNFV solution and define "Telco Cloud" KPI.
17 The last section also describes how to automate these tests within the OPNFV continuous integration project.
19 .. _ETSI: http://docbox.etsi.org/ISG/NFV/Open/Published/gs_NFV001v010101p%20-%20Use%20Cases.pdf
21 ETSI NFV defined 9 use cases (ref ETSI_):
24 * VNF Forwarding graphs
25 * Virtual Network Platform as a Service
26 * Virtualisation of Mobile Core and IMS
27 * Virtualisation of Mobile station
29 * Virtualization of CDNs (vCDN)
30 * Virtualization of the Home environment
32 .. _`Openstack Telco Working Group`: https://wiki.openstack.org/wiki/TelcoWorkingGroup
34 Most of the use cases are also discussed in upstream projects (e.g. `Openstack Telco Working Group`_ )
36 For release 1 (Arno), 4 test suites have been selected:
37 * Rally Bench test suite for Openstack
38 * Openstack Tempest test suite
39 * OpenDaylight test suite
42 The 3 first suites are directly inherited from upstream projects.
43 vPing, that is already present in Tempest suite, has been developped to provided a basic "hellow world" functional test example.
45 .. _`Continuous Integration`: https://build.opnfv.org/ci/view/functest/
47 vIMS, vEPC, vPE, vHGW, vCDN use cases are not considered for first release.
48 It does not mean that such use cases cannot be tested on OPNFV Arno.
49 It means that these use cases have not been integrated in the `Continuous Integration`_ and no specific work (integration or developpment) have been done for R1.
56 We assume that an OPNFV solution has been installed.
60 The installation of the OPNFV solution is out of scope of this document but can be found [here_].
61 In the rest of the document the OPNFV solution would be considered as the System Under Test (SUT).
63 The installation and configuration of the tools needed to perform the tests will be described in the following sections.
65 For release 1, the tools are not automatically installed.
67 .. _pharos: https://wiki.opnfv.org/pharos
69 It is recommended to install the different tools on the jump host server as defined in the pharos_ project.
70 The high level architecture can be described as follow::
72 CIMC/Lights+out management Admin Private Public Storage
78 | +-----------------+ | | + |
80 +-----+ Jumpserver | | | | |
81 | | +---------------------+ | | |
83 | | +----------+ | | | | |
84 | | | Rally | +---- --------------------------+ | |
86 | | | Robot | | | | | |
88 | | | vPing | | | | | |
90 | | | Tempest | | | | | |
91 | | +----------+ | | | | |
92 | | FuncTests +-----------------------------------------+ |
94 | | +--------------------------------------------------+
96 | +-----------------+ | | | |
98 | +----------------+ | | | |
100 +----+ +--------------+-+ | | | |
102 | | | +--------------+-+ | | | |
104 | | | | +--------------+-+ | | | |
105 | | | | | 4 | | | | |
106 | +-+ | | +--------------+-+ | | | |
107 | | | | | 5 +---------------+ | | |
108 | +-+ | | nodes for | | | | |
109 | | | | deploying +-------------------------+ | |
110 | +-+ | opnfv | | | | |
111 | | | SUT +-----------------------------------+ |
113 | | +--------------------------------------------+
114 | +----------------+ | | | |
120 -----------------------------
121 Description of the test cases
122 -----------------------------
124 Rally bench test suite
125 ======================
127 .. _Rally: https://wiki.openstack.org/wiki/Rally
129 The OPNFV scenarios are based on the collection of Rally_ scenarios:
139 The goal of this test suite is to test the different modules of OpenStack and get significant figures that could help us to define telco Cloud KPI.
141 This test suite provides performance information on VIM (OpenStack) part.
143 No SLA were defined for release 1, we just consider whether the tests are passed or failed.
145 In the future SLA shall be considered (e.g. accepting booting time for a given image with a given flavour).
147 Through its integration in Continuous Integration, the evolution of the performance of these tests shall also be considered.
152 .. _Tempest: http://docs.openstack.org/developer/tempest/overview.html
154 Tempest_ is the OpenStack Integration Test Suite. We use Rally to run Tempest suite.
156 The goal of this test is to check the OpenStack installation (sanity checks).
167 The goal of this test can be described as follow::
170 +-------------+ +-------------+
174 | +------------------>| |
177 | +------------------>| |
178 | Tester | | System |
179 | | Boot VM2 | Under |
180 | +------------------>| Test |
181 | | VM2 pings VM1 | |
184 | | shutdown VM2, OK | |
185 | | else (timeout) | |
189 +-------------+ +-------------+
192 This example, using OpenStack Python clients can be considered as an "Hello World" example and may be modified for future use.
194 .. _tooling_installation:
196 ----------------------
198 ----------------------
200 2 external tools are needed for the functional tests on Arno:
204 Rally is used for benching and Tempest. Robot is used for OpenDaylight.
206 A script (config_test.py) has been created to simplify as much as possible the installation of the different suites of tests.
207 This script config_test.py_ is hosted in OPNFV git and uses the configuration file functest.yaml.
211 usage: config_functest.py [-h] [-d] action
213 positional arguments:
214 action Possible actions are: 'start|check|clean'
217 -h, --help show this help message and exit
218 -d, --debug Debug mode
221 * start: will prepare the functional testing environment
222 * check: will check the configuration (scenarios available, environment variables properly set, networks,..)
223 * clean: will clean the functional test environement if existing
226 * Install Rally environment
228 * Retrieve test scenarios
229 * Setup ODL environment
230 * Create temporary neutron external network
231 * Create temporary neutron private network
232 * Create router to connect both
233 * Create Glance images
237 .. _`OpenRC`: http://docs.openstack.org/user-guide/common/cli_set_environment_variables_using_openstack_rc.html
239 .. _`Rally installation procedure`: https://rally.readthedocs.org/en/latest/tutorial/step_0_installation.html
241 .. _`config_test.py` : https://git.opnfv.org/cgit/functest/tree/testcases/config_functest.py
242 .. _`config_test.py` : https://git.opnfv.org/cgit/functest/tree/testcases/functest.yaml
249 The procedure to set up functional testing environment can be described as follow::
251 Log on the Jumphost server
252 Be sure you are no root
253 $ wget https://git.opnfv.org/cgit/functest/plain/testcases/config_functest.py
254 $ wget https://git.opnfv.org/cgit/functest/plain/testcases/functest.yaml
255 Modify and adapt needed parameters in the functest.yaml. Follow the instructions below.
256 Retrieve OpenStack source file (configure your `OpenRC`_ file to let Rally access to your OpenStack, you can either export it from Horizon or build it manually (OpenStack credentials are required)
257 $ source Your_OpenRC_file
258 $ python config_functest.py -d start
260 At the end of the executing, a new directory will be created ~/.functest with the following structure::
263 ~/.functest/Rally_repo
264 ~/.functest/Rally_test
266 ~/.functest/functest.yaml
267 ~/.functest/trusty-server-cloudimg-amd64-disk1.img
269 NOTE: the Rally environment will be installed under ~/.rally/
272 HOWTO configure functest.yaml:
274 Do not change the directories structure
275 * image_name: name of the image that will be created in Glance
276 * image_url: URL of the image to be downloaded
277 * image_disk_format: glance image disk format (raw, qcow2, ...)
279 * neutron_public_net_name: name of the OpenStack external network. If not existing, it will be created
280 * neutron_public_subnet_name: external network subnet to be created if not existing
281 * neutron_public_subnet_cidr: range of the external subnet. IMPORTANT: this subnet range must be reachable from the jumpstart server
282 * neutron_public_subnet_start: start IP
283 * neutron_public_subnet_end: end IP
285 * neutron_private_net_name: name of an OpenStack private network. If not existing, it will be created
286 * neutron_private_subnet_name: private subnet network to be created if not existing
287 * neutron_private_subnet_cidr: range of the private subnet.
288 * neutron_private_subnet_start: start IP
289 * neutron_private_subnet_end: end IP
290 * neutron_router_name: name of the router between the private and the public networks
292 * ping_timeout: time out of the vPing test case
293 * vm_flavor: name of the flavor used to create the VMs
294 * vm_name_1: name of the first VM
295 * vm_name_2: name of the second VM
298 Please note that you need to install this environment only once. Until the credentials of the System Under Test are not changing, the testing environment shall be fine.
300 If you need more details on Rally installation, see `Rally installation procedure`_.
302 You can check if the configuration of rally is fine by typing 'rally deployment check', you shall see the list of available services as follow::
304 # rally deployment check
305 keystone endpoints are valid and following service are available:
306 +-------------+-----------+------------+
307 | Services | Type | Status |
308 +-----------+-------------+------------+
309 | cinder | volume | Available |
310 | cinderv2 | volumev2 | Available |
311 | glance | image | Available |
312 | keystone | identity | Available |
313 | neutron | network | Available |
314 | nova | compute | Available |
315 | nova_ec2 | compute_ec2 | Available |
316 | novav3 | computev3 | Available |
317 +-----------+-------------+------------+
320 +--------------------------------------+----------------------------------------------+------------+
321 | UUID | Name | Size (B) |
322 +--------------------------------------+----------------------------------------------+------------+
323 | 0a15951f-6388-4d5d-8531-79e7205eb140 | cirros_2015_04_10_13_13_18 | 13167616 |
324 | b1504066-045a-4f8f-8919-8c665ef3f400 | Ubuntu 14.04 64b | 253297152 |
325 +--------------------------------------+----------------------------------------------+------------+
328 +--------------------------------------+---------------------+-------+----------+-----------+-----------+
329 | ID | Name | vCPUs | RAM (MB) | Swap (MB) | Disk (GB) |
330 +--------------------------------------+---------------------+-------+----------+-----------+-----------+
331 | 110e6375-a058-4af6-b21e-b765187904d2 | m1.medium | 2 | 1024 | | 20 |
332 | 7084d7e7-415a-455d-a55a-2ad286ddf7c9 | m1.large | 4 | 4096 | | 80 |
333 | a0345ba7-c667-4fd2-964f-7e98f8cda279 | m1.xlarge | 4 | 8192 | | 200 |
334 | accdc28c-5e20-4859-a5cc-61cf9009e56d | m1.small | 1 | 512 | | 10 |
335 +--------------------------------------+---------------------+-------+----------+-----------+-----------+
344 Several scenarios are available (mainly based on native Rally scenarios):
355 * all (every module except tempest and smoke)
357 You can run the script as follow::
359 # python run_rally.py keystone
362 * get the json scenario (if not already available) and put it into the scenario folder
364 * generate the html result page into the result folder as opnfv-[module name]-[timestamp].html
365 * generate the json result page into the result folder as opnfv-[module name]-[timestamp].json
371 It is possible to use Rally to perform Tempest tests (ref: `tempest installation guide using Rally`_)
372 You just need to run::
376 The different modes available are smoke, baremetal, compute, data_processing, identity, image, network, object_storage, orchestration, telemetry, and volume. By default if you do not precise anything then smoke tests be selected by default.
378 .. _`tempest installation guide using Rally`: https://www.mirantis.com/blog/rally-openstack-tempest-testing-made-simpler/
382 ODL wiki page describes system preparation and running tests. See `Integration Group CSIT`_.
384 .. _`Integration Group CSIT`: https://wiki.opendaylight.org/view/CrossProject:Integration_Group:CSIT
396 Results are available in the result folder through a html page and a json file.
401 You can get the results of tempest by typing::
405 You shall see the results as follow::
407 Total results of verification:
409 +--------------------------------------+--------------------------------------+----------+-------+----------+----------------------------+----------+
410 | UUID | Deployment UUID | Set name | Tests | Failures | Created at | Status |
411 +--------------------------------------+--------------------------------------+----------+-------+----------+----------------------------+----------+
412 | 0144c50f-ab03-45fb-9c36-242ad6440b46 | d9e1bb21-8e36-4d89-b137-0c852dbb308e | smoke | 87 | 32 | 2015-05-05 16:36:00.986003 | finished |
413 +--------------------------------------+--------------------------------------+----------+-------+----------+----------------------------+----------+
415 If you run this test several times, you will see as many lines as test attempts.
417 You can get more details on the test by typing::
419 # rally verify show --uuid <UUID of the test>
420 # rally verify detailed --uuid <UUID of the test>
422 "show" will show you all the restults including the time needed to execute the test.
423 "detailed" will display additional elements (errors)
425 Example of test result display::
427 +------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------+--------+
428 | name | time | status |
429 +------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------+--------+
430 | tempest.api.network.test_routers.RoutersTest.test_create_show_list_update_delete_router[id-f64403e2-8483-4b34-8ccd-b09a87bcc68c,smoke] | 0.011466 | FAIL |
431 | tempest.api.network.test_security_groups.SecGroupIPv6Test.test_create_list_update_show_delete_security_group[id-bfd128e5-3c92-44b6-9d66-7fe29d22c802,smoke]| 1.234566 | OK |
432 | tempest.api.network.test_security_groups.SecGroupIPv6Test.test_create_show_delete_security_group_rule[id-cfb99e0e-7410-4a3d-8a0c-959a63ee77e9,smoke] | 1.060221 | OK |
433 | tempest.api.network.test_security_groups.SecGroupIPv6Test.test_list_security_groups[id-e30abd17-fef9-4739-8617-dc26da88e686,smoke] | 0.060797 | OK |
434 | tempest.api.network.test_security_groups.SecGroupTest.test_create_list_update_show_delete_security_group[id-bfd128e5-3c92-44b6-9d66-7fe29d22c802,smoke] | 0.685149 | OK |
435 | tempest.api.network.test_security_groups.SecGroupTest.test_create_show_delete_security_group_rule[id-cfb99e0e-7410-4a3d-8a0c-959a63ee77e9,smoke] | 0.730561 | OK |
436 | tempest.api.network.test_security_groups.SecGroupTest.test_list_security_groups[id-e30abd17-fef9-4739-8617-dc26da88e686,smoke] | 0.116862 | OK |
437 | tempest.api.object_storage.test_account_quotas.AccountQuotasTest | 0.0 | SKIP |
443 Tests can be executed with script *start_test.sh* from directory *functest/testcases/Controllers/ODL/CI*. For usage example see::
445 # bash ~./.functest/ODL/start_test.sh -h
449 The test can be executed with command::
451 #python ~./.functest/vPing.py
460 Connection of your platform
461 ===========================
463 .. _`Octopus procedure`: https://wiki.opnfv.org/octopus/jenkins_slave_connection/
465 If you want to add your platform to the community automation, please follow the `Octopus procedure`_.
467 Integrating into CI Pipeline
468 ============================
470 .. _`pipeline document`: https://wiki.opnfv.org/octopus/pipelines
472 Contact Octopus Team (#opnfv-octopus) and see `pipeline document`_ for more details.
480 OPNFV main site: opnfvmain_.
482 OPNFV functional test page: opnfvfunctest_.
484 IRC support chan: #opnfv-testperf
486 .. _opnfvmain: http://www.opnfv.org
487 .. _opnfvfunctest: https://wiki.opnfv.org/opnfv_functional_testing