X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=blobdiff_plain;f=src%2Fbindings%2Frmr-python%2Fdocs%2Fsource%2Findex.rst;h=8b354daf273892f3794b1d99ec0001e82b700353;hb=0b6077fcd74759b097964d49ccb57e36bd86f9bb;hp=cbda718dd3ba514bfaf50357ee1a467ed48ca1fe;hpb=0cb4b57403307f128b3597a52fa77cbc8524f078;p=ric-plt%2Flib%2Frmr.git diff --git a/src/bindings/rmr-python/docs/source/index.rst b/src/bindings/rmr-python/docs/source/index.rst index cbda718..8b354da 100644 --- a/src/bindings/rmr-python/docs/source/index.rst +++ b/src/bindings/rmr-python/docs/source/index.rst @@ -40,12 +40,24 @@ are not yet implemented in this library (do we need them?): Unit Testing ============ +You can unit test in docker or outside of docker. +The preferred method (by far) is to use Docker, because it encapsulates rmr, as well as ensuring that ports that rmr opens do not conflict with the host machine + +:: + + docker build -t rmrunittestt:latest -f Dockerfile-Unit-Test . + +A coverage report will be shown in stdout. + +It is possible to run tox locally provided that rmr is intalled, and you are prepared to have the test open ports (4562) as ``rmr_init`` must succeed for the tests to proceed. :: tox open htmlcov/index.html +The added benefit of the local option is that the coverage report can be viewed in html, which I find easier to read than the term coverage reort the docker build will print. + Installation ============