Rename neutron_tempest_plugin_api to tempest_neutron
[functest.git] / docs / release / release-notes / functest-release.rst
1 .. SPDX-License-Identifier: CC-BY-4.0
2
3 ======================================
4 OPNFV master release note for Functest
5 ======================================
6
7 Abstract
8 ========
9
10 This document contains the release notes of the Functest project.
11
12 OPNFV master Release
13 ====================
14
15 Functest deals with functional testing of the OPNFV solution.
16 It includes test cases developed within the project, test cases developed in
17 other OPNFV projects and it also integrates test cases from other upstream
18 communities.
19
20 OpenStack
21 ---------
22
23 The internal test cases are:
24
25  * connection_check
26  * tenantnetwork1
27  * tenantnetwork2
28  * vmready1
29  * vmready2
30  * singlevm1
31  * singlevm2
32  * vping_ssh
33  * vping_userdata
34  * cinder_test
35  * tempest_smoke
36  * tempest_horizon
37  * odl
38  * tempest_neutron
39  * tempest_cinder
40  * tempest_keystone
41  * tempest_heat
42  * rally_sanity
43  * refstack_compute
44  * refstack_object
45  * refstack_platform
46  * tempest_full
47  * tempest_scenario
48  * tempest_slow
49  * patrole
50  * barbican
51  * neutron_trunk
52  * networking-bgpvpn
53  * networking-sfc
54  * octavia
55  * rally_full
56  * rally_jobs
57  * vmtp
58  * shaker
59  * cloudify
60  * cloudify_ims
61  * heat_ims
62  * vyos_vrouter
63  * juju_epc
64
65 Kubernetes
66 ----------
67
68 The internal test cases are:
69
70  * k8s_smoke
71  * xrally_kubernetes
72  * k8s_conformance
73
74 Release Data
75 ============
76
77 +--------------------------------------+--------------------------------------+
78 | **Project**                          | functest                             |
79 +--------------------------------------+--------------------------------------+
80 | **Repository branch**                | master                               |
81 +--------------------------------------+--------------------------------------+
82
83 Deliverables
84 ============
85
86 Software
87 --------
88
89  Functest Docker images (OpenStack):
90
91  * https://hub.docker.com/r/opnfv/functest-healthcheck
92  * https://hub.docker.com/r/opnfv/functest-smoke
93  * https://hub.docker.com/r/opnfv/functest-benchmarking
94  * https://hub.docker.com/r/opnfv/functest-vnf
95  * https://hub.docker.com/r/opnfv/functest-smoke-cntt
96  * https://hub.docker.com/r/opnfv/functest-benchmarking-cntt
97
98  Functest Docker images (Kubernetes):
99
100  * https://hub.docker.com/r/opnfv/functest-kubernetes-healthcheck
101  * https://hub.docker.com/r/opnfv/functest-kubernetes-smoke
102
103 Docker tag for master: latest
104
105 Documents
106 ---------
107
108  * Functest Guides: https://functest.readthedocs.io/en/latest/
109  * API Docs: https://functest-api.readthedocs.io/en/latest/
110
111 Version change
112 ==============
113
114 Key changes
115 -----------
116
117  * update testcases and containers to `OpenStack master`_ and to
118    `Kubernetes master`_
119
120 .. _`OpenStack master`: https://github.com/openstack/requirements/blob/master/upper-constraints.txt
121 .. _`Kubernetes master`: https://github.com/kubernetes/kubernetes
122
123 Key benefits
124 ------------
125
126  * the enduser can easily deploy its own `Functest toolchains`_ in few commands
127  * everyone can pick stable Functest rolling releases (latest included)
128  * Functest can verify VIM in production even on `Raspberry PI`_
129  * all testcases can run in parallel (tested with 4 executors in our gates)
130  * no remaining resources detected in our gates after multiple runs
131
132 .. _`Functest toolchains`: https://wiki.opnfv.org/pages/viewpage.action?pageId=32015004
133 .. _`Raspberry PI`: https://wiki.opnfv.org/display/functest/Run+Functest+containers+on+Raspberry+PI
134
135 Code quality
136 ------------
137
138  * pylint: 10.00/10
139  * code coverage: 70%
140
141 Useful links
142 ============
143
144  * wiki project page: https://wiki.opnfv.org/display/functest/Opnfv+Functional+Testing
145  * Functest git repository: https://github.com/opnfv/functest
146  * Functest CI dashboard: https://build.opnfv.org/ci/view/functest/
147  * JIRA dashboard: https://jira.opnfv.org/secure/Dashboard.jspa?selectPageId=10611
148  * Functest IRC channel: #opnfv-functest
149  * Reporting page: http://testresults.opnfv.org/reporting/master/functest/functest.html