Kolla contains a suite of tests in the
Any proposed code change in gerrit is automatically rejected by the OpenStack Jenkins server1 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
test-requirements.txt files, so the only package you install is
$ 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:
$ tox -e py27
To run the style tests:
$ tox -e pep8
To run multiple tests separate items by commas:
$ tox -e py27,py35,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/tests directory use:
$ tox -e py27 kolla.tests
To run the tests of a specific file say
$ tox -e py27 test_set_config
To run the tests in the
ConfigFileTest class in the
$ tox -e py27 test_set_config.ConfigFileTest
To run the
ConfigFileTest.test_delete_path_not_exists test method in the
$ tox -e py27 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()
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.