aboutsummaryrefslogtreecommitdiff
path: root/HACKING
diff options
context:
space:
mode:
Diffstat (limited to 'HACKING')
-rw-r--r--HACKING17
1 files changed, 17 insertions, 0 deletions
diff --git a/HACKING b/HACKING
new file mode 100644
index 0000000..b641e8c
--- /dev/null
+++ b/HACKING
@@ -0,0 +1,17 @@
+Tests Code Coverage
+===================
+
+To have a nicely HTML viewable report on tests code coverage, do as follows:
+
+* Install `python-coverage` (`pip install coverage` in case you use pip)
+* Run the following command:
+
+ python-coverage run -m unittest lava_tool.tests.test_suite 2>/dev/null && python-coverage html
+
+* The report will be saved in a directory called `lava_tool_coverage`: open
+the `index.html` file in there to see the report.
+
+Notes:
+
+ * To re-run the coverage report, you have to delete the `lava_tool_coverage`
+directory first, otherwise `python-coverage` will fail.