From ad397b4dd7e579a71759617e879bbf948d9f9ce9 Mon Sep 17 00:00:00 2001 From: Eric Harney Date: Mon, 15 Jan 2018 17:06:30 -0500 Subject: [PATCH] Add contributor notes on how to use pdb with tests Change-Id: Ib15a4c06f80dfcfaff2f195ecf0f3afbfb5bfa0b --- doc/source/contributor/testing.rst | 28 ++++++++++++++++++++++++++++ 1 file changed, 28 insertions(+) diff --git a/doc/source/contributor/testing.rst b/doc/source/contributor/testing.rst index 754ff5a2fb8..c900035e75f 100644 --- a/doc/source/contributor/testing.rst +++ b/doc/source/contributor/testing.rst @@ -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