aboutsummaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorMorgan Richomme <morgan.richomme@orange.com>2016-01-29 16:15:38 +0000
committerGerrit Code Review <gerrit@172.30.200.206>2016-01-29 16:15:39 +0000
commitca4ab3711fcc87f9f7c722008b81e3cffea782c2 (patch)
tree4f1fc3c6f827cc2bd2a3c391f0c9b4acd914ba93 /docs
parentfeecd6ccf9231ffdb82ac6bb2b1dcbb8389e457c (diff)
parent1f5d8a36ce871b32aaf4a44102d4e11a67f074cf (diff)
Merge "Editorials"
Diffstat (limited to 'docs')
-rw-r--r--docs/configguide/index.rst95
-rw-r--r--docs/devguide/index.rst74
-rw-r--r--docs/userguide/index.rst607
3 files changed, 395 insertions, 381 deletions
diff --git a/docs/configguide/index.rst b/docs/configguide/index.rst
index 52bc6272..f23b11d4 100644
--- a/docs/configguide/index.rst
+++ b/docs/configguide/index.rst
@@ -1,12 +1,11 @@
-***********************************************
+===============================================
OPNFV FUNCTEST configuration/installation guide
-***********************************************
+===============================================
.. toctree::
:numbered:
:maxdepth: 2
-============
Introduction
============
@@ -14,7 +13,6 @@ Introduction
This document describes how to install and configure Functest in OPNFV.
-=============
Prerequisites
=============
@@ -24,18 +22,18 @@ document.
Several prerequisites are needed for functest:
- 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
+ #. A Jumphost to run Functest on
+ #. Docker daemon shall be installed on the Jumphost
+ #. A public/external network created on the SUT
+ #. Connectivity from the Jumphost to the SUT public/external network
+ #. 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
-===================
+-------------------
.. _Ubuntu: https://docs.docker.com/installation/ubuntulinux/
.. _RHEL: https://docs.docker.com/installation/rhel/
@@ -50,23 +48,24 @@ Add your user to docker group to be able to run commands without sudo::
References:
+
* Ubuntu_
* RHEL_
-Connectivy to OPNFV management network
-======================================
+Connectivity to OPNFV management network
+----------------------------------------
Some of the Functest tools need to have access to the OpenStack management
network of the controllers `[1]`_.
For this reason, an interface shall be configured in the Jumphost in the
-OpenStack management network range.
+OpenStack management network range.
Example::
The OPNFV Fuel installation uses VLAN tagged 300 and subnet 192.168.1.0/24 as
Openstack Management network.
-
+ .
Supposing that eth1 is the physical interface with access to that subnet:
$ ip link add name eth1.300 link eth1 type vlan id 300
$ ip link set eth1.300 up
@@ -74,18 +73,17 @@ Example::
External network on SUT
-=======================
+-----------------------
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.
+an external network created along with a router.
-=======================
High level architecture
=======================
@@ -152,16 +150,16 @@ The high level architecture of Functest within OPNFV can be described as follow:
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.
+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 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
@@ -171,32 +169,32 @@ 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 Docker hub::
- $ docker pull opnfv/functest:brahmaputra.1.0
+ $ docker pull opnfv/functest:brahmaputra.1.0
Check that the image is available::
$ docker images
-Run the docker container giving the environment variables
+Run the docker container giving the environment variables::
+
- 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...)
+
+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
follows::
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
+Optionally, 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:brahmaputra.1.0 /bin/bash
@@ -205,7 +203,8 @@ 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:brahmaputra.1.0 /bin/bash
-The local file will be mounted in the container under /home/opnfv/functest/conf/openstack.creds
+The local file will be mounted in the container under
+/home/opnfv/functest/conf/openstack.creds
After the run command the prompt appears which means that we are inside the
container and ready to run Functest.
@@ -229,8 +228,13 @@ Inside the container, you must have the following directory structure::
Basically the container includes:
- * Functest directory to store the configuration (the OpenStack creds are paste in /home/opngb/functest/conf), the data (images neede for test for offline testing), results (some temporary artifacts may be stored here)
- * Repositories: the functest repository will be used to prepare the environement, run the tests. Other repositories are used for the installation of the tooling (e.g. rally) and/or the retrieval of feature projects scenarios (e.g. bgpvpn)
+ * Functest directory to store the configuration (the OpenStack creds are paste
+ in /home/opngb/functest/conf), the data (images neede for test for offline
+ testing), results (some temporary artifacts may be stored here)
+ * Repositories: the functest repository will be used to prepare the
+ environment, run the tests. Other repositories are used for the installation
+ of the tooling (e.g. rally) and/or the retrieval of feature projects
+ scenarios (e.g. bgpvpn)
The arborescence under the functest repo can be described as follow::
@@ -265,17 +269,21 @@ The arborescence under the functest repo can be described as follow::
We may distinguish 4 different folders:
- * commons: it is a folder dedicated to store traffic profile or any test inputs that could be reused by any test project
- * docker: this folder includes the scripts that will be used to setup the environment and run the tests
+ * commons: it is a folder dedicated to store traffic profile or any test
+ inputs that could be reused by any test project
+ * docker: this folder includes the scripts that will be used to setup the
+ environment and run the tests
* docs: this folder includes the user and installation/configuration guide
- * testcases: this folder includes the scripts required by Functest internal test cases
+ * testcases: this folder includes the scripts required by Functest internal
+ test cases
Firstly run the script to install functest environment::
$ ${repos_dir}/functest/docker/prepare_env.sh
-NOTE: ${repos_dir} is a default environment variable inside the docker container, which points to /home/opnfv/repos
+NOTE: ${repos_dir} is a default environment variable inside the docker
+container, which points to /home/opnfv/repos
Run the script to start the tests::
@@ -284,13 +292,14 @@ Run the script to start the tests::
NOTE: This will run ALL the tests by default, see `[2]`_ for details
Focus on the OpenStack credentials
-==================================
+----------------------------------
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.
+ * 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
@@ -299,10 +308,10 @@ Once the credentials are there, they shall be sourced before running the tests::
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
+ 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
@@ -312,9 +321,10 @@ In case you need to provide different configuration parameters to Functest (e.g.
-v $(pwd)/config_functest.yaml:/home/opnfv/functest/conf/config_functest.yaml \
"${cmd1} && ${cmd2}"
-=================
+
Integration in CI
=================
+
In CI we use the docker file and execute commande within the container from
Jenkins.
@@ -377,14 +387,12 @@ Docker clean in functest-cleanup builder `[3]`_::
fi
-=============
Configuration
=============
-Everything is preconfigured in the docker file.
+Everything is preconfigured in the docker file.
It is however possible to customize the list of tests, see `[2]` for details.
-======
Errors
======
@@ -392,7 +400,6 @@ Errors
-==========
References
==========
.. _`[1]`: https://ask.openstack.org/en/question/68144/keystone-unable-to-use-the-public-endpoint/
@@ -404,7 +411,7 @@ OPNFV main site: opnfvmain_.
OPNFV functional test page: opnfvfunctest_.
-IRC support chan: #opnfv-testperf
+IRC support channel: #opnfv-testperf
.. _opnfvmain: http://www.opnfv.org
.. _opnfvfunctest: https://wiki.opnfv.org/opnfv_functional_testing
diff --git a/docs/devguide/index.rst b/docs/devguide/index.rst
index e6a294f8..bdf0e5b2 100644
--- a/docs/devguide/index.rst
+++ b/docs/devguide/index.rst
@@ -39,6 +39,7 @@ Functest can be described as follow::
Functest deals with internal and external test cases.
The Internal test cases in Brahmaputra are:
+
* vPing
* ODL
* Tempest
@@ -77,41 +78,42 @@ The Functest docker directories are::
|-- releng
`-- vims-test
-
-+--------------+-------------------+---------------------------------------------------------+
-| Directory | Subdirectory | Comments |
-+--------------+-------------------+---------------------------------------------------------+
-| | <project>/conf | All the useful configuration file(s) for <project> |
-| | | the openstack creds are put there for CI |
-| | | It is recommended to push it there when passing the |
-| | | credentials to container through the -v option |
-| +-------------------+---------------------------------------------------------+
-| opnfv | <project>/data | Usefull data, images for <projects> |
-| | | By default we put an image cirros-0.3.4-x86_64-disk.img |
-| | | This image can be used by any projects |
-| +-------------------+---------------------------------------------------------+
-| | <project>/results | Local result directory of project <project> |
-+--------------+-------------------+---------------------------------------------------------+
-| | bgpvpn | |
-| +-------------------+ +
-| repos | doctor | |
-| +-------------------+ +
-| | functest | |
-| +-------------------+ +
-| | odl_integration | |
-| +-------------------+ Clone of the useful repositories +
-| | onos | These repositories may include: |
-| +-------------------+ - tooling +
-| | promise | - scenario |
-| +-------------------+ - scripts +
-| | rally | |
-| +-------------------+ +
-| | releng | |
-| +-------------------+ +
-| | vims-test | |
-| +-------------------+ +
-| | <your project> | |
-+--------------+-------------------+---------------------------------------------------------+
+::
+
+ +--------------+-------------------+---------------------------------------------------------+
+ | Directory | Subdirectory | Comments |
+ +--------------+-------------------+---------------------------------------------------------+
+ | | <project>/conf | All the useful configuration file(s) for <project> |
+ | | | the openstack creds are put there for CI |
+ | | | It is recommended to push it there when passing the |
+ | | | credentials to container through the -v option |
+ | +-------------------+---------------------------------------------------------+
+ | opnfv | <project>/data | Usefull data, images for <projects> |
+ | | | By default we put an image cirros-0.3.4-x86_64-disk.img |
+ | | | This image can be used by any projects |
+ | +-------------------+---------------------------------------------------------+
+ | | <project>/results | Local result directory of project <project> |
+ +--------------+-------------------+---------------------------------------------------------+
+ | | bgpvpn | |
+ | +-------------------+ +
+ | repos | doctor | |
+ | +-------------------+ +
+ | | functest | |
+ | +-------------------+ +
+ | | odl_integration | |
+ | +-------------------+ Clone of the useful repositories +
+ | | onos | These repositories may include: |
+ | +-------------------+ - tooling +
+ | | promise | - scenario |
+ | +-------------------+ - scripts +
+ | | rally | |
+ | +-------------------+ +
+ | | releng | |
+ | +-------------------+ +
+ | | vims-test | |
+ | +-------------------+ +
+ | | <your project> | |
+ +--------------+-------------------+---------------------------------------------------------+
Before running the test suite, you must prepare the environement by running::
@@ -214,7 +216,7 @@ The current libraries used in Functest container are::
prepare_env.sh
-============
+==============
This script can be adapted if you need to set up a specific environment before running the tests.
diff --git a/docs/userguide/index.rst b/docs/userguide/index.rst
index f08ac0a0..8cd09ae9 100644
--- a/docs/userguide/index.rst
+++ b/docs/userguide/index.rst
@@ -1,25 +1,23 @@
-*************************
+=========================
OPNFV FUNCTEST user guide
-*************************
+=========================
.. toctree::
:numbered:
:maxdepth: 2
-============
Introduction
============
-The goal of this documents is to describe the Functest test cases as well as
+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]`
+A presentation has been created for the first OPNFV Summit `[4]`_.
It is assumed that Functest container has been properly installed `[1]`_.
-=============================
Description of the test cases
=============================
@@ -27,45 +25,45 @@ Functest is an OPNFV project dedicated to functional testing.
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 different test suites which several test cases within.
+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:
-
-+----------------+----------------+--------------------------------------------+
-| 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 | |
-+----------------+----------------+--------------------------------------------+
+The current list of test suites can be distributed in 3 main domains::
+
+ +----------------+----------------+--------------------------------------------+
+ | 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.
@@ -91,17 +89,17 @@ 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)
+ * 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.
VIM
-===
+---
vPing
------
+^^^^^
The goal of this test can be described as follows::
@@ -141,7 +139,7 @@ The goal of this test can be described as follows::
vPing_userdata
---------------
+^^^^^^^^^^^^^^
The goal of this test can be described as follow::
@@ -171,7 +169,7 @@ 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.
@@ -205,7 +203,7 @@ corresponding REST API interfaces.
Rally bench test suites
------------------------
+^^^^^^^^^^^^^^^^^^^^^^^
Rally `[3]`_ is a benchmarking tool that answers the question::
@@ -231,7 +229,7 @@ Basic SLA (stop test on errors) have been implemented.
SDN Controllers
-===============
+---------------
Brahmaputra introduces new SDN controllers.
There are currently 3 possible controllers:
@@ -241,7 +239,7 @@ There are currently 3 possible controllers:
* OpenContrail (OCL)
OpenDaylight
-------------
+^^^^^^^^^^^^
The OpenDaylight (ODL) test suite consists of a set of basic tests inherited
from ODL project.
@@ -289,7 +287,7 @@ The list of tests can be described as follow:
ONOS
-----
+^^^^
TestON Framework is used to test ONOS function.
The test cases deal with L2 and L3 functions.
@@ -298,54 +296,59 @@ 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 the initialization of the
- docker environment and functions called by 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
- * Update Network :: Update the Network and compare it in ONOS
- * Delete Network :: Delete the Network and check if it's NULL in ONOS or not
- * Create Subnet :: Post Subnet data and check it in ONOS
- * Update Subnet :: Update the Subnet and compare it in ONOS
- * Delete Subnet :: Delete the Subnet and check if it's NULL in ONOS or not
- * Create Port :: Post Port data and check it in ONOS
- * Update Port :: Update the Port and compare it in ONOS
- * Delete Port :: Delete the Port and check if it's NULL in ONOS or not
+ * Create Network: Post Network data and check it in ONOS
+ * Update Network: Update the Network and compare it in ONOS
+ * Delete Network: Delete the Network and check if it's NULL in ONOS or
+ not
+ * Create Subnet: Post Subnet data and check it in ONOS
+ * Update Subnet: Update the Subnet and compare it in ONOS
+ * Delete Subnet: Delete the Subnet and check if it's NULL in ONOS or not
+ * Create Port: Post Port data and check it in ONOS
+ * Update Port: Update the Port and compare it in ONOS
+ * Delete Port: Delete the Port and check if it's NULL in ONOS or not
* FUNCvirNetNBL3
- * 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
- * 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
- * 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
+ * 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
+ * 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
+ * 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
OpenContrail
-------------
+^^^^^^^^^^^^
TODO OVNO
Features
-========
+--------
vIMS
-----
+^^^^
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 is described as follows:
@@ -363,16 +366,15 @@ The deployment of a complete functional VNF allows the test of most of the
essential functions needed for a NFV system.
Promise
--------
+^^^^^^^
TODO promise
-==============
Manual testing
==============
-Once the Functest docker container is running and Functest environment ready
+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.
@@ -427,7 +429,6 @@ full Functest run.
You may also add you own test by adding a section into the function run_test()
-=================
Automated testing
=================
@@ -509,15 +510,14 @@ At the end of an automated execution, everything is cleaned.
We keep only the users/networks that have been statically declared in '[9]'_
-============
Test results
============
VIM
-===
+---
vPing
------
+^^^^^
vPing results are displayed in the console::
@@ -544,7 +544,7 @@ vPing results are displayed in the console::
vPing_userdata
---------------
+^^^^^^^^^^^^^^
vPing_userdata results are displayed in the console::
@@ -566,7 +566,7 @@ A json file is produced and pushed into the test result database.
Tempest
--------
+^^^^^^^
The Tempest results are displayed in the console::
@@ -576,15 +576,15 @@ The Tempest results are displayed in the console::
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 |
+------------------------------------------------------------------------------------------------------------------------------------------+-----------+---------+
@@ -605,7 +605,7 @@ inspect tempest.log file stored into related Rally deployment folder.
The Tempest results are pushed to the Test Database.
Rally
------
+^^^^^
The Rally results are displayed in the console, each module is run one after the
other. Tables are displayed::
@@ -636,16 +636,16 @@ other. Tables are displayed::
Full duration: 71.4614388943
-At the end of the module test, a message is displayed to provide a global
+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.
+Database.
Controllers
-===========
+-----------
OpenDaylight
-------------
+^^^^^^^^^^^^
The results of ODL tests can be seen in the console::
@@ -689,14 +689,14 @@ The results of ODL tests can be seen in the console::
ODL result page
-.. figure:: ./images/functestODL.png
+.. figure:: ../images/functestODL.png
:width: 170mm
:align: center
:alt: ODL suite result page
ONOS
-----
+^^^^
The ONOS test logs can be found in OnosSystemTest/TestON/logs
(ONOSCI_PATH to be added),and also can be seen in the console::
@@ -778,16 +778,16 @@ If any problem occurs during the test, a ERROR message will be provided in the t
OpenContrail
-------------
+^^^^^^^^^^^^
TODO OVNO
Feature
-=======
+-------
vIMS
-----
+^^^^
The results in the console are very verbose::
@@ -861,7 +861,12 @@ steps:
* DEBUG - Pushing results to DB.... => tests saved
-==========================
+Promise
+^^^^^^^
+
+TODO Promise
+
+
Functest in test Dashboard
==========================
@@ -881,45 +886,46 @@ Overall Architecture
The Test result management in Brahmaputra can be summarized as follow::
- +-------------+ +-------------+ +-------------+
+ +-------------+ +-------------+ +-------------+
| | | | | |
| Test | | Test | | Test |
- | Project #1 | | Project #2 | | Project #N |
+ | Project #1 | | Project #2 | | Project #N |
| | | | | |
- +-------------+ +-------------+ +-------------+
+ +-------------+ +-------------+ +-------------+
| | |
- ▼ ▼ ▼
+ V V V
+-----------------------------------------+
| |
| Test Rest API front end |
| http://testresults.opnfv.org/testapi |
| |
+-----------------------------------------+
- ▲ |
- | ▼
+ A |
+ | V
| +-------------------------+
| | |
| | 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:
+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
@@ -940,7 +946,7 @@ Test project::
{
"id": <ID>,
"name": <Name of the Project>,
- "creation_date": "YYYY-MM-DD HH:MM:SS",
+ "creation_date": "YYYY-MM-DD HH:MM:SS",
"description": <Short description>
},
@@ -953,7 +959,7 @@ Test case::
"description": <short description>,
"url":<URL for longer description>
},
-
+
Test results::
{
@@ -968,156 +974,156 @@ Test results::
"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.
+
+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 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.
@@ -1128,57 +1134,57 @@ 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.
+Based on dashboard post-porcessed results, a Test dashboard is automatically
+generated.
TODO LF
or http://testresults.opnfv.org/proto/
-===============
+
Troubleshooting
===============
VIM
-===
+---
vPing
------
+^^^^^
vPing_userdata
---------------
+^^^^^^^^^^^^^^
Tempest
--------
+^^^^^^^
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. |
-+-----------------------------+------------------------------------------------+
+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
@@ -1188,33 +1194,32 @@ related Rally deployment folder.
Rally
------
+^^^^^
Same error causes than for Tempest mentioned above may lead to error in Rally.
Controllers
-===========
+-----------
ODL
----
+^^^
ONOS
-----
+^^^^
OpenContrail
-------------
+^^^^^^^^^^^^
Feature
-=======
+-------
vIMS
-----
+^^^^
-==========
References
==========
@@ -1227,7 +1232,7 @@ References
.. _`[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
+.. _`[10]`: https://git.opnfv.org/cgit/functest/tree/testcases/VIM/OpenStack/CI/rally_cert/task.yaml
OPNFV main site: opnfvmain_.