From b88a0fc5fad9c79eb2eecf15ef45b2db55a3e565 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Sebasti=C3=A1n=20Ram=C3=ADrez?= Date: Mon, 20 Apr 2020 20:45:32 +0200 Subject: [PATCH] :memo: Add docs about reporting coverage in HTML (#161) --- {{cookiecutter.project_slug}}/README.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/{{cookiecutter.project_slug}}/README.md b/{{cookiecutter.project_slug}}/README.md index c0a2acf561..beff9d1dac 100644 --- a/{{cookiecutter.project_slug}}/README.md +++ b/{{cookiecutter.project_slug}}/README.md @@ -174,6 +174,22 @@ For example, to stop on first error: docker-compose exec backend bash /app/tests-start.sh -x ``` +#### Test Coverage + +Because the test scripts forward arguments to `pytest`, you can enable test coverage HTML report generation by passing `--cov-report=html`. + +To run the local tests with coverage HTML reports: + +```Bash +DOMAIN=backend sh ./scripts/test-local.sh --cov-report=html +``` + +To run the tests in a running stack with coverage HTML reports: + +```bash +docker-compose exec backend bash /app/tests-start.sh --cov-report=html +``` + ### Live development with Python Jupyter Notebooks If you know about Python [Jupyter Notebooks](http://jupyter.org/), you can take advantage of them during local development.