openstack/kolla-ansible
Code Issues Proposed changes
4df7d69874
kolla-ansible/doc/source/contributor/running-tests.rst
Michal Nasiadka d8f31e0a5e CI: Add ansible-lint to tox 
* Reworked tox pep8 into linters job, that runs:
  - pep8
  - bandit
  - bashate
  - doc8
  - yamllint
  - ansible-lint (validate-all-files.py + ansible-lint)

* Skip E701 - missing galaxy_info in meta and E602 see [1].
* Skip E301 and E503 - followup later in a separate change
* Added ansible-role-jobs to zuul.d/project.yaml which will run
  openstack-tox-linters job in check queue
* Fixed remaining style issue
* Made tox and docs reference the new env for linters
* Dropped pype environment (not supported)

[1]: https://github.com/ansible/ansible-lint/issues/457

Change-Id: I494b4b151804aac8173120e6c6e42bc2fdb00234
2020-05-17 17:02:38 +02:00

2.6 KiB
Raw Blame History

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

pip install tox

For more information, see the unit testing section of the Testing wiki page. For example:

To run the default set of tests:

tox

To run the Python 3.7 tests:

tox -e py37

To run the style tests:

tox -e linters

To run multiple tests separate items by commas:

tox -e py37,linters

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:

tox -e py37 kolla-ansible.tests

To run the tests of a specific file kolla-ansible/tests/test_kolla_docker.py:

tox -e py37 test_kolla_docker

To run the tests in the ModuleArgsTest class in the kolla-ansible/tests/test_kolla_docker.py file:

tox -e py37 test_kolla_docker.ModuleArgsTest

To run the ModuleArgsTest.test_module_args test method in the kolla-ansible/tests/test_kolla_docker.py file:

tox -e py37 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 <user/features.html#debugging-with-oslo-debug-helper>.