diff options
| author |   Morgan Richomme <morgan.richomme@orange.com> | 2016-01-29 08:27:55 +0000 |
|---|---|---|
| committer |   Gerrit Code Review <gerrit@172.30.200.206> | 2016-01-29 08:27:56 +0000 |
| commit | 30d6f68a184873fb635852de0f271c2a11960483 (patch) | |
| tree | 8107db3f83d7182b66886144e738452ea0beacd9 | |
| parent | 306ee84657d0dea1397191dd38bf6515e40debbe (diff) | |
| parent | 7c5cfcf8085174066c35cfc39c4b6745a5819ecd (diff) | |
Merge "Update doc"
| -rw-r--r-- | docs/configguide/index.rst | 236 | ||||
| -rw-r--r-- | docs/functest.rst | 776 | ||||
| -rw-r--r-- | docs/userguide/index.rst | 909 |
3 files changed, 863 insertions, 1058 deletions
diff --git a/docs/configguide/index.rst b/docs/configguide/index.rst index 85954e770..52bc6272f 100644 --- a/docs/configguide/index.rst +++ b/docs/configguide/index.rst @@ -18,13 +18,21 @@ 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). +The OPNFV deployment is out of the scope of this document but it can be found in +XXX. The OPNFV platform is considered as the System Under Test (SUT) in this +document. 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 + + 1. A Jumphost to run Functest on + 2. Docker daemon shall be installed on the Jumphost + 3. A public/external network created on the SUT + 4. Connectivity from the Jumphost to the SUT public/external network + 5. Connectivity from the Jumphost to the SUT management network + +NOTE: “Jumphost” refers to any server which meets the previous requirements. +Normally it is the same server from where the OPNFV deployment has been +triggered. Docker installation =================== @@ -48,13 +56,17 @@ References: Connectivy to OPNFV management network ====================================== -Some of the Functest tools need to have access to the OpenStack management network of the controllers `[1]`_. +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). +For this reason, an interface shall be configured in the Jumphost in the +OpenStack management network range. Example:: - The OPNFV Fuel installation uses VLAN tagged 300 and subnet 192.168.1.0/24 as Openstack Management network. + 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 @@ -64,8 +76,12 @@ Example:: 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. +Some of the tests against the VIM (Virtual Infrastructure Manager) need an +existing public network to succeed. This is needed, for example, to create +floating IPs to access instances from the public network (i.e. Jumphost). + +By default, any of the four OPNFV installers provide a fresh installation with +an external network created along with a router. @@ -75,111 +91,126 @@ 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 + CIMC/Lights+out management Admin Private Public Storage + PXE + + + + + IP_PRIV/24 | | + | | + + | + | | | IP_PUB/24 | + | +----------------------------+ | | + | + | | | | | | | + +-----+ Jumphost | | | | | + | | +----------+ | | | + | | | | | | | + | | +--------------------+ | | | | | + | | | | | | | | | + | | | Tools | +--------------------+ | | + | | | - Rally | | | | | | + | | | - Robot | | | | | | + | | | - TestON | | | | | | + | | | | | | | | | + | | | Testcases | | | | | | + | | | - VIM | | | | | | + | | | -- vPing | | | | | | + | | | -- vPing_userdata | | | | | | + | | | -- Tempest | | | | | | + | | | -- Rally | | | | | | + | | | - Controller | | | | | | + | | | -- odl | | | | | | + | | | -- onos | | | | | | + | | | -- opencontrail | | | | | | + | | | | | | | | | + | | | Features | | | | | | + | | | - vIMS | | | | | | + | | | | | | | | | + | | +--------------------+ | | | | | + | | +------------------------------+ | + | | Functest Docker | | | | | + | | +---------------------------------------+ + | | | | | | | + | +----------------------------+ | | | | + | | | | | + | +----------------+ | | | | + | | 1 | | | | | + +----+ +--------------+-+ | | | | + | | | 2 | | | | | + | | | +--------------+-+ | | | | + | | | | 3 | | | | | + | | | | +--------------+-+ | | | | + | | | | | 4 | | | | | + | +-+ | | +--------------+-+ | | | | + | | | | | 5 +---------------+ | | | + | +-+ | | nodes for | | | | | + | | | | deploying +-------------------------+ | | + | +-+ | opnfv | | | | | + | | | SUT +-----------------------------------+ | + | +-+ | | | | | + | | +--------------------------------------------+ + | +----------------+ | | | | + | | | | | + | + + + + + +All the libraries and dependencies needed by all the Functest tools are +pre-installed in the Docker image. +This allows running Functest on any platform with any Operating System. + +The Docker image will: + + * retrieve OpenStack credentials + * prepare the environment according to the SUT + * perform the appropriate 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]`_ + + +This Docker image can be integrated into CI or deployed **independently** 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. +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:: +Pull the Functest Docker image from the Docker hub:: + + $ docker pull opnfv/functest:brahmaputra.1.0 - $ 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...) + - INSTALLER_TYPE. Possible values are "apex", "compass", "fuel" or "joid". + - 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...) -The minimum command to create the Functest docker file can be described as follow:: +The minimum command to create the Functest docker file can be described as +follows:: - docker run -it -e "INSTALLER_IP=10.20.0.2" -e "INSTALLER_TYPE=fuel" opnfv/functest:latest_stable /bin/bash + docker run -it -e "INSTALLER_IP=10.20.0.2" -e "INSTALLER_TYPE=fuel" opnfv/functest:brahmaputra.1.0 /bin/bash -Optionnaly, it is possible to precise the container name through the option --name:: +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 + docker run --name "CONTAINER_NAME" -it -e "INSTALLER_IP=10.20.0.2" -e "INSTALLER_TYPE=fuel" opnfv/functest:brahmaputra.1.0 /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 + 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:brahmaputra.1.0 /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. +The local file will be mounted in the container under /home/opnfv/functest/conf/openstack.creds -Once run you shall be inside the docker container and ready to run Functest. +After the run command the prompt appears which means that we are inside the +container and ready to run Functest. -Inside the container, you must have the following arborescence:: +Inside the container, you must have the following directory structure:: `-- home `-- opnfv @@ -255,17 +286,24 @@ 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) +The OpenStack credentials are needed to test the VIM. There are 3 ways to +provide them to Functest: + + * using the -v option when running the Docker container + * create an empty file in /home/opnfv/functest/conf/openstack.creds and paste the needed info in it. + * automatically retrieved using the following script:: + $repos_dir/releng/utils/fetch_os_creds.sh + +Once the credentials are there, they shall be sourced before running the tests:: -If not source you will get an error during the test environnement preparation. + source /home/opnfv/functest/conf/openstack.creds 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:: +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" @@ -277,7 +315,8 @@ In case you need to provide different configuration parameters to Functest (e.g. ================= Integration in CI ================= -In CI we use the docker file and execute commande within the container from Jenkins. +In CI we use the docker file and execute commande within the container from +Jenkins. Docker creation in set-functest-env builder `[3]`_:: @@ -342,7 +381,8 @@ Docker clean in functest-cleanup builder `[3]`_:: 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. +Everything is preconfigured in the docker file. +It is however possible to customize the list of tests, see `[2]` for details. ====== Errors diff --git a/docs/functest.rst b/docs/functest.rst deleted file mode 100644 index ed436f586..000000000 --- a/docs/functest.rst +++ /dev/null @@ -1,776 +0,0 @@ -=========================== -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 - -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. - -The last section also describes how to automate these tests within the OPNFV continuous integration project. - -.. _ETSI: http://docbox.etsi.org/ISG/NFV/Open/Published/gs_NFV001v010101p%20-%20Use%20Cases.pdf - -ETSI NFV defined 9 use cases (ref ETSI_): - * VNF as a Service - * NFV as a service - * VNF Forwarding graphs - * Virtual Network Platform as a Service - * Virtualisation of Mobile Core and IMS - * Virtualisation of Mobile station - * Fixed Access NFV - * Virtualization of CDNs (vCDN) - * 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), 4 test suites have been selected: - * Rally Bench test suite for Openstack - * Openstack Tempest test suite - * OpenDaylight test suite - * vPing - -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 "hello world" functional test example. - -.. _`Continuous Integration`: https://build.opnfv.org/ci/view/functest/ - -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 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 Arno solution has been installed. - -.. _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 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. - -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 - + - + + IP_PRIV/24 | | - | | + + | - | | | IP_PUB/24 | - | +-----------------+ | | + | - | | | | | | | - +-----+ Jumpserver | | | | | - | | +---------------------+ | | | - | | | | | | | - | | +----------+ | | | | | - | | | Rally | +---- --------------------------+ | | - | | | | | | | | | - | | | Robot | | | | | | - | | | | | | | | | - | | | vPing | | | | | | - | | | | | | | | | - | | | Tempest | | | | | | - | | +----------+ | | | | | - | | FuncTest +-----------------------------------------+ | - | | | | | | | - | | +--------------------------------------------------+ - | | | | | | | - | +-----------------+ | | | | - | | | | | - | +----------------+ | | | | - | | 1 | | | | | - +----+ +--------------+-+ | | | | - | | | 2 | | | | | - | | | +--------------+-+ | | | | - | | | | 3 | | | | | - | | | | +--------------+-+ | | | | - | | | | | 4 | | | | | - | +-+ | | +--------------+-+ | | | | - | | | | | 5 +---------------+ | | | - | +-+ | | nodes for | | | | | - | | | | deploying +-------------------------+ | | - | +-+ | opnfv | | | | | - | | | SUT +-----------------------------------+ | - | +-+ | | | | | - | | +--------------------------------------------+ - | +----------------+ | | | | - | | | | | - | + + + + - -.. _description: - ------------------------------ -Description of the test cases ------------------------------ - -vPing -===== - -The goal of this test can be described as follow:: - - vPing testcase - +-------------+ +-------------+ - | | | | - | | | | - | | 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. - -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 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 defined (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 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. - -The goal of this test is to to check the basic OpenStack functionality on a fresh installation. - - - -.. _tooling_installation: - ----------------------- -Tooling installation ----------------------- - -.. _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 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:: - - # rally deployment check - keystone endpoints are valid and following service are available: - +-------------+-----------+------------+ - | Services | Type | Status | - +-----------+-------------+------------+ - | cinder | volume | Available | - | cinderv2 | volumev2 | Available | - | glance | image | Available | - | keystone | identity | Available | - | neutron | network | Available | - | nova | compute | Available | - | nova_ec2 | compute_ec2 | Available | - | novav3 | computev3 | Available | - +-----------+-------------+------------+ - - # rally show images - +--------------------------------------+----------------------------------------------+------------+ - | UUID | Name | Size (B) | - +--------------------------------------+----------------------------------------------+------------+ - | 0a15951f-6388-4d5d-8531-79e7205eb140 | cirros_2015_04_10_13_13_18 | 13167616 | - | b1504066-045a-4f8f-8919-8c665ef3f400 | Ubuntu 14.04 64b | 253297152 | - +--------------------------------------+----------------------------------------------+------------+ - - # rally show flavors - +--------------------------------------+---------------------+-------+----------+-----------+-----------+ - | ID | Name | vCPUs | RAM (MB) | Swap (MB) | Disk (GB) | - +--------------------------------------+---------------------+-------+----------+-----------+-----------+ - | 110e6375-a058-4af6-b21e-b765187904d2 | m1.medium | 2 | 1024 | | 20 | - | 7084d7e7-415a-455d-a55a-2ad286ddf7c9 | m1.large | 4 | 4096 | | 80 | - | a0345ba7-c667-4fd2-964f-7e98f8cda279 | m1.xlarge | 4 | 8192 | | 200 | - | accdc28c-5e20-4859-a5cc-61cf9009e56d | m1.small | 1 | 512 | | 10 | - +--------------------------------------+---------------------+-------+----------+-----------+-----------+ - - # 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 | - +--------------------------------------+------------------------------+------+ - - --------------- -Manual testing --------------- - -vPing -===== - -You can run the vPing testcase by typing:: - - [user@jumphost]$ python <functest_repo_directory>/vPing/vPing.py -d <Your_functest_directory> - - -OpenDaylight -============ - -You can run ODL suite as follow:: - - [user@jumphost]$ python <functest_repo_directory>testcases/Controllers/ODL/CI/start_tests.sh - -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 - - -Rally bench suite -================= - -You can run the script as follow:: - - [user@jumphost]$ python <functest_repo_directory>/testcases/VIM/OpenStack/CI/libraries/run_rally.py <functest_repo_directory> <module_to_be_tested> - -with <module_to_be_tested> set to: - * authenticate - * cinder - * nova - * requests - * glance - * keystone - * neutron - * quotas - * all - -The script will: - * 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 -============= - -It is possible to use Rally to perform Tempest tests (ref: `tempest installation guide using Rally`_) -You just need to run:: - - # rally verify start smoke - -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/ - - -.. _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. - -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)`_ - -Rally bench suite -================= - -.. _`functest wiki (Rally section)`: https://wiki.opnfv.org/r1_rally_bench - -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 - - -.. figure:: ./images/functestRally1.png - :scale: 50 % - :align: center - :alt: Details on Glance test from Rally bench suite - - -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 -============= - -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 | - +--------------------------------------+--------------------------------------+----------+-------+----------+----------------------------+----------------+----------+ - -If you run this test several times, you will see as many lines as test attempts. - -You can get more details on the test by typing:: - - # rally verify show --uuid <UUID of the test> - # rally verify detailed --uuid <UUID of the test> - -"show" will show you all the restults including the time needed to execute the test. -"detailed" will display additional elements (errors) - -Example of test result display:: - - +------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------+--------+ - | 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 -=========================== - -.. _`Octopus procedure`: https://wiki.opnfv.org/octopus/jenkins_slave_connection/ - -If you want to add your platform to the community automation, please follow the `Octopus procedure`_. - -Integrating into CI Pipeline -============================ - -.. _`pipeline document`: https://wiki.opnfv.org/octopus/pipelines - -Contact Octopus Team (#opnfv-octopus) and see `pipeline document`_ for more details. - -.. _references: - ----------- -References ----------- - -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/userguide/index.rst b/docs/userguide/index.rst index df4e200df..f08ac0a01 100644 --- a/docs/userguide/index.rst +++ b/docs/userguide/index.rst @@ -11,10 +11,12 @@ OPNFV FUNCTEST user guide Introduction ============ -The goal of this document is describing the Functest test cases for Brahmaputra. +The goal of this documents is to describe the Functest test cases as well as +provide a procedure about how to execute (or launch) them. + 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]`_. +It is assumed that Functest container has been properly installed `[1]`_. ============================= @@ -22,49 +24,76 @@ 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. +In the continuous integration, it is launched after an OPNFV fresh installation. +The Functest target is to verify the basic functions of the infrastructure. -Functest includes several test suites that usually include several test cases. -Some are developped within the Functest project, some in dedicated feature projects. +Functest includes different test suites which several test cases within. +Test cases are developed in Functest and in feature projects. The current list of test suites can be distributed in 3 main domains: -+----------------+----------------+---------------------------------------------------------+ -| Component | Test suite | Comments | -+----------------+----------------+---------------------------------------------------------+ -| | vPing | NFV "Hello World" | -| VIM +----------------+---------------------------------------------------------+ -|(Virtualised | Tempest | OpenStack reference test suite `[2]`_ | -| Infrastructure +----------------+---------------------------------------------------------+ -| Manager) | 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 developed upstream. For example, Tempest `[2]`_ is the OpenStack integration test suite. -Functest is in charge of the integration of different functional test suites in OPNFV. - -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. ++----------------+----------------+--------------------------------------------+ +| Method | Test suite | Comments | ++================+================+============================================+ +| | vPing | NFV "Hello World" | +| +----------------+--------------------------------------------+ +| VIM | vPing_userdata | Ping using userdata and cloud-init | +| | | mechanism | +| +----------------+--------------------------------------------+ +|(Virtualised | Tempest | OpenStack reference test suite `[2]`_ | +| Infrastructure +----------------+--------------------------------------------+ +| Manager) | Rally scenario | OpenStack testing tool testing OpenStack | +| | | modules `[3]`_ | ++----------------+----------------+--------------------------------------------+ +| | OpenDaylight | Opendaylight Test suite | +| +----------------+--------------------------------------------+ +| Controllers | ONOS | Test suite of ONOS L2 and L3 functions | +| +----------------+--------------------------------------------+ +| | OpenContrail | | ++----------------+----------------+--------------------------------------------+ +| Features | vIMS | Show the capability to deploy a real NFV | +| | | test cases. | +| | | The IP Multimedia Subsytem is a typical | +| | | Telco test case, referenced by ETSI. | +| | | It provides a fully functional VoIP System.| +| +----------------+--------------------------------------------+ +| | Promise | Resource reservation and management project| +| | | to identify NFV related requirements and | +| | | realize resource reservation for future | +| | | usage by capacity management of resource | +| | | pools regarding compute, network and | +| | | storage. | +| +----------------+--------------------------------------------+ +| | SDNVPN | | ++----------------+----------------+--------------------------------------------+ + + +Most of the test suites are developed upstream. +For example, Tempest `[2]`_ is the OpenStack integration test suite. +Functest is in charge of the integration of different functional test suites. + +The Tempest suite has been customized but no new test cases have been created. +Some OPNFV feature projects (.e.g. SDNVPN) have created Tempest tests cases and +pushed to upstream. + +The tests run from CI are pushed into a database. +The goal is to populate the database with results and to show them on a Test +Dashboard. + +There is no real notion of Test domain or Test coverage yet. +Basic components (VIM, controllers) are tested through their own suites. +Feature projects also provide their own test suites. + +vIMS test case was 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 combinations: + + * 3 controllers (OpenDayligh, ONOS, OpenContrail) + * 4 installers (Apex, Compass, Fuel, Joid) + +However most of the tests shall be runnable on any configuration. The different scenarios are described in the section hereafter. @@ -74,11 +103,50 @@ VIM vPing ----- -The goal of this test can be described as follow:: +The goal of this test can be described as follows:: vPing test case +-------------+ +-------------+ | | | | + | | Boot VM1 | | + | +------------------>| | + | | | | + | | Get IP VM1 | | + | +------------------>| | + | Tester | | System | + | | Boot VM2 | Under | + | +------------------>| Test | + | | | | + | | Create (VM2) | | + | | floating IP | | + | +------------------>| | + | | | | + | | SCP vPing script | | + | | to VM2 | | + | +------------------>| | + | | | | + | | SSH to VM2 | | + | +------------------>| | + | | | | + | | Ping VM1 | | + | | private IP | | + | +------------------>| | + | | | | + | | If ping: | | + | | exit OK | | + | | else (timeout) | | + | | exit KO | | + | | | | + +-------------+ +-------------+ + + +vPing_userdata +-------------- + +The goal of this test can be described as follow:: + + vPing_userdata test case + +-------------+ +-------------+ | | | | | | Boot VM1 | | | +------------------>| | @@ -89,50 +157,65 @@ The goal of this test can be described as follow:: | | Boot VM2 | Under | | +------------------>| Test | | | VM2 pings VM1 | | - | | | | + | | (cloud-init) | | | | 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. +This example can be considered as an "Hello World" example. 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. +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 + * other specific tests useful in validating an OpenStack deployment We use Rally `[3]`_ to run Tempest suite. Rally generates automatically tempest.conf configuration file. -Before running actual test cases Functest creates needed resources and updates needed parameters into the configuration file. -When the Tempest suite is run, each test duration is measured and full console output is stored into tempest.log file. +Before running actual test cases Functest creates needed resources. +Needed parameters are updated in the configuration file. +When the Tempest suite is run, each test duration is measured. +The full console output is stored in the tempest.log file. -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. +As an addition of Arno, Brahmaputra runs a customized set of Tempest test cases. +The list is specificed through --tests-file when running Rally. +This option has been introduced in Rally in version 0.1.2. -The customized test list is available on the Functest repo `[4]`_ and contains more than 200 tempest test cases chosen for Functest deployment. -The list consists of two main parts: +The customized test list is available in the Functest repo `[4]`_ +This list contains more than 200 Tempest test cases. +The list can be divied into 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) + 2) Set of test cases from DefCore list `[8]`_ -The goal of Tempest test suite is to check the basic functionality of different OpenStack components on an OPNFV fresh installation using corresponding REST API interfaces. +The goal of Tempest test suite is to check the basic functionalities of +different OpenStack components on an OPNFV fresh installation using +corresponding REST API interfaces. Rally bench test suites ----------------------- -Rally `[3]`_ is a benchmarking tool that answers the question: “How does OpenStack work at scale?”. +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 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 @@ -144,26 +227,26 @@ The OPNFV scenarios are based on the collection of the existing Rally scenarios: * requests * vm -For Brahmaputra, we integrated the rally certification feature introduced in Rally 0.1.1. - -SLA +Basic SLA (stop test on errors) have been implemented. SDN Controllers =============== -Brahmaputra introduces new SDN controllers in addition of odl already integrated in Arno. +Brahmaputra introduces new SDN controllers. There are currently 3 possible controllers: - * odl - * onos - * opencontrail + * OpenDaylight (ODL) + * ONOS + * OpenContrail (OCL) OpenDaylight ------------ -The ODL test suite consists of a set of basic tests inherited from ODL project. -The suite verifies creation and deletion of networks, subnets and ports with OpenDaylight and Neutron. +The OpenDaylight (ODL) test suite consists of a set of basic tests inherited +from ODL project. +The suite verifies creation and deletion of networks, subnets and ports with +OpenDaylight and Neutron. The list of tests can be described as follow: @@ -208,11 +291,15 @@ The list of tests can be described as follow: ONOS ---- -For ONOS function test,TestON Framework is being used. -The test cases contains L2 and L3 function.We config the function by OpenStack,and then check it in ONOS. -Following describe the test cases: +TestON Framework is used to test ONOS function. +The test cases deal with L2 and L3 functions. +ONOS is configured through OPNFV scenario. +The ONOS test suite can be run on any ONOS compliant scenario. + +The test cases may be described as follow: - * onosfunctest: The mainly executable file,contains init the docker environment for test and function call of FUNCvirNetNB and FUNCvirNetNBL3 + * onosfunctest: The mainly executable file contains the initialization of the + docker environment and functions called by FUNCvirNetNB and FUNCvirNetNBL3 * FUNCvirNetNB * Create Network :: Post Network data and check it in ONOS @@ -230,19 +317,23 @@ Following describe the test cases: * Create Router :: Post dataes for create Router and check it in ONOS * Update Router :: Update the Router and compare it in ONOS * Delete Router :: Delete the Router dataes and check it in ONOS - * Create RouterInterface :: Post RouterInterface data to an exist Router and check it in ONOS + * Create RouterInterface :: Post RouterInterface data to an exist Router and + check it in ONOS * Delete RouterInterface :: Delete the RouterInterface and check the Router * Create FloatingIp :: Post dataes for create FloatingIp and check it in ONOS * Update FloatingIp :: Update the FloatingIp and compare it in ONOS - * Delete FloatingIp :: Delete the FloatingIp and check if it's NULL in ONOS or not - * Create External Gateway :: Post dataes for create External Gateway to an exit Router and check it + * Delete FloatingIp :: Delete the FloatingIp and check if it's NULL in ONOS + or not + * Create External Gateway :: Post dataes for create External Gateway to an + exit Router and check it * Update External Gateway :: Update the External Gateway and compare it - * Delete External Gateway :: Delete the External Gateway and check if it's NULL in ONOS or not + * Delete External Gateway :: Delete the External Gateway and check if it's + NULL in ONOS or not OpenContrail ------------ -TODO +TODO OVNO @@ -251,32 +342,42 @@ Features vIMS ---- -The goal of this test suite consists in: +The goal of this test suite consists of: * deploying a VNF orchestrator (cloudify) - * deploy a Clearwater vIMS (IP Multimedia Subsystem) VNF from this orchestrator based on a TOSCA blueprint defined in `[5]`_ + * 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: +The Clearwater architecture is described as follows: .. 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. +Two types of information are stored in the Test Database: -X --- + * the duration of each step (orchestion deployment, VNF deployment and test) + * the test results + +The deployment of a complete functional VNF allows the test of most of the +essential functions needed for a NFV system. + +Promise +------- -TODO +TODO promise ============== 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. +Once the Functest docker container is running and Functest environment ready +(through /home/opnfv/repos/functest/docker/prepare_env.sh script), the system is +ready to run the tests. -The script run_tests.sh has several options:: +The script run_tests.sh is located in $repos_dir/functest/docker and it has +several options:: ./run_tests.sh -h Script to trigger the tests automatically. @@ -289,24 +390,39 @@ The script run_tests.sh has several options:: -r|--report push results to database (false by default) -n|--no-clean do not clean up OpenStack resources after test run -t|--test run specific set of tests - <test_name> one or more of the following: vping,odl,rally,tempest,vims. Separated by comma. + <test_name> one or more of the following: vping,vping_userdata,odl,rally,tempest,vims,onos,promise. Separated by comma. examples: run_tests.sh run_tests.sh --test vping,odl run_tests.sh -t tempest,rally --no-clean -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 -n option is used for preserving all the existing OpenStack resources after execution test cases. - -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> - -Within Tempest test suite you can define which test cases you want to execute in your environment by editing test_list.txt file before executing run_tests.sh script. - -Please note that Functest includes cleaning mechanism in order to remove everything except what was present after a fresh install. If you create your own VMs, tenants, networks etc. and then launch Functest, they all will be deleted after executing the tests. Use --no-clean option with run_test.sh in order to preserve all the existing resources. However, be aware that Tempest and Rally create of lot of resources (users, tenants, networks, volumes etc.) that are not always properly cleaned, so this cleaning function has been set to keep the system as clean as possible after a full Functest run. +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 -n option is used for preserving all the existing OpenStack resources after +execution test cases. + +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> + +Within Tempest test suite you can define which test cases you want to execute in +your environment by editing test_list.txt file before executing run_tests.sh +script. + +Please note that Functest includes cleaning mechanism in order to remove +everything except what was present after a fresh install. +If you create your own VMs, tenants, networks etc. and then launch Functest, +they all will be deleted after executing the tests. Use --no-clean option with +run_test.sh in order to preserve all the existing resources. +However, be aware that Tempest and Rally create of lot of resources (users, +tenants, networks, volumes etc.) that are not always properly cleaned, so this +cleaning 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() @@ -315,7 +431,82 @@ 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. +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. + +When the tests are automatically started from CI, a basic algorithm has been +created in order to detect whether the test is runnable or not on the given +scenario. +In fact, one of the most challenging task in Brahmaputra consists in dealing +with lots of scenario and installers. +Functest test suites cannot be systematically run (e.g. run the ODL suite on an +ONOS scenario). + +CI provides several information: + + * The installer (apex|compass|fuel|joid) + * The scenario [controller]-[feature]-[mode] with + + * controller = (odl|onos|ocl|nosdn) + * feature = (ovs(dpdk)|kvm) + * mode = (ha|noha) + +Constraints per test case are defined in the Functest configuration file +/home/opnfv/functest/config/config_functest.yaml:: + + test-dependencies: + functest: + vims: + scenario: '(ocl)|(odl)|(nosdn)' + vping: + vping_userdata: + scenario: '(ocl)|(odl)|(nosdn)' + tempest: + rally: + odl: + scenario: 'odl' + onos: + scenario: 'onos' + .... + +At the end of the Functest environment creation (prepare_env.sh see `[1]`_), a +file (/home/opnfv/functest/conf/testcase-list.txt) is created with the list of +all the runnable tests. +We consider the static constraints as regex and compare them with the scenario. +For instance, odl can be run only on scenario including odl in its name. + +The order of execution is also described in the Functest configuration file:: + + test_exec_priority: + + 1: vping + 2: vping_userdata + 3: tempest + 4: odl + 5: onos + 6: ovno + #7: doctor + 8: promise + 9: odl-vpnservice + 10: bgpvpn + #11: openstack-neutron-bgpvpn-api-extension-tests + 12: vims + 13: rally + +The tests are executed as follow: + + * Basic scenario (vPing, vPing_userdata, Tempest) + * Controller suites: ODL or ONOS or OpenContrail + * Feature projects + * vIMS + * Rally (benchmark scenario) + +At the end of an automated execution, everything is cleaned. +We keep only the users/networks that have been statically declared in '[9]'_ ============ @@ -328,7 +519,34 @@ VIM vPing ----- -vPing result is displayed in the console:: +vPing results are displayed in the console:: + + FUNCTEST.info: Running vPing test... + 2016-01-23 03:18:20,153 - vPing- INFO - Creating neutron network vping-net... + 2016-01-23 03:18:35,476 - vPing- INFO - Flavor found 'm1.small' + 2016-01-23 03:18:36,350 - vPing- INFO - vPing Start Time:'2016-01-23 03:18:36' + 2016-01-23 03:18:38,571 - vPing- INFO - Creating instance 'opnfv-vping-1' with IP 192.168.130.30... + 2016-01-23 03:18:53,716 - vPing- INFO - Instance 'opnfv-vping-1' is ACTIVE. + 2016-01-23 03:18:55,239 - vPing- INFO - Creating instance 'opnfv-vping-2' with IP 192.168.130.40... + 2016-01-23 03:19:15,593 - vPing- INFO - Instance 'opnfv-vping-2' is ACTIVE. + 2016-01-23 03:19:15,593 - vPing- INFO - Creating floating IP for the second VM... + 2016-01-23 03:19:18,017 - vPing- INFO - Floating IP created: '10.2.65.6' + 2016-01-23 03:19:18,017 - vPing- INFO - Associating floating ip: '10.2.65.6' to VM2 + 2016-01-23 03:19:37,839 - vPing- INFO - SCP ping script to VM2... + 2016-01-23 03:19:37,839 - vPing- INFO - Waiting for ping... + 2016-01-23 03:19:40,130 - vPing- INFO - vPing detected! + 2016-01-23 03:19:40,130 - vPing- INFO - vPing duration:'63.8' + 2016-01-23 03:19:40,130 - vPing- INFO - Cleaning up... + 2016-01-23 03:20:06,574 - vPing- INFO - Deleting network 'vping-net'... + 2016-01-23 03:20:13,587 - vPing- INFO - vPing OK + + + + +vPing_userdata +-------------- + +vPing_userdata results are 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' @@ -352,55 +570,82 @@ 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. - -In order to check all the available test case related debug information, please inspect tempest.log file stored into related Rally deployment folder. + FUNCTEST.info: Running Tempest tests... + 2016-01-28 07:56:55,380 - run_tempest - INFO - Creating tenant and user for Tempest suite + 2016-01-28 07:56:56.127 23795 INFO rally.verification.tempest.tempest [-] Starting: Creating configuration file for Tempest. + 2016-01-28 07:56:59.512 23795 INFO rally.verification.tempest.tempest [-] Completed: Creating configuration file for Tempest. + 16-01-28 07:57:00,597 - run_tempest - INFO - Starting Tempest test suite: '--tests-file /home/opnfv/repos/functest/testcases/VIM/OpenStack/CI/custom_tests/test_list.txt'. + Total results of verification: + + +--------------------------------------+--------------------------------------+----------+-------+----------+----------------------------+----------+ + | UUID | Deployment UUID | Set name | Tests | Failures | Created at | Status | + +--------------------------------------+--------------------------------------+----------+-------+----------+----------------------------+----------+ + | e0bf7770-2c0f-4c63-913c-cd51a6edd96d | 16582e1e-7b01-4d5d-9c13-a26db8567b7b | | 144 | 30 | 2016-01-28 07:57:01.044856 | finished | + +--------------------------------------+--------------------------------------+----------+-------+----------+----------------------------+----------+ + + Tests: + + +------------------------------------------------------------------------------------------------------------------------------------------+-----------+---------+ + | name | time | status | + +------------------------------------------------------------------------------------------------------------------------------------------+-----------+---------+ + | tempest.api.compute.flavors.test_flavors.FlavorsV2TestJSON.test_get_flavor | 0.29804 | success | + | tempest.api.compute.flavors.test_flavors.FlavorsV2TestJSON.test_list_flavors | 0.06289 | success | + | tempest.api.compute.images.test_images.ImagesTestJSON.test_delete_saving_image | 9.21756 | success | + | tempest.api.compute.images.test_images_oneserver.ImagesOneServerTestJSON.test_create_delete_image | 8.65376 | success | + | tempest.api.compute.images.test_images_oneserver.ImagesOneServerTestJSON.test_create_image_specify_multibyte_character_image_name | 9.10993 | success | + | tempest.api.compute.images.test_list_image_filters.ListImageFiltersTestJSON.test_list_images_filter_by_changes_since | 0.19585 | success | + ........................................... + 2016-01-28 08:19:32,132 - run_tempest - INFO - Results: {'timestart': '2016-01-2807:57:01.044856', 'duration': 1350, 'tests': 144, 'failures': 30} + 2016-01-28 08:19:32,133 - run_tempest - INFO - Pushing results to DB: 'http://testresults.opnfv.org/testapi/results'. + 2016-01-28 08:19:32,278 - run_tempest - INFO - Deleting tenant and user for Tempest suite) + +In order to check all the available test case related debug information, please +inspect tempest.log file stored into related Rally deployment folder. + +The Tempest results are pushed to the Test Database. Rally ----- - TODO + +The Rally results are displayed in the console, each module is run one after the +other. Tables are displayed:: + + +-------------------------------------------------------------------------------------------+ + | Response Times (sec) | + +----------------------+-------+--------+--------+--------+-------+-------+---------+-------+ + | action | min | median | 90%ile | 95%ile | max | avg | success | count | + +----------------------+-------+--------+--------+--------+-------+-------+---------+-------+ + | keystone.create_role | 0.358 | 0.572 | 0.772 | 0.811 | 1.106 | 0.603 | 100.0% | 20 | + | keystone.add_role | 0.32 | 0.436 | 0.846 | 0.903 | 1.018 | 0.51 | 100.0% | 20 | + | keystone.list_roles | 0.102 | 0.185 | 0.253 | 0.275 | 0.347 | 0.188 | 100.0% | 20 | + | total | 0.845 | 1.223 | 1.821 | 1.822 | 1.823 | 1.302 | 100.0% | 20 | + +----------------------+-------+--------+--------+--------+-------+-------+---------+-------+ + Load duration: 7.13633608818 + Full duration: 36.7863121033 + .............. + +------------------------------------------------------------------------------------------+ + | Response Times (sec) | + +---------------------+-------+--------+--------+--------+-------+-------+---------+-------+ + | action | min | median | 90%ile | 95%ile | max | avg | success | count | + +---------------------+-------+--------+--------+--------+-------+-------+---------+-------+ + | nova.create_keypair | 1.005 | 1.784 | 3.025 | 3.636 | 4.373 | 2.004 | 100.0% | 20 | + | nova.delete_keypair | 0.199 | 0.699 | 1.007 | 1.244 | 3.014 | 0.79 | 100.0% | 20 | + | total | 1.249 | 2.625 | 4.259 | 4.845 | 5.131 | 2.794 | 100.0% | 20 | + +---------------------+-------+--------+--------+--------+-------+-------+---------+-------+ + Load duration: 14.9231169224 + Full duration: 71.4614388943 + + +At the end of the module test, a message is displayed to provide a global +summary (Test OK or test failed). The raw results are pushed into the Test +Database. + Controllers =========== -odl ---- +OpenDaylight +------------ The results of ODL tests can be seen in the console:: @@ -425,13 +670,13 @@ The results of ODL tests can be seen in the console:: .............................................................................. - 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.Delete Networks :: Checking Network deleted in OpenStack a... | PASS | + 2 critical tests, 2 passed, 0 failed + 2 tests total, 2 passed, 0 failed ============================================================================== - Neutron :: Test suite for Neutron Plugin | FAIL | - 18 critical tests, 15 passed, 3 failed - 18 tests total, 15 passed, 3 failed + Neutron :: Test suite for Neutron Plugin | PASS | + 18 critical tests, 18 passed, 0 failed + 18 tests total, 18 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 @@ -450,23 +695,14 @@ The results of ODL tests can be seen in the console:: :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 +ONOS ---- -The ONOS test logs output to OnosSystemTest/TestON/logs with ONOSCI_PATH added,and also can be seen in the console:: +The ONOS test logs can be found in OnosSystemTest/TestON/logs +(ONOSCI_PATH to be added),and also can be seen in the console:: ****************************** - Result summary for Testcase4 + Result summary for Testcase4 ****************************** 2016-01-14 05:25:40,529 - FUNCvirNetNBL3 - INFO - ONOS Router Delete test Start @@ -500,13 +736,13 @@ The ONOS test logs output to OnosSystemTest/TestON/logs with ONOSCI_PATH added,a ***************************** - Result: Pass + Result: Pass ***************************** ....................................................................................... ****************************** - Result summary for Testcase9 + Result summary for Testcase9 ****************************** ....................................................................................... @@ -519,15 +755,15 @@ The ONOS test logs output to OnosSystemTest/TestON/logs with ONOSCI_PATH added,a ....................................................................................... ***************************** - Result: Failed + Result: Failed ***************************** -There's a Result summary for each testcase,and a total summary for the whole test file,if any problem occured,ERROR can be seen in the testcase summary and total summary:: +There is a result summary for each testcase, and a global summary for the whole test. +If any problem occurs during the test, a ERROR message will be provided in the test and the the global summary:: ************************************* Test Execution Summary - - ************************************* + ************************************* Test Start : 14 Jan 2016 05:25:37 Test End : 14 Jan 2016 05:25:41 @@ -540,10 +776,11 @@ There's a Result summary for each testcase,and a total summary for the whole tes Success Percentage : 72% Execution Result : 100% -opencontrail + +OpenContrail ------------ -TODO +TODO OVNO Feature @@ -614,17 +851,288 @@ The results in the console are very verbose:: 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 +Please note that vIMS traces are very verbose but can bee summarized in several +steps: + + * INFO: environment prepared successfully => environment OK + * INFO - Cloudify-manager server is UP ! => orchestrator deployed + * INFO The deployment of clearwater-opnfv is ended => VNF deployed + * Multiple Identities (UDP) - (6505550771, 6505550675) Passed => tests run + * DEBUG - Pushing results to DB.... => tests saved + ========================== 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 create a dashboard to give a high level overview of the test activities. -You can find more information about the dashboard from Testing Dashboard wiki page `[6]`_. - +The OPNFV testing group created a test collection database to collect the test +results from CI. +Any test project running on any lab integrated in CI can push the results to +this database. +This databse can be used afterwards to see the evolution of the tests and +compare the results versus the installers, the scenario or the labs. + +You can find more information about the dashboard from Testing Dashboard wiki +page `[6]`_. + + +Overall Architecture +-------------------- + +The Test result management in Brahmaputra can be summarized as follow:: + + +-------------+ +-------------+ +-------------+ + | | | | | | + | Test | | Test | | Test | + | Project #1 | | Project #2 | | Project #N | + | | | | | | + +-------------+ +-------------+ +-------------+ + | | | + ▼ ▼ ▼ + +-----------------------------------------+ + | | + | Test Rest API front end | + | http://testresults.opnfv.org/testapi | + | | + +-----------------------------------------+ + ▲ | + | ▼ + | +-------------------------+ + | | | + | | Test Results DB | + | | Mongo DB | + | | | + | +-------------------------+ + | + | + +----------------------+ + | | + | test Dashboard | + | | + +----------------------+ + +The Test dashboard URL is: TODO LF +A proto Test dashboard has been realized: http://testresults.opnfv.org/proto/ + +Test API description +-------------------- + +The Test API is used to declare pods, projects, test cases and test results. +An additional method dashboard has been added to post-process the raw results. +The data model is very basic, 4 objects are created: + * Pods + * Test projects + * Test cases + * Test results + +Pods:: + + { + "id": <ID>, + "details": <URL description of the POD>, + "creation_date": YYYY-MM-DD HH:MM:SS , + "name": <The POD Name>, + "mode": <metal or virtual> + }, + +Test project:: + + { + "id": <ID>, + "name": <Name of the Project>, + "creation_date": "YYYY-MM-DD HH:MM:SS", + "description": <Short description> + }, + +Test case:: + + { + "id": <ID>, + "name":<Name of the test case>, + "creation_date": "YYYY-MM-DD HH:MM:SS", + "description": <short description>, + "url":<URL for longer description> + }, + +Test results:: + + { + "_id": <ID, + "project_name": <Reference to project>, + "pod_name": <Reference to POD where the test was executed>, + "version": <Scenario on which the test was executed>, + "installer": <Installer Apex or Compass or Fuel or Joid>, + "description": <Short description>, + "creation_date": "YYYY-MM-DD HH:MM:SS", + "case_name": <Reference to the test case> + "details":{ + <- the results to be put here -> + } + + +For Brahmaputra, we got: + + * 16 pods + * 18 projects + * 101 test cases + +The projects and the test cases have been frozen in December. +But all were not ready for Brahmaputra. + + + +The API can described as follow:: + +**Version:** + ++--------+--------------------------+------------------------------------------+ +| Method | Path | Description | ++========+==========================+==========================================+ +| GET | /version | Get API version | ++--------+--------------------------+------------------------------------------+ + + +**Pods:** + ++--------+--------------------------+------------------------------------------+ +| Method | Path | Description | ++========+==========================+==========================================+ +| GET | /pods | Get the list of declared Labs (PODs) | ++--------+--------------------------+------------------------------------------+ +| POST | /pods | Declare a new POD | +| | | Content-Type: application/json | +| | | { | +| | | "name": "pod_foo", | +| | | "creation_date": "YYYY-MM-DD HH:MM:SS"| +| | | } | ++--------+--------------------------+------------------------------------------+ + +**Projects:** + ++--------+--------------------------+------------------------------------------+ +| Method | Path | Description | ++========+==========================+==========================================+ +| GET | /test_projects | Get the list of test projects | ++--------+--------------------------+------------------------------------------+ +| GET |/test_projects/{project} | Get details on {project} | +| | | | ++--------+--------------------------+------------------------------------------+ +| POST | /test_projects | Add a new test project | +| | | Content-Type: application/json | +| | | { | +| | | "name": "project_foo", | +| | | "description": "whatever you want" | +| | | } | ++--------+--------------------------+------------------------------------------+ +| PUT | /test_projects/{project} | Update a test project | +| | | | +| | | Content-Type: application/json | +| | | { | +| | | <the field(s) you want to modify> | +| | | } | ++--------+--------------------------+------------------------------------------+ +| DELETE | /test_projects/{project} | Delete a test project | ++--------+--------------------------+------------------------------------------+ + + +**Test cases:** + ++--------+--------------------------+------------------------------------------+ +| Method | Path | Description | ++========+==========================+==========================================+ +| GET | /test_projects/{project}/| Get the list of test cases of {project} | +| | cases | | ++--------+--------------------------+------------------------------------------+ +| POST | /test_projects/{project}/| Add a new test case to {project} | +| | cases | Content-Type: application/json | +| | | { | +| | | "name": "case_foo", | +| | | "description": "whatever you want" | +| | | "creation_date": "YYYY-MM-DD HH:MM:SS"| +| | | "url": "whatever you want" | +| | | } | ++--------+--------------------------+------------------------------------------+ +| PUT | /test_projects/{project}?| Modify a test case of {project} | +| | case_name={case} | | +| | | Content-Type: application/json | +| | | { | +| | | <the field(s) you want to modify> | +| | | } | ++--------+--------------------------+------------------------------------------+ +| DELETE | /test_projects/{project}/| Delete a test case | +| | case_name={case} | | ++----------------+----------------+--------------------------------------------+ + +**Test Results:** + ++--------+--------------------------+------------------------------------------+ +| Method | Path | Description | ++========+==========================+==========================================+ +| GET |/results/project={project}| Get the test results of {project} | ++--------+--------------------------+------------------------------------------+ +| GET |/results/case={case} | Get the test results of {case} | ++--------+--------------------------+------------------------------------------+ +| GET |/results?pod={pod} | get the results on pod {pod} | ++--------+--------------------------+------------------------------------------+ +| GET |/results?installer={inst} | Get the test results of installer {inst} | ++--------+--------------------------+------------------------------------------+ +| GET |/results?version={version}| Get the test results of scenario | +| | | {version}. Initially the version param | +| | | was reflecting git version, in Functest | +| | | it was decided to move to scenario | ++--------+--------------------------+------------------------------------------+ +| GET |/results?project={project}| Get all the results of the test case | +| |&case={case} | {case} of the project {project} with | +| |&version={scenario} | version {scenario} installed by installer| +| |&installer={installer} | {installer} on POD {pod} stored since | +| |&pod={pod} | {days} days | +| | | {project_name} and {case_name} are | +| |&period={days} | mandatory, the other parameters are | +| | | optional. | ++--------+--------------------------+------------------------------------------+ +| POST | /results | Add a new test results | +| | | Content-Type: application/json | +| | | { | +| | | "project_name": "project_foo", | +| | | "case_name": "case_foo", | +| | | "pod_name": "pod_foo", | +| | | "installer": "installer_foo", | +| | | "version": "scenario_foo", | +| | | "details": <your results> | +| | | } | ++--------+--------------------------+------------------------------------------+ + + +**Dashboard:** + ++--------+--------------------------+------------------------------------------+ +| Method | Path | Description | ++========+==========================+==========================================+ +| GET |/dashboard? | Get all the dashboard ready results of | +| |&project={project} | {case} of the project {project} | +| |&case={case} | version {scenario} installed by installer| +| |&version={scenario} | {installer} on POD {pod} stored since | +| |&installer={installer} | {days} days | +| |&pod={pod} | | +| |&period={days} | {project_name} and {case_name} are | +| | | mandatory, the other parameters are | +| | | optional. | ++--------+--------------------------+------------------------------------------+ + + +The results with dashboard method are post-processed from raw results. +Please note that dashboard results are not stored. Only raw results are stored. + + + +Test Dashboard +-------------- + +Based on dashboard post-porcessed results, a Test dashboard is automatically +generated. + +TODO LF +or http://testresults.opnfv.org/proto/ =============== Troubleshooting @@ -637,35 +1145,65 @@ vPing ----- -Tempest -------- +vPing_userdata +-------------- -In the upstream OpenStack CI all the Tempest test cases are supposed to pass. If some test cases fail in an OPNFV deployment, the reason is very probably one of the following: - * Some resources required for execution test cases are missing. Such resources could be e.g. an external network and access to the management subnet (adminURL) from the Functest docker container. - * Some OpenStack components or services are missing or not configured properly. You can check running services in the controller and compute nodes e.g. with "systemctl" or "service" commands. Configuration parameters can be verified from related .conf files located under /etc/<component> directories. - * Used tempest.conf file doesn't contain all the needed parameters or some parameters are not set properly. When using Functest, tempest.conf file is generated by Rally and updated with needed parameters automatically before executing Tempest cases. You can find the used configuration file e.g. with "find / -name tempest.conf" command. Use "rally deployment list" command in order to check UUID of current deployment. +Tempest +------- -When some Tempest test case fails, captured traceback and possibly also related REST API requests/responses are output to the console. -More detailed debug information can be found from tempest.log file stored into related Rally deployment folder. +In the upstream OpenStack CI all the Tempest test cases are supposed to pass. +If some test cases fail in an OPNFV deployment, the reason is very probably one +of the following: + ++-----------------------------+------------------------------------------------+ +| Error | Details | ++=============================+================================================+ +| Resources required for test | Such resources could be e.g. an external | +| case execution are missing | network and access to the management subnet | +| | (adminURL) from the Functest docker container. | ++-----------------------------+------------------------------------------------+ +| OpenStack components or | Check running services in the controller and | +| services are missing or not | compute nodes (e.g. with "systemctl" or | +| configured properly | "service" commands). Configuration parameters | +| | can be verified from related .conf files | +| | located under /etc/<component> directories. | ++--------------------------------+---------------------------------------------+ +| Some resources required for | The tempest.conf file, automatically generated | +| execution test cases are | by Rally in Functest, does not contain all the | +| missing | needed parameters or some parameters are not | +| | set properly. | +| | The tempest.conf file is located in /home/opnfv| +| | /.rally/tempest/for-deployment-<UUID> in | +| | Functest container | +| | Use "rally deployment list" command in order to| +| | check UUID of current deployment. | ++-----------------------------+------------------------------------------------+ + + +When some Tempest test case fails, captured traceback and possibly also related +REST API requests/responses are output to the console. +More detailed debug information can be found from tempest.log file stored into +related Rally deployment folder. Rally ----- +Same error causes than for Tempest mentioned above may lead to error in Rally. Controllers =========== -odl +ODL --- -onos +ONOS ---- -opencontrail +OpenContrail ------------ @@ -686,7 +1224,10 @@ References .. _`[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 .. _`[6]`: https://wiki.opnfv.org/opnfv_test_dashboard - +.. _`[7]`: http://testresults.opnfv.org/testapi/test_projects/functest/cases +.. _`[8]`: https://wiki.openstack.org/wiki/Governance/DefCoreCommittee +.. _`[9]`: https://git.opnfv.org/cgit/functest/tree/testcases/VIM/OpenStack/CI/libraries/os_defaults.yaml +.. _`[10]`:https://git.opnfv.org/cgit/functest/tree/testcases/VIM/OpenStack/CI/rally_cert/task.yaml OPNFV main site: opnfvmain_. |