docs/functest.rst

   1 ===========================
   2 OPNFV functional test guide
   3 ===========================
   4
   5 Testing is a key challenge of OPNFV.
   6 It shall be possible to run functional tests on any OPNFV solution.
   7
   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
  12
  13 Functional tests shall be automated and collected results shall be used to improve the robustness and the reliability of the overall system.
  14
  15 Function tests may cover any domain that could lead to improve the OPNFV solution and define "Telco Cloud" KPI.
  16
  17 The last section also describes how to automate these tests within the OPNFV continuous integration project.
  18
  19 .. _ETSI: http://docbox.etsi.org/ISG/NFV/Open/Published/gs_NFV001v010101p%20-%20Use%20Cases.pdf
  20
  21 ETSI NFV defined 9 use cases (ref ETSI_):
  22  * VNF as a Service
  23  * NFV as a service
  24  * VNF Forwarding graphs
  25  * Virtual Network Platform as a Service
  26  * Virtualisation of Mobile Core and IMS
  27  * Virtualisation of Mobile station
  28  * Fixed Access NFV
  29  * Virtualization of CDNs (vCDN)
  30  * Virtualization of the Home environment
  31
  32 .. _`Openstack Telco Working Group`: https://wiki.openstack.org/wiki/TelcoWorkingGroup
  33
  34 Most of the use cases are also discussed in upstream projects (e.g. `Openstack Telco Working Group`_ )
  35
  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
  40  * vPing
  41
  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.
  44
  45 .. _`Continuous Integration`: https://build.opnfv.org/ci/view/functest/
  46
  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.
  50
  51 .. _prereqs:
  52
  53 -------------
  54 Prerequisites
  55 -------------
  56 We assume that an OPNFV solution has been installed.
  57
  58 .. _here: TBC
  59
  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).
  62
  63 The installation and configuration of the tools needed to perform the tests will be described in the following sections.
  64
  65 For release 1, the tools are not automatically installed.
  66
  67 .. _pharos: https://wiki.opnfv.org/pharos
  68
  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::
  71
  72  CIMC/Lights+out management                  Admin     Private   Public   Storage
  73                                               PXE
  74                                                                    +
  75  +                                             +     IP_PRIV/24    |        |
  76  |                                             |         +         +        |
  77  |                                             |         |    IP_PUB/24     |
  78  |     +-----------------+                     |         |         +        |
  79  |     |                 |                     |         |         |        |
  80  +-----+  Jumpserver     |                     |         |         |        |
  81  |     |                 +---------------------+         |         |        |
  82  |     |                 |                     |         |         |        |
  83  |     |  +----------+   |                     |         |         |        |
  84  |     |  |  Rally   |   +---- --------------------------+         |        |
  85  |     |  |          |   |                     |         |         |        |
  86  |     |  |  Robot   |   |                     |         |         |        |
  87  |     |  |          |   |                     |         |         |        |
  88  |     |  |  vPing   |   |                     |         |         |        |
  89  |     |  |          |   |                     |         |         |        |
  90  |     |  | Tempest  |   |                     |         |         |        |
  91  |     |  +----------+   |                     |         |         |        |
  92  |     |   FuncTests     +-----------------------------------------+        |
  93  |     |                 |                     |         |         |        |
  94  |     |                 +--------------------------------------------------+
  95  |     |                 |                     |         |         |        |
  96  |     +-----------------+                     |         |         |        |
  97  |                                             |         |         |        |
  98  |    +----------------+                       |         |         |        |
  99  |    |             1  |                       |         |         |        |
 100  +----+ +--------------+-+                     |         |         |        |
 101  |    | |             2  |                     |         |         |        |
 102  |    | | +--------------+-+                   |         |         |        |
 103  |    | | |             3  |                   |         |         |        |
 104  |    | | | +--------------+-+                 |         |         |        |
 105  |    | | | |             4  |                 |         |         |        |
 106  |    +-+ | | +--------------+-+               |         |         |        |
 107  |      | | | |             5  +---------------+         |         |        |
 108  |      +-+ | |  nodes for     |               |         |         |        |
 109  |        | | |  deploying     +-------------------------+         |        |
 110  |        +-+ |  opnfv         |               |         |         |        |
 111  |          | |     SUT        +-----------------------------------+        |
 112  |          +-+                |               |         |         |        |
 113  |            |                +--------------------------------------------+
 114  |            +----------------+               |         |         |        |
 115  |                                             |         |         |        |
 116  |                                             +         +         +        +
 117
 118 .. _description:
 119
 120 -----------------------------
 121 Description of the test cases
 122 -----------------------------
 123
 124 Rally bench test suite
 125 ======================
 126
 127 .. _Rally: https://wiki.openstack.org/wiki/Rally
 128
 129 The OPNFV scenarios are based on the collection of Rally_ scenarios:
 130  * authenticate
 131  * cinder
 132  * nova
 133  * vm
 134  * glance
 135  * keystone
 136  * neutron
 137  * quotas
 138
 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.
 140
 141 This test suite provides performance information on VIM (OpenStack) part.
 142
 143 No SLA were defined for release 1, we just consider whether the tests are passed or failed.
 144
 145 In the future SLA shall be considered (e.g. accepting booting time for a given image with a given flavour).
 146
 147 Through its integration in Continuous Integration, the evolution of the performance of these tests shall also be considered.
 148
 149 Tempest
 150 =======
 151
 152 .. _Tempest: http://docs.openstack.org/developer/tempest/overview.html
 153
 154 Tempest_ is the OpenStack Integration Test Suite. We use Rally to run Tempest suite.
 155
 156 The goal of this test is to check the OpenStack installation (sanity checks).
 157
 158
 159 OpenDaylight
 160 ============
 161
 162 TODO Peter
 163
 164 vPing
 165 =====
 166
 167 The goal of this test can be described as follow::
 168
 169  vPing testcase
 170  +-------------+                   +-------------+
 171  |             |                   |             |
 172  |             |                   |             |
 173  |             |     Boot VM1      |             |
 174  |             +------------------>|             |
 175  |             |                   |             |
 176  |             |     Get IP VM1    |             |
 177  |             +------------------>|             |
 178  |   Tester    |                   |   System    |
 179  |             |     Boot VM2      |    Under    |
 180  |             +------------------>|     Test    |
 181  |             | VM2 pings VM1     |             |
 182  |             |                   |             |
 183  |             | Check console log |             |
 184  |             |    If ping:       |             |
 185  |             |      exit OK      |             |
 186  |             |    else (timeout) |             |
 187  |             |      exit KO      |             |
 188  |             |                   |             |
 189  |             |                   |             |
 190  +-------------+                   +-------------+
 191
 192
 193 This example, using OpenStack Python clients can be considered as an "Hello World" example and may be modified for future use.
 194
 195 .. _tooling_installation:
 196
 197 ----------------------
 198 Tooling installation
 199 ----------------------
 200
 201 2 external tools are needed for the functional tests on Arno:
 202  * Rally
 203  * Robot
 204
 205 Rally is used for benching and Tempest. Robot is used for OpenDaylight.
 206
 207 A script (config_test.py) has been created to simplify as much as possible the installation of the different suites of tests.
 208 This script config_test.py_ is hosted in OPNFV git and uses the configuration file functest.yaml.
 209
 210
 211
 212 usage: config_functest.py [-h] [-d] action
 213
 214 positional arguments:
 215   action       Possible actions are: 'start|check|clean'
 216
 217 optional arguments:
 218   -h, --help   show this help message and exit
 219   -d, --debug  Debug mode
 220
 221 Actions
 222  * start: will prepare the functional testing environment
 223  * check: will check the configuration (scenarios available, environment variables properly set, networks,..)
 224  * clean: will clean the functional test environement if existing
 225
 226 This script will:
 227  * Install Rally environment
 228  * Install Tempest
 229  * Retrieve test scenarios
 230  * Setup ODL environment
 231  * Create temporary neutron private network
 232  * Create router to connect both
 233  * Create Glance images
 234
 235
 236 Useful links:
 237
 238 .. _`OpenRC`: http://docs.openstack.org/user-guide/common/cli_set_environment_variables_using_openstack_rc.html
 239
 240 .. _`Rally installation procedure`: https://rally.readthedocs.org/en/latest/tutorial/step_0_installation.html
 241
 242 .. _`config_test.py` : https://git.opnfv.org/cgit/functest/tree/testcases/config_functest.py
 243
 244 .. _`config_test.py` : https://git.opnfv.org/cgit/functest/tree/testcases/functest.yaml
 245
 246
 247
 248
 249
 250
 251 The procedure to set up functional testing environment can be described as follow::
 252
 253     Log on the Jumphost server
 254     Be sure you are no root
 255     $ wget https://git.opnfv.org/cgit/functest/plain/testcases/config_functest.py
 256     $ wget https://git.opnfv.org/cgit/functest/plain/testcases/functest.yaml
 257     Modify and adapt needed parameters in the functest.yaml. Follow the instructions below.
 258     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)
 259     $ source Your_OpenRC_file
 260     $ python config_functest.py -d start
 261
 262 At the end of the executing, a new directory will be created ~/.functest with the following structure::
 263
 264  ~/.functest/ODL
 265  ~/.functest/Rally_repo
 266  ~/.functest/Rally_test
 267  ~/.functest/vPing
 268  ~/.functest/functest.yaml
 269  ~/.functest/trusty-server-cloudimg-amd64-disk1.img
 270
 271 NOTE: the Rally environment will be installed under ~/.rally/
 272
 273
 274 HOWTO configure functest.yaml:
 275
 276 Do not change the directories structure
 277     * image_name:               name of the image that will be created in Glance
 278     * image_url:                URL of the image to be downloaded
 279     * image_disk_format:        glance image disk format (raw, qcow2, ...)
 280
 281     * neutron_private_net_name:     name of an OpenStack private network. If not existing, it will be created
 282     * neutron_private_subnet_name:  private subnet network to be created if not existing
 283     * neutron_private_subnet_cidr:  range of the private subnet.
 284     * neutron_private_subnet_start: start IP
 285     * neutron_private_subnet_end:   end IP
 286     * neutron_router_name:          name of the router between the private and the public networks
 287
 288     * ping_timeout: time out of the vPing test case
 289     * vm_flavor:    name of the flavor used to create the VMs
 290     * vm_name_1:    name of the first VM
 291     * vm_name_2:    name of the second VM
 292
 293
 294 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.
 295
 296 If you need more details on Rally installation, see `Rally installation procedure`_.
 297
 298 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::
 299
 300     # rally deployment check
 301     keystone endpoints are valid and following service are available:
 302     +-------------+-----------+------------+
 303     | Services  | Type        | Status     |
 304     +-----------+-------------+------------+
 305     | cinder    | volume      | Available  |
 306     | cinderv2  | volumev2    | Available  |
 307     | glance    | image       | Available  |
 308     | keystone  | identity    | Available  |
 309     | neutron   | network     | Available  |
 310     | nova      | compute     | Available  |
 311     | nova_ec2  | compute_ec2 | Available  |
 312     | novav3    | computev3   | Available  |
 313     +-----------+-------------+------------+
 314
 315     # rally show images
 316     +--------------------------------------+----------------------------------------------+------------+
 317     | UUID                                 | Name                                         | Size (B)   |
 318     +--------------------------------------+----------------------------------------------+------------+
 319     | 0a15951f-6388-4d5d-8531-79e7205eb140 | cirros_2015_04_10_13_13_18                   | 13167616   |
 320     | b1504066-045a-4f8f-8919-8c665ef3f400 | Ubuntu 14.04 64b                             | 253297152  |
 321     +--------------------------------------+----------------------------------------------+------------+
 322
 323     # rally show flavors
 324     +--------------------------------------+---------------------+-------+----------+-----------+-----------+
 325     | ID                                   | Name                | vCPUs | RAM (MB) | Swap (MB) | Disk (GB) |
 326     +--------------------------------------+---------------------+-------+----------+-----------+-----------+
 327     | 110e6375-a058-4af6-b21e-b765187904d2 | m1.medium           | 2     | 1024     |           | 20        |
 328     | 7084d7e7-415a-455d-a55a-2ad286ddf7c9 | m1.large            | 4     | 4096     |           | 80        |
 329     | a0345ba7-c667-4fd2-964f-7e98f8cda279 | m1.xlarge           | 4     | 8192     |           | 200       |
 330     | accdc28c-5e20-4859-a5cc-61cf9009e56d | m1.small            | 1     | 512      |           | 10        |
 331     +--------------------------------------+---------------------+-------+----------+-----------+-----------+
 332
 333 --------------
 334 Manual testing
 335 --------------
 336
 337 Rally bench suite
 338 =================
 339
 340 Several scenarios are available (mainly based on native Rally scenarios):
 341  * glance
 342  * nova
 343  * authenticate
 344  * keystone
 345  * neutron
 346  * vm
 347  * quotas
 348  * request
 349  * tempest
 350  * smoke
 351  * all (every module except tempest and smoke)
 352
 353 You can run the script as follow::
 354
 355     # python run_rally.py keystone
 356
 357 The script will:
 358  * get the json scenario (if not already available) and put it into the scenario folder
 359  * run rally
 360  * generate the html result page into the result folder as opnfv-[module name]-[timestamp].html
 361  * generate the json result page into the result folder as opnfv-[module name]-[timestamp].json
 362  * generate OK or KO
 363
 364 Tempest suite
 365 =============
 366
 367 It is possible to use Rally to perform Tempest tests (ref: `tempest installation guide using Rally`_)
 368 You just need to run::
 369
 370      # rally verify start
 371
 372 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.
 373
 374 .. _`tempest installation guide using Rally`: https://www.mirantis.com/blog/rally-openstack-tempest-testing-made-simpler/
 375
 376 OpenDaylight
 377 ============
 378 ODL wiki page describes system preparation and running tests. See `Integration Group CSIT`_.
 379
 380 .. _`Integration Group CSIT`: https://wiki.opendaylight.org/view/CrossProject:Integration_Group:CSIT
 381
 382
 383 .. _manualtest:
 384
 385 --------------
 386 Test results
 387 --------------
 388
 389 Rally bench suite
 390 =================
 391
 392 Results are available in the result folder through a html page and a json file.
 393
 394 Tempest suite
 395 =============
 396
 397 You can get the results of tempest by typing::
 398
 399     # rally verify list
 400
 401 You shall see the results as follow::
 402
 403     Total results of verification:
 404
 405     +--------------------------------------+--------------------------------------+----------+-------+----------+----------------------------+----------+
 406     | UUID                                 | Deployment UUID                      | Set name | Tests | Failures | Created at                 | Status   |
 407     +--------------------------------------+--------------------------------------+----------+-------+----------+----------------------------+----------+
 408     | 0144c50f-ab03-45fb-9c36-242ad6440b46 | d9e1bb21-8e36-4d89-b137-0c852dbb308e | smoke    | 87    | 32       | 2015-05-05 16:36:00.986003 | finished |
 409     +--------------------------------------+--------------------------------------+----------+-------+----------+----------------------------+----------+
 410
 411 If you run this test several times, you will see as many lines as test attempts.
 412
 413 You can get more details on the test by typing::
 414
 415     # rally verify show --uuid <UUID of the test>
 416     # rally verify detailed --uuid <UUID of the test>
 417
 418 "show" will show you all the restults including the time needed to execute the test.
 419 "detailed" will display additional elements (errors)
 420
 421 Example of test result display::
 422
 423     +------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------+--------+
 424     | name                                                                                                                                                       | time      | status |
 425     +------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------+--------+
 426     | tempest.api.network.test_routers.RoutersTest.test_create_show_list_update_delete_router[id-f64403e2-8483-4b34-8ccd-b09a87bcc68c,smoke]                     | 0.011466  | FAIL   |
 427     | 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     |
 428     | tempest.api.network.test_security_groups.SecGroupIPv6Test.test_create_show_delete_security_group_rule[id-cfb99e0e-7410-4a3d-8a0c-959a63ee77e9,smoke]       | 1.060221  | OK     |
 429     | tempest.api.network.test_security_groups.SecGroupIPv6Test.test_list_security_groups[id-e30abd17-fef9-4739-8617-dc26da88e686,smoke]                         | 0.060797  | OK     |
 430     | 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     |
 431     | tempest.api.network.test_security_groups.SecGroupTest.test_create_show_delete_security_group_rule[id-cfb99e0e-7410-4a3d-8a0c-959a63ee77e9,smoke]           | 0.730561  | OK     |
 432     | tempest.api.network.test_security_groups.SecGroupTest.test_list_security_groups[id-e30abd17-fef9-4739-8617-dc26da88e686,smoke]                             | 0.116862  | OK     |
 433     | tempest.api.object_storage.test_account_quotas.AccountQuotasTest                                                                                           | 0.0       | SKIP   |
 434     | ...                                                                                                                                                        |   ...     |  ...   |
 435
 436 OpenDaylight
 437 ============
 438
 439 Tests can be executed with script *start_test.sh* from directory *functest/testcases/Controllers/ODL/CI*. For usage example see::
 440
 441     # bash ~./.functest/ODL/start_test.sh -h
 442
 443 vPing
 444 =====
 445 The test can be executed with command::
 446
 447     #python ~./.functest/vPing.py -d
 448
 449
 450 .. _automatictest:
 451
 452 ------------------
 453 Testing Automation
 454 ------------------
 455
 456 Connection of your platform
 457 ===========================
 458
 459 .. _`Octopus procedure`: https://wiki.opnfv.org/octopus/jenkins_slave_connection/
 460
 461 If you want to add your platform to the community automation, please follow the `Octopus procedure`_.
 462
 463 Integrating into CI Pipeline
 464 ============================
 465
 466 .. _`pipeline document`: https://wiki.opnfv.org/octopus/pipelines
 467
 468 Contact Octopus Team (#opnfv-octopus) and see `pipeline document`_ for more details.
 469
 470 .. _references:
 471
 472 ----------
 473 References
 474 ----------
 475
 476 OPNFV main site: opnfvmain_.
 477
 478 OPNFV functional test page: opnfvfunctest_.
 479
 480 IRC support chan: #opnfv-testperf
 481
 482 .. _opnfvmain: http://www.opnfv.org
 483 .. _opnfvfunctest: https://wiki.opnfv.org/opnfv_functional_testing