kolla-ansible/doc/source/contributor/running-tests.rst
chenxing 31526d4c26 doc: Start using openstackdoctheme's extlink extension
This ensures we have version-specific references to other projects [1].
Note that this doesn't mean the URLs are actually valid - we need to do
more work (linkcheck?) here, but it's an improvement nonetheless.

[1] https://docs.openstack.org/openstackdocstheme/latest/#external-link-helper

Change-Id: I118e4d211617c5df66ff04dc04e308a1d2fc67ad
2019-06-17 23:00:42 +08:00

103 lines
2.5 KiB
ReStructuredText

.. _running-tests:
=============
Running tests
=============
Kolla-ansible contains a suit of tests in the ``tests`` directory.
Any proposed code change in gerrit is automatically rejected by the
`Zuul CI system <https://docs.openstack.org/infra/system-config/zuulv3.html>`__
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
For more information, see `the unit testing section of the Testing wiki page
<https://wiki.openstack.org/wiki/Testing#Unit_Tests>`_. For example:
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,py37,pep8
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
string.
To run the tests located only in the ``kolla-ansible/tests``
directory use:
.. code-block:: console
tox -e py27 kolla-ansible.tests
To run the tests of a specific file
``kolla-ansible/tests/test_kolla_docker.py``:
.. code-block:: console
tox -e py27 test_kolla_docker
To run the tests in the ``ModuleArgsTest`` class in
the ``kolla-ansible/tests/test_kolla_docker.py`` file:
.. code-block:: console
tox -e py27 test_kolla_docker.ModuleArgsTest
To run the ``ModuleArgsTest.test_module_args`` test method in
the ``kolla-ansible/tests/test_kolla_docker.py`` file:
.. code-block:: console
tox -e py27 test_kolla_docker.ModuleArgsTest.test_module_args
Debugging unit tests
--------------------
In order to break into the debugger from a unit test we need to insert
a breaking point to the code:
.. code-block:: python
import pdb; pdb.set_trace()
Then run ``tox`` with the debug environment as one of the following:
.. code-block:: console
tox -e debug
tox -e debug test_file_name.TestClass.test_name
For more information, see the :oslotest-doc:`oslotest documentation
<user/features.html#debugging-with-oslo-debug-helper>`.