openstack
/
keystone
Code Issues Proposed changes

Document running with pdb 

There was no documentation in "Developing with Keystone" that
makes it obvious that you can use "tox -e debug" to run with pdb
breakpoints.

Change-Id: I82cc827d076a4d95ab6a2f903ceb0cde34005bc3
This commit is contained in:
Brant Knudson 2014-01-12 11:32:15 -06:00
parent eb79d256b3
commit 8ac5b7576d
1 changed files with 15 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
doc/source/developing.rst
View File

@ -160,6 +160,21 @@ common configuration of Python 2.7 and PEP-8), list the environments with the
See ``tox.ini`` for the full list of available test environments.
Running with PDB
~~~~~~~~~~~~~~~~
Using PDB breakpoints with tox and testr normally doesn't work since the tests
just fail with a BdbQuit exception rather than stopping at the breakpoint.
To run with PDB breakpoints during testing, use the ``debug`` tox environment
rather than ``py27``. Here's an example, passing the name of a test since
you'll normally only want to run the test that hits your breakpoint::
$ tox -e debug keystone.tests.test_auth.AuthWithToken.test_belongs_to
For reference, the ``debug`` tox environment implements the instructions
here: https://wiki.openstack.org/wiki/Testr#Debugging_.28pdb.29_Tests
Test Structure
==============