From 2828bfcfb0fd8df92072fcc72655e2f683a95bdc Mon Sep 17 00:00:00 2001 From: Eric Harney Date: Mon, 19 Oct 2015 14:57:44 -0400 Subject: [PATCH] devref doc: assorted fixes in "Unit Tests" 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 --- doc/source/devref/unit_tests.rst | 12 +++++++----- 1 file changed, 7 insertions(+), 5 deletions(-) diff --git a/doc/source/devref/unit_tests.rst b/doc/source/devref/unit_tests.rst index 3e4e9c3a00a..c0287455f10 100644 --- a/doc/source/devref/unit_tests.rst +++ b/doc/source/devref/unit_tests.rst @@ -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 `_. 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.