docs/testing/user/userguide/test_details.rst

   1 .. SPDX-License-Identifier: CC-BY-4.0
   2
   3 The different test cases are described in the remaining sections of this
   4 document.
   5
   6 VIM (Virtualized Infrastructure Manager)
   7 ----------------------------------------
   8
   9 Healthcheck tests
  10 ^^^^^^^^^^^^^^^^^
  11 Since Danube, healthcheck tests have been refactored and rely on SNAPS, an
  12 OPNFV middleware project.
  13
  14 SNAPS stands for "SDN/NFV Application development Platform and Stack".
  15 SNAPS is an object-oriented OpenStack library packaged with tests that exercise
  16 OpenStack.
  17 More information on SNAPS can be found in  `[13]`_
  18
  19 Three tests are declared as healthcheck tests and can be used for gating by the
  20 installer, they cover functionally the tests previously done by healthcheck
  21 test case.
  22
  23 The tests are:
  24
  25
  26  * *connection_check*
  27  * *api_check*
  28  * *snaps_health_check*
  29
  30 Connection_check consists in 9 test cases (test duration < 5s) checking the
  31 connectivity with Glance, Keystone, Neutron, Nova and the external network.
  32
  33 Api_check verifies the retrieval of OpenStack clients: Keystone, Glance,
  34 Neutron and Nova and may perform some simple queries. When the config value of
  35 snaps.use_keystone is True, functest must have access to the cloud's private
  36 network. This suite consists in 49 tests (test duration < 2 minutes).
  37
  38 Snaps_health_check creates a VM with a single port with an IPv4 address that
  39 is assigned by DHCP and then validates the expected IP with the actual.
  40
  41 Self-obviously, successful completion of the 'healthcheck' testcase is a
  42 necessary pre-requisite for the execution of all other test Tiers.
  43
  44
  45 vPing_ssh
  46 ^^^^^^^^^
  47
  48 Given the script **ping.sh**::
  49
  50     #!/bin/sh
  51     ping -c 1 $1 2>&1 >/dev/null
  52     RES=$?
  53     if [ "Z$RES" = "Z0" ] ; then
  54         echo 'vPing OK'
  55     else
  56         echo 'vPing KO'
  57     fi
  58
  59
  60 The goal of this test is to establish an SSH connection using a floating IP
  61 on the Public/External network and verify that 2 instances can talk over a
  62 Private Tenant network::
  63
  64  vPing_ssh test case
  65  +-------------+                    +-------------+
  66  |             |                    |             |
  67  |             | Boot VM1 with IP1  |             |
  68  |             +------------------->|             |
  69  |   Tester    |                    |   System    |
  70  |             | Boot VM2           |    Under    |
  71  |             +------------------->|     Test    |
  72  |             |                    |             |
  73  |             | Create floating IP |             |
  74  |             +------------------->|             |
  75  |             |                    |             |
  76  |             | Assign floating IP |             |
  77  |             | to VM2             |             |
  78  |             +------------------->|             |
  79  |             |                    |             |
  80  |             | Establish SSH      |             |
  81  |             | connection to VM2  |             |
  82  |             | through floating IP|             |
  83  |             +------------------->|             |
  84  |             |                    |             |
  85  |             | SCP ping.sh to VM2 |             |
  86  |             +------------------->|             |
  87  |             |                    |             |
  88  |             | VM2 executes       |             |
  89  |             | ping.sh to VM1     |             |
  90  |             +------------------->|             |
  91  |             |                    |             |
  92  |             |    If ping:        |             |
  93  |             |      exit OK       |             |
  94  |             |    else (timeout): |             |
  95  |             |      exit Failed   |             |
  96  |             |                    |             |
  97  +-------------+                    +-------------+
  98
  99 This test can be considered as an "Hello World" example.
 100 It is the first basic use case which **must** work on any deployment.
 101
 102 vPing_userdata
 103 ^^^^^^^^^^^^^^
 104
 105 This test case is similar to vPing_ssh but without the use of Floating IPs
 106 and the Public/External network to transfer the ping script.
 107 Instead, it uses Nova metadata service to pass it to the instance at booting
 108 time.
 109 As vPing_ssh, it checks that 2 instances can talk to
 110 each other on a Private Tenant network::
 111
 112  vPing_userdata test case
 113  +-------------+                     +-------------+
 114  |             |                     |             |
 115  |             | Boot VM1 with IP1   |             |
 116  |             +-------------------->|             |
 117  |             |                     |             |
 118  |             | Boot VM2 with       |             |
 119  |             | ping.sh as userdata |             |
 120  |             | with IP1 as $1.     |             |
 121  |             +-------------------->|             |
 122  |   Tester    |                     |   System    |
 123  |             | VM2 executes ping.sh|    Under    |
 124  |             | (ping IP1)          |     Test    |
 125  |             +-------------------->|             |
 126  |             |                     |             |
 127  |             | Monitor nova        |             |
 128  |             |  console-log VM 2   |             |
 129  |             |    If ping:         |             |
 130  |             |      exit OK        |             |
 131  |             |    else (timeout)   |             |
 132  |             |      exit Failed    |             |
 133  |             |                     |             |
 134  +-------------+                     +-------------+
 135
 136 When the second VM boots it will execute the script passed as userdata
 137 automatically. The ping will be detected by periodically capturing the output
 138 in the console-log of the second VM.
 139
 140
 141 Tempest
 142 ^^^^^^^
 143
 144 Tempest `[2]`_ is the reference OpenStack Integration test suite.
 145 It is a set of integration tests to be run against a live OpenStack cluster.
 146 Tempest has suites of tests for:
 147
 148   * OpenStack API validation
 149   * Scenarios
 150   * Other specific tests useful in validating an OpenStack deployment
 151
 152 Functest uses Rally `[3]`_ to run the Tempest suite.
 153 Rally generates automatically the Tempest configuration file **tempest.conf**.
 154 Before running the actual test cases,
 155 Functest creates the needed resources (user, tenant) and
 156 updates the appropriate parameters into the configuration file.
 157
 158 When the Tempest suite is executed, each test duration is measured and the full
 159 console output is stored to a *log* file for further analysis.
 160
 161 The Tempest testcases are distributed across three
 162 Tiers:
 163
 164   * Smoke Tier - Test Case 'tempest_smoke_serial'
 165   * Components Tier - Test case 'tempest_full_parallel'
 166   * Neutron Trunk Port - Test case 'neutron_trunk'
 167   * OpenStack interop testcases - Test case 'refstack_defcore'
 168   * Testing and verifying RBAC policy enforcement - Test case 'patrole'
 169
 170 NOTE: Test case 'tempest_smoke_serial' executes a defined set of tempest smoke
 171 tests with a single thread (i.e. serial mode). Test case
 172 'tempest_full_parallel' executes all defined Tempest tests using several
 173 concurrent threads (i.e. parallel mode). The number of threads activated
 174 corresponds to the number of available logical CPUs.
 175
 176 NOTE: The 'neutron_trunk' test set allows to connect a VM to multiple VLAN
 177 separated networks using a single NIC. The feature neutron trunk ports have
 178 been supported by Apex, Fuel and Compass, so the tempest testcases have been
 179 integrated normally.
 180
 181 NOTE: Rally is also used to run Openstack Interop testcases `[9]`_, which focus
 182 on testing interoperability between OpenStack clouds.
 183
 184 NOTE: Patrole is a tempest plugin for testing and verifying RBAC policy
 185 enforcement. It runs Tempest-based API tests using specified RBAC roles, thus
 186 allowing deployments to verify that only intended roles have access to those
 187 APIs. Patrole currently offers testing for the following OpenStack services:
 188 Nova, Neutron, Glance, Cinder and Keystone. Currently in functest, only neutron
 189 and glance are tested.
 190
 191 The goal of the Tempest test suite is to check the basic functionalities of the
 192 different OpenStack components on an OPNFV fresh installation, using the
 193 corresponding REST API interfaces.
 194
 195
 196 Rally bench test suites
 197 ^^^^^^^^^^^^^^^^^^^^^^^
 198
 199 Rally `[3]`_ is a benchmarking tool that answers the question:
 200
 201 *How does OpenStack work at scale?*
 202
 203 The goal of this test suite is to benchmark all the different OpenStack modules
 204 and get significant figures that could help to define Telco Cloud KPIs.
 205
 206 The OPNFV Rally scenarios are based on the collection of the actual Rally
 207 scenarios:
 208
 209  * authenticate
 210  * cinder
 211  * glance
 212  * heat
 213  * keystone
 214  * neutron
 215  * nova
 216  * quotas
 217
 218 A basic SLA (stop test on errors) has been implemented.
 219
 220 The Rally testcases are distributed across two Tiers:
 221
 222   * Smoke Tier - Test Case 'rally_sanity'
 223   * Components Tier - Test case 'rally_full'
 224
 225 NOTE: Test case 'rally_sanity' executes a limited number of Rally smoke test
 226 cases. Test case 'rally_full' executes the full defined set of Rally tests.
 227
 228
 229 snaps_smoke
 230 ------------
 231
 232 This test case contains tests that setup and destroy environments with VMs with
 233 and without Floating IPs with a newly created user and project. Set the config
 234 value snaps.use_floating_ips (True|False) to toggle this functionality.
 235 Please note that When the configuration value of snaps.use_keystone is True,
 236 Functest must have access the cloud's private network.
 237 This suite consists in 120 tests (test duration ~= 50 minutes)
 238
 239
 240 SDN Controllers
 241 ---------------
 242
 243 OpenDaylight
 244 ^^^^^^^^^^^^
 245
 246 The OpenDaylight (ODL) test suite consists of a set of basic tests inherited
 247 from the ODL project using the Robot `[11]`_ framework.
 248 The suite verifies creation and deletion of networks, subnets and ports with
 249 OpenDaylight and Neutron.
 250
 251 The list of tests can be described as follows:
 252
 253  * Basic Restconf test cases
 254
 255    * Connect to Restconf URL
 256    * Check the HTTP code status
 257
 258  * Neutron Reachability test cases
 259
 260    * Get the complete list of neutron resources (networks, subnets, ports)
 261
 262  * Neutron Network test cases
 263
 264    * Check OpenStack networks
 265    * Check OpenDaylight networks
 266    * Create a new network via OpenStack and check the HTTP status code returned
 267      by Neutron
 268    * Check that the network has also been successfully created in OpenDaylight
 269
 270  * Neutron Subnet test cases
 271
 272    * Check OpenStack subnets
 273    * Check OpenDaylight subnets
 274    * Create a new subnet via OpenStack and check the HTTP status code returned
 275      by Neutron
 276    * Check that the subnet has also been successfully created in OpenDaylight
 277
 278  * Neutron Port test cases
 279
 280    * Check OpenStack Neutron for known ports
 281    * Check OpenDaylight ports
 282    * Create a new port via OpenStack and check the HTTP status code returned by
 283      Neutron
 284    * Check that the new port has also been successfully created in OpenDaylight
 285
 286  * Delete operations
 287
 288    * Delete the port previously created via OpenStack
 289    * Check that the port has been also successfully deleted in OpenDaylight
 290    * Delete previously subnet created via OpenStack
 291    * Check that the subnet has also been successfully deleted in OpenDaylight
 292    * Delete the network created via OpenStack
 293    * Check that the network has also been successfully deleted in OpenDaylight
 294
 295 Note: the checks in OpenDaylight are based on the returned HTTP status
 296 code returned by OpenDaylight.
 297
 298
 299 Features
 300 --------
 301
 302 Functest has been supporting several feature projects since Brahmaputra:
 303
 304
 305 +-----------------+---------+----------+--------+-----------+-----------+
 306 | Test            | Brahma  | Colorado | Danube | Euphrates |  Fraser   |
 307 +=================+=========+==========+========+===========+===========+
 308 | barometer       |         |          |    X   |     X     |     X     |
 309 +-----------------+---------+----------+--------+-----------+-----------+
 310 | bgpvpn          |         |    X     |    X   |     X     |     X     |
 311 +-----------------+---------+----------+--------+-----------+-----------+
 312 | copper          |         |    X     |        |           |           |
 313 +-----------------+---------+----------+--------+-----------+-----------+
 314 | doctor          |    X    |    X     |    X   |     X     |     X     |
 315 +-----------------+---------+----------+--------+-----------+-----------+
 316 | domino          |         |    X     |    X   |     X     |           |
 317 +-----------------+---------+----------+--------+-----------+-----------+
 318 | fds             |         |          |    X   |     X     |     X     |
 319 +-----------------+---------+----------+--------+-----------+-----------+
 320 | moon            |         |    X     |        |           |           |
 321 +-----------------+---------+----------+--------+-----------+-----------+
 322 | multisite       |         |    X     |    X   |           |           |
 323 +-----------------+---------+----------+--------+-----------+-----------+
 324 | netready        |         |          |    X   |           |           |
 325 +-----------------+---------+----------+--------+-----------+-----------+
 326 | odl_sfc         |         |    X     |    X   |     X     |     X     |
 327 +-----------------+---------+----------+--------+-----------+-----------+
 328 | opera           |         |          |    X   |           |           |
 329 +-----------------+---------+----------+--------+-----------+-----------+
 330 | orchestra       |         |          |    X   |     X     |     X     |
 331 +-----------------+---------+----------+--------+-----------+-----------+
 332 | parser          |         |          |    X   |     X     |     X     |
 333 +-----------------+---------+----------+--------+-----------+-----------+
 334 | promise         |    X    |    X     |    X   |     X     |     X     |
 335 +-----------------+---------+----------+--------+-----------+-----------+
 336 | security_scan   |         |    X     |    X   |           |           |
 337 +-----------------+---------+----------+--------+-----------+-----------+
 338 | clover          |         |          |        |           |     X     |
 339 +-----------------+---------+----------+--------+-----------+-----------+
 340 | stor4nfv        |         |          |        |           |     X     |
 341 +-----------------+---------+----------+--------+-----------+-----------+
 342
 343 Please refer to the dedicated feature user guides for details.
 344
 345
 346 VNF
 347 ---
 348
 349
 350 cloudify_ims
 351 ^^^^^^^^^^^^
 352 The IP Multimedia Subsystem or IP Multimedia Core Network Subsystem (IMS) is an
 353 architectural framework for delivering IP multimedia services.
 354
 355 vIMS has been integrated in Functest to demonstrate the capability to deploy a
 356 relatively complex NFV scenario on the OPNFV platform. The deployment of a
 357 complete functional VNF allows the test of most of the essential functions
 358 needed for a NFV platform.
 359
 360 The goal of this test suite consists of:
 361
 362  * deploy a VNF orchestrator (Cloudify)
 363  * deploy a Clearwater vIMS (IP Multimedia Subsystem) VNF from this
 364    orchestrator based on a TOSCA blueprint defined in `[5]`_
 365  * run suite of signaling tests on top of this VNF
 366
 367 The Clearwater architecture is described as follows:
 368
 369 .. figure:: ../../../images/clearwater-architecture.png
 370    :align: center
 371    :alt: vIMS architecture
 372
 373
 374 cloudify_ims_perf
 375 ^^^^^^^^^^^^^^^^^
 376 This testcase extends the cloudify_ims test case.
 377 The first part is similar but the testing part is different.
 378 The testing part consists in automating a realistic signaling load on the vIMS
 379 using an Ixia loader (proprietary tools)
 380
 381  - You need to have access to an Ixia licence server defined in the
 382    configuration file and have ixia image locally.
 383
 384 This test case is available but not declared in testcases.yaml. The declaration
 385 of the testcase is simple, connect to your functest-vnf docker, add the
 386 following section in
 387 /usr/lib/python2.7/site-packacges/functest/ci/testcases.yaml::
 388
 389   -
 390       case_name: cloudify_ims_perf
 391       project_name: functest
 392       criteria: 80
 393       blocking: false
 394       description: >-
 395           Stress tests based on Cloudify. Ixia loader images and access to Ixia
 396           server license.
 397       dependencies:
 398           installer: ''
 399           scenario: 'os-nosdn-nofeature-ha'
 400       run:
 401           module: 'functest.opnfv_tests.vnf.ims.cloudify_ims_perf'
 402           class: 'CloudifyImsPerf'
 403
 404 vyos-vrouter
 405 ^^^^^^^^^^^^
 406 This test case deals with the deployment and the test of vyos vrouter with
 407 Cloudify orchestrator. The test case can do testing for interchangeability of
 408 BGP Protocol using vyos.
 409
 410 The Workflow is as follows:
 411  * Deploy
 412     Deploy VNF Testing topology by Cloudify using blueprint.
 413  * Configuration
 414     Setting configuration to Target VNF and reference VNF using ssh
 415  * Run
 416     Execution of test command for test item written YAML format  file.
 417     Check VNF status and behavior.
 418  * Reporting
 419     Output of report based on result using JSON format.
 420
 421 The vyos-vrouter architecture is described in `[14]`_
 422
 423 juju_epc
 424 ^^^^^^^^
 425
 426 .. _`[2]`: http://docs.openstack.org/developer/tempest/overview.html
 427 .. _`[3]`: https://rally.readthedocs.org/en/latest/index.html
 428 .. _`[5]`: https://github.com/Orange-OpenSource/opnfv-cloudify-clearwater/blob/master/openstack-blueprint.yaml
 429 .. _`[8]`: https://github.com/openstack/refstack-client
 430 .. _`[9]`: https://github.com/openstack/defcore
 431 .. _`[10]`: https://github.com/openstack/interop/blob/master/2016.08/procedure.rst
 432 .. _`[11]`: http://robotframework.org/
 433 .. _`[12]`: http://docs.opnfv.org/en/latest/submodules/functest/docs/testing/user/userguide/index.html
 434 .. _`[13]`: https://wiki.opnfv.org/display/PROJ/SNAPS-OO
 435 .. _`[14]`: https://github.com/oolorg/opnfv-functest-vrouter