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  |             | If ping:          |             |
 184  |             |  shutdown VM2, OK |             |
 185  |             | else (timeout)    |             |
 186  |             |           test KO |             |
 187  |             |                   |             |
 188  |             |                   |             |
 189  +-------------+                   +-------------+
 190
 191
 192 This example, using OpenStack Python clients can be considered as an "Hello World" example and may be modified for future use.
 193
 194 .. _tooling_installation:
 195
 196 ----------------------
 197 Tooling installation
 198 ----------------------
 199
 200 2 external tools are needed for the functional tests on Arno:
 201  * Rally
 202  * Robot
 203
 204 Rally is used for benching and Tempest. Robot is used for OpenDaylight.
 205
 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.
 208
 209
 210
 211 usage: config_functest.py [-h] [-d] action
 212
 213 positional arguments:
 214   action       Possible actions are: 'start|check|clean'
 215
 216 optional arguments:
 217   -h, --help   show this help message and exit
 218   -d, --debug  Debug mode
 219
 220 Actions
 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
 224
 225 This script will:
 226  * Install Rally environment
 227  * Install Tempest
 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
 234
 235
 236 Useful links:
 237 .. _`OpenRC`: http://docs.openstack.org/user-guide/common/cli_set_environment_variables_using_openstack_rc.html
 238
 239 .. _`Rally installation procedure`: https://rally.readthedocs.org/en/latest/tutorial/step_0_installation.html
 240
 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
 243
 244
 245
 246
 247
 248
 249 The procedure to set up functional testing environment can be described as follow::
 250
 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
 259
 260 At the end of the executing, a new directory will be created ~/.functest with the following structure::
 261
 262  ~/.functest/ODL
 263  ~/.functest/Rally_repo
 264  ~/.functest/Rally_test
 265  ~/.functest/vPing
 266  ~/.functest/functest.yaml
 267  ~/.functest/trusty-server-cloudimg-amd64-disk1.img
 268
 269 NOTE: the Rally environment will be installed under ~/.rally/
 270
 271
 272 HOWTO configure functest.yaml:
 273
 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, ...)
 278
 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
 284
 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
 291
 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
 296
 297
 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.
 299
 300 If you need more details on Rally installation, see `Rally installation procedure`_.
 301
 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::
 303
 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     +-----------+-------------+------------+
 318
 319     # rally show images
 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     +--------------------------------------+----------------------------------------------+------------+
 326
 327     # rally show flavors
 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     +--------------------------------------+---------------------+-------+----------+-----------+-----------+
 336
 337 --------------
 338 Manual testing
 339 --------------
 340
 341 Rally bench suite
 342 =================
 343
 344 Several scenarios are available (mainly based on native Rally scenarios):
 345  * glance
 346  * nova
 347  * authenticate
 348  * keystone
 349  * neutron
 350  * vm
 351  * quotas
 352  * request
 353  * tempest
 354  * smoke
 355  * all (every module except tempest and smoke)
 356
 357 You can run the script as follow::
 358
 359     # python run_rally.py keystone
 360
 361 The script will:
 362  * get the json scenario (if not already available) and put it into the scenario folder
 363  * run rally
 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
 366  * generate OK or KO
 367
 368 Tempest suite
 369 =============
 370
 371 It is possible to use Rally to perform Tempest tests (ref: `tempest installation guide using Rally`_)
 372 You just need to run::
 373
 374      # rally verify start
 375
 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.
 377
 378 .. _`tempest installation guide using Rally`: https://www.mirantis.com/blog/rally-openstack-tempest-testing-made-simpler/
 379
 380 OpenDaylight
 381 ============
 382 ODL wiki page describes system preparation and running tests. See `Integration Group CSIT`_.
 383
 384 .. _`Integration Group CSIT`: https://wiki.opendaylight.org/view/CrossProject:Integration_Group:CSIT
 385
 386
 387 .. _manualtest:
 388
 389 --------------
 390 Test results
 391 --------------
 392
 393 Rally bench suite
 394 =================
 395
 396 Results are available in the result folder through a html page and a json file.
 397
 398 Tempest suite
 399 =============
 400
 401 You can get the results of tempest by typing::
 402
 403     # rally verify list
 404
 405 You shall see the results as follow::
 406
 407     Total results of verification:
 408
 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     +--------------------------------------+--------------------------------------+----------+-------+----------+----------------------------+----------+
 414
 415 If you run this test several times, you will see as many lines as test attempts.
 416
 417 You can get more details on the test by typing::
 418
 419     # rally verify show --uuid <UUID of the test>
 420     # rally verify detailed --uuid <UUID of the test>
 421
 422 "show" will show you all the restults including the time needed to execute the test.
 423 "detailed" will display additional elements (errors)
 424
 425 Example of test result display::
 426
 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   |
 438     | ...                                                                                                                                                        |   ...     |  ...   |
 439
 440 OpenDaylight
 441 ============
 442
 443 Tests can be executed with script *start_test.sh* from directory *functest/testcases/Controllers/ODL/CI*. For usage example see::
 444
 445     # bash ~./.functest/ODL/start_test.sh -h
 446
 447 vPing
 448 =====
 449 The test can be executed with command::
 450
 451     #python ~./.functest/vPing.py
 452
 453
 454 .. _automatictest:
 455
 456 ------------------
 457 Testing Automation
 458 ------------------
 459
 460 Connection of your platform
 461 ===========================
 462
 463 .. _`Octopus procedure`: https://wiki.opnfv.org/octopus/jenkins_slave_connection/
 464
 465 If you want to add your platform to the community automation, please follow the `Octopus procedure`_.
 466
 467 Integrating into CI Pipeline
 468 ============================
 469
 470 .. _`pipeline document`: https://wiki.opnfv.org/octopus/pipelines
 471
 472 Contact Octopus Team (#opnfv-octopus) and see `pipeline document`_ for more details.
 473
 474 .. _references:
 475
 476 ----------
 477 References
 478 ----------
 479
 480 OPNFV main site: opnfvmain_.
 481
 482 OPNFV functional test page: opnfvfunctest_.
 483
 484 IRC support chan: #opnfv-testperf
 485
 486 .. _opnfvmain: http://www.opnfv.org
 487 .. _opnfvfunctest: https://wiki.opnfv.org/opnfv_functional_testing