1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
2 .. http://creativecommons.org/licenses/by/4.0
4 ==================================
5 OPNFV FUNCTEST Configuration Guide
6 ==================================
15 +------------+----------+------------------+----------------------------------+
16 | **Date** | **Ver.** | **Author** | **Comment** |
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 +------------+----------+------------------+----------------------------------+
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
34 High level architecture
35 -----------------------
37 The high level architecture of Functest within OPNFV can be described as
40 CIMC/Lights+out management Admin Mgmt/API Public Storage Private
44 | +----------------------------+ | | | | |
46 +-----+ Jumphost | | | | | |
47 | | +--------+ | | | |
49 | | +--------------------+ | | | | | |
51 | | | Tools | +----------------+ | | |
52 | | | - Rally | | | | | | |
53 | | | - Robot | | | | | | |
54 | | | - TestON | | | | | | |
55 | | | - RefStack | | | | | | |
56 | | | | |-------------------------+ | |
57 | | | Testcases | | | | | | |
58 | | | - VIM | | | | | | |
60 | | | - SDN Controller | | | | | | |
62 | | | - Features | | | | | | |
64 | | | - VNF | | | | | | |
66 | | +--------------------+ | | | | | |
67 | | Functest Docker + | | | | |
71 | +----------------------------+ | | | | |
73 | +----------------+ | | | | |
75 +----+ +--------------+-+ | | | | |
77 | | | +--------------+-+ | | | | |
79 | | | | +--------------+-+ | | | | |
80 | | | | | 4 | | | | | |
81 | +-+ | | +--------------+-+ | | | | |
82 | | | | | 5 +-------------+ | | | |
83 | +-+ | | nodes for | | | | | |
84 | | | | deploying +---------------------+ | | |
85 | +-+ | OPNFV | | | | | |
86 | | | +------------------------------+ | |
88 | | +--------------------------------------+ |
90 | | +----------------------------------------------+
91 | +----------------+ | | | | |
94 SUT = System Under Test
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.
100 The automated mechanisms inside the Functest Docker container will:
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
107 This Docker image can be integrated into CI or deployed independently.
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.
114 The functional test cases are described in the Functest User Guide `[2]`_
116 .. include:: ./prerequisites.rst
118 .. include:: ./configguide.rst
120 .. include:: ./ci.rst
126 `[1]`_ : Keystone and public end point constraint
128 `[2]`_ : Functest User guide
130 `[3]`_ : Functest Jenkins jobs
132 `[4]`_ : Functest Configuration guide
138 IRC support channel: #opnfv-functest
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