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