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  |             |  Including Ping   |             |
 182  |             |at the end of boot |             |
 183  |             |                   |             |
 184  |             |                   |             |
 185  +-------------+                   +-------------+
 186
 187
 188 This example, using OpenStack python clients can be considered as an "hellow World" example and may be modified for future use.
 189
 190 .. _tooling_installation:
 191
 192 ----------------------
 193 Tooling installation
 194 ----------------------
 195
 196 2 external tools are needed for the functional tests on Arno:
 197  * Rally
 198  * Robot
 199
 200 Rally is used for benching and Tempest. Robot is used ofr OpenDaylight.
 201
 202 A script has been created to simplify as much as possible the launch of the different suites of tests.
 203
 204 This script will:
 205  * Check the environment
 206  * Install tools
 207  * Retrieve test scenarios
 208  * Upload cloud images
 209  * Create temporary test networks
 210
 211
 212 .. _`OpenRC`: http://docs.openstack.org/user-guide/common/cli_set_environment_variables_using_openstack_rc.html
 213
 214 .. _`Rally installation procedure`: https://rally.readthedocs.org/en/latest/tutorial/step_0_installation.html
 215
 216 .. _`config_test.py` : https://git.opnfv.org/cgit/functest/tree/testcases/config_functest.py
 217
 218 This script config_test.py_ is hosted in OPNFV git and uses the configuration file functest.yaml.
 219
 220 3 actions are possible:
 221  * clean: will clean the functional test environement used for functional testing
 222  * check: will check the configuration (scenarios available, environment variables properly set, networks,..)
 223  * start: will prepare the functional testing
 224
 225
 226 The procedure to set up fonctional testing environement can be described as follow::
 227
 228     Log on the Jumphost server
 229     $ wget https://git.opnfv.org/cgit/functest/plain/testcases/config_functest.py
 230     $ wget https://git.opnfv.org/cgit/functest/plain/testcases/functest.yaml
 231     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)
 232     $ source Your_OpenRC_file
 233     $ python config_functest.py start
 234
 235 At the end of the configuration, you shall get the .functest repository::
 236
 237     TODO
 238
 239 Please note that you need to install this environment only once. Until the credentials of the System Under Test are not changing, the testing environemnt shall be fine.
 240
 241 If you need more details on Rally installation, see `Rally installation procedure`_.
 242
 243 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::
 244
 245     # rally deployment check
 246     keystone endpoints are valid and following service are available:
 247     +-------------+-----------+------------+
 248     | Services  | Type        | Status     |
 249     +-----------+-------------+------------+
 250     | cinder    | volume      | Available  |
 251     | cinderv2  | volumev2    | Available  |
 252     | glance    | image       | Available  |
 253     | keystone  | identity    | Available  |
 254     | neutron   | network     | Available  |
 255     | nova      | compute     | Available  |
 256     | nova_ec2  | compute_ec2 | Available  |
 257     | novav3    | computev3   | Available  |
 258     +-----------+-------------+------------+
 259
 260     # rally show images
 261     +--------------------------------------+----------------------------------------------+------------+
 262     | UUID                                 | Name                                         | Size (B)   |
 263     +--------------------------------------+----------------------------------------------+------------+
 264     | 0a15951f-6388-4d5d-8531-79e7205eb140 | cirros_2015_04_10_13_13_18                   | 13167616   |
 265     | b1504066-045a-4f8f-8919-8c665ef3f400 | Ubuntu 14.04 64b                             | 253297152  |
 266     +--------------------------------------+----------------------------------------------+------------+
 267
 268     # rally show flavors
 269     +--------------------------------------+---------------------+-------+----------+-----------+-----------+
 270     | ID                                   | Name                | vCPUs | RAM (MB) | Swap (MB) | Disk (GB) |
 271     +--------------------------------------+---------------------+-------+----------+-----------+-----------+
 272     | 110e6375-a058-4af6-b21e-b765187904d2 | m1.medium           | 2     | 1024     |           | 20        |
 273     | 7084d7e7-415a-455d-a55a-2ad286ddf7c9 | m1.large            | 4     | 4096     |           | 80        |
 274     | a0345ba7-c667-4fd2-964f-7e98f8cda279 | m1.xlarge           | 4     | 8192     |           | 200       |
 275     | accdc28c-5e20-4859-a5cc-61cf9009e56d | m1.small            | 1     | 512      |           | 10        |
 276     +--------------------------------------+---------------------+-------+----------+-----------+-----------+
 277
 278 --------------
 279 Manual testing
 280 --------------
 281
 282 Rally bench suite
 283 =================
 284
 285 Several scenarios are available (mainly based on native Rally scenarios):
 286  * glance
 287  * nova
 288  * authenticate
 289  * keystone
 290  * neutron
 291  * vm
 292  * quotas
 293  * request
 294  * tempest
 295  * smoke
 296  * all (every module except tempest and smoke)
 297
 298 You can run the script as follow::
 299
 300     # python run_rally.py keystone
 301
 302 The script will:
 303  * get the json scenario (if not already available) and put it into the scenario folder
 304  * run rally
 305  * generate the html result page into the result folder as opnfv-[module name]-[timestamp].html
 306  * generate the json result page into the result folder as opnfv-[module name]-[timestamp].json
 307  * generate OK or KO
 308
 309 Tempest suite
 310 =============
 311
 312 It is possible to use Rally to perform Tempest tests (ref: `tempest installation guide using Rally`_)
 313 You just need to run::
 314
 315      # rally verify start
 316
 317 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.
 318
 319 .. _`tempest installation guide using Rally`: https://www.mirantis.com/blog/rally-openstack-tempest-testing-made-simpler/
 320
 321 OpenDaylight
 322 ============
 323 ODL wiki page describes system preparation and running tests. See `Integration Group CSIT`_.
 324
 325 .. _`Integration Group CSIT`: https://wiki.opendaylight.org/view/CrossProject:Integration_Group:CSIT
 326
 327
 328 .. _manualtest:
 329
 330 --------------
 331 Test results
 332 --------------
 333
 334 Rally bench suite
 335 =================
 336
 337 Results are available in the result folder through a html page and a json file.
 338
 339 Tempest suite
 340 =============
 341
 342 You can get the results of tempest by typing::
 343
 344     # rally verify list
 345
 346 You shall see the results as follow::
 347
 348     Total results of verification:
 349
 350     +--------------------------------------+--------------------------------------+----------+-------+----------+----------------------------+----------+
 351     | UUID                                 | Deployment UUID                      | Set name | Tests | Failures | Created at                 | Status   |
 352     +--------------------------------------+--------------------------------------+----------+-------+----------+----------------------------+----------+
 353     | 0144c50f-ab03-45fb-9c36-242ad6440b46 | d9e1bb21-8e36-4d89-b137-0c852dbb308e | smoke    | 87    | 32       | 2015-05-05 16:36:00.986003 | finished |
 354     +--------------------------------------+--------------------------------------+----------+-------+----------+----------------------------+----------+
 355
 356 If you run this test several times, you will see as many lines as test attempts.
 357
 358 You can get more details on the test by typing::
 359
 360     # rally verify show --uuid <UUID of the test>
 361     # rally verify detailed --uuid <UUID of the test>
 362
 363 "show" will show you all the restults including the time needed to execute the test.
 364 "detailed" will display additional elements (errors)
 365
 366 Example of test result display::
 367
 368     +------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------+--------+
 369     | name                                                                                                                                                       | time      | status |
 370     +------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------+--------+
 371     | tempest.api.network.test_routers.RoutersTest.test_create_show_list_update_delete_router[id-f64403e2-8483-4b34-8ccd-b09a87bcc68c,smoke]                     | 0.011466  | FAIL   |
 372     | 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     |
 373     | tempest.api.network.test_security_groups.SecGroupIPv6Test.test_create_show_delete_security_group_rule[id-cfb99e0e-7410-4a3d-8a0c-959a63ee77e9,smoke]       | 1.060221  | OK     |
 374     | tempest.api.network.test_security_groups.SecGroupIPv6Test.test_list_security_groups[id-e30abd17-fef9-4739-8617-dc26da88e686,smoke]                         | 0.060797  | OK     |
 375     | 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     |
 376     | tempest.api.network.test_security_groups.SecGroupTest.test_create_show_delete_security_group_rule[id-cfb99e0e-7410-4a3d-8a0c-959a63ee77e9,smoke]           | 0.730561  | OK     |
 377     | tempest.api.network.test_security_groups.SecGroupTest.test_list_security_groups[id-e30abd17-fef9-4739-8617-dc26da88e686,smoke]                             | 0.116862  | OK     |
 378     | tempest.api.object_storage.test_account_quotas.AccountQuotasTest                                                                                           | 0.0       | SKIP   |
 379     | ...                                                                                                                                                        |   ...     |  ...   |
 380
 381 OpenDaylight
 382 ============
 383
 384 Tests can be executed with script *start_test.sh* from directory *functest/testcases/Controllers/ODL/CI*. For usage example see::
 385
 386     # bash ~./.functest/ODL/start_test.sh -h
 387
 388 vPing
 389 =====
 390 The test can be executed with command::
 391
 392     #python ~./.functest/vPing.py
 393
 394
 395 .. _automatictest:
 396
 397 ------------------
 398 Testing Automation
 399 ------------------
 400
 401 Connection of your platform
 402 ===========================
 403
 404 .. _`Octopus procedure`: https://wiki.opnfv.org/octopus/jenkins_slave_connection/
 405
 406 If you want to add your platform to the community automation, please follow the `Octopus procedure`_.
 407
 408 Integrating into CI Pipeline
 409 ============================
 410
 411 .. _`pipeline document`: https://wiki.opnfv.org/octopus/pipelines
 412
 413 Contact Octopus Team (#opnfv-octopus) and see `pipeline document`_ for more details.
 414
 415 .. _references:
 416
 417 ----------
 418 References
 419 ----------
 420
 421 OPNFV main site: opnfvmain_.
 422
 423 OPNFV functional test page: opnfvfunctest_.
 424
 425 IRC support chan: #opnfv-testperf
 426
 427 .. _opnfvmain: http://www.opnfv.org
 428 .. _opnfvfunctest: https://wiki.opnfv.org/opnfv_functional_testing