Running tests¶
Kolla-kubernetes contains a suite of tests in the kolla_kubernetes/tests
directories.
Any proposed code change in gerrit is automatically rejected by the OpenStack Jenkins server [1] 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 and it is safe to install tox in venv:
$virtualenv .venv
$source .venv/bin/activate
$ 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_kubernetes/tests
directory use:
$ tox -e py27 kolla_kubernetes.tests
To run the tests of a specific file say kolla_kubernetes/tests/test_utils.py:
$ tox -e py27 test_utils
To run the tests in the TestJinjaUtils class in
the kolla_kubernetes/tests/test_utils.py file:
$ tox -e py27 test_utils.TestJinjaUtils
To run the TestJinjaUtils.test_merge_configs_and_self_render test method in
the kolla_kubernetes/tests/test_utils.py file:
$ 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:
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.
Footnotes
| [1] | See http://docs.openstack.org/infra/system-config/jenkins.html |