Add contributor notes on how to use pdb with tests

Change-Id: Ib15a4c06f80dfcfaff2f195ecf0f3afbfb5bfa0b
This commit is contained in:
Eric Harney 2018-01-15 17:06:30 -05:00
parent 5419ca908c
commit ad397b4dd7

View File

@ -211,3 +211,31 @@ Therefore, it is preferable to use:
.. rubric:: Footnotes
.. [#f1] See :doc:`jenkins`.
Debugging
---------
**Debugging unit tests**
It is possible to attach a debugger to unit tests.
First, modify the test you want to debug by adding the
following to the test code itself:
.. code-block:: python
import pdb
pdb.set_trace()
Then run the unit test with pdb enabled:
.. code-block:: bash
source .tox/py35/bin/activate
testr init
ostestr --pdb cinder.tests.unit.test_volume_utils
# or
ostestr -n cinder.tests.unit.test_volume_utils
# or
ostestr -n cinder/tests/unit/test_context.py