Describe how to run tests in the development docs

python-happybase · May 22, 2012 · 9cddacf · 9cddacf
1 parent 01f643b
commit 9cddacf
Showing 1 changed file with 21 additions and 0 deletions.
diff --git a/doc/development.rst b/doc/development.rst
@@ -9,4 +9,25 @@ The HappyBase source code repository is hosted on GitHub:
 
 Feel free to report issues. Patches are also most welcome.
 
+
+Test suite
+----------
+
+The tests use the `nose` test suite. To execute the tests, run:
+
+.. code-block:: sh
+
+   $ make test
+
+Test outputs are shown on the console. A test code coverage report is saved in
+`coverage/index.html`.
+
+If the Thrift server is not running on localhost, you can specify these
+environment variables (both are optional) before running the tests:
+
+.. code-block:: sh
+
+   $ export HAPPYBASE_HOST=host.example.org
+   $ export HAPPYBASE_PORT=9091
+
 .. vim: set spell spelllang=en: