1 .. _functest-userguide:
3 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
4 .. SPDX-License-Identifier: CC-BY-4.0
6 =========================
7 OPNFV FUNCTEST user guide
8 =========================
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-23 | 1.0.1 | Morgan Richomme | Adaptations for Danube |
23 +------------+----------+------------------+----------------------------------+
24 | 2017-08-16 | 1.0.2 | Morgan Richomme | Adaptations for Euphrates |
25 +------------+----------+------------------+----------------------------------+
31 The goal of this document is to describe the OPNFV Functest test cases and to
32 provide a procedure to execute them. In the OPNFV Danube system release,
33 a Functest CLI utility is introduced for an easier execution of test procedures.
35 **IMPORTANT**: It is assumed here that the Functest Docker container is already
36 properly deployed and that all instructions described in this guide are to be
37 performed from *inside* the deployed Functest Docker container.
39 .. include:: ./test_overview.rst
41 .. include:: ./test_details.rst
43 .. include:: ./runfunctest.rst
45 .. include:: ./test_results.rst
47 .. include:: ./reporting.rst
49 .. figure:: ../../../images/functest-reporting-status.png
51 :alt: Functest reporting portal Fuel status page
53 .. include:: ./troubleshooting.rst
59 `[1]`_: Functest configuration guide
61 `[2]`_: OpenStack Tempest documentation
63 `[3]`_: Rally documentation
65 `[4]`_: Functest in depth (Danube)
67 `[5]`_: Clearwater vIMS blueprint
71 `[7]`_: OpenSCAP web site
73 `[8]`_: Refstack client
77 `[10]`_: OpenStack interoperability procedure
79 `[11]`_: Robot Framework web site
81 `[12]`_: Functest User guide
87 `[15]`_: Testing OpenStack Tempest part 1
89 `OPNFV main site`_: OPNFV official web site
91 `Functest page`_: Functest wiki page
93 IRC support chan: #opnfv-functest
95 .. _`[1]`: http://docs.opnfv.org/en/stable-danube/submodules/functest/docs/testing/user/configguide/index.html
96 .. _`[2]`: http://docs.openstack.org/developer/tempest/overview.html
97 .. _`[3]`: https://rally.readthedocs.org/en/latest/index.html
98 .. _`[4]`: http://events.linuxfoundation.org/sites/events/files/slides/Functest%20in%20Depth_0.pdf
99 .. _`[5]`: https://github.com/Orange-OpenSource/opnfv-cloudify-clearwater/blob/master/openstack-blueprint.yaml
100 .. _`[6]`: https://scap.nist.gov/
101 .. _`[7]`: https://github.com/OpenSCAP/openscap
102 .. _`[8]`: https://github.com/openstack/refstack-client
103 .. _`[9]`: https://github.com/openstack/defcore
104 .. _`[10]`: https://github.com/openstack/interop/blob/master/2016.08/procedure.rst
105 .. _`[11]`: http://robotframework.org/
106 .. _`[12]`: http://docs.opnfv.org/en/stable-danube/submodules/functest/docs/testing/user/userguide/index.html
107 .. _`[13]`: https://wiki.opnfv.org/display/PROJ/SNAPS-OO
108 .. _`[14]`: https://github.com/oolorg/opnfv-functest-vrouter
109 .. _`[15]`: https://aptira.com/testing-openstack-tempest-part-1/
110 .. _`OPNFV main site`: http://www.opnfv.org
111 .. _`Functest page`: https://wiki.opnfv.org/functest
112 .. _`OpenRC`: http://docs.openstack.org/user-guide/common/cli_set_environment_variables_using_openstack_rc.html
113 .. _`Rally installation procedure`: https://rally.readthedocs.org/en/latest/tutorial/step_0_installation.html
114 .. _`config_functest.yaml` : https://git.opnfv.org/cgit/functest/tree/functest/ci/config_functest.yaml
115 .. _`Functest reporting`: http://testresults.opnfv.org/reporting/functest/release/danube/index-status-fuel.html