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=29a6c94aa72008a01135e25e3d28b4e9241792d0;hpb=91aa7028e6bb9e16c16d119cec608c8395e8e322;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 29a6c94..8b354da 100644 --- a/src/bindings/rmr-python/docs/source/index.rst +++ b/src/bindings/rmr-python/docs/source/index.rst @@ -40,18 +40,23 @@ are not yet implemented in this library (do we need them?): Unit Testing ============ -You can unit test outside of docker, or in docker. Unit testing outside of docker currently requires rmr to be installed. +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 :: - tox - open htmlcov/index.html + docker build -t rmrunittestt:latest -f Dockerfile-Unit-Test . + +A coverage report will be shown in stdout. -Or, use the provided Dockerfile (building is enough): +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. :: - docker build -t rmrunittestt:latest -f Dockerfile-Unit-Test . + 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 ============