1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
|
.. This work is licensed under a Creative Commons Attribution 4.0 International License.
.. http://creativecommons.org/licenses/by/4.0
==================================
OPNFV FUNCTEST Configuration Guide
==================================
.. toctree::
:numbered:
:maxdepth: 2
Introduction
============
This document describes how to install and configure Functest in OPNFV.
The Functest CLI is utilized during the Functest environment preparation
step. The given example commands should work in both virtual and bare
metal cases alike.
High level architecture
-----------------------
The high level architecture of Functest within OPNFV can be described as
follows::
CIMC/Lights+out management Admin Private Public Storage
PXE
+ + + + +
| | | | |
| +----------------------------+ | | | |
| | | | | | |
+-----+ Jumphost | | | | |
| | +--------+ | | |
| | | | | | |
| | +--------------------+ | | | | |
| | | | | | | | |
| | | Tools | +----------------+ | |
| | | - Rally | | | | | |
| | | - Robot | | | | | |
| | | - TestON | | | | | |
| | | | | | | | |
| | | Testcases | | | | | |
| | | - VIM | | | | | |
| | | -- healthcheck | | | | | |
| | | -- vPing_ssh | | | | | |
| | | -- vPing_userdata | | | | | |
| | | -- Tempest_smoke | | | | | |
| | | -- Rally_sanity | | | | | |
| | | -- Tempest_full | | | | | |
| | | -- Rally_full | | | | | |
| | | | | | | | |
| | | - SDN Controller | | | | | |
| | | -- odl | | | | | |
| | | -- onos | | | | | |
| | | | | | | | |
| | | - VNF | | | | | |
| | | -- vIMS | | | | | |
| | | | | | | | |
| | +--------------------+ | | | | |
| | +-------------------------+ |
| | Functest Docker | | | | |
| | +---------------------------------+
| | | | | | |
| +----------------------------+ | | | |
| | | | |
| +----------------+ | | | |
| | 1 | | | | |
+----+ +--------------+-+ | | | |
| | | 2 | | | | |
| | | +--------------+-+ | | | |
| | | | 3 | | | | |
| | | | +--------------+-+ | | | |
| | | | | 4 | | | | |
| +-+ | | +--------------+-+ | | | |
| | | | | 5 +-------------+ | | |
| +-+ | | nodes for | | | | |
| | | | deploying +---------------------+ | |
| +-+ | OPNFV | | | | |
| | | +------------------------------+ |
| +-+ SUT | | | | |
| | +--------------------------------------+
| +----------------+ | | | |
| | | | |
+ + + + +
SUT = System Under Test
All the libraries and dependencies needed by all of the Functest tools
are pre-installed into the Docker image. This allows running Functest
on any platform on any Operating System.
The automated mechanisms inside the Functest Docker container will:
* Retrieve OpenStack credentials
* Prepare the environment according to the SUT
* Perform the appropriate functional tests
* Push the test results into the OPNFV test result database
This Docker image can be integrated into CI or deployed independently.
Please note that the Functest Docker container has been designed for
OPNFV, however, it would be possible to adapt it to any VIM + controller
environment, since most of the test cases are integrated from upstream
communities.
The functional test cases are described in the Functest User Guide `[2]`_
Prerequisites
=============
The OPNFV deployment is out of the scope of this document but it can be
found in http://artifacts.opnfv.org/opnfvdocs/colorado/docs/configguide/index.html.
The OPNFV platform is considered as the System Under Test (SUT) in this
document.
Several prerequisites are needed for Functest:
#. A Jumphost to run Functest on
#. A Docker daemon shall be installed on the Jumphost
#. A public/external network created on the SUT
#. An admin/management network created on the SUT
#. Connectivity from the Jumphost to the SUT public/external network
#. Connectivity from the Jumphost to the SUT admin/management network
WARNING: Connectivity from Jumphost is essential and it is of paramount
importance to make sure it is working before even considering to install
and run Functest. Make also sure you understand how your networking is
designed to work.
NOTE: **Jumphost** refers to any server which meets the previous
requirements. Normally it is the same server from where the OPNFV
deployment has been triggered previously.
NOTE: If your Jumphost is operating behind a company http proxy and/or
Firewall, please consult first the section `Proxy Support`_, towards
the end of this document. The section details some tips/tricks which
*may* be of help in a proxified environment.
Docker installation
-------------------
Docker installation and configuration is only needed to be done once
through the life cycle of Jumphost.
If your Jumphost is based on Ubuntu, RHEL or CentOS linux, please
consult the references below for more detailed instructions. The
commands below are offered as a short reference.
*Tip:* For running docker containers behind the proxy, you need first
some extra configuration which is described in section
`Docker Installation on CentOS behind http proxy`_. You should follow
that section before installing the docker engine.
Docker installation needs to be done as root user. You may use other
userid's to create and run the actual containers later if so desired.
Log on to your Jumphost as root user and install the Docker Engine
(e.g. for CentOS family)::
curl -sSL https://get.docker.com/ | sh
systemctl start docker
*Tip:* If you are working through proxy, please set the https_proxy
environment variable first before executing the curl command.
Add your user to docker group to be able to run commands without sudo::
sudo usermod -aG docker <your_user>
A reconnect is needed. There are 2 ways for this:
#. Re-login to your account
#. su - <username>
References - Installing Docker Engine on different Linux Operating Systems:
* Ubuntu_
* RHEL_
* CentOS_
.. _Ubuntu: https://docs.docker.com/engine/installation/linux/ubuntulinux/
.. _RHEL: https://docs.docker.com/engine/installation/linux/rhel/
.. _CentOS: https://docs.docker.com/engine/installation/linux/centos/
Public/External network on SUT
------------------------------
Some of the tests against the VIM (Virtual Infrastructure Manager) need
connectivity through an existing public/external network in order to
succeed. This is needed, for example, to create floating IPs to access
VM instances through the public/external network (i.e. from the Docker
container).
By default, the four OPNFV installers provide a fresh installation with
a public/external network created along with a router. Make sure that
the public/external subnet is reachable from the Jumphost.
*Hint:* For the given OPNFV Installer in use, the IP sub-net address
used for the public/external network is usually a planning item and
should thus be known. Consult the OPNFV Configuration guide `[4]`_, and
ensure you can reach each node in the SUT, from the Jumphost using the
'ping' command using the respective IP address on the public/external
network for each node in the SUT. The details of how to determine the
needed IP addresses for each node in the SUT may vary according to the
used installer and are therefore ommitted here.
Connectivity to Admin/Management network on SUT
-----------------------------------------------
Some of the Functest tools need to have access to the OpenStack
admin/management network of the controllers `[1]`_.
For this reason, check the connectivity from the Jumphost to all the
controllers in cluster in the OpenStack admin/management network range.
Installation and configuration
==============================
.. include:: ./configguide.rst
Integration in CI
=================
In CI we use the Docker image and execute the appropriate commands within the
container from Jenkins.
Docker creation in set-functest-env builder `[3]`_::
envs="INSTALLER_TYPE=${INSTALLER_TYPE} -e INSTALLER_IP=${INSTALLER_IP} -e NODE_NAME=${NODE_NAME}"
[...]
docker pull opnfv/functest:latest_stable
cmd="docker run -id -e $envs ${labconfig} ${sshkey} ${res_volume} opnfv/functest:latest_stable /bin/bash"
echo "Functest: Running docker run command: ${cmd}"
${cmd}
docker ps -a
sleep 5
container_id=$(docker ps | grep 'opnfv/functest:latest_stable' | awk '{print $1}' | head -1)
echo "Container ID=${container_id}"
if [ -z ${container_id} ]; then
echo "Cannot find opnfv/functest container ID ${container_id}. Please check if it is existing."
docker ps -a
exit 1
fi
echo "Starting the container: docker start ${container_id}"
docker start ${container_id}
sleep 5
docker ps
if [ $(docker ps | grep 'opnfv/functest:latest_stable' | wc -l) == 0 ]; then
echo "The container opnfv/functest with ID=${container_id} has not been properly started. Exiting..."
exit 1
fi
cmd="${FUNCTEST_REPO_DIR}/docker/prepare_env.sh"
echo "Executing command inside the docker: ${cmd}"
docker exec ${container_id} ${cmd}
Test execution in functest-all builder `[3]`_::
echo "Functest: run $FUNCTEST_SUITE_NAME"
cmd="${FUNCTEST_REPO_DIR}/docker/run_tests.sh --test $FUNCTEST_SUITE_NAME ${flag}"
container_id=$(docker ps -a | grep opnfv/functest | awk '{print $1}' | head -1)
docker exec $container_id $cmd
Docker clean in functest-cleanup builder `[3]`_::
echo "Cleaning up docker containers/images..."
# Remove previous running containers if exist
if [[ ! -z $(docker ps -a | grep opnfv/functest) ]]; then
echo "Removing existing opnfv/functest containers..."
docker ps | grep opnfv/functest | awk '{print $1}' | xargs docker stop
docker ps -a | grep opnfv/functest | awk '{print $1}' | xargs docker rm
fi
# Remove existing images if exist
if [[ ! -z $(docker images | grep opnfv/functest) ]]; then
echo "Docker images to remove:"
docker images | head -1 && docker images | grep opnfv/functest
image_tags=($(docker images | grep opnfv/functest | awk '{print $2}'))
for tag in "${image_tags[@]}"; do
echo "Removing docker image opnfv/functest:$tag..."
docker rmi opnfv/functest:$tag
done
fi
References
==========
.. _`[1]`: https://ask.openstack.org/en/question/68144/keystone-unable-to-use-the-public-endpoint/
.. _`[2]`: http://artifacts.opnfv.org/functest/docs/userguide/index.html
.. _`[3]`: https://git.opnfv.org/cgit/releng/tree/jjb/functest/functest-ci-jobs.yml
.. _`[4]`: http://artifacts.opnfv.org/opnfvdocs/colorado/docs/configguide/index.html
OPNFV main site: opnfvmain_.
OPNFV functional test page: opnfvfunctest_.
IRC support channel: #opnfv-functest
.. _opnfvmain: http://www.opnfv.org
.. _opnfvfunctest: https://wiki.opnfv.org/opnfv_functional_testing
|
