summaryrefslogtreecommitdiffstats
path: root/HACKING.rst
diff options
context:
space:
mode:
authorMonty Taylor <mordred@inaugust.com>2013-02-11 15:22:24 -0600
committerMonty Taylor <mordred@inaugust.com>2013-02-11 19:04:43 -0800
commitb7714e82fdbede2dfe328eaae0add07f6e2b92c5 (patch)
tree5f8d6bf45e4b36ce473b0c68be156599eb6fd05d /HACKING.rst
parentf9c4cd90a94516ec05acbb62b13b48af646fa218 (diff)
downloadnova-b7714e82fdbede2dfe328eaae0add07f6e2b92c5.tar.gz
nova-b7714e82fdbede2dfe328eaae0add07f6e2b92c5.tar.xz
nova-b7714e82fdbede2dfe328eaae0add07f6e2b92c5.zip
Update docs about testing.
Add an entry to the HACKING file about testr. While in there, noticed a reference to the now-defunct nova/testing dir. Fixed that, moved the testing README into nova/tests and remove the nova/testing dir. Change-Id: Ibf6fb82658ba73eee9123fa53b340d0b72afb292
Diffstat (limited to 'HACKING.rst')
-rw-r--r--HACKING.rst22
1 files changed, 21 insertions, 1 deletions
diff --git a/HACKING.rst b/HACKING.rst
index 213495832..fade33ee4 100644
--- a/HACKING.rst
+++ b/HACKING.rst
@@ -218,7 +218,27 @@ submitted bug fix does have a unit test, be sure to add a new one that fails
without the patch and passes with the patch.
For more information on creating unit tests and utilizing the testing
-infrastructure in OpenStack Nova, please read nova/testing/README.rst.
+infrastructure in OpenStack Nova, please read nova/tests/README.rst.
+
+
+Running Tests
+-------------
+The testing system is based on a combination of tox and testr. The canonical
+approach to running tests is to simply run the command `tox`. This will
+create virtual environments, populate them with depenedencies and run all of
+the tests that OpenStack CI systems run. Behind the scenes, tox is running
+`testr run --parallel`, but is set up such that you can supply any additional
+testr arguments that are needed to tox. For example, you can run:
+`tox -- --analyze-isolation` to cause tox to tell testr to add
+--analyze-isolation to its argument list.
+
+It is also possible to run the tests inside of a virtual environment
+you have created, or it is possible that you have all of the dependencies
+installed locally already. In this case, you can interact with the testr
+command directly. Running `testr run` will run the entire test suite. `testr
+run --parallel` will run it in parallel (this is the default incantation tox
+uses.) More information about testr can be found at:
+http://wiki.openstack.org/testr
openstack-common