.. This work is licensed under a Creative Commons Attribution 4.0 International License.
.. http://creativecommons.org/licenses/by/4.0

Overview of the functest suites
===============================

Functest is the OPNFV project primarily targeting function testing.
In the Continuous Integration pipeline, it is launched after an OPNFV fresh
installation to validate and verify the basic functions of the infrastructure.

The current list of test suites can be distributed in 3 main domains VIM,
Controllers and Features.

+----------------+----------------+-------------------------------------------+
| Domain         | Test suite     | Comments                                  |
+================+================+===========================================+
|                | vPing          | NFV "Hello World" using SSH connection    |
|                |                | and floatting IP                          |
|                +----------------+-------------------------------------------+
|    VIM         | vPing_userdata | Ping using userdata and cloud-init        |
|                |                | mechanism                                 |
|                +----------------+-------------------------------------------+
|(Virtualised    | Tempest        | OpenStack reference test suite            |
| Infrastructure +----------------+-------------------------------------------+
| Manager)       | Rally bench    | OpenStack testing tool benchmarking       |
|                |                | OpenStack modules                         |
+----------------+----------------+-------------------------------------------+
|                | OpenDaylight   | Opendaylight Test suite                   |
|                +----------------+-------------------------------------------+
| Controllers    | ONOS           | Test suite of ONOS L2 and L3 functions    |
|                |                | See `ONOSFW User Guide`_ for details      |
+----------------+----------------+-------------------------------------------+
| Features       | vIMS           | Example of a real VNF deployment to show  |
|                |                | the NFV capabilities of the platform.     |
|                |                | The IP Multimedia Subsytem is a typical   |
|                |                | Telco test case, referenced by ETSI.      |
|                |                | It provides a fully functional VoIP System|
|                +----------------+-------------------------------------------+
|                | Promise        | Resource reservation and management       |
|                |                | project to identify NFV related           |
|                |                | requirements and realize resource         |
|                |                | reservation for future usage by capacity  |
|                |                | management of resource pools regarding    |
|                |                | compute, network and storage.             |
|                |                | See `Promise User Guide`_ for details     |
|                +----------------+-------------------------------------------+
|                | Doctor         | Doctor platform, as of Brahmaputra release|
|                |                | , provides the two features:              |
|                |                | * Immediate Notification                  |
|                |                | * Consistent resource state awareness     |
|                |                | (compute), see `Doctor User Guide`_ for   |
|                |                | details                                   |
+----------------+----------------+-------------------------------------------+


Functest includes different test suites with several test cases within. Some
of the tests are developed by Functest contributors whereas others are
integrated from upstream communities or other OPNFV projects. For example,
`Tempest <http://docs.openstack.org/developer/tempest/overview.html>`_ is the
OpenStack integration test suite and Functest is in charge of the selection,
integration and automation of the appropriate test cases for OPNFV.

The Tempest suite has been customized but no new test cases have been created.

The results produced by the tests run from CI are pushed and collected in a NoSQL
database. The goal is to populate the database with results from different sources
and scenarios and to show them on a Dashboard.

There is no real notion of Test domain or Test coverage. Basic components
(VIM, controllers) are tested through their own suites. Feature projects also
provide their own test suites with different ways of running their tests.

Functest considers OPNFV as a black box and, since the Brahmaputra release,
it offers lots of potential combinations:

  * 2 controllers (OpenDayligh, ONOS)
  * 4 installers (Apex, Compass, Fuel, Joid)

Most of the tests are runnable on any combination, but some others might have
restrictions imposed by the installers or the available deployed features.

.. _`Doctor User Guide`: http://artifacts.opnfv.org/opnfvdocs/brahmaputra/docs/userguide/featureusage-doctor.html
.. _`Promise User Guide`: http://artifacts.opnfv.org/promise/brahmaputra/docs/userguide/index.html
.. _`ONOSFW User Guide`: http://artifacts.opnfv.org/onosfw/brahmaputra/docs/userguide/index.html


..
    Revision: 90608a9253aed220a1c373b77d7dbc8b44f171d3
    Build date: 2016-02-25