From 638ccd537fc3de33767ea6116af3789957d9c98c Mon Sep 17 00:00:00 2001 From: Sayan Chowdhury Date: Jun 18 2019 05:34:42 +0000 Subject: Update the README and to include how to generate coverage report Signed-off-by: Sayan Chowdhury --- diff --git a/README.md b/README.md index 9b9fd89..813f2e6 100644 --- a/README.md +++ b/README.md @@ -42,6 +42,16 @@ You can run the unit-tests, which live in the `joystick.tests` package, with the python3 -m pytest joystick ``` +To generate the test coverage report, run the following command: + +``` +python3 -m pytest --cov=joystick --cov-report html joystick +cd htmlcov +python3 -m http.server +``` + +Once the last command fires up the server, head over to `http://localhost:8000/` in your browser. + ### Copyright and License This project is copyright Red Hat and other contributors, licensed under the terms of the GNU General Public License version 3. See the `LICENSE` file for the complete text of the license. Refer to the git history for complete authorship details diff --git a/htmlcov/index.html b/htmlcov/index.html index 430b85e..cd03667 100644 --- a/htmlcov/index.html +++ b/htmlcov/index.html @@ -22,7 +22,7 @@