1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
2 .. SPDX-License-Identifier: CC-BY-4.0
4 Installation and configuration
5 ==============================
7 Alpine containers have been introduced in Euphrates.
8 Alpine allows Functest testing in several very light containers and thanks to
9 the refactoring on dependency management should allow the creation of light and
10 fully customized docker images.
15 Docker images are available on the dockerhub:
18 * opnfv/functest-healthcheck
19 * opnfv/functest-smoke
20 * opnfv/functest-features
21 * opnfv/functest-components
23 * opnfv/functest-parser
24 * opnfv/functest-restapi
26 The tag "opnfv-5.0.0" is the official release image in Euphrates, but you can also pull "euphrates"
27 tag as it is being maintained by Functest team and might include bugfixes.
29 The Functest docker container environment can -in principle- be also
30 used with non-OPNFV official installers (e.g. 'devstack'), with the
31 **disclaimer** that support for such environments is outside of the
32 scope and responsibility of the OPNFV project.
35 Preparing your environment
36 --------------------------
44 See section on environment variables for details.
48 export OS_AUTH_URL=XXX
49 export OS_USER_DOMAIN_NAME=XXX
50 export OS_PROJECT_DOMAIN_NAME=XXX
51 export OS_USERNAME=XXX
52 export OS_TENANT_NAME=XXX
53 export OS_PROJECT_NAME=XXX
54 export OS_PASSWORD=XXX
55 export OS_VOLUME_API_VERSION=XXX
56 export OS_IDENTITY_API_VERSION=XXX
57 export OS_IMAGE_API_VERSION=XXX
59 See section on OpenStack credentials for details.
61 Create a directory for the different images (attached as a Docker volume)::
63 mkdir -p images && wget -q -O- https://git.opnfv.org/functest/plain/functest/ci/download_images.sh?h=stable/euphrates | bash -s -- images && ls -1 images/*
65 images/CentOS-7-aarch64-GenericCloud.qcow2
66 images/CentOS-7-aarch64-GenericCloud.qcow2.xz
67 images/CentOS-7-x86_64-GenericCloud.qcow2
68 images/cirros-0.4.0-x86_64-disk.img
69 images/cirros-0.4.0-x86_64-lxc.tar.gz
70 images/cirros-d161201-aarch64-disk.img
71 images/cirros-d161201-aarch64-initramfs
72 images/cirros-d161201-aarch64-kernel
73 images/cloudify-manager-premium-4.0.1.qcow2
75 images/trusty-server-cloudimg-amd64-disk1.img
76 images/ubuntu-14.04-server-cloudimg-amd64-disk1.img
77 images/ubuntu-14.04-server-cloudimg-arm64-uefi1.img
78 images/ubuntu-16.04-server-cloudimg-amd64-disk1.img
81 Testing healthcheck suite
82 --------------------------
84 Run healthcheck suite::
86 sudo docker run --env-file env \
87 -v $(pwd)/openstack.creds:/home/opnfv/functest/conf/env_file \
88 -v $(pwd)/images:/home/opnfv/functest/images \
89 opnfv/functest-healthcheck
91 Results shall be displayed as follows::
93 +----------------------------+------------------+---------------------+------------------+----------------+
94 | TEST CASE | PROJECT | TIER | DURATION | RESULT |
95 +----------------------------+------------------+---------------------+------------------+----------------+
96 | connection_check | functest | healthcheck | 00:06 | PASS |
97 | api_check | functest | healthcheck | 06:52 | PASS |
98 | snaps_health_check | functest | healthcheck | 00:42 | PASS |
99 +----------------------------+------------------+---------------------+------------------+----------------+
100 NOTE: the duration is a reference and it might vary depending on your SUT.
107 sudo docker run --env-file env \
108 -v $(pwd)/openstack.creds:/home/opnfv/functest/conf/env_file \
109 -v $(pwd)/images:/home/opnfv/functest/images \
112 Results shall be displayed as follows::
114 +------------------------------+------------------+---------------+------------------+----------------+
115 | TEST CASE | PROJECT | TIER | DURATION | RESULT |
116 +------------------------------+------------------+---------------+------------------+----------------+
117 | vping_ssh | functest | smoke | 00:45 | PASS |
118 | vping_userdata | functest | smoke | 00:36 | PASS |
119 | tempest_smoke_serial | functest | smoke | 14:04 | PASS |
120 | rally_sanity | functest | smoke | 23:59 | PASS |
121 | refstack_defcore | functest | smoke | 14:37 | FAIL |
122 | snaps_smoke | functest | smoke | 42:09 | PASS |
123 | odl | functest | smoke | 00:00 | SKIP |
124 | odl_netvirt | functest | smoke | 00:00 | SKIP |
125 +------------------------------+------------------+---------------+------------------+----------------+
126 Note: if the scenario does not support some tests, they are indicated as SKIP.
127 See User guide for details.
129 Testing features suite
130 ----------------------
134 sudo docker run --env-file env \
135 -v $(pwd)/openstack.creds:/home/opnfv/functest/conf/env_file \
136 -v $(pwd)/images:/home/opnfv/functest/images \
137 opnfv/functest-features
139 Results shall be displayed as follows::
141 +-----------------------------+------------------------+------------------+------------------+----------------+
142 | TEST CASE | PROJECT | TIER | DURATION | RESULT |
143 +-----------------------------+------------------------+------------------+------------------+----------------+
144 | doctor-notification | doctor | features | 00:00 | SKIP |
145 | bgpvpn | sdnvpn | features | 00:00 | SKIP |
146 | functest-odl-sfc | sfc | features | 00:00 | SKIP |
147 | barometercollectd | barometer | features | 00:00 | SKIP |
148 | fds | fastdatastacks | features | 00:00 | SKIP |
149 +-----------------------------+------------------------+------------------+------------------+----------------+
150 Note: if the scenario does not support some tests, they are indicated as SKIP.
151 See User guide for details.
153 Testing components suite
154 ------------------------
156 Run components suite::
158 sudo docker run --env-file env \
159 -v $(pwd)/openstack.creds:/home/opnfv/functest/conf/env_file \
160 -v $(pwd)/images:/home/opnfv/functest/images \
161 opnfv/functest-components
163 Results shall be displayed as follows::
165 +-------------------------------+------------------+--------------------+------------------+----------------+
166 | TEST CASE | PROJECT | TIER | DURATION | RESULT |
167 +-------------------------------+------------------+--------------------+------------------+----------------+
168 | tempest_full_parallel | functest | components | 52:42 | PASS |
169 | rally_full | functest | components | 114:22 | PASS |
170 +-------------------------------+------------------+--------------------+------------------+----------------+
177 sudo docker run --env-file env \
178 -v $(pwd)/openstack.creds:/home/opnfv/functest/conf/env_file \
179 -v $(pwd)/images:/home/opnfv/functest/images \
182 Results shall be displayed as follows::
184 +---------------------------------+-------------------+--------------+------------------+----------------+
185 | TEST CASE | PROJECT | TIER | DURATION | RESULT |
186 +---------------------------------+-------------------+--------------+------------------+----------------+
187 | cloudify_ims | functest | vnf | 28:49 | FAIL |
188 | vyos_vrouter | functest | vnf | 27:57 | FAIL |
189 | juju_epc | functest | vnf | 55:03 | PASS |
190 | orchestra_openims | orchestra | vnf | 00:00 | SKIP |
191 | orchestra_clearwaterims | orchestra | vnf | 00:00 | SKIP |
192 +---------------------------------+-------------------+--------------+------------------+----------------+
195 Environment variables
196 =====================
198 Several environement variables may be specified:
199 * INSTALLER_TYPE=(apex|compass|daisy|fuel|joid)
200 * DEPLOY_SCENARIO=<vim>-<controller>-<nfv_feature>-<ha_mode>
203 The format for the DEPLOY_SCENARIO env variable can be described as follows:
204 * vim: (os|k8s) = OpenStack or Kubernetes
205 * controller is one of ( nosdn | odl )
206 * nfv_feature is one or more of ( ovs | kvm | sfc | bgpvpn | nofeature )
207 * ha_mode (high availability) is one of ( ha | noha )
209 If several features are pertinent then use the underscore character '_' to
210 separate each feature (e.g. ovs_kvm). 'nofeature' indicates that no OPNFV
213 The list of supported scenarios per release/installer is indicated in the
216 **NOTE:** The scenario name is mainly used to automatically detect
217 if a test suite is runnable or not (e.g. it will prevent ODL test suite to be
218 run on 'nosdn' scenarios). If not set, Functest will try to run the default test
219 cases that might not include SDN controller or a specific feature
221 **NOTE:** An HA scenario means that 3 OpenStack controller nodes are
222 deployed. It does not necessarily mean that the whole system is HA. See
223 installer release notes for details.
225 Finally, three additional environment variables can also be passed in
226 to the Functest Docker Container, using the -e
227 "<EnvironmentVariable>=<Value>" mechanism. The first two parameters are
228 only relevant to Jenkins CI invoked testing and **should not be used**
229 when performing manual test scenarios:
231 * NODE_NAME = <Test POD Name>
232 * BUILD_TAG = <Jenkins Build Tag>
236 * <Test POD Name> = Symbolic name of the POD where the tests are run.
237 Visible in test results files, which are stored
238 to the database. This option is only used when
239 tests are activated under Jenkins CI control.
240 It indicates the POD/hardware where the test has
241 been run. If not specified, then the POD name is
242 defined as "Unknown" by default.
243 DO NOT USE THIS OPTION IN MANUAL TEST SCENARIOS.
244 * <Jenkins Build tag> = Symbolic name of the Jenkins Build Job.
245 Visible in test results files, which are stored
246 to the database. This option is only set when
247 tests are activated under Jenkins CI control.
248 It enables the correlation of test results,
249 which are independently pushed to the results database
250 from different Jenkins jobs.
251 DO NOT USE THIS OPTION IN MANUAL TEST SCENARIOS.
254 Openstack credentials
255 =====================
256 OpenStack credentials are mandatory and must be provided to Functest.
257 When running the command "functest env prepare", the framework will
258 automatically look for the Openstack credentials file
259 "/home/opnfv/functest/conf/env_file" and will exit with
260 error if it is not present or is empty.
262 There are 2 ways to provide that file:
264 * by using a Docker volume with -v option when creating the Docker container.
265 This is referred to in docker documentation as "Bind Mounting".
266 See the usage of this parameter in the following chapter.
267 * or creating manually the file '/home/opnfv/functest/conf/env_file'
268 inside the running container and pasting the credentials in it. Consult
269 your installer guide for further details. This is however not
270 instructed in this document.
272 In proxified environment you may need to change the credentials file.
273 There are some tips in chapter: `Proxy support`_
277 If you need to connect to a server that is TLS-enabled (the auth URL
278 begins with "https") and it uses a certificate from a private CA or a
279 self-signed certificate, then you will need to specify the path to an
280 appropriate CA certificate to use, to validate the server certificate
281 with the environment variable OS_CACERT::
284 /etc/ssl/certs/ca.crt
286 However, this certificate does not exist in the container by default.
287 It has to be copied manually from the OpenStack deployment. This can be
290 #. Create manually that file and copy the contents from the OpenStack
292 #. (Recommended) Add the file using a Docker volume when starting the
295 -v <path_to_your_cert_file>:/etc/ssl/certs/ca.cert
297 You might need to export OS_CACERT environment variable inside the
300 export OS_CACERT=/etc/ssl/certs/ca.crt
302 Certificate verification can be turned off using OS_INSECURE=true. For
303 example, Fuel uses self-signed cacerts by default, so an pre step would
306 export OS_INSECURE=true
308 Functest docker container directory structure
309 =============================================
310 Inside the Functest docker container, the following directory structure
311 should now be in place::
333 Underneath the '/home/opnfv/functest' directory, the Functest docker container
334 includes two main directories:
336 * The **conf** directory stores configuration files (e.g. the
337 OpenStack creds are stored in path '/home/opnfv/functest/conf/env_file'),
338 * the **results** directory stores some temporary result log files
340 src and repos directories are used to host third party code used for the tests.
342 The structure of functest repo can be described as follows::
359 | |-- thirdparty-requirements.txt
364 | | `-- release-notes
393 │ |-- check_deployment.py
394 │ |-- config_aarch64_patch.yaml
395 │ |-- config_functest.yaml
396 │ |-- config_patch.yaml
397 │ |-- download_images.sh
399 │ |-- rally_aarch64_patch.conf
401 │ |-- testcases.yaml
402 │ |-- tier_builder.py
403 │ |-- tier_handler.py
407 │ │ |-- cli_env.py
408 │ │ |-- cli_os.py
409 │ │ |-- cli_testcase.py
410 │ │ |-- cli_tier.py
411 │ |-- functest-complete.sh
414 │ |-- robotframework.py
423 │ |-- refstack_client
442 │ |-- test_utils.py
450 | |-- functest_utils.py
451 | |-- functest_vacation.py
452 | |-- openstack_clean.py
453 | |-- openstack_tacker.py
454 | `-- openstack_utils.py
458 |-- test-requirements.txt
460 |-- upper-constraints.txt
462 (Note: All *.pyc files removed from above list for brevity...)
464 We may distinguish several directories, the first level has 5 directories:
466 * **api**: This directory is dedicated to the API (framework) documentations.
467 * **commons**: This directory is dedicated for storage of traffic profile or
468 any other test inputs that could be reused by any test project.
469 * **docker**: This directory includes the needed files and tools to
470 build the Functest Docker images.
471 * **docs**: This directory includes documentation: Release Notes,
472 User Guide, Configuration Guide and Developer Guide.
473 * **functest**: This directory contains all the code needed to run
474 functest internal cases and OPNFV onboarded feature or VNF test cases.
476 Functest directory has 7 sub-directories, which is located under
477 /usr/lib/python2.7/site-packages/functest:
478 * **api**: This directory is dedicated for the internal Functest API.
479 * **ci**: This directory contains test structure definition files
480 (e.g <filename>.yaml) and bash shell/python scripts used to
481 configure and execute Functional tests. The test execution script
482 can be executed under the control of Jenkins CI jobs.
483 * **cli**: This directory holds the python based Functest CLI utility
484 source code, which is based on the Python 'click' framework.
485 * **core**: This directory holds the python based Functest core
486 source code. Three abstraction classes have been created to ease
487 the integration of internal, feature or vnf cases.
488 * **opnfv_tests**: This directory includes the scripts required by
489 Functest internal test cases and other feature projects test cases.
490 * **tests**: This directory includes the functest unit tests.
491 * **utils**: this directory holds Python source code for some general
492 purpose helper utilities, which testers can also re-use in their
493 own test code. See for an example the Openstack helper utility:
494 'openstack_utils.py'.
499 By default all the logs are put un /home/opnfv/functest/results/functest.log.
500 If you want to have more logs in console, you may edit the logging.ini file
502 Connect on the docker then edit the file located in
503 /usr/lib/python2.7/site-packages/functest/ci/logging.ini
505 Change wconsole to console in the desired module to get more traces.
511 You may also directly modify the python code or the configuration file (e.g.
512 testcases.yaml used to declare test constraints) under
513 /usr/lib/python2.7/site-packages/functest
521 When typing **exit** in the container prompt, this will cause exiting
522 the container and probably stopping it. When stopping a running Docker
523 container all the changes will be lost, there is a keyboard shortcut
524 to quit the container without stopping it: <CTRL>-P + <CTRL>-Q. To
525 reconnect to the running container **DO NOT** use the *run* command
526 again (since it will create a new container), use the *exec* or *attach*
529 docker ps # <check the container ID from the output>
530 docker exec -ti <CONTAINER_ID> /bin/bash
532 There are other useful Docker commands that might be needed to manage possible
533 issues with the containers.
535 List the running containers::
539 List all the containers including the stopped ones::
543 Start a stopped container named "FunTest"::
547 Attach to a running container named "StrikeTwo"::
549 docker attach StrikeTwo
551 It is useful sometimes to remove a container if there are some problems::
553 docker rm <CONTAINER_ID>
555 Use the *-f* option if the container is still running, it will force to
558 docker rm -f <CONTAINER_ID>
560 Check the Docker documentation [`dockerdocs`_] for more information.
563 Checking Openstack and credentials
564 ----------------------------------
565 It is recommended and fairly straightforward to check that Openstack
566 and credentials are working as expected.
568 Once the credentials are there inside the container, they should be
569 sourced before running any Openstack commands::
571 source /home/opnfv/functest/conf/env_file
573 After this, try to run any OpenStack command to see if you get any
574 output, for instance::
578 This will return a list of the actual users in the OpenStack
579 deployment. In any other case, check that the credentials are sourced::
583 This command must show a set of environment variables starting with
586 OS_REGION_NAME=RegionOne
587 OS_USER_DOMAIN_NAME=Default
588 OS_PROJECT_NAME=admin
590 OS_IDENTITY_API_VERSION=3
591 OS_PASSWORD=da54c27ae0d10dfae5297e6f0d6be54ebdb9f58d0f9dfc
592 OS_AUTH_URL=http://10.1.0.9:5000/v3
595 OS_ENDPOINT_TYPE=internalURL
596 OS_INTERFACE=internalURL
598 OS_PROJECT_DOMAIN_NAME=Default
601 If the OpenStack command still does not show anything or complains
602 about connectivity issues, it could be due to an incorrect url given to
603 the OS_AUTH_URL environment variable. Check the deployment settings.
607 If your Jumphost node is operating behind a http proxy, then there are
608 2 places where some special actions may be needed to make operations
611 #. Initial installation of docker engine First, try following the
612 official Docker documentation for Proxy settings. Some issues were
613 experienced on CentOS 7 based Jumphost. Some tips are documented
614 in section: `Docker Installation on CentOS behind http proxy`_
617 If that is the case, make sure the resolv.conf and the needed
618 http_proxy and https_proxy environment variables, as well as the
619 'no_proxy' environment variable are set correctly::
621 # Make double sure that the 'no_proxy=...' line in the
622 # 'env_file' file is commented out first. Otherwise, the
623 # values set into the 'no_proxy' environment variable below will
624 # be ovewrwritten, each time the command
625 # 'source ~/functest/conf/env_file' is issued.
628 sed -i 's/export no_proxy/#export no_proxy/' env_file
631 # Next calculate some IP addresses for which http_proxy
632 # usage should be excluded:
634 publicURL_IP=$(echo $OS_AUTH_URL | grep -Eo "([0-9]+\.){3}[0-9]+")
636 adminURL_IP=$(openstack catalog show identity | \
637 grep adminURL | grep -Eo "([0-9]+\.){3}[0-9]+")
639 export http_proxy="<your http proxy settings>"
640 export https_proxy="<your https proxy settings>"
641 export no_proxy="127.0.0.1,localhost,$publicURL_IP,$adminURL_IP"
643 # Ensure that "git" uses the http_proxy
644 # This may be needed if your firewall forbids SSL based git fetch
645 git config --global http.sslVerify True
646 git config --global http.proxy <Your http proxy settings>
648 For example, try to use the **nc** command from inside the functest
652 Connection to opnfv.org 80 port [tcp/http] succeeded!
655 Connection to opnfv.org 443 port [tcp/https] succeeded!
657 Note: In a Jumphost node based on the CentOS family OS, the **nc**
658 commands might not work. You can use the **curl** command instead.
660 curl http://www.opnfv.org:80
662 <HTML><HEAD><meta http-equiv="content-type"
667 curl https://www.opnfv.org:443
669 <HTML><HEAD><meta http-equiv="content-type"
674 (Ignore the content. If command returns a valid HTML page, it proves
677 Docker Installation on CentOS behind http proxy
678 -----------------------------------------------
679 This section is applicable for CentOS family OS on Jumphost which
680 itself is behind a proxy server. In that case, the instructions below
681 should be followed **before** installing the docker engine::
683 1) # Make a directory '/etc/systemd/system/docker.service.d'
684 # if it does not exist
685 sudo mkdir /etc/systemd/system/docker.service.d
687 2) # Create a file called 'env.conf' in that directory with
688 # the following contents:
690 EnvironmentFile=-/etc/sysconfig/docker
692 3) # Set up a file called 'docker' in directory '/etc/sysconfig'
693 # with the following contents:
694 HTTP_PROXY="<Your http proxy settings>"
695 HTTPS_PROXY="<Your https proxy settings>"
696 http_proxy="${HTTP_PROXY}"
697 https_proxy="${HTTPS_PROXY}"
699 4) # Reload the daemon
700 systemctl daemon-reload
702 5) # Sanity check - check the following docker settings:
703 systemctl show docker | grep -i env
707 EnvironmentFile=/etc/sysconfig/docker (ignore_errors=yes)
708 DropInPaths=/etc/systemd/system/docker.service.d/env.conf
710 Now follow the instructions in [`Install Docker on CentOS`_] to download
711 and install the **docker-engine**. The instructions conclude with a
712 "test pull" of a sample "Hello World" docker container. This should now
713 work with the above pre-requisite actions.
716 .. _`[4]`: http://docs.opnfv.org/en/latest/submodules/functest/docs/testing/user/configguide/index.html
717 .. _`dockerdocs`: https://docs.docker.com/
718 .. _`Proxy`: https://docs.docker.com/engine/admin/systemd/#http-proxy
719 .. _`Install Docker on CentOS`: https://docs.docker.com/engine/installation/linux/centos/
720 .. _`Functest User Guide`: http://docs.opnfv.org/en/stable-danube/submodules/functest/docs/testing/user/userguide/index.html
721 .. _`images/CentOS-7-x86_64-GenericCloud.qcow2`: https://cloud.centos.org/centos/7/images/CentOS-7-x86_64-GenericCloud.qcow2
722 .. _`images/cirros-0.4.0-x86_64-disk.img`: http://download.cirros-cloud.net/0.4.0/cirros-0.4.0-x86_64-disk.img
723 .. _`images/ubuntu-14.04-server-cloudimg-amd64-disk1.img`: https://cloud-images.ubuntu.com/releases/14.04/release/ubuntu-14.04-server-cloudimg-amd64-disk1.img