diff --git a/TESTING.rst b/TESTING.rst index d18128661..5d3b8e757 100644 --- a/TESTING.rst +++ b/TESTING.rst @@ -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 ========== diff --git a/doc/source/devref/index.rst b/doc/source/devref/index.rst index 1b7fb8147..cb18f72c1 100644 --- a/doc/source/devref/index.rst +++ b/doc/source/devref/index.rst @@ -35,6 +35,7 @@ Contents: drivers_architecture hostconfig maintenance + testing Indices and tables diff --git a/doc/source/devref/testing.rst b/doc/source/devref/testing.rst new file mode 100644 index 000000000..4735fa614 --- /dev/null +++ b/doc/source/devref/testing.rst @@ -0,0 +1 @@ +.. include:: ../../../TESTING.rst diff --git a/releasenotes/notes/functional-test-b0855d6f1d85da30.yaml b/releasenotes/notes/functional-test-b0855d6f1d85da30.yaml new file mode 100644 index 000000000..a94628e52 --- /dev/null +++ b/releasenotes/notes/functional-test-b0855d6f1d85da30.yaml @@ -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