blob: 88b13feacc4edf03eb4793e795772ba98fd1248a (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
|
.. _running-tests:
=============
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 <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``, ``test-requirements.txt`` and
``doc/requirements.txt`` files, so the only package you install is ``tox``
itself:
.. code-block:: console
pip install tox
See the `unit testing <https://wiki.openstack.org/wiki/Testing#Unit_Tests>`__
section of the Testing wiki page for more information.
Following are some simple examples.
To run the Python 3.8 tests:
.. code-block:: console
tox -e py38
To run the style tests:
.. code-block:: console
tox -e pep8
To run multiple tests separate items by commas:
.. code-block:: console
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:
.. code-block:: console
tox -e py38 kolla.tests
To run the tests of a specific file say ``kolla/tests/test_set_config.py``:
.. code-block:: console
tox -e py38 test_set_config
To run the tests in the ``ConfigFileTest`` class in
the ``kolla/tests/test_set_config.py`` file:
.. code-block:: console
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:
.. code-block:: console
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.
.. code-block:: console
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:
.. code-block:: python
import pdb; pdb.set_trace()
Then run :command:`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>`.
.. rubric:: Footnotes
|
