From ace83abb5d62ef91bafd20219be1bdaf4f57f091 Mon Sep 17 00:00:00 2001 From: John Levon Date: Fri, 12 Nov 2021 15:27:23 +0000 Subject: add a doc on testing Split out testing information to a separate document. Signed-off-by: John Levon Reviewed-by: Swapnil Ingle --- docs/testing.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) create mode 100644 docs/testing.md (limited to 'docs') 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. -- cgit v1.1