summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorWouter Bolsterlee <uws@xs4all.nl>2012-05-22 23:14:03 +0200
committerWouter Bolsterlee <uws@xs4all.nl>2012-05-22 23:14:03 +0200
commit9cddacff2c30591ce63bcbe90e14e4d1364daef2 (patch)
treefce76273dd4abd382d5f2d4fd4527b659442097c /doc
parent01f643bee6f71f1af1a52ecd06170b8a1f0ef578 (diff)
downloadhappybase-9cddacff2c30591ce63bcbe90e14e4d1364daef2.tar.gz
Describe how to run tests in the development docs
Diffstat (limited to 'doc')
-rw-r--r--doc/development.rst21
1 files changed, 21 insertions, 0 deletions
diff --git a/doc/development.rst b/doc/development.rst
index a05e3e2..943078c 100644
--- 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: