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 --------------------------
45 See section on environment variables for details.
49 export OS_AUTH_URL=XXX
50 export OS_USER_DOMAIN_NAME=XXX
51 export OS_PROJECT_DOMAIN_NAME=XXX
52 export OS_USERNAME=XXX
53 export OS_TENANT_NAME=XXX
54 export OS_PROJECT_NAME=XXX
55 export OS_PASSWORD=XXX
56 export OS_VOLUME_API_VERSION=XXX
57 export OS_IDENTITY_API_VERSION=XXX
58 export OS_IMAGE_API_VERSION=XXX
60 See section on OpenStack credentials for details.
62 Create a directory for the different images (attached as a Docker volume)::
64 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/*
66 images/CentOS-7-aarch64-GenericCloud.qcow2
67 images/CentOS-7-aarch64-GenericCloud.qcow2.xz
68 images/CentOS-7-x86_64-GenericCloud.qcow2
69 images/cirros-0.4.0-x86_64-disk.img
70 images/cirros-0.4.0-x86_64-lxc.tar.gz
71 images/cirros-d161201-aarch64-disk.img
72 images/cirros-d161201-aarch64-initramfs
73 images/cirros-d161201-aarch64-kernel
74 images/cloudify-manager-premium-4.0.1.qcow2
76 images/trusty-server-cloudimg-amd64-disk1.img
77 images/ubuntu-14.04-server-cloudimg-amd64-disk1.img
78 images/ubuntu-14.04-server-cloudimg-arm64-uefi1.img
79 images/ubuntu-16.04-server-cloudimg-amd64-disk1.img
82 Testing healthcheck suite
83 --------------------------
85 Run healthcheck suite::
87 sudo docker run --env-file env \
88 -v $(pwd)/openstack.creds:/home/opnfv/functest/conf/env_file \
89 -v $(pwd)/images:/home/opnfv/functest/images \
90 opnfv/functest-healthcheck
92 Results shall be displayed as follows::
94 +----------------------------+------------------+---------------------+------------------+----------------+
95 | TEST CASE | PROJECT | TIER | DURATION | RESULT |
96 +----------------------------+------------------+---------------------+------------------+----------------+
97 | connection_check | functest | healthcheck | 00:06 | PASS |
98 | api_check | functest | healthcheck | 06:52 | PASS |
99 | snaps_health_check | functest | healthcheck | 00:42 | PASS |
100 +----------------------------+------------------+---------------------+------------------+----------------+
101 NOTE: the duration is a reference and it might vary depending on your SUT.
108 sudo docker run --env-file env \
109 -v $(pwd)/openstack.creds:/home/opnfv/functest/conf/env_file \
110 -v $(pwd)/images:/home/opnfv/functest/images \
113 Results shall be displayed as follows::
115 +------------------------------+------------------+---------------+------------------+----------------+
116 | TEST CASE | PROJECT | TIER | DURATION | RESULT |
117 +------------------------------+------------------+---------------+------------------+----------------+
118 | vping_ssh | functest | smoke | 00:45 | PASS |
119 | vping_userdata | functest | smoke | 00:36 | PASS |
120 | tempest_smoke_serial | functest | smoke | 14:04 | PASS |
121 | rally_sanity | functest | smoke | 23:59 | PASS |
122 | refstack_defcore | functest | smoke | 14:37 | FAIL |
123 | snaps_smoke | functest | smoke | 42:09 | PASS |
124 | odl | functest | smoke | 00:00 | SKIP |
125 | odl_netvirt | functest | smoke | 00:00 | SKIP |
126 +------------------------------+------------------+---------------+------------------+----------------+
127 Note: if the scenario does not support some tests, they are indicated as SKIP.
128 See User guide for details.
130 Testing features suite
131 ----------------------
135 sudo docker run --env-file env \
136 -v $(pwd)/openstack.creds:/home/opnfv/functest/conf/env_file \
137 -v $(pwd)/images:/home/opnfv/functest/images \
138 opnfv/functest-features
140 Results shall be displayed as follows::
142 +-----------------------------+------------------------+------------------+------------------+----------------+
143 | TEST CASE | PROJECT | TIER | DURATION | RESULT |
144 +-----------------------------+------------------------+------------------+------------------+----------------+
145 | doctor-notification | doctor | features | 00:00 | SKIP |
146 | bgpvpn | sdnvpn | features | 00:00 | SKIP |
147 | functest-odl-sfc | sfc | features | 00:00 | SKIP |
148 | barometercollectd | barometer | features | 00:00 | SKIP |
149 | fds | fastdatastacks | features | 00:00 | SKIP |
150 +-----------------------------+------------------------+------------------+------------------+----------------+
151 Note: if the scenario does not support some tests, they are indicated as SKIP.
152 See User guide for details.
154 Testing components suite
155 ------------------------
157 Run components suite::
159 sudo docker run --env-file env \
160 -v $(pwd)/openstack.creds:/home/opnfv/functest/conf/env_file \
161 -v $(pwd)/images:/home/opnfv/functest/images \
162 opnfv/functest-components
164 Results shall be displayed as follows::
166 +-------------------------------+------------------+--------------------+------------------+----------------+
167 | TEST CASE | PROJECT | TIER | DURATION | RESULT |
168 +-------------------------------+------------------+--------------------+------------------+----------------+
169 | tempest_full_parallel | functest | components | 52:42 | PASS |
170 | rally_full | functest | components | 114:22 | PASS |
171 +-------------------------------+------------------+--------------------+------------------+----------------+
178 sudo docker run --env-file env \
179 -v $(pwd)/openstack.creds:/home/opnfv/functest/conf/env_file \
180 -v $(pwd)/images:/home/opnfv/functest/images \
183 Results shall be displayed as follows::
185 +---------------------------------+-------------------+--------------+------------------+----------------+
186 | TEST CASE | PROJECT | TIER | DURATION | RESULT |
187 +---------------------------------+-------------------+--------------+------------------+----------------+
188 | cloudify_ims | functest | vnf | 28:49 | FAIL |
189 | vyos_vrouter | functest | vnf | 27:57 | FAIL |
190 | juju_epc | functest | vnf | 55:03 | PASS |
191 | orchestra_openims | orchestra | vnf | 00:00 | SKIP |
192 | orchestra_clearwaterims | orchestra | vnf | 00:00 | SKIP |
193 +---------------------------------+-------------------+--------------+------------------+----------------+
196 Environment variables
197 =====================
199 Several environement variables may be specified:
200 * INSTALLER_TYPE=(apex|compass|daisy|fuel|joid)
201 * INSTALLER_IP=<Specific IP Address>
202 * DEPLOY_SCENARIO=<vim>-<controller>-<nfv_feature>-<ha_mode>
205 INSTALLER IP may be required by some test cases like SFC or Barometer in order
206 to access the installer node and the deployment.
208 The format for the DEPLOY_SCENARIO env variable can be described as follows:
209 * vim: (os|k8s) = OpenStack or Kubernetes
210 * controller is one of ( nosdn | odl )
211 * nfv_feature is one or more of ( ovs | kvm | sfc | bgpvpn | nofeature )
212 * ha_mode (high availability) is one of ( ha | noha )
214 If several features are pertinent then use the underscore character '_' to
215 separate each feature (e.g. ovs_kvm). 'nofeature' indicates that no OPNFV
218 The list of supported scenarios per release/installer is indicated in the
221 **NOTE:** The scenario name is mainly used to automatically detect
222 if a test suite is runnable or not (e.g. it will prevent ODL test suite to be
223 run on 'nosdn' scenarios). If not set, Functest will try to run the default test
224 cases that might not include SDN controller or a specific feature
226 **NOTE:** An HA scenario means that 3 OpenStack controller nodes are
227 deployed. It does not necessarily mean that the whole system is HA. See
228 installer release notes for details.
230 Finally, three additional environment variables can also be passed in
231 to the Functest Docker Container, using the -e
232 "<EnvironmentVariable>=<Value>" mechanism. The first two parameters are
233 only relevant to Jenkins CI invoked testing and **should not be used**
234 when performing manual test scenarios:
236 * NODE_NAME = <Test POD Name>
237 * BUILD_TAG = <Jenkins Build Tag>
238 * CI_DEBUG = <DebugTraceValue>
242 * <Test POD Name> = Symbolic name of the POD where the tests are run.
243 Visible in test results files, which are stored
244 to the database. This option is only used when
245 tests are activated under Jenkins CI control.
246 It indicates the POD/hardware where the test has
247 been run. If not specified, then the POD name is
248 defined as "Unknown" by default.
249 DO NOT USE THIS OPTION IN MANUAL TEST SCENARIOS.
250 * <Jenkins Build tag> = Symbolic name of the Jenkins Build Job.
251 Visible in test results files, which are stored
252 to the database. This option is only set when
253 tests are activated under Jenkins CI control.
254 It enables the correlation of test results,
255 which are independently pushed to the results database
256 from different Jenkins jobs.
257 DO NOT USE THIS OPTION IN MANUAL TEST SCENARIOS.
258 * <DebugTraceValue> = "true" or "false"
259 Default = "false", if not specified
260 If "true" is specified, then additional debug trace
261 text can be sent to the test results file / log files
262 and also to the standard console output.
265 Openstack credentials
266 =====================
267 OpenStack credentials are mandatory and must be provided to Functest.
268 When running the command "functest env prepare", the framework will
269 automatically look for the Openstack credentials file
270 "/home/opnfv/functest/conf/env_file" and will exit with
271 error if it is not present or is empty.
273 There are 2 ways to provide that file:
275 * by using a Docker volume with -v option when creating the Docker container.
276 This is referred to in docker documentation as "Bind Mounting".
277 See the usage of this parameter in the following chapter.
278 * or creating manually the file '/home/opnfv/functest/conf/env_file'
279 inside the running container and pasting the credentials in it. Consult
280 your installer guide for further details. This is however not
281 instructed in this document.
283 In proxified environment you may need to change the credentials file.
284 There are some tips in chapter: `Proxy support`_
288 If you need to connect to a server that is TLS-enabled (the auth URL
289 begins with "https") and it uses a certificate from a private CA or a
290 self-signed certificate, then you will need to specify the path to an
291 appropriate CA certificate to use, to validate the server certificate
292 with the environment variable OS_CACERT::
295 /etc/ssl/certs/ca.crt
297 However, this certificate does not exist in the container by default.
298 It has to be copied manually from the OpenStack deployment. This can be
301 #. Create manually that file and copy the contents from the OpenStack
303 #. (Recommended) Add the file using a Docker volume when starting the
306 -v <path_to_your_cert_file>:/etc/ssl/certs/ca.cert
308 You might need to export OS_CACERT environment variable inside the
311 export OS_CACERT=/etc/ssl/certs/ca.crt
313 Certificate verification can be turned off using OS_INSECURE=true. For
314 example, Fuel uses self-signed cacerts by default, so an pre step would
317 export OS_INSECURE=true
319 Functest docker container directory structure
320 =============================================
321 Inside the Functest docker container, the following directory structure
322 should now be in place::
344 Underneath the '/home/opnfv/functest' directory, the Functest docker container
345 includes two main directories:
347 * The **conf** directory stores configuration files (e.g. the
348 OpenStack creds are stored in path '/home/opnfv/functest/conf/env_file'),
349 * the **results** directory stores some temporary result log files
351 src and repos directories are used to host third party code used for the tests.
353 The structure of functest repo can be described as follows::
370 | |-- thirdparty-requirements.txt
375 | | `-- release-notes
404 │ |-- check_deployment.py
405 │ |-- config_aarch64_patch.yaml
406 │ |-- config_functest.yaml
407 │ |-- config_patch.yaml
408 │ |-- download_images.sh
410 │ |-- rally_aarch64_patch.conf
412 │ |-- testcases.yaml
413 │ |-- tier_builder.py
414 │ |-- tier_handler.py
418 │ │ |-- cli_env.py
419 │ │ |-- cli_os.py
420 │ │ |-- cli_testcase.py
421 │ │ |-- cli_tier.py
422 │ |-- functest-complete.sh
425 │ |-- robotframework.py
434 │ |-- refstack_client
453 │ |-- test_utils.py
461 | |-- functest_utils.py
462 | |-- functest_vacation.py
463 | |-- openstack_clean.py
464 | |-- openstack_tacker.py
465 | `-- openstack_utils.py
469 |-- test-requirements.txt
471 |-- upper-constraints.txt
473 (Note: All *.pyc files removed from above list for brevity...)
475 We may distinguish several directories, the first level has 5 directories:
477 * **api**: This directory is dedicated to the API (framework) documentations.
478 * **commons**: This directory is dedicated for storage of traffic profile or
479 any other test inputs that could be reused by any test project.
480 * **docker**: This directory includes the needed files and tools to
481 build the Functest Docker images.
482 * **docs**: This directory includes documentation: Release Notes,
483 User Guide, Configuration Guide and Developer Guide.
484 * **functest**: This directory contains all the code needed to run
485 functest internal cases and OPNFV onboarded feature or VNF test cases.
487 Functest directory has 7 sub-directories, which is located under
488 /usr/lib/python2.7/site-packages/functest:
489 * **api**: This directory is dedicated for the internal Functest API.
490 * **ci**: This directory contains test structure definition files
491 (e.g <filename>.yaml) and bash shell/python scripts used to
492 configure and execute Functional tests. The test execution script
493 can be executed under the control of Jenkins CI jobs.
494 * **cli**: This directory holds the python based Functest CLI utility
495 source code, which is based on the Python 'click' framework.
496 * **core**: This directory holds the python based Functest core
497 source code. Three abstraction classes have been created to ease
498 the integration of internal, feature or vnf cases.
499 * **opnfv_tests**: This directory includes the scripts required by
500 Functest internal test cases and other feature projects test cases.
501 * **tests**: This directory includes the functest unit tests.
502 * **utils**: this directory holds Python source code for some general
503 purpose helper utilities, which testers can also re-use in their
504 own test code. See for an example the Openstack helper utility:
505 'openstack_utils.py'.
510 By default all the logs are put un /home/opnfv/functest/results/functest.log.
511 If you want to have more logs in console, you may edit the logging.ini file
513 Connect on the docker then edit the file located in
514 /usr/lib/python2.7/site-packages/functest/ci/logging.ini
516 Change wconsole to console in the desired module to get more traces.
522 You may also directly modify the python code or the configuration file (e.g.
523 testcases.yaml used to declare test constraints) under
524 /usr/lib/python2.7/site-packages/functest
532 When typing **exit** in the container prompt, this will cause exiting
533 the container and probably stopping it. When stopping a running Docker
534 container all the changes will be lost, there is a keyboard shortcut
535 to quit the container without stopping it: <CTRL>-P + <CTRL>-Q. To
536 reconnect to the running container **DO NOT** use the *run* command
537 again (since it will create a new container), use the *exec* or *attach*
540 docker ps # <check the container ID from the output>
541 docker exec -ti <CONTAINER_ID> /bin/bash
543 There are other useful Docker commands that might be needed to manage possible
544 issues with the containers.
546 List the running containers::
550 List all the containers including the stopped ones::
554 Start a stopped container named "FunTest"::
558 Attach to a running container named "StrikeTwo"::
560 docker attach StrikeTwo
562 It is useful sometimes to remove a container if there are some problems::
564 docker rm <CONTAINER_ID>
566 Use the *-f* option if the container is still running, it will force to
569 docker rm -f <CONTAINER_ID>
571 Check the Docker documentation [`dockerdocs`_] for more information.
574 Checking Openstack and credentials
575 ----------------------------------
576 It is recommended and fairly straightforward to check that Openstack
577 and credentials are working as expected.
579 Once the credentials are there inside the container, they should be
580 sourced before running any Openstack commands::
582 source /home/opnfv/functest/conf/env_file
584 After this, try to run any OpenStack command to see if you get any
585 output, for instance::
589 This will return a list of the actual users in the OpenStack
590 deployment. In any other case, check that the credentials are sourced::
594 This command must show a set of environment variables starting with
597 OS_REGION_NAME=RegionOne
598 OS_USER_DOMAIN_NAME=Default
599 OS_PROJECT_NAME=admin
601 OS_IDENTITY_API_VERSION=3
602 OS_PASSWORD=da54c27ae0d10dfae5297e6f0d6be54ebdb9f58d0f9dfc
603 OS_AUTH_URL=http://10.1.0.9:5000/v3
606 OS_ENDPOINT_TYPE=internalURL
607 OS_INTERFACE=internalURL
609 OS_PROJECT_DOMAIN_NAME=Default
612 If the OpenStack command still does not show anything or complains
613 about connectivity issues, it could be due to an incorrect url given to
614 the OS_AUTH_URL environment variable. Check the deployment settings.
618 If your Jumphost node is operating behind a http proxy, then there are
619 2 places where some special actions may be needed to make operations
622 #. Initial installation of docker engine First, try following the
623 official Docker documentation for Proxy settings. Some issues were
624 experienced on CentOS 7 based Jumphost. Some tips are documented
625 in section: `Docker Installation on CentOS behind http proxy`_
628 If that is the case, make sure the resolv.conf and the needed
629 http_proxy and https_proxy environment variables, as well as the
630 'no_proxy' environment variable are set correctly::
632 # Make double sure that the 'no_proxy=...' line in the
633 # 'env_file' file is commented out first. Otherwise, the
634 # values set into the 'no_proxy' environment variable below will
635 # be ovewrwritten, each time the command
636 # 'source ~/functest/conf/env_file' is issued.
639 sed -i 's/export no_proxy/#export no_proxy/' env_file
642 # Next calculate some IP addresses for which http_proxy
643 # usage should be excluded:
645 publicURL_IP=$(echo $OS_AUTH_URL | grep -Eo "([0-9]+\.){3}[0-9]+")
647 adminURL_IP=$(openstack catalog show identity | \
648 grep adminURL | grep -Eo "([0-9]+\.){3}[0-9]+")
650 export http_proxy="<your http proxy settings>"
651 export https_proxy="<your https proxy settings>"
652 export no_proxy="127.0.0.1,localhost,$publicURL_IP,$adminURL_IP"
654 # Ensure that "git" uses the http_proxy
655 # This may be needed if your firewall forbids SSL based git fetch
656 git config --global http.sslVerify True
657 git config --global http.proxy <Your http proxy settings>
659 For example, try to use the **nc** command from inside the functest
663 Connection to opnfv.org 80 port [tcp/http] succeeded!
666 Connection to opnfv.org 443 port [tcp/https] succeeded!
668 Note: In a Jumphost node based on the CentOS family OS, the **nc**
669 commands might not work. You can use the **curl** command instead.
671 curl http://www.opnfv.org:80
673 <HTML><HEAD><meta http-equiv="content-type"
678 curl https://www.opnfv.org:443
680 <HTML><HEAD><meta http-equiv="content-type"
685 (Ignore the content. If command returns a valid HTML page, it proves
688 Docker Installation on CentOS behind http proxy
689 -----------------------------------------------
690 This section is applicable for CentOS family OS on Jumphost which
691 itself is behind a proxy server. In that case, the instructions below
692 should be followed **before** installing the docker engine::
694 1) # Make a directory '/etc/systemd/system/docker.service.d'
695 # if it does not exist
696 sudo mkdir /etc/systemd/system/docker.service.d
698 2) # Create a file called 'env.conf' in that directory with
699 # the following contents:
701 EnvironmentFile=-/etc/sysconfig/docker
703 3) # Set up a file called 'docker' in directory '/etc/sysconfig'
704 # with the following contents:
705 HTTP_PROXY="<Your http proxy settings>"
706 HTTPS_PROXY="<Your https proxy settings>"
707 http_proxy="${HTTP_PROXY}"
708 https_proxy="${HTTPS_PROXY}"
710 4) # Reload the daemon
711 systemctl daemon-reload
713 5) # Sanity check - check the following docker settings:
714 systemctl show docker | grep -i env
718 EnvironmentFile=/etc/sysconfig/docker (ignore_errors=yes)
719 DropInPaths=/etc/systemd/system/docker.service.d/env.conf
721 Now follow the instructions in [`Install Docker on CentOS`_] to download
722 and install the **docker-engine**. The instructions conclude with a
723 "test pull" of a sample "Hello World" docker container. This should now
724 work with the above pre-requisite actions.
727 .. _`[4]`: http://docs.opnfv.org/en/latest/submodules/functest/docs/testing/user/configguide/index.html
728 .. _`dockerdocs`: https://docs.docker.com/
729 .. _`Proxy`: https://docs.docker.com/engine/admin/systemd/#http-proxy
730 .. _`Install Docker on CentOS`: https://docs.docker.com/engine/installation/linux/centos/
731 .. _`Functest User Guide`: http://docs.opnfv.org/en/stable-danube/submodules/functest/docs/testing/user/userguide/index.html
732 .. _`images/CentOS-7-x86_64-GenericCloud.qcow2`: https://cloud.centos.org/centos/7/images/CentOS-7-x86_64-GenericCloud.qcow2
733 .. _`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
734 .. _`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