From a19593e86182aac25e32dc0c626ef883bd55498b Mon Sep 17 00:00:00 2001 From: Nir Soffer Date: Sun, 30 Jul 2023 20:12:15 +0300 Subject: [PATCH] Document running the tests and inspecting coverage Signed-off-by: Nir Soffer --- docs/devel-quick-start.md | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) diff --git a/docs/devel-quick-start.md b/docs/devel-quick-start.md index 65a46e60f..017878d09 100644 --- a/docs/devel-quick-start.md +++ b/docs/devel-quick-start.md @@ -74,6 +74,30 @@ enough resources: That's all! You are ready to submit your first pull request! +## Running the tests + +To run all unit tests run: + +``` +make test +``` + +To run only part of the test suite you can use one of the `test-*` +targets, for example: + +``` +make test-vrg-vr +``` + +To open an HTML coverage report in the default browser run: + +``` +make coverage +``` + +The coverage report depends on the tests ran before inspecting the +coverage. + ## Setting up the `drenv` tool *Ramen* uses the `drenv` tool to build a development environment