Added test document

This doc explain how to run kolla tests.

Change-Id: I498e18187c2c69bbd37c490ce4e1a8548f933791
Partially-implements: blueprint documentation-rework
This commit is contained in:
MD NADEEM 2016-06-10 10:13:44 +05:30 committed by Md Nadeem
parent 319fd3e794
commit 66b6eccd1b
2 changed files with 89 additions and 0 deletions

View File

@ -67,3 +67,4 @@ Developer Docs

doc/running-tests.rst Normal file
View File

@ -0,0 +1,88 @@
.. _running-tests:
Running tests
Kolla contains a suite of tests in the
``tests`` and ``kolla/tests`` directories.
Any proposed code change in gerrit is automatically rejected by the OpenStack
Jenkins server [#f1]_ if the change causes test failures.
It is recommended for developers to run the test suite before submitting patch
for review. This allows to catch errors as early as possible.
Preferred way to run the tests
The preferred way to run the unit tests is using ``tox``. It executes tests in
isolated environment, by creating separate virtualenv and installing
dependencies from the ``requirements.txt`` and ``test-requirements.txt`` files,
so the only package you install is ``tox`` itself:
.. code-block:: console
$ pip install tox
See `the unit testing section of the Testing wiki page`_ for more information.
Following are some simple examples.
To run the Python 2.7 tests:
.. code-block:: console
$ tox -e py27
To run the style tests:
.. code-block:: console
$ tox -e pep8
To run multiple tests separate items by commas:
.. code-block:: console
$ tox -e py27,py34,pep8
.. _the unit testing section of the Testing wiki page:
Running a subset of tests
Instead of running all tests, you can specify an individual directory, file,
class or method that contains test code, i.e. filter full names of tests by a
To run the tests located only in the ``kolla/tests``
directory use:
.. code-block:: console
$ tox -e py27 kolla.tests
To run the tests of a specific file say ``kolla/tests/``:
.. code-block:: console
$ tox -e py27 test_kolla_docker
To run the tests in the ``ModuleArgsTest`` class in
the ``kolla/tests/`` file:
.. code-block:: console
$ tox -e py27 test_kolla_docker.ModuleArgsTest
To run the ``ModuleArgsTest.test_module_args`` test method in
the ``kolla/tests/``` file:
.. code-block:: console
$ tox -e py27 test_kolla_docker.ModuleArgsTest.test_module_args
.. rubric:: Footnotes
.. [#f1] See