diff options
| author | John Levon <john.levon@nutanix.com> | 2021-11-12 15:27:23 +0000 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2021-11-12 15:27:23 +0000 |
| commit | ace83abb5d62ef91bafd20219be1bdaf4f57f091 (patch) | |
| tree | 374c1c3179dd2d3df5b0941dbfee09942c3fd074 /docs | |
| parent | 353fee1349a1917e01bda8f225554e7f71939364 (diff) | |
| download | libvfio-user-ace83abb5d62ef91bafd20219be1bdaf4f57f091.zip libvfio-user-ace83abb5d62ef91bafd20219be1bdaf4f57f091.tar.gz libvfio-user-ace83abb5d62ef91bafd20219be1bdaf4f57f091.tar.bz2 | |
add a doc on testing
Split out testing information to a separate document.
Signed-off-by: John Levon <john.levon@nutanix.com>
Reviewed-by: Swapnil Ingle <swapnil.ingle@nutanix.com>
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/testing.md | 17 |
1 files changed, 17 insertions, 0 deletions
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. |