diff options
| -rw-r--r-- | README.md | 8 | ||||
| -rw-r--r-- | docs/testing.md | 17 |
2 files changed, 22 insertions, 3 deletions
@@ -61,13 +61,10 @@ Build requirements: * `cmake` (v2 or above) * `apt install libjson-c-dev libcmocka-dev libssl-dev` *or* * `yum install json-c-devel libcmocka-devel openssl-devel` - * `valgrind` for testing To build: make && make install - # optional - make test By default a debug build is created. To create a release build do: @@ -276,6 +273,11 @@ backed by hugepages: Becasue SPDK must be run as root, either fix the vfio-user socket permissions or configure libvirt to run QEMU as root. +Testing +======= + +See [Testing](docs/testing.md). + History ======= diff --git a/docs/testing.md b/docs/testing.md new file mode 100644 index 0000000..6da018e --- /dev/null +++ b/docs/testing.md @@ -0,0 +1,17 @@ +Testing +======= + +Running `make test` runs most of the integrated tests. You should have +`valgrind` installed. + +Running `make pre-push` runs the above builds and tests in different configurations: GCC, +clang, and with ASAN enabled. + +There are some [older unit tests](test/unit-tests.c) written in C, but most +tests are now done via Python, in the [test/py](test/py) sub-directory. You can +run just the Python tests via `make pytest` or `make pytest-valgrind`. + +The master branch is run through [Coverity](scan.coverity.com) when a new PR +lands. + +You can also run `make gcov` to get code coverage reports. |