Setup code coverage reporting (#45)

* See if we can use slipcover JSON with codecov

* Clean up stray lines from codecov action example

* Add wheel to dev requirements; only upload code coverage once

* Try only running slipcover on python 3.9

* Fix invalid syntax in unit test github action

* Revise conditional syntax, make codecov verbose

* Switch to pytest-cov

* Fix github actions syntax

* Add code coverage files to gitignore

* Add tests for not implemented error methods in base formatter

* Add code coverage badge

Author: rlskoeser

.github/workflows/unit_tests.yml

@@ -9,6 +9,9 @@ on:
       - 'tests/**'
   pull_request:
 
+env:
+  COV_PYTHON_VERSION: "3.9"
+
 jobs:
   python-unit:
     runs-on: ubuntu-latest
@@ -32,5 +35,17 @@ jobs:
           pip install -e ".[dev]"
           python -m pip install tox tox-gh-actions
         if: steps.python-cache.outputs.cache-hit != 'true'
-      - name: Run unit tests
+
+      # for all versions but the one we use for code coverage, run normally
+      - name: Run unit tests normally
         run: tox
+        if: ${{ matrix.python != env.COV_PYTHON_VERSION }}
+
+      # run code coverage in one version only
+      - name: Run unit tests with code coverage reporting
+        run: tox -e coverage
+        if: ${{ matrix.python == env.COV_PYTHON_VERSION }}
+      - name: Upload test coverage to Codecov
+        uses: codecov/codecov-action@v3
+        if: ${{ matrix.python == env.COV_PYTHON_VERSION }}
+

.gitignore

@@ -34,3 +34,7 @@ venv/
 ENV/
 env.bak/
 venv.bak/
+
+# code coverage
+.coverage
+coverage.xml

README.md

@@ -4,6 +4,7 @@ Repository for the DHTech 2022 Hackathon
 
 [![License](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
 [![unit tests](https://github.com/dh-tech/hackathon-2022/actions/workflows/unit_tests.yml/badge.svg)](https://github.com/dh-tech/hackathon-2022/actions/workflows/unit_tests.yml)
+[![codecov](https://codecov.io/gh/dh-tech/hackathon-2022/branch/main/graph/badge.svg?token=GE7HZE8C9D)](https://codecov.io/gh/dh-tech/hackathon-2022)
 [![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
 <!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
 [![All Contributors](https://img.shields.io/badge/all_contributors-5-orange.svg?style=flat-square)](#contributors-)

setup.cfg

@@ -39,7 +39,9 @@ dev =
   tox
   sphinx
   twine
-test = 
+  wheel
+  pytest-cov
+test =
   pytest>=7.2
 
 [options.packages.find]

tests/test_dateformat/test_base.py

@@ -1,3 +1,5 @@
+import pytest
+
 from undate.dateformat.base import BaseDateFormat
 
 
@@ -26,3 +28,11 @@ def test_formatters_are_unique(self):
         #     name = "ISO8601"
 
         # assert len(BaseDateFormat.available_formatters()) != len(BaseDateFormat.__subclasses__())
+
+    def test_parse_not_implemented(self):
+        with pytest.raises(NotImplementedError):
+            BaseDateFormat().parse("foo bar baz")
+
+    def test_parse_to_string(self):
+        with pytest.raises(NotImplementedError):
+            BaseDateFormat().to_string(1991)

tox.ini

@@ -27,6 +27,13 @@ deps =
 commands =
     flake8 --ignore=E501,E402,F401 src/undate/ tests/
 
+[testenv:coverage]
+deps =
+    pytest
+    pytest-cov
+commands =
+    pytest --cov=./ --cov-report=xml
+
 [testenv:docs]
 description = invoke sphinx-build to build the HTML docs
 basepython = python3.10