1 .. SPDX-License-Identifier: CC-BY-4.0
3 ************************
4 Functest Developer Guide
5 ************************
15 Functest is a project dealing with functional testing.
16 The project produces its own internal test cases but can also be considered
17 as a framework to support feature and VNF onboarding project testing.
19 Therefore there are many ways to contribute to Functest. You can:
21 * Develop new internal test cases
22 * Integrate the tests from your feature project
23 * Develop the framework to ease the integration of external test cases
25 Additional tasks involving Functest but addressing all the test projects
26 may also be mentioned:
28 * The API / Test collection framework
30 * The automatic reporting portals
31 * The testcase catalog
33 This document describes how, as a developer, you may interact with the
34 Functest project. The first section details the main working areas of
35 the project. The Second part is a list of "How to" to help you to join
36 the Functest family whatever your field of interest is.
39 ========================
40 Functest developer areas
41 ========================
44 Functest High level architecture
45 ================================
47 Functest is a project delivering test containers dedicated to OPNFV.
48 It includes the tools, the scripts and the test scenarios.
49 In Euphrates Alpine containers have been introduced in order to lighten the
50 container and manage testing slicing. The new containers are created according
51 to the different tiers:
53 * functest-core: https://hub.docker.com/r/opnfv/functest-core/
54 * functest-healthcheck: https://hub.docker.com/r/opnfv/functest-healthcheck/
55 * functest-smoke: https://hub.docker.com/r/opnfv/functest-smoke/
56 * functest-features: https://hub.docker.com/r/opnfv/functest-features/
57 * functest-components: https://hub.docker.com/r/opnfv/functest-components/
58 * functest-vnf: https://hub.docker.com/r/opnfv/functest-vnf/
59 * functest-restapi: https://hub.docker.com/r/opnfv/functest-restapi/
61 Standalone functest dockers are maintained for Euphrates but Alpine containers
64 Functest can be described as follow::
66 +----------------------+
68 | +--------------+ | +-------------------+
70 | | Tools | +------------------+ OPNFV |
71 | | Scripts | | | System Under Test |
74 | +--------------+ | +-------------------+
78 +----------------------+
80 Functest internal test cases
81 ============================
82 The internal test cases in Euphrates are:
97 By internal, we mean that this particular test cases have been developed and/or
98 integrated by functest contributors and the associated code is hosted in the
100 An internal case can be fully developed or a simple integration of
101 upstream suites (e.g. Tempest/Rally developed in OpenStack, or odl suites are
102 just integrated in Functest).
104 The structure of this repository is detailed in `[1]`_.
105 The main internal test cases are in the opnfv_tests subfolder of the
106 repository, the internal test cases can be grouped by domain:
109 * openstack: api_check, connection_check, snaps_health_check, vping_ssh,
110 vping_userdata, tempest_*, rally_*
113 If you want to create a new test case you will have to create a new folder
114 under the testcases directory (See next section for details).
116 Functest external test cases
117 ============================
118 The external test cases are inherited from other OPNFV projects, especially the
121 The external test cases are:
132 * orchestra_clearwaterims
137 External test cases integrated in previous versions but not released in
146 The code to run these test cases is hosted in the repository of the project.
147 Please note that orchestra test cases are hosted in Functest repository and not
148 in orchestra repository. Vyos_vrouter and juju_vepc code is also hosted in
149 functest as there are no dedicated projects.
155 Functest is a framework.
157 Historically Functest is released as a docker file, including tools, scripts
158 and a CLI to prepare the environment and run tests.
159 It simplifies the integration of external test suites in CI pipeline and
160 provide commodity tools to collect and display results.
162 Since Colorado, test categories also known as **tiers** have been created to
163 group similar tests, provide consistent sub-lists and at the end optimize
164 test duration for CI (see How To section).
166 The definition of the tiers has been agreed by the testing working group.
175 Functest abstraction classes
176 ============================
178 In order to harmonize test integration, abstraction classes have been
181 * testcase: base for any test case
182 * unit: run unit tests as test case
183 * feature: abstraction for feature project
184 * vnf: abstraction for vnf onboarding
186 The goal is to unify the way to run tests in Functest.
188 Feature, unit and vnf_base inherit from testcase::
190 +----------------------------------------------------------------+
197 | - is_successful() |
199 +----------------------------------------------------------------+
202 +--------------------+ +---------+ +------------------------+ +-----------------+
204 | feature | | unit | | vnf | | robotframework |
206 | | | | |- prepare() | | |
207 | - execute() | | | |- deploy_orchestrator() | | |
208 | BashFeature class | | | |- deploy_vnf() | | |
209 | | | | |- test_vnf() | | |
210 | | | | |- clean() | | |
211 +--------------------+ +---------+ +------------------------+ +-----------------+
217 :url: http://artifacts.opnfv.org/functest/docs/apidoc/functest.core.testcase.html
222 :url: http://artifacts.opnfv.org/functest/docs/apidoc/functest.core.feature.html
227 :url: http://artifacts.opnfv.org/functest/docs/apidoc/functest.core.unit.html
232 :url: http://artifacts.opnfv.org/functest/docs/apidoc/functest.core.vnf.html
237 :url: http://artifacts.opnfv.org/functest/docs/apidoc/functest.core.robotframework.html
240 see `[5]`_ to get code samples
243 Functest util classes
244 =====================
246 In order to simplify the creation of test cases, Functest develops also some
247 functions that are used by internal test cases.
248 Several features are supported such as logger, configuration management and
249 Openstack capabilities (tacker,..).
250 These functions can be found under <repo>/functest/utils and can be described
258 |-- functest_utils.py
259 |-- openstack_tacker.py
260 `-- openstack_utils.py
262 It is recommended to use the SNAPS-OO library for deploying OpenStack
263 instances. SNAPS `[4]`_ is an OPNFV project providing OpenStack utils.
268 Functest is using the Test collection framework and the TestAPI developed by
269 the OPNFV community. See `[6]`_ for details.
274 A web page is automatically generated every day to display the status based on
275 jinja2 templates `[3]`_.
281 Additional dashboarding is managed at the testing group level, see `[7]`_ for
289 See How to section on Functest wiki `[8]`_
296 _`[1]`: http://artifacts.opnfv.org/functest/docs/configguide/index.html Functest configuration guide
298 _`[2]`: http://artifacts.opnfv.org/functest/docs/userguide/index.html functest user guide
300 _`[3]`: https://git.opnfv.org/cgit/releng/tree/utils/test/reporting
302 _`[4]`: https://git.opnfv.org/snaps/
304 _`[5]` : http://testresults.opnfv.org/functest/framework/index.html
306 _`[6]`: http://docs.opnfv.org/en/latest/testing/testing-dev.html
308 _`[7]`: https://opnfv.biterg.io/goto/283dba93ca18e95964f852c63af1d1ba
310 _`[8]`: https://wiki.opnfv.org/pages/viewpage.action?pageId=7768932
312 IRC support chan: #opnfv-functest