docs/testing/user/configguide/index.rst

   1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
   2 .. http://creativecommons.org/licenses/by/4.0
   3
   4 ==================================
   5 OPNFV FUNCTEST Configuration Guide
   6 ==================================
   7
   8 .. toctree::
   9    :numbered:
  10    :maxdepth: 2
  11
  12 Version history
  13 ===============
  14
  15 +------------+----------+------------------+----------------------------------+
  16 | **Date**   | **Ver.** | **Author**       | **Comment**                      |
  17 |            |          |                  |                                  |
  18 +------------+----------+------------------+----------------------------------+
  19 | 2016-08-17 | 1.0.0    | Juha Haapavirta  | Colorado release                 |
  20 |            |          | Column Gaynor    |                                  |
  21 +------------+----------+------------------+----------------------------------+
  22 | 2017-01-19 | 1.0.1    | Morgan Richomme  | Adaptations for Danube           |
  23 |            |          |                  | * update testcase list           |
  24 |            |          |                  | * update docker command          |
  25 +------------+----------+------------------+----------------------------------+
  26
  27 Introduction
  28 ============
  29 This document describes how to install and configure Functest in OPNFV.
  30 The Functest CLI is used during the Functest environment preparation
  31 phase. The given example commands should work in both virtual and bare
  32 metal cases alike.
  33
  34 High level architecture
  35 -----------------------
  36
  37 The high level architecture of Functest within OPNFV can be described as
  38 follows::
  39
  40  CIMC/Lights+out management               Admin  Mgmt/API  Public  Storage Private
  41                                            PXE
  42  +                                           +       +        +       +       +
  43  |                                           |       |        |       |       |
  44  |     +----------------------------+        |       |        |       |       |
  45  |     |                            |        |       |        |       |       |
  46  +-----+       Jumphost             |        |       |        |       |       |
  47  |     |                            +--------+       |        |       |       |
  48  |     |                            |        |       |        |       |       |
  49  |     |   +--------------------+   |        |       |        |       |       |
  50  |     |   |                    |   |        |       |        |       |       |
  51  |     |   | Tools              |   +----------------+        |       |       |
  52  |     |   | - Rally            |   |        |       |        |       |       |
  53  |     |   | - Robot            |   |        |       |        |       |       |
  54  |     |   | - TestON           |   |        |       |        |       |       |
  55  |     |   | - RefStack         |   |        |       |        |       |       |
  56  |     |   |                    |   |-------------------------+       |       |
  57  |     |   | Testcases          |   |        |       |        |       |       |
  58  |     |   | - VIM              |   |        |       |        |       |       |
  59  |     |   |                    |   |        |       |        |       |       |
  60  |     |   | - SDN Controller   |   |        |       |        |       |       |
  61  |     |   |                    |   |        |       |        |       |       |
  62  |     |   | - Features         |   |        |       |        |       |       |
  63  |     |   |                    |   |        |       |        |       |       |
  64  |     |   | - VNF              |   |        |       |        |       |       |
  65  |     |   |                    |   |        |       |        |       |       |
  66  |     |   +--------------------+   |        |       |        |       |       |
  67  |     |     Functest Docker        +        |       |        |       |       |
  68  |     |                            |        |       |        |       |       |
  69  |     |                            |        |       |        |       |       |
  70  |     |                            |        |       |        |       |       |
  71  |     +----------------------------+        |       |        |       |       |
  72  |                                           |       |        |       |       |
  73  |    +----------------+                     |       |        |       |       |
  74  |    |             1  |                     |       |        |       |       |
  75  +----+ +--------------+-+                   |       |        |       |       |
  76  |    | |             2  |                   |       |        |       |       |
  77  |    | | +--------------+-+                 |       |        |       |       |
  78  |    | | |             3  |                 |       |        |       |       |
  79  |    | | | +--------------+-+               |       |        |       |       |
  80  |    | | | |             4  |               |       |        |       |       |
  81  |    +-+ | | +--------------+-+             |       |        |       |       |
  82  |      | | | |             5  +-------------+       |        |       |       |
  83  |      +-+ | |  nodes for     |             |       |        |       |       |
  84  |        | | |  deploying     +---------------------+        |       |       |
  85  |        +-+ |  OPNFV         |             |       |        |       |       |
  86  |          | |                +------------------------------+       |       |
  87  |          +-+     SUT        |             |       |        |       |       |
  88  |            |                +--------------------------------------+       |
  89  |            |                |             |       |        |       |       |
  90  |            |                +----------------------------------------------+
  91  |            +----------------+             |       |        |       |       |
  92  |                                           |       |        |       |       |
  93  +                                           +       +        +       +       +
  94               SUT = System Under Test
  95
  96 All the libraries and dependencies needed by all of the Functest tools
  97 are pre-installed into the Docker image. This allows running Functest
  98 on any platform on any Operating System.
  99
 100 The automated mechanisms inside the Functest Docker container will:
 101
 102   * Retrieve OpenStack credentials
 103   * Prepare the environment according to the System Under Test (SUT)
 104   * Perform the appropriate functional tests
 105   * Push the test results into the OPNFV test result database
 106
 107 This Docker image can be integrated into CI or deployed independently.
 108
 109 Please note that the Functest Docker container has been designed for OPNFV,
 110 however, it would be possible to adapt it to any OpenStack based VIM +
 111 controller environment, since most of the test cases are integrated from
 112 upstream communities.
 113
 114 The functional test cases are described in the Functest User Guide `[2]`_
 115
 116 .. include:: ./prerequisites.rst
 117
 118 .. include:: ./configguide.rst
 119
 120 .. include:: ./ci.rst
 121
 122
 123 References
 124 ==========
 125
 126 `[1]`_ : Keystone and public end point constraint
 127
 128 `[2]`_ : Functest User guide
 129
 130 `[3]`_ : Functest Jenkins jobs
 131
 132 `[4]`_ : Functest Configuration guide
 133
 134 `OPNFV main site`_
 135
 136 `Functest page`_
 137
 138 IRC support channel: #opnfv-functest
 139
 140 .. _`[1]`: https://ask.openstack.org/en/question/68144/keystone-unable-to-use-the-public-endpoint/
 141 .. _`[2]`: http://docs.opnfv.org/en/stable-danube/submodules/functest/docs/testing/user/userguide/index.html
 142 .. _`[3]`: https://git.opnfv.org/cgit/releng/tree/jjb/functest/functest-ci-jobs.yml
 143 .. _`[4]`: http://docs.opnfv.org/en/stable-danube/submodules/functest/docs/testing/user/configguide/index.html
 144 .. _`OPNFV main site`: http://www.opnfv.org
 145 .. _`Functest page`: https://wiki.opnfv.org/functest