fb3f40b05cdeb19763cac3e9d74686e62db2da91
[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  * odl
37  * neutron-tempest-plugin-api
38  * rally_sanity
39  * refstack_compute
40  * refstack_object
41  * refstack_platform
42  * tempest_full
43  * tempest_scenario
44  * tempest_slow
45  * patrole
46  * barbican
47  * neutron_trunk
48  * networking-bgpvpn
49  * networking-sfc
50  * octavia
51  * rally_full
52  * rally_jobs
53  * vmtp
54  * shaker
55  * cloudify
56  * cloudify_ims
57  * heat_ims
58  * vyos_vrouter
59  * juju_epc
60
61 Kubernetes
62 ----------
63
64 The internal test cases are:
65
66  * k8s_smoke
67  * xrally_kubernetes
68  * k8s_conformance
69
70 Release Data
71 ============
72
73 +--------------------------------------+--------------------------------------+
74 | **Project**                          | functest                             |
75 +--------------------------------------+--------------------------------------+
76 | **Repository branch**                | master                               |
77 +--------------------------------------+--------------------------------------+
78
79 Deliverables
80 ============
81
82 Software
83 --------
84
85  Functest Docker images (OpenStack):
86
87  * https://hub.docker.com/r/opnfv/functest-healthcheck
88  * https://hub.docker.com/r/opnfv/functest-smoke
89  * https://hub.docker.com/r/opnfv/functest-benchmarking
90  * https://hub.docker.com/r/opnfv/functest-vnf
91
92  Functest Docker images (Kubernetes):
93
94  * https://hub.docker.com/r/opnfv/functest-kubernetes-healthcheck
95  * https://hub.docker.com/r/opnfv/functest-kubernetes-smoke
96
97 Docker tag for master: latest
98
99 Documents
100 ---------
101
102  * Functests Guides: https://functest.readthedocs.io/en/latest/
103  * API Docs: https://functest-api.readthedocs.io/en/latest/
104
105 Version change
106 ==============
107
108 Key changes
109 -----------
110
111  * update testcases and containers to `OpenStack master`_ and to
112    `Kubernetes master`_
113
114 .. _`OpenStack master`: https://github.com/openstack/requirements/blob/master/upper-constraints.txt
115 .. _`Kubernetes master`: https://github.com/kubernetes/kubernetes
116
117 Key benefits
118 ------------
119
120  * the enduser can easily deploy its own `Functest toolchains`_ in few commands
121  * everyone can pick stable Functest rolling releases (latest included)
122  * Functest can verify VIM in production even on `Raspberry PI`_
123  * all testcases can run in parallel (tested with 4 executors in our gates)
124  * no remaining resources detected in our gates after multiple runs
125
126 .. _`Functest toolchains`: https://wiki.opnfv.org/pages/viewpage.action?pageId=32015004
127 .. _`Raspberry PI`: https://wiki.opnfv.org/display/functest/Run+Functest+containers+on+Raspberry+PI
128
129 Code quality
130 ------------
131
132  * pylint: 10.00/10
133  * code coverage: 70%
134
135 Useful links
136 ============
137
138  * wiki project page: https://wiki.opnfv.org/display/functest/Opnfv+Functional+Testing
139  * Functest git repository: https://github.com/opnfv/functest
140  * Functest CI dashboard: https://build.opnfv.org/ci/view/functest/
141  * JIRA dashboard: https://jira.opnfv.org/secure/Dashboard.jspa?selectPageId=10611
142  * Functest IRC channel: #opnfv-functest
143  * Reporting page: http://testresults.opnfv.org/reporting/master/functest/functest.html