Add Test Coverage reporting.

jonathanza · Jan 28, 2023 · 2ebb1d9 · 2ebb1d9
1 parent d78644d
commit 2ebb1d9
Show file tree

Hide file tree

Showing 4 changed files with 107 additions and 24 deletions.
diff --git a/.coveragerc b/.coveragerc
@@ -0,0 +1,16 @@
+[run]
+
+include =
+    poker_*.py
+
+omit =
+    */__init__.py
+    */tests/*
+    */venv/*
+
+[report]
+exclude_lines =
+    raise NotImplementedError
+    return NotImplemented
+    return None
+    pass
diff --git a/Pipfile b/Pipfile
@@ -10,6 +10,7 @@ rich = "*"
 black = "*"
 pylint = "*"
 isort = "*"
+coverage = "*"
 
 [requires]
 python_version = "3.10"

diff --git a/Pipfile.lock b/Pipfile.lock
diff --git a/README.md b/README.md
@@ -1,6 +1,6 @@
 # PokerHand Class
 
-[![Codacy Badge](https://api.codacy.com/project/badge/Grade/53ae48d1931949baa8e1dd1855ea364e)](https://app.codacy.com/gh/jonathanza/poker_hands?utm_source=github.com&utm_medium=referral&utm_content=jonathanza/poker_hands&utm_campaign=Badge_Grade_Settings)
+[![Codacy Badge](https://app.codacy.com/project/badge/Grade/ec8a9ce37ca748f9b4226da7dd5efff9)](https://www.codacy.com/gh/jonathanza/poker_hands/dashboard?utm_source=github.com&utm_medium=referral&utm_content=jonathanza/poker_hands&utm_campaign=Badge_Grade) [![Codacy Badge](https://app.codacy.com/project/badge/Coverage/ec8a9ce37ca748f9b4226da7dd5efff9)](https://www.codacy.com/gh/jonathanza/poker_hands/dashboard?utm_source=github.com&utm_medium=referral&utm_content=jonathanza/poker_hands&utm_campaign=Badge_Coverage)
 
 The `PokerHand` class is a Python class that can be used to classify a poker hand into one of the following categories:
 
@@ -156,6 +156,14 @@ pipenv install --skip-lock --dev --pre
 pipenv shell
 ```
 
+### Test Coverage
+
+```bash
+coverage run -m unittest unit_tests.py
+coverage xml -o coverage.xml
+bash <(curl -Ls https://coverage.codacy.com/get.sh) report -r coverage.xml
+```
+
 ### Lint Code
 
 #### [Black](https://pypi.org/project/black/)