X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=blobdiff_plain;ds=sidebyside;f=redismodule%2FREADME.md;h=7bccee0c1c04ba99afe6ea12b20eda747ede1675;hb=c1df826a579f8d52abb7f7c5a490fec3f7a1c7cb;hp=306edd88e33d5bddeb5837cb6cad37b912b1597f;hpb=a9dd09828c123da4387067c38dedcb54fd348dff;p=ric-plt%2Fdbaas.git diff --git a/redismodule/README.md b/redismodule/README.md index 306edd8..7bccee0 100755 --- a/redismodule/README.md +++ b/redismodule/README.md @@ -3,24 +3,29 @@ This subdirectory provides implementation for the commands which are implemented as a [Redis modules](https://redis.io/topics/modules-intro). -# Compiling and UT (Unit Tests) +# Compiling and Unit Tests -To compile and install run standard automake commands -in the redismodule directory: +To compile, run unit tests and install use the commands: ``` ./autogen.sh ./configure make +make test make install ``` -To run unit tests `cpputest` and `valgrind` -need to be installed as additional dependencies. -To enable and run unit tests use the commands: +By default unit tests and valgrind memory checking are enabled. +This requires `cpputest` and `valgrind` as additional dependencies. +Unit test memory checking can be disabled with the `configure` option +`--disable-unit-test-memcheck` and the unit tests can be completely disabled +with the `configure` option `--disable-unit-test`. +For example to compile and install with unit tests completely disabled +one would run the commands: ``` ./autogen.sh -./configure --enable-unit-test -make test +./configure --disable-unit-test +make +make install ``` # Commands