blob: bdf0e5b265a13f0b104e271700b3b24dfb69e249 (
plain)
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
|
******************************
OPNFV FUNCTEST developer guide
******************************
.. toctree::
:numbered:
:maxdepth: 2
============
Introduction
============
This document describes how feature projects aiming to run functional tests can be integrated into FuncTest framework.
================================
Functest High level architecture
================================
Functest is project delivering a test container dedicated to OPNFV.
It includes the tools, the scripts and the test scenarios.
Functest can be described as follow::
+----------------------+
| |
| +--------------+ | +-------------------+
| | | | Public | |
| | Tools | +------------------+ OPNFV |
| | Scripts | | | System Under Test |
| | Scenarios | +------------------+ |
| | | | Management | |
| +--------------+ | +-------------------+
| |
| Functest Docker |
| |
+----------------------+
Functest deals with internal and external test cases.
The Internal test cases in Brahmaputra are:
* vPing
* ODL
* Tempest
* vIMS
* Rally
see `[2]`_ for details.
Functest can also be considered as a framework that may include external OPNFV projects.
This framework will ease the integration of the feature test suite to the CI.
==================
How Functest works
==================
The installation and the launch of the Functest docker image is described in `[1]`_.
The Functest docker directories are::
home
|
`-- opnfv
|-- functest
| |-- conf
| |-- data
| `-- results
`-- repos
|-- bgpvpn
|-- doctor
|-- functest
|-- odl_integration
|-- onos
|-- ovno
|-- promise
|-- rally
|-- releng
`-- vims-test
::
+--------------+-------------------+---------------------------------------------------------+
| Directory | Subdirectory | Comments |
+--------------+-------------------+---------------------------------------------------------+
| | <project>/conf | All the useful configuration file(s) for <project> |
| | | the openstack creds are put there for CI |
| | | It is recommended to push it there when passing the |
| | | credentials to container through the -v option |
| +-------------------+---------------------------------------------------------+
| opnfv | <project>/data | Usefull data, images for <projects> |
| | | By default we put an image cirros-0.3.4-x86_64-disk.img |
| | | This image can be used by any projects |
| +-------------------+---------------------------------------------------------+
| | <project>/results | Local result directory of project <project> |
+--------------+-------------------+---------------------------------------------------------+
| | bgpvpn | |
| +-------------------+ +
| repos | doctor | |
| +-------------------+ +
| | functest | |
| +-------------------+ +
| | odl_integration | |
| +-------------------+ Clone of the useful repositories +
| | onos | These repositories may include: |
| +-------------------+ - tooling +
| | promise | - scenario |
| +-------------------+ - scripts +
| | rally | |
| +-------------------+ +
| | releng | |
| +-------------------+ +
| | vims-test | |
| +-------------------+ +
| | <your project> | |
+--------------+-------------------+---------------------------------------------------------+
Before running the test suite, you must prepare the environement by running::
$ /home/opnfv/repos/functest/docker/prepare_env.sh
By running prepare_env.sh, you build the test environement required by the tests including the retrieval and sourcing of OpenStack credentials.
This is an example of the env variables we have in the docker container:
* HOSTNAME=373f77816eb0
* INSTALLER_TYPE=fuel
* repos_dir=/home/opnfv/repos
* INSTALLER_IP=10.20.0.2
* PATH=/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin
* PWD=/home/opnfv
* SHLVL=1
* HOME=/home/opnfv
* NODE_NAME=opnfv-jump-2
* creds=/home/opnfv/functest/conf/openstack.creds
* _=/usr/bin/env
The prepare_env.sh will source the credentials, so once run you should have access to the following env variables::
root@373f77816eb0:~# env|grep OS_
OS_REGION_NAME=RegionOne
OS_PROJECT_NAME=admin
OS_PASSWORD=admin
OS_AUTH_STRATEGY=keystone
OS_AUTH_URL=http://172.30.10.70:5000/v2.0
OS_USERNAME=admin
OS_TENANT_NAME=admin
OS_ENDPOINT_TYPE=internalURL
OS_NO_CACHE=true
Then you may run the test suite by running::
$ /home/opnfv/repos/functest/docker/run_tests.sh -t <your project>
see `[2]`_ for details.
=========================
How to integrate Functest
=========================
The files of the Functest repository you must modify to integrate Functest are:
* functest/docker/Dockerfile
* functest/docker/common.sh
* functest/docker/requirements.pip
* functest/docker/run_tests.sh
* functest/docker/prepare_env.sh
* functest/config_funtest.yaml
Dockerfile
==========
This file lists the repositories to be cloned in the Functest container. The repositories can be internal or external::
RUN git clone https://gerrit.opnfv.org/gerrit/<your porject> ${repos_dir}/<your project>
Common.sh
==========
This file can be used to declare the branch and commit variables of your projects::
<YOUR_PROJECT>_BRANCH=$(cat $config_file | grep -w <your project>_branch | awk 'END {print $NF}')
<YOUR_PROJECT>_COMMIT=$(cat $config_file | grep -w <your project>_commit | awk 'END {print $NF}')
echo "<YOUR_PROJECT>_BRANCH=${<YOUR_PROJECT>_BRANCH}"
echo "<YOUR_PROJECT>_COMMIT=${<YOUR_PROJECT>_COMMIT}"
requirements.pip
================
This file can be used to preloaded all the needed Python libraries (and avoid that each project does it)
The current libraries used in Functest container are::
# cat requirements.pip
pyyaml==3.10
gitpython==1.0.1
python-neutronclient==2.6.0
python-novaclient==2.28.1
python-glanceclient==1.1.0
python-cinderclient==1.4.0
python-ceilometerclient==1.5.1
python-keystoneclient==1.6.0
virtualenv==1.11.4
pexpect==4.0
requests==2.8.0
robotframework==2.9.1
robotframework-requests==0.3.8
robotframework-sshlibrary==2.1.1
configObj==5.0.6
Flask==0.10.1
prepare_env.sh
==============
This script can be adapted if you need to set up a specific environment before running the tests.
run_tests.sh
============
This script is used to run the tests. You must thus complete the cases with you own project::
;;
"promise")
info "Running PROMISE test case..."
# TODO
;;
"doctor")
info "Running Doctor test..."
python ${FUNCTEST_REPO_DIR}/testcases/features/doctor.py
;;
"<your project>")
info "Running <your project> test..."
# your script that launchs your tests...
;;
And do not forget to update also the help line::
-t|--test run specific set of tests
<test_name> one or more of the following: vping,odl,rally,tempest,vims,onos, promise. Separated by comma.
config_funtest.yaml
===================
This file is the main configuration file of Functest. You must add the references to your project::
general:
directories:
dir_repo_<your project>: /home/opnfv/repos/<your project>
repositories:
# branch and commit ID to which the repos will be reset (HEAD)
<your project>_branch: master
<your project>_commit: latest
==========
References
==========
.. _`[1]`: Functest configuration guide URL
.. _`[2]`: functest user guide URL
OPNFV main site: opnfvmain_.
OPNFV functional test page: opnfvfunctest_.
IRC support chan: #opnfv-testperf
.. _opnfvmain: http://www.opnfv.org
.. _opnfvfunctest: https://wiki.opnfv.org/opnfv_functional_testing
.. _`OpenRC`: http://docs.openstack.org/user-guide/common/cli_set_environment_variables_using_openstack_rc.html
.. _`Rally installation procedure`: https://rally.readthedocs.org/en/latest/tutorial/step_0_installation.html
.. _`config_test.py` : https://git.opnfv.org/cgit/functest/tree/testcases/config_functest.py
.. _`config_functest.yaml` : https://git.opnfv.org/cgit/functest/tree/testcases/config_functest.yaml
|
