Update README with test running instructions.

Change-Id: I772b8fda5abdd07bc212a5fc7358e4b712425cd2

1 files changed, 19 insertions, 0 deletions

diff --git a/README.rst b/README.rst
index 4a3aa1a..8b4dee9 100644
--- a/README.rst
+++ b/README.rst
@@ -73,3 +73,22 @@ oslo.packaging functionality will not be enabled.
 It should also work fine if additional arguments are passed to `setup()`,
 but it should be noted that they will be clobbered by any options in the
 setup.cfg file.
+
+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