Use constants from rmr for message summary

[ric-app/qp-driver.git] / docs / developers-guide.rst

diff --git a/docs/developers-guide.rst b/docs/developers-guide.rst
index bc8afd0..da078ff 100755 (executable)
--- a/docs/developers-guide.rst
+++ b/docs/developers-guide.rst
@@ -13,10 +13,33 @@ Developers Guide
 Testing RMR Healthcheck
 -----------------------
 The following instructions should deploy the QP Driver container in bare docker, and allow you
-to test that the rmr healthcheck is working.
+to test that the RMR healthcheck is working.
 
 ::
 
     docker build -t qpd:latest -f  Dockerfile .
     docker run -d --net=host -e USE_FAKE_SDL=1 qpd:latest
     docker exec -it CONTAINER_ID /usr/local/bin/rmr_probe -h 127.0.0.1:4562
+
+Unit Testing
+------------
+
+Running the unit tests requires the python packages ``tox`` and ``pytest``.
+
+The RMR library is also required during unit tests. If running directly from tox
+(outside a Docker container), install RMR according to its instructions.
+
+Upon completion, view the test coverage like this:
+
+::
+
+   tox
+   open htmlcov/index.html
+
+Alternatively, if you cannot install RMR locally, you can run the unit
+tests in Docker. This is somewhat less nice because you don't get the
+pretty HTML report on coverage.
+
+::
+
+   docker build  --no-cache -f Dockerfile-Unit-Test .