diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/configguide/index.rst | 374 | ||||
| -rw-r--r-- | docs/functest.rst | 663 | ||||
| -rw-r--r-- | docs/images/clearwater-architecture.png | bin | 0 -> 263292 bytes | |||
| -rw-r--r-- | docs/images/functestODL.png | bin | 0 -> 71828 bytes | |||
| -rw-r--r-- | docs/images/functestRally1.png | bin | 0 -> 50132 bytes | |||
| -rw-r--r-- | docs/images/functestRally2.png | bin | 0 -> 26652 bytes | |||
| -rw-r--r-- | docs/userguide/index.rst | 540 |
7 files changed, 1398 insertions, 179 deletions
diff --git a/docs/configguide/index.rst b/docs/configguide/index.rst new file mode 100644 index 00000000..85954e77 --- /dev/null +++ b/docs/configguide/index.rst @@ -0,0 +1,374 @@ +*********************************************** +OPNFV FUNCTEST configuration/installation guide +*********************************************** + +.. toctree:: + :numbered: + :maxdepth: 2 + +============ +Introduction +============ + +** DOCUMENT IS IN PROGRESS FOR BRAHMAPUTRA ** + +This document describes how to install and configure Functest in OPNFV. + +============= +Prerequisites +============= + +The installation of the OPNFV solution is out of scope of this document but can be found in XXX. +In the rest of the document the OPNFV solution would be considered as the System Under Test (SUT). + +Several prerequisites are needed for functest: + 1) docker must be installed on the Jumphost + 2) a connectivity from the jumphost to the SUT management network is needed + 3) an external network must be configured + +Docker installation +=================== + +.. _Ubuntu: https://docs.docker.com/installation/ubuntulinux/ +.. _RHEL: https://docs.docker.com/installation/rhel/ + +Log on your jumphost then install docker (e.g. for Ubuntu):: + + curl -sSL https://get.docker.com/ | sh + +Add your user to docker group to be able to run commands without sudo:: + + sudo usermod -aG docker <your_user> + + +References: + * Ubuntu_ + * RHEL_ + +Connectivy to OPNFV management network +====================================== + +Some of the Functest tools need to have access to the OpenStack management network of the controllers `[1]`_. + +For this reason and besides the public network, you need to configure an interface on the management network as well in your jumphost (or wherever you want to deploy the Functest docker to run the tests). + +Example:: + + The OPNFV Fuel installation uses VLAN tagged 300 and subnet 192.168.1.0/24 as Openstack Management network. + Supposing that eth1 is the physical interface with access to that subnet: + $ ip link add name eth1.300 link eth1 type vlan id 300 + $ ip link set eth1.300 up + $ ip addr add 192.168.1.66/24 dev eth1.300 + + +External network on SUT +======================= + +Some of the tests on VIM need an external network. You may perform functest without an external network but some of the tests will fail. +A default floating ip pool must be configured in nova.conf. + + + +======================= +High level architecture +======================= + +The high level architecture of Functest within OPNFV can be described as follow:: + + CIMC/Lights+out management Admin Private Public Storage + PXE + + + + + IP_PRIV/24 | | + | | + + | + | | | IP_PUB/24 | + | +--------------------------+ | | + | + | | | | | | | + +-----+ Jumphost | | | | | + | | +--------------------+ | | | + | | | | | | | + | | +------------------+ | | | | | + | | | | | | | | | + | | | Tools | +------------------------------+ | | + | | | - Rally | | | | | | + | | | - Robot | | | | | | + | | | - TestON | | | | | | + | | | | | | | | | + | | | Testcases | | | | | | + | | | - VIM | | | | | | + | | | -- vPing | | | | | | + | | | -- Tempest | | | | | | + | | | -- Rally | | | | | | + | | | - Controller | | | | | | + | | | -- odl | | | | | | + | | | -- onos | | | | | | + | | | -- opencontrail | | | | | | + | | | | | | | | | + | | | Features | | | | | | + | | | - vIMS | | | | | | + | | | | | | | | | + | | +------------------+ | | | | | + | | +----------------------------------------+ | + | | Functest Docker | | | | | + | | +-------------------------------------------------+ + | | | | | | | + | +--------------------------+ | | | | + | | | | | + | +----------------+ | | | | + | | 1 | | | | | + +----+ +--------------+-+ | | | | + | | | 2 | | | | | + | | | +--------------+-+ | | | | + | | | | 3 | | | | | + | | | | +--------------+-+ | | | | + | | | | | 4 | | | | | + | +-+ | | +--------------+-+ | | | | + | | | | | 5 +-----------------------+ | | | + | +-+ | | nodes for | | | | | + | | | | deploying +---------------------------------+ | | + | +-+ | opnfv | | | | | + | | | SUT +-------------------------------------------+ | + | +-+ | | | | | + | | +----------------------------------------------------+ + | +----------------+ | | | | + | | | | | + | + + + + + +All the components needed by Functest are in the docker file. +Thanks to docker, there is no more library issues. + +This docker file will: + * prepare the environment for functional testing + * retrieve SUT credentials + * perform the tests + * push the results into the OPNFV test result database + +This docker file can be integrated into CI or deployed independantly of the CI. +A description of the Brahmaputra testcases can be retrieved in the Functest user guide `[2]`_ + +Please note that the Functest container has been designed for OPNFV, however, it would be possible to adapt it to any VIM+controller environment as most of the testcases are upstream testcases. + +=================== +Manual Installation +=================== + +Pull the Functest Docker image from the hub:: + + $ docker pull opnfv/functest + +Check that the image is available:: + + $ docker images + +Run the docker container giving the environment variables + - INSTALLER_TYPE. Possible values are "apex", "compass", "fuel", "joid" or "foreman" (Arno). + - INSTALLER_IP. each installer has its installation strategy. Functest may need to know the IP of the installer to retrieve the credentials (e.g. usually "10.20.0.2" for fuel, not neede for joid, "172.30.10.73" foreman...) + +The minimum command to create the Functest docker file can be described as follow:: + + docker run -it -e "INSTALLER_IP=10.20.0.2" -e "INSTALLER_TYPE=fuel" opnfv/functest:latest_stable /bin/bash + +Optionnaly, it is possible to precise the container name through the option --name:: + + docker run --name "CONTAINER_NAME" -it -e "INSTALLER_IP=10.20.0.2" -e "INSTALLER_TYPE=fuel" opnfv/functest:latest_stable /bin/bash + +It is also possible to to indicate the path of the OpenStack creds using -v:: + + docker run -it -e "INSTALLER_IP=10.20.0.2" -e "INSTALLER_TYPE=fuel" -v <path_to_your_local_creds_file>:/home/opnfv/functest/conf/openstack.creds opnfv/functest:latest_stable /bin/bash + +Your local file will be paste within the container under /home/opnfv/functest/conf/openstack.creds and used by the different test suites. + +Once run you shall be inside the docker container and ready to run Functest. + +Inside the container, you must have the following arborescence:: + + `-- home + `-- opnfv + |-- functest + | |-- conf + | |-- data + | `-- results + `-- repos + |-- bgpvpn + |-- functest + |-- odl_integration + |-- rally + |-- releng + `-- vims-test + + +Basically the container includes: + + * Functest directory to store the configuration (the OpenStack creds are paste in /home/opngb/functest/conf), the data (images neede for test for offline testing), results (some temporary artifacts may be stored here) + * Repositories: the functest repository will be used to prepare the environement, run the tests. Other repositories are used for the installation of the tooling (e.g. rally) and/or the retrieval of feature projects scenarios (e.g. bgpvpn) + +The arborescence under the functest repo can be described as follow:: + + . + |-- INFO + |-- LICENSE + |-- commons + | |-- ims + | |-- mobile + | `-- traffic-profile-guidelines.rst + |-- docker + | |-- Dockerfile + | |-- common.sh + | |-- prepare_env.sh + | |-- requirements.pip + | `-- run_tests.sh + |-- docs + | |-- configguide + | |-- functest.rst + | |-- images + | `-- userguide + `-- testcases + |-- Controllers + |-- VIM + |-- __init__.py + |-- config_functest.py + |-- config_functest.yaml + |-- functest_utils.py + |-- functest_utils.pyc + |-- vIMS + `-- vPing + +We may distinguish 4 different folders: + + * commons: it is a folder dedicated to store traffic profile or any test inputs that could be reused by any test project + * docker: this folder includes the scripts that will be used to setup the environment and run the tests + * docs: this folder includes the user and installation/configuration guide + * testcases: this folder includes the scripts required by Functest internal test cases + + +Firstly run the script to install functest environment:: + + $ ${repos_dir}/functest/docker/prepare_env.sh + +NOTE: ${repos_dir} is a default environment variable inside the docker container, which points to /home/opnfv/repos + +Run the script to start the tests:: + + $ ${repos_dir}/functest/docker/run_tests.sh + +NOTE: This will run ALL the tests by default, see `[2]`_ for details + +Focus on the OpenStack credentials +================================== + +The OpenStack creds are needed to test the VIM. They can be retrieved in several ways: + * using the -v option when creating + * sourcing them manually once connected on the docker, once log perform a source <openstack_creds> + * automatically retrieved via a script (CI) + +If not source you will get an error during the test environnement preparation. + +Additional Options +================== + +In case you need to provide different configuration parameters to Functest (e.g. commit IDs or branches for the repositories, …) copy the config_functest.yaml from the repository to your current directory and run docker with a volume:: + + $ wget https://git.opnfv.org/cgit/functest/plain/testcases/config_functest.yaml + $ cmd1 = "/home/opnfv/repos/functest/docker/prepare_env.sh" + $ cmd2 = "/home/opnfv/repos/functest/docker/run_tests.sh" + $ docker run -t -e "INSTALLER_TYPE=fuel" -e "INSTALLER_IP=10.20.0.2" opnfv/functest \ + -v $(pwd)/config_functest.yaml:/home/opnfv/functest/conf/config_functest.yaml \ + "${cmd1} && ${cmd2}" + +================= +Integration in CI +================= +In CI we use the docker file and execute commande 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 + + +============= +Configuration +============= + +Everything is preconfigured in the docker file. So except the credentials, there is no specific configuration needed. it is possible to customize the list of tests, see `[2]` for details. + +====== +Errors +====== + + + + + +========== +References +========== +.. _`[1]`: https://ask.openstack.org/en/question/68144/keystone-unable-to-use-the-public-endpoint/ +.. _`[2]`: url functest user guide +.. _`[3]`: https://git.opnfv.org/cgit/releng/tree/jjb/functest/functest-ci-jobs.yml + + +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 diff --git a/docs/functest.rst b/docs/functest.rst index de4c537c..ed436f58 100644 --- a/docs/functest.rst +++ b/docs/functest.rst @@ -2,15 +2,21 @@ OPNFV functional test guide =========================== +.. contents:: + +------------ +Introduction +------------ + Testing is a key challenge of OPNFV. It shall be possible to run functional tests on any OPNFV solution. The goal of this document consists in -* a description of functional tests for OPNFV -* a description of the tools needed to perform these tests -* the procedure to configure the tools and the scenarios associated with these tests + * a description of functional tests for OPNFV + * a description of the tools needed to perform these tests + * the procedure to configure the tools and the scenarios associated with these tests -Functional tests shall be automated and collected results shall be used to improve the robustness and the reliability of the overall system. +Functional tests shall be automated (as much as possible) and collected results shall be used to improve the robustness and the reliability of the overall system. Function tests may cover any domain that could lead to improve the OPNFV solution and define "Telco Cloud" KPI. @@ -30,47 +36,66 @@ ETSI NFV defined 9 use cases (ref ETSI_): * Virtualization of the Home environment .. _`Openstack Telco Working Group`: https://wiki.openstack.org/wiki/TelcoWorkingGroup +.. _`functest guide`: https://wiki.opnfv.org/_media/opnfv-_functest.pdf + Most of the use cases are also discussed in upstream projects (e.g. `Openstack Telco Working Group`_ ) -For release 1 (Arno), 5 test suites have been selected: +For release 1 (Arno), 4 test suites have been selected: * Rally Bench test suite for Openstack * Openstack Tempest test suite * OpenDaylight test suite * vPing - * vIMS The 3 first suites are directly inherited from upstream projects. -vPing, that is already present in Tempest suite, has been developped to provided a basic "hellow world" functional test example. +vPing, that is already present in Tempest suite, has been developped to provided a basic "hello world" functional test example. .. _`Continuous Integration`: https://build.opnfv.org/ci/view/functest/ -vEPC, vPE, vHGW, vCDN use cases are not considered for first release. +vIMS, vEPC, vPE, vHGW, vCDN, vWhatever use cases are not considered for first release. It does not mean that such use cases cannot be tested on OPNFV Arno. -It means that these use cases have not been integrated in the `Continuous Integration`_ and no specific work (integration or developpment) have been done for R1. +It means that these testcases have not been integrated in the `Continuous Integration`_ and no specific work (integration or developpment) have been done for the first release. +We may expect that new VNFs and new scenarios will be created and integrated in the future releases. See `functest guide`_ for details. .. _prereqs: ------------- Prerequisites ------------- -We assume that an OPNFV solution has been installed. +We assume that an OPNFV Arno solution has been installed. -.. _here: TBC +.. _here: https://wiki.opnfv.org/documentation/Arno The installation of the OPNFV solution is out of scope of this document but can be found [here_]. In the rest of the document the OPNFV solution would be considered as the System Under Test (SUT). The installation and configuration of the tools needed to perform the tests will be described in the following sections. -For release 1, the tools are not automatically installed. +For Arno SR1, the tools are automatically installed. Manual sourcing of OpenStack credentials is no more required if you are fully integrated in the continuous integration. +A script has been added to automatically retrieve the credentials. +However, if you still install manually functest, you will need to source the rc file on the machine you are running the tests. +More details will be provided in the configuration section. .. _pharos: https://wiki.opnfv.org/pharos It is recommended to install the different tools on the jump host server as defined in the pharos_ project. -The high level architecture can be described as follow: -code:: +For functest, the following libraries are needed. You can install them either with yum install or apt-get install, depending on your operating system: + * python-pip + * python-dev + * libffi-dev + * libxml2-dev + * libxslt1-dev + +You will also need some Python modules: + * sudo pip install GitPython + * sudo pip install python-novaclient + * sudo pip install python-neutronclient + * sudo pip install python-glanceclient + * sudo pip install python-keystoneclient + + +The high level architecture can be described as follow:: CIMC/Lights+out management Admin Private Public Storage PXE @@ -90,9 +115,9 @@ code:: | | | | | | | | | | | | vPing | | | | | | | | | | | | | | | - | | | vIMS | | | | | | + | | | Tempest | | | | | | | | +----------+ | | | | | - | | FuncTests +-----------------------------------------+ | + | | FuncTest +-----------------------------------------+ | | | | | | | | | | +--------------------------------------------------+ | | | | | | | @@ -124,54 +149,15 @@ code:: Description of the test cases ----------------------------- -Rally bench test suite -====================== - -.. _Rally: https://wiki.openstack.org/wiki/Rally - -The OPNFV scenarios are based on the collection of Rally_ default scenarios: - * authenticate - * cinder - * nova - * vm - * glance - * keystone - * neutron - * quotas - -The goal of this test suite is to test the different modules of OpenStack and get significant figures that could help us to define telco Cloud KPI. - -This test suite provides performance information on VIM (OpenStack) part. - -No SLA were defined for release 1, we just consider whether the tests are passed or failed. - -In the future SLA shall be considered (e.g. accepting booting time for a given image with a given flavour). - -Through its integration in Continuous Integration, the evolution of the performance of these tests shall also be considered. - -Tempest -======= - -.. _Tempest: http://docs.openstack.org/developer/tempest/overview.html - -Tempest_ is the OpenStack Integration Test Suite. We use Rally to run Tempest suite. - -The goal of this test is to check the OpenStack installation (sanity checks). - - -OpenDaylight -============ - vPing ===== -The goal of this test can be described as follow: - -code:: +The goal of this test can be described as follow:: vPing testcase +-------------+ +-------------+ | | | | + | | | | | | Boot VM1 | | | +------------------>| | | | | | @@ -180,47 +166,109 @@ code:: | Tester | | System | | | Boot VM2 | Under | | +------------------>| Test | - | | Including Ping | | - | |at the end of boot | | + | | VM2 pings VM1 | | | | | | + | | Check console log | | + | | If ping: | | + | | exit OK | | + | | else (timeout) | | + | | exit KO | | | | | | - | | Check console | | - | | Grep Ping | | - | +------------------>| | | | | | +-------------+ +-------------+ -The vPing test case is already present in Tempest suite. +This example, using OpenStack Python clients can be considered as an "Hello World" example and may be modified for future use. + +In SR1, some code has been added in order to push the results (status and duration) into a centralized test result database. + +OpenDaylight +============ + +The ODL suite consists in a set of basic tests inherited from ODL project. The suite tests the creation and deletion of network, subnet, port though OpenDaylight and Neutron. + +The list of tests can be described as follow: + * Restconf.basic: Get the controller modules via Restconf + * Neutron.Networks + + * Check OpenStack Networks :: Checking OpenStack Neutron for known networks + * Check OpenDaylight Networks :: Checking OpenDaylight Neutron API + * Create Network :: Create new network in OpenStack + * Check Network :: Check Network created in OpenDaylight + * Neutron.Networks :: Checking Network created in OpenStack are pushed + + * Neutron.Subnets + + * Check OpenStack Subnets :: Checking OpenStack Neutron for known Subnets + * Check OpenDaylight subnets :: Checking OpenDaylight Neutron API + * Create New subnet :: Create new subnet in OpenStack + * Check New subnet :: Check new subnet created in OpenDaylight + * Neutron.Subnets :: Checking Subnets created in OpenStack are pushed + + * Neutron.Ports + + * Check OpenStack ports :: Checking OpenStack Neutron for known ports + * Check OpenDaylight ports :: Checking OpenDaylight Neutron API + * Create New Port :: Create new port in OpenStack + * Check New Port :: Check new subnet created in OpenDaylight + * Neutron.Ports :: Checking Port created in OpenStack are pushed + + * Delete Ports + + * Delete previously created subnet in OpenStack + * Check subnet deleted in OpenDaylight + * Check subnet deleted in OpenStack + + * Delete network + + * Delete previously created network in OpenStack + * Check network deleted in OpenDaylight + * Check network deleted in OpenStack + + * + + +Rally bench test suite +====================== + +.. _Rally: https://wiki.openstack.org/wiki/Rally + +Rally bench test suite consist in a suite of light performance tests on some of the OpenStack components. + +The goal of this test suite is to test the different modules of OpenStack and get significant figures that could help us to define telco Cloud KPI. + +The OPNFV scenarios are based on the collection of the existing Rally_ scenarios: + * authenticate + * cinder + * nova + * requests + * glance + * keystone + * neutron + * quotas + -This example, using OpenStack python clients can be considered as an "hellow World" example and may be modified for future use. +This test suite provides performance information on VIM (OpenStack) part. +No SLA were defined for release 1, we just consider whether the tests are passed or failed. -vIMS -==== +In the future SLA shall be defined (e.g. accepting booting time for a given image with a given flavour). -vIMS is one of the testcases defined by ETSI. +Through its integration in Continuous Integration, the evolution of the performance of these tests shall also be considered. -.. figure:: images/Ims_overview.png - :scale: 50 - :alt: IMS (src wikipedia) +Tempest +======= -the goal of this test consists in deploying a virtualized IP Multimedia Subsystem (vIMS) on OPNFV, configuring it to deliver services to a set of emulated SIP endpoints, deploying a virtualized test system that implements those emulated SIP endpoints, and performing a series of simple functional tests on the vIMS, including the ability to establish SIP sessions between emulated endpoints. +.. _Tempest: http://docs.openstack.org/developer/tempest/overview.html -This functional test will verify that - * The OpenStack Nova API can be called to instantiate a set of VMs that together comprise a vIMS network function - * The OpenStack Glance service is capable of serving up the required images - * The virtual networking component of the platform can provide working IP connectivity between and among the VMs - * The platform as a whole is capable of supporting the running of a real virtualized network function that delivers a typical service offered by a network operator, i.e. voice telephony +Tempest_ is the OpenStack Integration Test Suite. We use Rally to run Tempest suite. -Functional testing of vIMS in OPNFV Release 1 will be limited to a basic, non-scalable and non-fault-tolerant deployment of IMS. -Furthermore, in this release the vIMS will perform only control plane functions (i.e. processing of SIP signaling messages) and will not be passing RTP media streams. +The Tempest.conf configuration file is automatically generated by Rally then the Tempest suite is run, each test duration is measured. -In future releases, the same software elements can be deployed with multiple instances of each VNF component to provide a fault tolerant and dynamically scalable deployment of IMS. With the addition of virtualized Session Border Controller software elements, the scope of vIMS functional testing can be further expanded to include the handling of RTP media. +We considered the smoke test suite for Arno. -.. _clearwater: http://www.projectclearwater.org/ +The goal of this test is to to check the basic OpenStack functionality on a fresh installation. -The vIMS core function is based on the clearwater_ open source solution. .. _tooling_installation: @@ -229,26 +277,169 @@ The vIMS core function is based on the clearwater_ open source solution. Tooling installation ---------------------- -2 external tools are needed for the R1 functional tests: +.. _fetch_os_creds.sh: https://git.opnfv.org/cgit/releng/tree/utils/fetch_os_creds.sh + +2 external tools are needed for the functional tests on Arno: * Rally * Robot - -Rally -===== - -.. _`Rally installation procedure`: https://rally.readthedocs.org/en/latest/tutorial/step_0_installation.html - -.. _`OpenRC`: http://docs.openstack.org/user-guide/common/cli_set_environment_variables_using_openstack_rc.html - -The Rally creation can be describe as follow (ref: `Rally installation procedure`_): - * Create or enter a folder where you want to check out the tool repos. - * $ git clone https://git.openstack.org/openstack/rally - * $ ./rally/install_rally.sh - * configure your `OpenRC`_ file to let Rally access to your OpenStack, you can either export it from Horizon or build it manually (OpenStack credentials are required) - * $ source Your_OpenRC_file - * $ rally deployment create --fromenv --name=my-opnfv-test - * $ rally-manage tempest install +Rally is used for benchmarking and running Tempest. Robot is used for running OpenDaylight test suites. + +A script (config_test.py) has been created to simplify as much as possible the installation of the different suites of tests. + +This script config_test.py_ is hosted in OPNFV repository and uses the configuration file config_functest.yaml_:: + + usage: config_functest.py [-h] [-d] [-f] path action + + positional arguments: + repo_path path to the repository + action Possible actions are: 'start|check|clean' + + optional arguments: + -h, --help show this help message and exit + -d, --debug Debug mode + -f, --force used to avoid prompting the user for confirmation when cleaning functest environment. + +Actions + * start: will prepare the functional testing environment + * check: will check the configuration (scenarios available, environment variables properly set, networks,..) + * clean: will clean the functional test environement if existing + +This script will: + * Install Rally environment + * Install Robot environment + * Install Tempest + * Retrieve test scenarios + * Create temporary neutron private network (if needed) + * Create Glance images + + +When integrated in CI, there are no additional prerequisites. +When running functest manually, the only prerequisite consists in retrieving the OpenStack credentials (rc file). +This file shall be saved on the jumphost. It must be sourced by the user (who shall have sudo rights) executing the tests. + +For the Continuous Integration we store this file under $HOME/functest/opnfv-openrc.sh on the jumphost server so CI can automatically execute the suite of tests + +The procedure to set up functional testing environment can be described as follow: + +Log on the Jumphost server. Be sure you are no root then execute:: + + [user@jumphost]$ mkdir <Your_functest_directory> + [user@jumphost]$ cd <Your_functest_directory> + [user@jumphost]$ git clone https://git.opnfv.org/functest + [user@jumphost]$ cd testcases/ + +Modify and adapt needed parameters in the config_functest.yaml. Follow the instructions below. + +Retrieve OpenStack source file (configure your `OpenRC`_ file to let Rally access to your OpenStack, you can either export it from Horizon or build it manually (OpenStack credentials are required):: + + [user@jumphost]$ source Your_OpenRC_file + [user@jumphost]$ python <functest_repo_directory>/config_functest.py -d <Your_functest_directory> start + +In SR1, a script has been created: fetch_os_creds.sh_. This script retrieves automatically the credentials of your OpenStack solution. You may run it manually:: + + [user@jumphost]$ /home/jenkins-ci/functest/fetch_os_creds.sh -d <destination> -i <installer_type> -a <installer_ip> + +with + * installer_type = fuel or foreman + * installer_ip the IP of your installer + * the destination shall be the full path including the file name. + +Examples:: + + [user@jumphost]$./fetch_os_creds.sh -d ./credentials -i foreman -a 172.30.10.73 + [user@jumphost]$./fetch_os_creds.sh -d ./credentials -i fuel -a 10.20.0.2 + + +At the end of the git clone, the tree of <functest_repo_directory> will have the following structure:: + + |-- docs/ + | |-- functest.rst + | |-- images + | |-- Ims_overview.png + |-- INFO + |-- LICENSE + |-- testcases/ + |-- config_functest.py + |-- config_functest.yaml + |-- functest_utils.py + |-- Controllers/ + | |-- ODL/ + | |-- CI/ + | | |-- create_venv.sh + | | |-- custom_tests/ + | | | |-- neutron + | | |-- integration/ + | | | |-- distributions + | | | |-- features + | | | |-- feature-selector + | | | |-- packaging + | | | |-- pom.xml + | | | |-- test + | | | |-- vm + | | |-- logs + | | |-- requirements.pip + | | |-- start_tests.sh + | | |-- test_list.txt + | |-- ODL.md + |-- functest_utils.py + |-- VIM/ + | |-- OpenStack/ + | |-- CI/ + | | |-- libraries/ + | | | |-- run_rally.py + | | |-- suites/ + | | |-- opnfv-authenticate.json + | | |-- opnfv-cinder.json + | | |-- opnfv-glance.json + | | |-- opnfv-heat.json + | | |-- opnfv-keystone.json + | | |-- opnfv-neutron.json + | | |-- opnfv-nova.json + | | |-- opnfv-quotas.json + | | |-- opnfv-requests.json + | | |-- opnfv-smoke-green.json + | | |-- opnfv-smoke.json + | | |-- opnfv-tempest.json + | | |-- opnfv-vm.json + | |-- OpenStack.md + |-- vPing/ + |-- CI/ + |-- libraries/ + |-- vPing.py + + +NOTE: the Rally environment will be installed under ~/.rally/ the default Tempest configuration (automatically generated by Rally based on OpenStack credentials) can be found under .rally/tempest/for-deployment-<deployment_id>/tempest.conf + + +Configuration of config_functest.yaml +===================================== + +Do not change the directories structure: + + * image_name: name of the image that will be created in Glance + * image_url: URL of the image to be downloaded + * image_disk_format: glance image disk format (raw, qcow2, ...) + + * neutron_private_net_name: name of an OpenStack private network. If not existing, it will be created + * neutron_private_subnet_name: private subnet network to be created if not existing + * neutron_private_subnet_cidr: range of the private subnet. + * neutron_private_subnet_start: start IP + * neutron_private_subnet_end: end IP + * neutron_router_name: name of the router between the private and the public networks + + * ping_timeout: time out of the vPing test case + * vm_flavor: name of the flavor used to create the VMs + * vm_name_1: name of the first VM + * vm_name_2: name of the second VM + * ip_1: IP of the first VM (matching the private subnet cidr) + * ip_2: IP of the second VM + + +Please note that you need to install this environment only once. +As long as the credentials of the System Under Test do not change, there is no reason to modify the testing environment. + +If you need more details on Rally installation, see `Rally installation procedure`_. You can check if the configuration of rally is fine by typing 'rally deployment check', you shall see the list of available services as follow:: @@ -272,7 +463,6 @@ You can check if the configuration of rally is fine by typing 'rally deployment | UUID | Name | Size (B) | +--------------------------------------+----------------------------------------------+------------+ | 0a15951f-6388-4d5d-8531-79e7205eb140 | cirros_2015_04_10_13_13_18 | 13167616 | - | 67734efd-75f6-4919-991e-bba9855f3ae1 | Ubuntu 12.04 64b | 260637184 | | b1504066-045a-4f8f-8919-8c665ef3f400 | Ubuntu 14.04 64b | 253297152 | +--------------------------------------+----------------------------------------------+------------+ @@ -286,76 +476,63 @@ You can check if the configuration of rally is fine by typing 'rally deployment | accdc28c-5e20-4859-a5cc-61cf9009e56d | m1.small | 1 | 512 | | 10 | +--------------------------------------+---------------------+-------+----------+-----------+-----------+ -Robot -===== -Summary: Set up python2.7 virtual environment:: + # rally show networks + Networks for user `admin` in tenant `admin`: + +--------------------------------------+------------------------------+------+ + | ID | Label | CIDR | + +--------------------------------------+------------------------------+------+ + | 4f43c349-956f-4073-9ef6-75bf4e62a0e7 | functest-net | None | + | faefaab1-e503-41fc-875b-5e3112be49ed | provider_network | None | + +--------------------------------------+------------------------------+------+ - mkvirtualenv robot - - pip install requests - pip install robotframework - pip install robotframework-sshlibrary - pip install robotframework-requests +-------------- +Manual testing +-------------- vPing ===== -Make sure that nova services are up:: +You can run the vPing testcase by typing:: + + [user@jumphost]$ python <functest_repo_directory>/vPing/vPing.py -d <Your_functest_directory> - #nova service list - +----+----------------+--------+----------+---------+-------+ - | Id | Binary | Host | Zone | Status | State | - +----+----------------+--------+----------+---------+-------+ - | 1 | nova-conductor | xxxxxx | internal | enabled | up | - | 3 | nova-network | xxxxxx | internal | enabled | up | - | 4 | nova-scheduler | xxxxxx | internal | enabled | up | - | 5 | nova-compute | xxxxxx | nova | enabled | up | - +----+----------------+--------+----------+---------+-------+ +OpenDaylight +============ -.. _vPing.py: https://git.opnfv.org/cgit/functest/tree/testcases/vPing/CI/libraries/vPing.py +You can run ODL suite as follow:: -Retrieve vPing.py_ script from OPNFV git repo + [user@jumphost]$ python <functest_repo_directory>testcases/Controllers/ODL/CI/start_tests.sh -Make sure you have sourced your OpenRC file:: +ODL wiki page describes system preparation and running tests. See `Integration Group CSIT`_. - # source Your_OpenRC_file +.. _`Integration Group CSIT`: https://wiki.opendaylight.org/view/CrossProject:Integration_Group:CSIT ------------------------------- -Functional test configuration ------------------------------- Rally bench suite ================= -Rally bench scenarios have been aggregated in json files. -A script has been developed to simplify the management of the tests and the integration in CI, get it from git:: +You can run the script as follow:: - # wget https://git.opnfv.org/cgit/functest/tree/testcases/VIM/OpenStack/CI/libraries/run_rally.py + [user@jumphost]$ python <functest_repo_directory>/testcases/VIM/OpenStack/CI/libraries/run_rally.py <functest_repo_directory> <module_to_be_tested> -Several scenarios are available (all based on native Rally scenarios): - * glance - * nova +with <module_to_be_tested> set to: * authenticate + * cinder + * nova + * requests + * glance * keystone * neutron - * vm * quotas - * request - * tempest - * all (every module except tempest) - -You can run the script as follow:: - - # python run_rally.py keystone + * all The script will: - * get the json scenario (if not already available) and put it into the scenario folder - * run rally - * generate the html result page into the result folder as opnfv-[module name]-[timestamp].html - * generate the json result page into the result folder as opnfv-[module name]-[timestamp].json - * generate OK or KO + * run rally with the selected scenario + * generate the html result page into <result_folder>/<timestamp>/opnfv-[module name].html + * generate the json result page into <result_folder>/<timestamp>/opnfv-[module name].json + * generate OK or NOK per test based on json result file Tempest suite ============= @@ -363,50 +540,132 @@ Tempest suite It is possible to use Rally to perform Tempest tests (ref: `tempest installation guide using Rally`_) You just need to run:: - # rally verify start + # rally verify start smoke -The different modes available are smoke, baremetal, compute, data_processing, identity, image, network, object_storage, orchestration, telemetry, and volume. By default if you do not precise anything then smoke tests be selected by default. +The different modes available are smoke, baremetal, compute, data_processing, identity, image, network, object_storage, orchestration, telemetry, and volume. For Arno, it was decided to focus on smoke tests. .. _`tempest installation guide using Rally`: https://www.mirantis.com/blog/rally-openstack-tempest-testing-made-simpler/ -OpenDaylight -============ -ODL wiki page describes system preparation and running tests. See `Integration Group CSIT`_. -.. _`Integration Group CSIT`: https://wiki.opendaylight.org/view/CrossProject:Integration_Group:CSIT +.. _manualtest: +-------------- +Test results +-------------- vPing ===== +vPing result is displayed in the console:: + + Functest: run vPing + 2015-09-13 22:11:49,502 - vPing- INFO - Glance image found 'functest-img' + 2015-09-13 22:11:49,502 - vPing- INFO - Creating neutron network functest-net... + 2015-09-13 22:11:50,275 - vPing- INFO - Flavor found 'm1.small' + 2015-09-13 22:11:50,318 - vPing- INFO - vPing Start Time:'2015-09-13 22:11:50' + 2015-09-13 22:11:50,470 - vPing- INFO - Creating instance 'opnfv-vping-1' with IP 192.168.120.30... + 2015-09-13 22:11:58,803 - vPing- INFO - Instance 'opnfv-vping-1' is ACTIVE. + 2015-09-13 22:11:58,981 - vPing- INFO - Creating instance 'opnfv-vping-2' with IP 192.168.120.40... + 2015-09-13 22:12:09,169 - vPing- INFO - Instance 'opnfv-vping-2' is ACTIVE. + 2015-09-13 22:12:09,169 - vPing- INFO - Waiting for ping... + 2015-09-13 22:13:11,329 - vPing- INFO - vPing detected! + 2015-09-13 22:13:11,329 - vPing- INFO - vPing duration:'81.0' + 2015-09-13 22:13:11,329 - vPing- INFO - Cleaning up... + 2015-09-13 22:13:18,727 - vPing- INFO - Deleting network 'functest-net'... + 015-09-13 22:13:19,470 - vPing- INFO - vPing OK + +A json file is produced and pushed into the test result database. -By default, the script’s is configured as follow:: +OpenDaylight +============ +.. _`functest wiki (ODL section)`: https://wiki.opnfv.org/r1_odl_suite + + +The results of ODL tests can be seen in the console:: + + ============================================================================== + Basic + ============================================================================== + Basic.010 Restconf OK :: Test suite to verify Restconf is OK + ============================================================================== + Get Controller Modules :: Get the controller modules via Restconf | PASS | + ------------------------------------------------------------------------------ + Basic.010 Restconf OK :: Test suite to verify Restconf is OK | PASS | + 1 critical test, 1 passed, 0 failed + 1 test total, 1 passed, 0 failed + ============================================================================== + Basic | PASS | + 1 critical test, 1 passed, 0 failed + 1 test total, 1 passed, 0 failed + ============================================================================== + Output: /home/jenkins-ci/workspace/functest-opnfv-jump-2/output.xml + Log: /home/jenkins-ci/workspace/functest-opnfv-jump-2/log.html + Report: /home/jenkins-ci/workspace/functest-opnfv-jump-2/report.html + + .............................................................................. + + Neutron.Delete Networks :: Checking Network deleted in OpenStack a... | FAIL | + 2 critical tests, 1 passed, 1 failed + 2 tests total, 1 passed, 1 failed + ============================================================================== + Neutron :: Test suite for Neutron Plugin | FAIL | + 18 critical tests, 15 passed, 3 failed + 18 tests total, 15 passed, 3 failed + ============================================================================== + Output: /home/jenkins-ci/workspace/functest-opnfv-jump-2/output.xml + Log: /home/jenkins-ci/workspace/functest-opnfv-jump-2/log.html + Report: /home/jenkins-ci/workspace/functest-opnfv-jump-2/report.html + +3 result files are generated: + * output.xml + * log.html + * report.html + + ODL result page + +.. figure:: ./images/functestODL.png + :width: 170mm + :align: center + :alt: ODL suite result page + + +Known issues +------------ + +Tests are expected to fail now: + * Check port deleted in OpenDaylight + * Check subnet deleted in OpenDaylight + * Check Network deleted in OpenDaylight + +These failures to delete objects in OpenDaylight (when removed via OpenStack Neutron) are due to the following bug: https://bugs.opendaylight.org/show_bug.cgi?id=3052. + +More details on `functest wiki (ODL section)`_ - * OS_USERNAME: admin - * OS_PASSWORD: test - * OS_AUTH_URL: http://192.168.20.71:5000/v2.0 - * OS_TENANT_NAME: invisible_to_admin - * Name of VM: opnfv-vping-1 , opnfv-vping-2 - * Flavor: m1.small - * Image: Ubuntu 14.04 (amd64) - * Network: private +Rally bench suite +================= -The script needs to be tuned to your specific system configuration +.. _`functest wiki (Rally section)`: https://wiki.opnfv.org/r1_rally_bench -vIMS -==== +Results are available in the result folder through a html page and a json file. +It generates a result page per module and can be described as follow. +.. figure:: ./images/functestRally2.png + :align: center + :alt: Example of Rally keystone test results -.. _manualtest: --------------- -Test results --------------- +.. figure:: ./images/functestRally1.png + :scale: 50 % + :align: center + :alt: Details on Glance test from Rally bench suite -Rally bench suite -================= -Results are available in the result folder through a html page and a json file. +Known issues +------------ +- some tests of Cinder suite may be failed due to time-out (timer could probably be extended in the configuration file) +- some test of Nova & Neutron suite may fail due to network issues (previously created network not properly cleaned and/or quota exceeded because of created ressources that have not be properly cleaned) or ODL bugs (see `ODL bug lists`_). + +More details on `functest wiki (Rally section)`_. Tempest suite ============= @@ -415,32 +674,74 @@ You can get the results of tempest by typing:: # rally verify list +You shall see the results as follow:: + Total results of verification: + +--------------------------------------+--------------------------------------+----------+-------+----------+----------------------------+----------------+----------+ + | UUID | Deployment UUID | Set name | Tests | Failures | Created at | Duration | Status | + +--------------------------------------+--------------------------------------+----------+-------+----------+----------------------------+----------------+----------+ + | 546c678a-19c4-4b2e-8f24-6f8c5ff20635 | 9c13dbbe-7a80-43db-8d6c-c4a61f257c7f | smoke | 111 | 15 | 2015-09-14 06:18:54.896224 | 0:00:51.804504 | finished | + +--------------------------------------+--------------------------------------+----------+-------+----------+----------------------------+----------------+----------+ -OpenDaylight -============ +If you run this test several times, you will see as many lines as test attempts. -Tests can be executed with script *start_test.sh* from directory *functest/testcases/Controllers/ODL/CI*. For usage example see:: +You can get more details on the test by typing:: - # bash start_test.sh -h + # rally verify show --uuid <UUID of the test> + # rally verify detailed --uuid <UUID of the test> -vPing -===== -The test can be executed with command:: +"show" will show you all the restults including the time needed to execute the test. +"detailed" will display additional elements (errors) - #python vPing.py +Example of test result display:: -vIMS -==== + +------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------+--------+ + | name | time | status | + +------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------+--------+ + | tempest.api.network.test_routers.RoutersTest.test_create_show_list_update_delete_router[id-f64403e2-8483-4b34-8ccd-b09a87bcc68c,smoke] | 0.011466 | FAIL | + | tempest.api.network.test_security_groups.SecGroupIPv6Test.test_create_list_update_show_delete_security_group[id-bfd128e5-3c92-44b6-9d66-7fe29d22c802,smoke]| 1.234566 | OK | + | tempest.api.network.test_security_groups.SecGroupIPv6Test.test_create_show_delete_security_group_rule[id-cfb99e0e-7410-4a3d-8a0c-959a63ee77e9,smoke] | 1.060221 | OK | + | tempest.api.network.test_security_groups.SecGroupIPv6Test.test_list_security_groups[id-e30abd17-fef9-4739-8617-dc26da88e686,smoke] | 0.060797 | OK | + | tempest.api.network.test_security_groups.SecGroupTest.test_create_list_update_show_delete_security_group[id-bfd128e5-3c92-44b6-9d66-7fe29d22c802,smoke] | 0.685149 | OK | + | tempest.api.network.test_security_groups.SecGroupTest.test_create_show_delete_security_group_rule[id-cfb99e0e-7410-4a3d-8a0c-959a63ee77e9,smoke] | 0.730561 | OK | + | tempest.api.network.test_security_groups.SecGroupTest.test_list_security_groups[id-e30abd17-fef9-4739-8617-dc26da88e686,smoke] | 0.116862 | OK | + | tempest.api.object_storage.test_account_quotas.AccountQuotasTest | 0.0 | SKIP | + | ... | ... | ... | +Known issues +------------ + +.. _`Rally patch`: https://review.openstack.org/#/c/187481/ +.. _`automatically generated tempest.conf`: https://github.com/openstack/rally/blob/master/rally/verification/tempest/config.py +.. _`functest wiki (Tempest section)`: https://wiki.opnfv.org/r1_tempest +.. _`ODL bug lists`: https://bugs.opendaylight.org/buglist.cgi?component=General&product=neutron&resolution=--- + +Several tests are declared as failed. They can be divided in 2 main categories: + * Multiple possible networks found, use a Network ID to be more specific. + * Network errors + +The Multiple possible netwok error occurs several times and may have different origins. It indicates that the test needs a network context to be run properly. A change in the `automatically generated tempest.conf`_ file could allow to precise the network ID. + +The network errors are various and dealing with all the aspects of networking: create/update/delete network/subnet/port/router. Some may be due to (possible) bug in tempest when it tries to delete networks which should not be there for the following tests. Some may be caused by the ODL bugs, several bugs related to tempest are already reported in `ODL bug lists`_. + +The follow-up of these tests can be found on the `functest wiki (Tempest section)`_. + .. _automatictest: ------------------ Testing Automation ------------------ +For Arno, the CI job performs the following actions: + * clean and prepare functest environment + * run vPing + * run ODL tests + * run Rally Bench + * run Tempest + * clean functest environment + Connection of your platform =========================== @@ -469,3 +770,7 @@ 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 diff --git a/docs/images/clearwater-architecture.png b/docs/images/clearwater-architecture.png Binary files differnew file mode 100644 index 00000000..987362ac --- /dev/null +++ b/docs/images/clearwater-architecture.png diff --git a/docs/images/functestODL.png b/docs/images/functestODL.png Binary files differnew file mode 100644 index 00000000..6bf7580e --- /dev/null +++ b/docs/images/functestODL.png diff --git a/docs/images/functestRally1.png b/docs/images/functestRally1.png Binary files differnew file mode 100644 index 00000000..3bfac09a --- /dev/null +++ b/docs/images/functestRally1.png diff --git a/docs/images/functestRally2.png b/docs/images/functestRally2.png Binary files differnew file mode 100644 index 00000000..dcd408b5 --- /dev/null +++ b/docs/images/functestRally2.png diff --git a/docs/userguide/index.rst b/docs/userguide/index.rst new file mode 100644 index 00000000..0229e703 --- /dev/null +++ b/docs/userguide/index.rst @@ -0,0 +1,540 @@ +************************* +OPNFV FUNCTEST user guide +************************* + +.. toctree:: + :numbered: + :maxdepth: 2 + + +============ +Introduction +============ + +The goal of this document consists in describing the Functest test cases for Brahmaputra. +A presentation has been created for the first OPNFV Summit: `[4]` + +This guide will detail how to launch the different tests assuming that Functest container has been properly installed `[1]`_. + + +============================= +Description of the test cases +============================= + +Functest is an OPNFV project dedicated to functional testing. +In the continuous integration, it is launched after a fresh installation of an OPNFV solution to verify the basic functions. + +Functest includes several test suites that usually include several test cases. +Some are developped within the Functest project, some in dedicated feature projects. + +The current list of test suites can be distributed in 3 main domains: + ++--------------+----------------+---------------------------------------------------------+ +| Component | Testcase | Comments | ++--------------+----------------+---------------------------------------------------------+ +| | vPing | NFV Hello World | +| +----------------+---------------------------------------------------------+ +| VIM | Tempest | OpenStack reference test suite `[2]`_ | +| +----------------+---------------------------------------------------------+ +| | Rally scenario | OpenStack testing tool testing OpenStack modules `[3]`_ | ++--------------+----------------+---------------------------------------------------------+ +| | odl | | +| +----------------+---------------------------------------------------------+ +| Controllers | onos | | +| +----------------+---------------------------------------------------------+ +| | opencontrail | | ++--------------+----------------+---------------------------------------------------------+ +| Features | vIMS | Show the capability to deploy a real NFV testcase | +| +----------------+---------------------------------------------------------+ +| | X | | ++--------------+----------------+---------------------------------------------------------+ + + +Most of the test suites are developped upstream, Functest is in charge of the integration in OPNFV. +Tempest `[2]`_, for example, is the OpenStack reference test suite. + +In Functest we customized the list of tests within Tempest but do not created our own test cases. +Some OPNFV feature projects (.e.g. SDNVPN) may create tempest scenario upstream that are integrated in our Tempest through our configuration. + +The test results are pushed into a test result database (when possible) in order to build a test dashboard. + +There is no real notion of Test domain or Test coverage yet, we tried to cover basic components such as VIM and controllers and integrate the tests of the feature projects. + +The vIMS test case was also integrated to demonstrate the capability to deploy a relatively complex NFV scenario on top of the OPNFV infrastructure. + +Functest considers OPNFV as a black box. OPNFV, since Brahmaputra, offers lots of possible combination (3 controllers, 4 installers). + +However most of the tests (except obviously those dedicated to a specific controller) shall be runnable on any configuration. + +The different scenarios are described in the section hereafter. + +VIM +=== + +vPing +----- + +The goal of this test can be described as follow:: + + vPing test case + +-------------+ +-------------+ + | | | | + | | | | + | | Boot VM1 | | + | +------------------>| | + | | | | + | | Get IP VM1 | | + | +------------------>| | + | Tester | | System | + | | Boot VM2 | Under | + | +------------------>| Test | + | | VM2 pings VM1 | | + | | | | + | | Check console log | | + | | If ping: | | + | | exit OK | | + | | else (timeout) | | + | | exit KO | | + | | | | + | | | | + +-------------+ +-------------+ + + +This example, using OpenStack Python clients can be considered as an "Hello World" example and may be modified for future use. +It is the first basic example, it must work on any configuration. + +Tempest +------- + +Tempest `[2]`_ is the reference OpenStack Integration test suite. It is a set of integration tests to be run against a live OpenStack cluster. +Tempest has batteries of tests for OpenStack API validation, Scenarios, and other specific tests useful in validating an OpenStack deployment. + +We use Rally `[3]`_ to run Tempest suite. +The tempest.conf configuration file is automatically generated by Rally then the Tempest suite is run, each test duration is measured. + +We considered the smoke test suite for Arno. For Brahmaputra, we decided to customize the list of test cases using the --tests-file option introduced in Rally in version 0.1.2. + +The custom list is available on the Functest repo `[4]`_ and contains more than 200 test cases. +This list contains tempest test cases chosen for Functest deployment. +It consists of two main parts: + + 1) Set of tempest smoke test cases + 2) Set of test cases from DefCore list (https://wiki.openstack.org/wiki/Governance/DefCoreCommittee) + +The goal of this test is to check the basic OpenStack functionalities on an OPNFV fresh installation. + + +Rally bench test suites +----------------------- + +Rally `[3]`_ is a benchmarking tool that answers the question: “How does OpenStack work at scale?”. + +The goal of this test suite is to test the different modules of OpenStack and get significant figures that could help us to define telco Cloud KPI. + +The OPNFV scenarios are based on the collection of the existing Rally scenarios: + * authenticate + * cinder + * glance + * heat + * keystone + * neutron + * nova + * quotas + * requests + * vm + +For Brahmaputra, we integrated the rally certification feature introduced in Rally 0.1.1. + +SLA + + +SDN Controllers +=============== + +Brahmaputra introduces new SDN controllers in addition of odl already integrated in Arno. +There are currently 3 possible controllers: + + * odl + * onos + * opencontrail + +OpenDaylight +------------ + +The ODL suite consists in a set of basic tests inherited from ODL project. +The suite tests the creation and deletion of network, subnet, port though OpenDaylight and Neutron. + +The list of tests can be described as follow:: + + * Restconf.basic: Get the controller modules via Restconf + * Neutron.Networks + + * Check OpenStack Networks :: Checking OpenStack Neutron for known networks + * Check OpenDaylight Networks :: Checking OpenDaylight Neutron API + * Create Network :: Create new network in OpenStack + * Check Network :: Check Network created in OpenDaylight + * Neutron.Networks :: Checking Network created in OpenStack are pushed + + * Neutron.Subnets + + * Check OpenStack Subnets :: Checking OpenStack Neutron for known Subnets + * Check OpenDaylight subnets :: Checking OpenDaylight Neutron API + * Create New subnet :: Create new subnet in OpenStack + * Check New subnet :: Check new subnet created in OpenDaylight + * Neutron.Subnets :: Checking Subnets created in OpenStack are pushed + + * Neutron.Ports + + * Check OpenStack ports :: Checking OpenStack Neutron for known ports + * Check OpenDaylight ports :: Checking OpenDaylight Neutron API + * Create New Port :: Create new port in OpenStack + * Check New Port :: Check new subnet created in OpenDaylight + * Neutron.Ports :: Checking Port created in OpenStack are pushed + + * Delete Ports + + * Delete previously created subnet in OpenStack + * Check subnet deleted in OpenDaylight + * Check subnet deleted in OpenStack + + * Delete network + + * Delete previously created network in OpenStack + * Check network deleted in OpenDaylight + * Check network deleted in OpenStack + + +ONOS +---- +TODO + +OpenContrail +------------ +TODO + + + +Features +======== + +vIMS +---- +The goal of this test suite consists in: + * deploying a VNF orchestrator (cloudify) + * deploy a Clearwater vIMS (IP Multimedia Subsystem) VNF from this orchestrator based on a TOSCA blueprint defined in `[5]`_ + * run suite of signaling tests on top of this VNF + +The Clearwater architecture may be described as follow: + +.. figure:: ../images/clearwater-architecture.png + :align: center + :alt: vIMS architecture + +The duration of each step (orchestion deployment, VNF deployment and test), as well as test results, are stored and, in CI, pushed into the test collection database. + +X +-- + +TODO + + +============== +Manual testing +============== + +Once you have installed Functest docker file `[1]`_, and configured the system (though /home/opnfv/repos/functest/docker/prepare_env.sh script), you are ready to run the tests. + +The script run_tests.sh has several options:: + + ./run_tests.sh -h + Script to trigger the tests automatically. + + usage: + bash run_tests.sh [--offline] [-h|--help] [-t <test_name>] + + where: + -o|--offline optional offline mode (experimental) + -h|--help show this help text + -r|--report push results to database (false by default) + -t|--test run specific set of tests + <test_name> one or more of the following: vping,odl,rally,tempest,vims. Separated by comma. + + examples: + run_tests.sh + run_tests.sh --test vping,odl + run_tests.sh --offline -t tempest,rally + +The -o option can be used to run the container offline (in case you are in a summit where there is no Internet connection...). It is an experimental option. + +The -r option is used by the Continuous Integration in order to push the test results into a test collection database, see in next section for details. In manual mode, you must not use it, your try will be anyway probably rejected as your POD must be declared in the database to collect the data. + +The -t option can be used to specify the list of test you want to launch, by default Functest will try to launch all its test suites in the following order vPing, odl, Tempest, vIMS, Rally. You may launch only one single test by using -t <the test you want to launch> + +Please note that Functest includes cleaning mechanism to remove everything except what was present after a fresh install. If you create VM, tenants, networks then launch Functest, there is a risk to remove elements. Be carefull or comment the cleaning phase in run_test.sh (comment call to clean_openstack.py). However, be aware that Tempest and rally triggers the creation of lots of components that are not always properly cleaned, this function has been set to keep the system as clean as possible after a full Functest run. + +You may also add you own test by adding a section into the function run_test() + + +================= +Automated testing +================= + +As mentioned in `[1]`, the prepare-env.sh and run_test.sh can be executed within the container from jenkins. 2 jobs have been created, one to run all the test and one that allows testing test suite by test suite. You thus just have to launch the acurate jenkins job on the target lab, all the tests shall be automatically run. + + +============ +Test results +============ + +VIM +=== + +vPing +----- + +vPing result is displayed in the console:: + + 2016-01-06 16:06:20,550 - vPing- INFO - Creating neutron network vping-net... + 2016-01-06 16:06:23,867 - vPing- INFO - Flavor found 'm1.small' + 2016-01-06 16:06:24,457 - vPing- INFO - vPing Start Time:'2016-01-06 16:06:24' + 2016-01-06 16:06:24,626 - vPing- INFO - Creating instance 'opnfv-vping-1' with IP 192.168.130.30... + 2016-01-06 16:06:39,351 - vPing- INFO - Instance 'opnfv-vping-1' is ACTIVE. + 2016-01-06 16:06:39,650 - vPing- INFO - Creating instance 'opnfv-vping-2' with IP 192.168.130.40... + 2016-01-06 16:06:53,330 - vPing- INFO - Instance 'opnfv-vping-2' is ACTIVE. + 2016-01-06 16:06:53,330 - vPing- INFO - Waiting for ping... + 2016-01-06 16:06:58,669 - vPing- INFO - vPing detected! + 2016-01-06 16:06:58,669 - vPing- INFO - vPing duration:'34.2' + 2016-01-06 16:06:58,670 - vPing- INFO - Cleaning up... + 2016-01-06 16:07:12,661 - vPing- INFO - Deleting network 'vping-net'... + 2016-01-06 16:07:14,748 - vPing- INFO - vPing OK + +A json file is produced and pushed into the test result database. + + +Tempest +------- + +The Tempest results are displayed in the console:: + + FUNCTEST.info: Running Tempest tests... + 2016-01-06 16:07:32,271 - run_tempest - INFO - Creating tenant and user for Tempest suite + 2016-01-06 16:07:38,864 - run_tempest - INFO - Starting Tempest test suite: '--tests-file /home/opnfv/repos/functest/testcases/VIM/OpenStack/CI/custom_tests/test_list.txt'. + + {23} tempest.api.compute.flavors.test_flavors.FlavorsV2TestJSON.test_get_flavor [0.131741s] ... ok + {13} tempest.api.compute.images.test_list_images.ListImagesTestJSON.test_get_image [0.367465s] ... ok + {23} tempest.api.compute.flavors.test_flavors.FlavorsV2TestJSON.test_list_flavors [0.089323s] ... ok + {13} tempest.api.compute.images.test_list_images.ListImagesTestJSON.test_list_images [0.245090s] ... ok + {13} tempest.api.compute.images.test_list_images.ListImagesTestJSON.test_list_images_with_detail [0.434553s] ... ok + {7} setUpClass (tempest.api.identity.admin.v3.test_services.ServicesTestJSON) [0.000000s] ... FAILED + {5} setUpClass (tempest.api.identity.admin.v3.test_groups.GroupsV3TestJSON) [0.000000s] ... FAILED + {4} setUpClass (tempest.api.network.test_floating_ips.FloatingIPTestJSON) [0.000000s] ... FAILED + {10} setUpClass (tempest.api.identity.admin.v3.test_policies.PoliciesTestJSON) [0.000000s] ... FAILED + {3} tempest.api.compute.servers.test_servers.ServersTestJSON.test_create_server_with_admin_password [3.107954s] ... ok + {9} tempest.api.compute.security_groups.test_security_groups.SecurityGroupsTestJSON.test_security_groups_create_list_delete [2.933169s] ... ok + ....... + {1} tempest.api.network.test_networks.BulkNetworkOpsIpV6TestJSON.test_bulk_create_delete_network [1.002445s] ... ok + {1} tempest.api.network.test_networks.BulkNetworkOpsIpV6TestJSON.test_bulk_create_delete_port [1.553398s] ... ok + {1} tempest.api.network.test_networks.BulkNetworkOpsIpV6TestJSON.test_bulk_create_delete_subnet [3.082247s] ... ok + {3} tempest.scenario.test_network_basic_ops.TestNetworkBasicOps.test_network_basic_ops [48.295630s] ... ok + {6} tempest.api.compute.servers.test_server_actions.ServerActionsTestJSON.test_rebuild_server [78.782038s] ... ok + {6} tempest.api.compute.servers.test_server_actions.ServerActionsTestJSON.test_resize_server_confirm [15.597440s] ... ok + {6} tempest.api.compute.servers.test_server_actions.ServerActionsTestJSON.test_resize_server_revert [19.248253s] ... ok + {6} tempest.api.compute.servers.test_server_actions.ServerActionsTestJSON.test_stop_start_server [7.078850s] ... ok + {6} tempest.api.compute.volumes.test_attach_volume.AttachVolumeTestJSON.test_attach_detach_volume [40.311720s] ... ok + {6} tempest.api.volume.test_volumes_actions.VolumesV1ActionsTest.test_attach_detach_volume_to_instance [1.159194s] ... ok + ....... + ====== + Totals + ====== + Ran: 199 tests in 241.0000 sec. + - Passed: 182 + - Skipped: 3 + - Expected Fail: 0 + - Unexpected Success: 0 + - Failed: 14 + Sum of execute time for each test: 481.0934 sec. + + +Rally +----- + TODO + +Controllers +=========== + +odl +--- + +The results of ODL tests can be seen in the console:: + + ============================================================================== + Basic + ============================================================================== + Basic.010 Restconf OK :: Test suite to verify Restconf is OK + ============================================================================== + Get Controller Modules :: Get the controller modules via Restconf | PASS | + ------------------------------------------------------------------------------ + Basic.010 Restconf OK :: Test suite to verify Restconf is OK | PASS | + 1 critical test, 1 passed, 0 failed + 1 test total, 1 passed, 0 failed + ============================================================================== + Basic | PASS | + 1 critical test, 1 passed, 0 failed + 1 test total, 1 passed, 0 failed + ============================================================================== + Output: /home/jenkins-ci/workspace/functest-opnfv-jump-2/output.xml + Log: /home/jenkins-ci/workspace/functest-opnfv-jump-2/log.html + Report: /home/jenkins-ci/workspace/functest-opnfv-jump-2/report.html + + .............................................................................. + + Neutron.Delete Networks :: Checking Network deleted in OpenStack a... | FAIL | + 2 critical tests, 1 passed, 1 failed + 2 tests total, 1 passed, 1 failed + ============================================================================== + Neutron :: Test suite for Neutron Plugin | FAIL | + 18 critical tests, 15 passed, 3 failed + 18 tests total, 15 passed, 3 failed + ============================================================================== + Output: /home/jenkins-ci/workspace/functest-opnfv-jump-2/output.xml + Log: /home/jenkins-ci/workspace/functest-opnfv-jump-2/log.html + Report: /home/jenkins-ci/workspace/functest-opnfv-jump-2/report.html + +3 result files are generated: + * output.xml + * log.html + * report.html + + ODL result page + +.. figure:: ./images/functestODL.png + :width: 170mm + :align: center + :alt: ODL suite result page + + +Known issues +------------ + +Tests are expected to fail now: + * Check port deleted in OpenDaylight + * Check subnet deleted in OpenDaylight + * Check Network deleted in OpenDaylight + +These failures to delete objects in OpenDaylight (when removed via OpenStack Neutron) are due to the following bug: https://bugs.opendaylight.org/show_bug.cgi?id=3052. + +onos +---- + +TODO + +opencontrail +------------ + +TODO + + +Feature +======= + +vIMS +---- + +The results in the console are very verbose:: + + FUNCTEST.info: Running vIMS test... + 2016-01-07 12:30:24,107 - vIMS - INFO - Prepare OpenStack plateform (create tenant and user) + 2016-01-07 12:30:24,484 - vIMS - INFO - Update OpenStack creds informations + 2016-01-07 12:30:24,484 - vIMS - INFO - Upload some OS images if it doesn't exist + 2016-01-07 12:30:24,917 - vIMS - INFO - centos_7 image doesn't exist on glance repository. + Try downloading this image and upload on glance ! + 2016-01-07 12:31:01,268 - vIMS - INFO - ubuntu_14.04 image doesn't exist on glance repository. + Try downloading this image and upload on glance ! + 2016-01-07 12:31:28,670 - vIMS - INFO - Update security group quota for this tenant + 2016-01-07 12:31:28,903 - vIMS - INFO - Update cinder quota for this tenant + 2016-01-07 12:31:29,355 - vIMS - INFO - Collect flavor id for cloudify manager server + 2016-01-07 12:31:30,453 - vIMS - INFO - Prepare virtualenv for cloudify-cli + 2016-01-07 12:31:30,453 - vIMS - DEBUG - Executing command : chmod +x /home/opnfv/repos/functest/testcases/vIMS/CI/create_venv.sh + 2016-01-07 12:31:30,460 - vIMS - DEBUG - Executing command : /home/opnfv/repos/functest/testcases/vIMS/CI/create_venv.sh /home/opnfv/functest/data/vIMS/ + 2016-01-07 12:31:30,469 - vIMS - INFO - Downloading the cloudify manager server blueprint + 2016-01-07 12:31:46,028 - vIMS - INFO - Cloudify deployment Start Time:'2016-01-07 12:31:46' + 2016-01-07 12:31:46,029 - vIMS - INFO - Writing the inputs file + 2016-01-07 12:31:46,032 - vIMS - INFO - Launching the cloudify-manager deployment + ......................................... + 2016-01-07 12:36:51 LOG <manager> [rabbitmq_3c04e.create] INFO: preparing fabric environment... + 2016-01-07 12:36:51 LOG <manager> [rabbitmq_3c04e.create] INFO: environment prepared successfully + ......................................... + 2016-01-07 12:42:51,982 - vIMS - INFO - Cloudify-manager server is UP ! + 2016-01-07 12:42:51,983 - vIMS - INFO - Cloudify deployment duration:'666.0' + 2016-01-07 12:42:51,983 - vIMS - INFO - Collect flavor id for all clearwater vm + 2016-01-07 12:42:53,330 - vIMS - INFO - vIMS VNF deployment Start Time:'2016-01-07 12:42:53' + 2016-01-07 12:42:53,330 - vIMS - INFO - Downloading the openstack-blueprint.yaml blueprint + 2016-01-07 12:43:05,798 - vIMS - INFO - Writing the inputs file + 2016-01-07 12:43:05,801 - vIMS - INFO - Launching the clearwater deployment + 2016-01-07 12:43:05,801 - vIMS - DEBUG - Executing command : /bin/bash -c 'source /home/opnfv/functest/data/vIMS/venv_cloudify/bin/activate; cd /home/opnfv/functest/data/vIMS/opnfv-cloudify-clearwater; cfy blueprints upload -b clearwater -p openstack-blueprint.yaml; cfy deployments create -b clearwater -d clearwater-opnfv --inputs inputs.yaml; cfy executions start -w install -d clearwater-opnfv --timeout 1800; ' + 2016-01-07 13:01:50,577 - vIMS - DEBUG - Validating openstack-blueprint.yaml + Blueprint validated successfully + Uploading blueprint openstack-blueprint.yaml to management server 172.30.10.165 + Uploaded blueprint, blueprint's id is: clearwater + Creating new deployment from blueprint clearwater at management server 172.30.10.165 + Deployment created, deployment's id is: clearwater-opnfv + ......................................... + 2016-01-07 13:01:50,578 - vIMS - INFO - The deployment of clearwater-opnfv is ended + 2016-01-07 13:01:50,578 - vIMS - INFO - vIMS VNF deployment duration:'1137.2' + 2016-01-07 13:04:50,591 - vIMS - DEBUG - Trying to get clearwater nameserver IP ... + 2016-01-07 13:04:55,176 - vIMS - INFO - vIMS functional test Start Time:'2016-01-07 13:04:55' + 2016-01-07 13:14:20,694 - vIMS - INFO - vIMS functional test duration:'565.5' + ......................................... + Basic Call - Rejected by remote endpoint (TCP) - (6505550603, 6505550969) Passed + Basic Call - Rejected by remote endpoint (UDP) - (6505550095, 6505550084) Passed + Basic Call - Messages - Pager model (TCP) - (6505550000, 6505550520) Passed + Basic Call - Messages - Pager model (UDP) - (6505550742, 6505550077) Passed + Basic Call - Pracks (TCP) - (6505550670, 6505550304) Passed + Basic Call - Pracks (UDP) - (6505550990, 6505550391) Passed + Basic Registration (TCP) - (6505550744) Passed + Basic Registration (UDP) - (6505550616) Passed + Multiple Identities (TCP) - (6505550957, 6505550949) Passed + Multiple Identities (UDP) - (6505550771, 6505550675) Passed + ......................................... + 2016-01-07 13:14:20,695 - vIMS - DEBUG - Trying to load test results + 2016-01-07 13:14:20,702 - vIMS - DEBUG - Push result into DB + 2016-01-07 13:14:20,702 - vIMS - DEBUG - Pushing results to DB.... + 2016-01-07 13:14:21,396 - vIMS - DEBUG - <Response [200]> + 2016-01-07 13:14:21,396 - vIMS - INFO - Launching the clearwater-opnfv undeployment + + +========================== +Functest in test Dashboard +========================== + +The OPNFV testing group created a test collection database to collect the test results from CI. +Any lab integrated in CI can push the results to this database. + +The idea is to centralize the resultes and created a dashboard to give a high level overview of the test activities. + +TODO + +========== +References +========== + +.. _`[1]`: Functest configuration guide URL +.. _`[2]`: http://docs.openstack.org/developer/tempest/overview.html +.. _`[3]`: https://rally.readthedocs.org/en/latest/index.html +.. _`[4]`: http://events.linuxfoundation.org/sites/events/files/slides/Functest%20in%20Depth_0.pdf +.. _`[5]`: https://github.com/Orange-OpenSource/opnfv-cloudify-clearwater/blob/master/openstack-blueprint.yaml + + +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 + |
