Merge pull request #20 from viperior/feature/code-coverage

Code Coverage Analysis

Author: dagpunk

.github/workflows/python-app.yml

@@ -32,4 +32,5 @@ jobs:
         pytest -v -x -n auto
     - name: Test with pytest
       run: |
-        pytest -v
+        python -m coverage run -m pytest -v
+        coverage report -m --fail-under 100

CHANGELOG.md

@@ -1,5 +1,18 @@
 # Changelog
 
+## [0.7.0](https://github.com/viperior/python-project-template/tree/v0.7.0) (2022-02-25)
+
+### Improvements
+
+* Measure code coverage using `coverage` and require 100% code coverage to pass PR checks (closes [#9][i9])
+
+### Testing
+
+* Improve the design of the `test_flip_coins_function` to use parametrized test input data and run multiple times with a range of coin count inputs
+* Exclude pylint success/failure reporting from code coverage measurement
+
+[i9]: https://github.com/viperior/python-project-template/issues/9
+
 ## [0.6.0](https://github.com/viperior/python-project-template/tree/v0.6.0) (2022-02-25)
 
 ### Improvements

requirements.in

@@ -1,3 +1,4 @@
+coverage==6.3.2
 pylint==2.12.2
 pytest==7.0.1
 pytest-xdist==2.5.0

requirements.txt

@@ -8,6 +8,8 @@ astroid==2.9.0
     # via pylint
 attrs==21.2.0
     # via pytest
+coverage==6.3.2
+    # via -r requirements.in
 execnet==1.9.0
     # via pytest-xdist
 iniconfig==1.1.1

tests/test_flip_coins_function.py

@@ -2,16 +2,26 @@
 
 import logging
 
+import pytest
+
 from games_of_chance.flip_coins import flip_coins
 
 
-def test_foo_function() -> None:
+@pytest.mark.parametrize("coin_count", list(range(11)) + list(range(10, 200, 10)) + [1, 2] * 30)
+def test_foo_function(coin_count: int) -> None:
     """Example test case
 
+    Parameters:
+    coin_count (int): The number of coins to flip
+
     Returns:
     None
     """
-    coin_flip_result = flip_coins(coins_to_flip=10, chosen_side="heads")
-    logging.debug("coin_flip_result = %s", coin_flip_result)
+    try:
+        coin_flip_result = flip_coins(coins_to_flip=coin_count, chosen_side="heads")
+        logging.debug("coin_flip_result = %s", coin_flip_result)
 
-    assert coin_flip_result["result"] in ["won", "lost", "tie"]
+        assert coin_flip_result["result"] in ["won", "lost", "tie"]
+    except AssertionError as error:
+        # Validate that trying to flip 0 coins causes an error
+        assert isinstance(error, AssertionError) and coin_count == 0

tests/test_python_code_quality.py

@@ -17,7 +17,9 @@ def test_python_code_quality() -> None:
     pylint_error_free_search_phrase = "Your code has been rated at 10.00/10"
     pylint_errors_detected = pylint_error_free_search_phrase not in standard_output_data
 
-    if pylint_errors_detected:
+    if pylint_errors_detected:  # pragma: no cover
         logging.error("Pylint errors detected:\n%s", standard_output_data)
+    else:  # pragma: no cover
+        logging.debug("Pylint success output:\n%s", standard_output_data)
 
     assert pylint_error_free_search_phrase in standard_output_data