aboutsummaryrefslogtreecommitdiffstats
path: root/docs/functest.rst
diff options
context:
space:
mode:
Diffstat (limited to 'docs/functest.rst')
-rw-r--r--docs/functest.rst127
1 files changed, 72 insertions, 55 deletions
diff --git a/docs/functest.rst b/docs/functest.rst
index 4276594e6..3db860f51 100644
--- a/docs/functest.rst
+++ b/docs/functest.rst
@@ -76,6 +76,22 @@ For release 1, the tools are automatically installed, but the tests are not full
.. _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
@@ -292,7 +308,7 @@ This script will:
When integrated in CI, 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.
+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
@@ -314,59 +330,60 @@ Retrieve OpenStack source file (configure your `OpenRC`_ file to let Rally acces
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
- ├── 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
+ |-- 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
@@ -537,7 +554,7 @@ OpenDaylight
.. _`functest wiki (ODL section)`: https://wiki.opnfv.org/r1_odl_suite
-The results of ODL tests can be seen in the console::
+The results of ODL tests can be seen in the console::
==============================================================================
Basic