openstack/cinder
Code Issues Proposed changes

devref doc: assorted fixes in "Unit Tests"

Browse Source 
Fix the example command for running a unit test.
(Colon versus period.)

Fix box formatting for tox commands.  (Need extra
newline after double colon.)

Fix a typo in the same section.

Fix broken ostestr doc link.

Remove testr and flake8 links that don't go anywhere.

Change-Id: I243e4f0639ef4a87e8950e0428b7556919094b0e
This commit is contained in:
Eric Harney 2015-10-19 14:57:44 -04:00
parent a2259f7c6c
commit 2828bfcfb0
1 changed files with 7 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
doc/source/devref/unit_tests.rst
View File

@ -23,13 +23,15 @@ Running a subset of tests using tox
-----------------------------------
One common activity is to just run a single test, you can do this with tox simply by
specifying to just run py27 or py34 tests against a single test::
tox -epy27 -- -n cinder.tests.unit.test_volume:AvailabilityZoneTestCase.test_list_availability_zones_cached
Or all file in the test_volume.py file::
tox -epy27 -- -n cinder.tests.unit.test_volume.AvailabilityZoneTestCase.test_list_availability_zones_cached
Or all tests in the test_volume.py file::
tox -epy27 -- -n cinder.tests.unit.test_volume
For more information on these options and how to run tests, please see the ostestr
documentation _a link: http://docs.openstack.org/developer/os-testr/
For more information on these options and how to run tests, please see the `ostestr
documentation <http://docs.openstack.org/developer/os-testr/>`_.
Run tests wrapper script
------------------------
@ -38,7 +40,7 @@ In addition you can also use the wrapper script run_tests.sh by simply executing
./run_tests.sh
This script is a wrapper around the `testr`_ testrunner and the `flake8`_ checker. Note that
This script is a wrapper around the testr testrunner and the flake8 checker. Note that
there has been talk around deprecating this wrapper and this method of testing, it's currently
available still but it may be good to get used to using tox or even ostestr directly.