kolla/doc/source/contributor/running-tests.rst

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 Zuul CI system 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, test-requirements.txt and doc/requirements.txt files, so the only package you install is tox itself:

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 3.8 tests:

tox -e py38

To run the style tests:

tox -e pep8

To run multiple tests separate items by commas:

tox -e py38,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, for example, filter full names of tests by a string.

To run the tests located only in the kolla/tests directory:

tox -e py38 kolla.tests

To run the tests of a specific file say kolla/tests/test_set_config.py:

tox -e py38 test_set_config

To run the tests in the ConfigFileTest class in the kolla/tests/test_set_config.py file:

tox -e py38 test_set_config.ConfigFileTest

To run the ConfigFileTest.test_delete_path_not_exists test method in the kolla/tests/test_set_config.py file:

tox -e py38 test_set_config.ConfigFileTest.test_delete_path_not_exists

Coverage Report Generation

In order to get coverage report for Kolla, run the below command.

tox -e cover

Debugging unit tests

In order to break into the debugger from a unit test we need to insert a breaking point to the code:

import pdb; pdb.set_trace()

Then run tox with the debug environment as one of the following:

tox -e debug
tox -e debug test_file_name.TestClass.test_name

For more information see the oslotest documentation <user/features.html#debugging-with-oslo-debug-helper>.

Footnotes