docs/testing/user/configguide/intro.rst

   1 .. SPDX-License-Identifier: CC-BY-4.0
   2
   3 Introduction
   4 ============
   5 This document describes how to install and configure Functest in OPNFV.
   6
   7 High level architecture
   8 -----------------------
   9
  10 The high level architecture of Functest within OPNFV can be described as
  11 follows::
  12
  13  CIMC/Lights+out management               Admin  Mgmt/API  Public  Storage Private
  14                                            PXE
  15  +                                           +       +        +       +       +
  16  |                                           |       |        |       |       |
  17  |     +----------------------------+        |       |        |       |       |
  18  |     |                            |        |       |        |       |       |
  19  +-----+       Jumphost             |        |       |        |       |       |
  20  |     |                            |        |       |        |       |       |
  21  |     |   +--------------------+   |        |       |        |       |       |
  22  |     |   |                    |   |        |       |        |       |       |
  23  |     |   | Tools              |   +----------------+        |       |       |
  24  |     |   | - Rally            |   |        |       |        |       |       |
  25  |     |   | - Robot            |   |        |       |        |       |       |
  26  |     |   | - RefStack         |   |        |       |        |       |       |
  27  |     |   |                    |   |-------------------------+       |       |
  28  |     |   | Testcases          |   |        |       |        |       |       |
  29  |     |   | - VIM              |   |        |       |        |       |       |
  30  |     |   |                    |   |        |       |        |       |       |
  31  |     |   | - SDN Controller   |   |        |       |        |       |       |
  32  |     |   |                    |   |        |       |        |       |       |
  33  |     |   | - Features         |   |        |       |        |       |       |
  34  |     |   |                    |   |        |       |        |       |       |
  35  |     |   | - VNF              |   |        |       |        |       |       |
  36  |     |   |                    |   |        |       |        |       |       |
  37  |     |   +--------------------+   |        |       |        |       |       |
  38  |     |     Functest Docker        +        |       |        |       |       |
  39  |     |                            |        |       |        |       |       |
  40  |     |                            |        |       |        |       |       |
  41  |     |                            |        |       |        |       |       |
  42  |     +----------------------------+        |       |        |       |       |
  43  |                                           |       |        |       |       |
  44  |    +----------------+                     |       |        |       |       |
  45  |    |             1  |                     |       |        |       |       |
  46  +----+ +--------------+-+                   |       |        |       |       |
  47  |    | |             2  |                   |       |        |       |       |
  48  |    | | +--------------+-+                 |       |        |       |       |
  49  |    | | |             3  |                 |       |        |       |       |
  50  |    | | | +--------------+-+               |       |        |       |       |
  51  |    | | | |             4  |               |       |        |       |       |
  52  |    +-+ | | +--------------+-+             |       |        |       |       |
  53  |      | | | |             5  +-------------+       |        |       |       |
  54  |      +-+ | |  nodes for     |             |       |        |       |       |
  55  |        | | |  deploying     +---------------------+        |       |       |
  56  |        +-+ |  OPNFV         |             |       |        |       |       |
  57  |          | |                +------------------------------+       |       |
  58  |          +-+     SUT        |             |       |        |       |       |
  59  |            |                +--------------------------------------+       |
  60  |            |                |             |       |        |       |       |
  61  |            |                +----------------------------------------------+
  62  |            +----------------+             |       |        |       |       |
  63  |                                           |       |        |       |       |
  64  +                                           +       +        +       +       +
  65               SUT = System Under Test
  66
  67 Note connectivity to management network is not needed for most of the
  68 testcases. But it may be needed for some specific snaps tests.
  69
  70 All the libraries and dependencies needed by all of the Functest tools are
  71 pre-installed into the Docker images. This allows running Functest on any
  72 platform.
  73
  74 The automated mechanisms inside the Functest Docker containers will:
  75
  76   * Prepare the environment according to the System Under Test (SUT)
  77   * Perform the appropriate functional tests
  78   * Push the test results into the OPNFV test result database (optional)
  79
  80 The OpenStack credentials file must be provided to the container.
  81
  82 These Docker images can be integrated into CI or deployed independently.
  83
  84 Please note that the Functest Docker images have been designed for OPNFV,
  85 however, it would be possible to adapt them to any OpenStack based VIM +
  86 controller environment, since most of the test cases are integrated from
  87 upstream communities.
  88
  89 The functional test cases are described in the Functest User `[2]`_
  90
  91 .. _`[2]`: http://docs.opnfv.org/en/latest/submodules/functest/docs/testing/user/userguide/index.html