functional test: documentation and relnotes

This patch adds releasenotes and documentation on how to run functional
tests.

Change-Id: I1b4a15d233470e32154586e3552b97e5b397fcdf
Closes-bug: #1647516
This commit is contained in:
Isaku Yamahata
2016-12-01 10:25:12 -08:00
parent 6b6b9ba8f9
commit da6128136b
4 changed files with 43 additions and 0 deletions

View File

@@ -166,6 +166,38 @@ Editable mode ensures that changes made to the source tree are
automatically reflected in the venv, and that such changes are not
overwritten during the next tox run.
Running functional tests
------------------------
Neutron defines different classes of test cases. One of them is functional
test. It requires pre-configured environment. But it's lighter than
running devstack or openstack deployment.
For definitions of functional tests, please refer to:
http://docs.openstack.org/developer/neutron/devref/development.environment.html#functional-tests
The script is provided to setup the environment.
At first make sure the latest version of pip command::
# ensure you have the latest version of pip command
# for example on ubuntu
$ sudo apt-get install python-pip
$ sudo pip --upgrade pip
And then run functional test as follows::
# assuming devstack is setup with networking-odl
$ cd networking-odl
$ ./tools/configure_for_func_testing.sh /path/to/devstack
$ tox -e dsvm-functional
For setting up devstack, please refer to neutron documentation:
https://wiki.openstack.org/wiki/NeutronDevstack
http://docs.openstack.org/developer/neutron/index.html
https://git.openstack.org/cgit/openstack/neutron/tree/TESTING.rst
References
==========

View File

@@ -35,6 +35,7 @@ Contents:
drivers_architecture
hostconfig
maintenance
testing
Indices and tables

View File

@@ -0,0 +1 @@
.. include:: ../../../TESTING.rst

View File

@@ -0,0 +1,9 @@
---
prelude: >
The new class of test cases, functional test, has been
added. So was help scripts to setup necessary environment.
other:
- The functional tests were added. It's new class of test cases,
which requires pre-configured environment. Environment to
run such tests can be configured by tool in
networking-odl/tools.configure_for_func_testing.sh