Merge pull request #45 from uktrade/ci/code-coverage

ci: report code coverage

.coveragerc

@@ -0,0 +1,2 @@
+[run]
+branch = True

.github/workflows/tests.yml

@@ -11,6 +11,8 @@ jobs:
     runs-on: ubuntu-20.04
     strategy:
       matrix:
+        # If changing how many times tests are run, must also change in codecov.yml
+        # to ensure test coverage is reported only after all tests have finished
         python-version:
           - "3.7.1"
           - "3.8.0"
@@ -47,4 +49,5 @@ jobs:
         run: "timeout 60 bash -c 'until echo > /dev/tcp/127.0.0.1/5432; do sleep 5; done'"
       - name: "Test"
         run: |
-          pytest
+          pytest --cov
+      - uses: codecov/codecov-action@v3

README.md

@@ -1,5 +1,7 @@
 # pg-force-execute
 
+[![PyPI package](https://img.shields.io/pypi/v/pg-force-execute?label=PyPI%20package&color=%234c1)](https://pypi.org/project/pg-force-execute/) [![Test suite](https://img.shields.io/github/actions/workflow/status/uktrade/pg-force-execute/tests.yml?label=Test%20suite)](https://github.com/uktrade/pg-force-execute/actions/workflows/tests.yml) [![Code coverage](https://img.shields.io/codecov/c/github/uktrade/pg-force-execute?label=Code%20coverage)](https://app.codecov.io/gh/uktrade/pg-force-execute)
+
 Context manager to run PostgreSQL queries with SQLAlchemy, terminating any other clients that continue to block it after a configurable delay.
 
 Using this to wrap queries is somewhat of a last resort, but is useful in certain Extract Transform Load (ETL) pipeline contexts. For example, if it is more important to replace one table with another than to allow running queries on the table to complete, then this can be used to run the relevant `ALTER TABLE RENAME TO` query.

codecov.yml

@@ -0,0 +1,4 @@
+comment: false
+codecov:
+  notify:
+    after_n_builds: 120

pyproject.toml

@@ -27,7 +27,9 @@ dev = [
     "pytest>=7.2.1",
 ]
 ci = [
-    "pytest==7.2.1",
+    "pytest",
+    "pytest-cov",
+    "coverage",
 ]
 ci-psycopg2-sqlalchemy1 = [
     "psycopg2==2.9.2",