add dev advice on running code coverage

censoredplanet · Nov 2, 2021 · b934f2a · b934f2a
1 parent 4f125ad
commit b934f2a
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 1 deletion.
diff --git a/.gitignore b/.gitignore
@@ -3,4 +3,5 @@ env/
 **/*egg-info/*
 pipeline/assets/GeoLite2*.mmdb
 .vscode/
-**/*.pyc
+**/*.pyc
+.coverage
diff --git a/docs/development.md b/docs/development.md
@@ -31,6 +31,16 @@ command
 
     python -m unittest pipeline.manual_e2e_test.PipelineManualE2eTest
 
+To view unit test code coverage install `coverage` and run
+
+    python -m coverage run --source="pipeline/" -m unittest
+    python -m coverage report -m --omit="*test*"
+
+To view E2E test code coverage run
+
+     python -m coverage run --source="pipeline/" -m unittest pipeline.manual_e2e_test.PipelineManualE2eTest
+     python -m coverage report -m --omit="*test*"
+
 ## Running development pipelines
 
 To test changes before merging them into production it helps to run development