Add code coverage

.github/workflows/test.yml

@@ -10,21 +10,21 @@ concurrency:
 
 jobs:
   tests:
-    name: Python ${{ matrix.python-version }}, Database ${{ matrix.database-type }}
+    name: Python ${{ matrix.python-version[0] }}, Database ${{ matrix.database-type }}
     runs-on: ubuntu-latest
 
     strategy:
       fail-fast: false
       matrix:
         python-version:
-          - "3.7"
-          - "3.8"
-          - "3.9"
-          - "3.10"
-          - "3.11"
-          - "pypy-3.7"
-          - "pypy-3.8"
-          - "pypy-3.9"
+          - ["3.7", "py37"]
+          - ["3.8", "py38"]
+          - ["3.9", "py39"]
+          - ["3.10", "py310"]
+          - ["3.11", "py311"]
+          - ["pypy-3.7", "pypy37"]
+          - ["pypy-3.8", "pypy38"]
+          - ["pypy-3.9", "pypy39"]
         database-type:
           - "sqlite"
           - "postgres"
@@ -45,10 +45,10 @@ jobs:
     steps:
       - uses: actions/checkout@v3
 
-      - name: Set up Python ${{ matrix.python-version }}
+      - name: Set up Python ${{ matrix.python-version[0] }}
         uses: actions/setup-python@v4
         with:
-          python-version: ${{ matrix.python-version }}
+          python-version: ${{ matrix.python-version[0] }}
           cache: pip
 
       - name: Install dependencies
@@ -58,3 +58,14 @@ jobs:
         run: tox
         env:
           DATABASE_TYPE: ${{ matrix.database-type }}
+          RUN_COVERAGE: yes
+
+      - name: Coverage report
+        run: tox -e cov-report
+
+      - name: 'Upload coverage'
+        uses: actions/upload-artifact@v3
+        with:
+          name: factory_coverage_${{ matrix.python-version[1] }}_${{ matrix.database-type }}
+          path: htmlcov/
+          retention-days: 1

Makefile

@@ -3,9 +3,21 @@ TESTS_DIR=tests
 DOC_DIR=docs
 EXAMPLES_DIR=examples
 SETUP_PY=setup.py
+PYTHON_ERROR_ON_WARN=python \
+  -b \
+  -X dev \
+  -Werror \
+  -Wdefault:"the imp module is deprecated in favour of importlib; see the module's documentation for alternative uses":DeprecationWarning:distutils: \
+  -Wdefault:"Using or importing the ABCs from 'collections' instead of from 'collections.abc' is deprecated, and in 3.8 it will stop working":DeprecationWarning:: \
+  -Wdefault:"Using or importing the ABCs from 'collections' instead of from 'collections.abc' is deprecated since Python 3.3, and in 3.9 it will stop working":DeprecationWarning:: \
+  -Wdefault:"set_output_charset() is deprecated":DeprecationWarning:: \
+  -Wdefault:"parameter codeset is deprecated":DeprecationWarning:: \
+  -Wdefault:"'cgi' is deprecated and slated for removal in Python 3.13":DeprecationWarning::
+# Remove cgi warning when dropping support for Django<=4.1.
 
 # Use current python binary instead of system default.
-COVERAGE = python $(shell which coverage)
+COVERAGE_PATH = $(shell which coverage)
+COVERAGE = python $(COVERAGE_PATH)
 FLAKE8 = flake8
 ISORT = isort
 CTAGS = ctags
@@ -54,17 +66,7 @@ testall:
 # DOC: Run tests for the currently installed version
 # Remove cgi warning when dropping support for Django<=4.1.
 test:
-	python \
-		-b \
-		-X dev \
-		-Werror \
-		-Wdefault:"the imp module is deprecated in favour of importlib; see the module's documentation for alternative uses":DeprecationWarning:distutils: \
-		-Wdefault:"Using or importing the ABCs from 'collections' instead of from 'collections.abc' is deprecated, and in 3.8 it will stop working":DeprecationWarning:: \
-		-Wdefault:"Using or importing the ABCs from 'collections' instead of from 'collections.abc' is deprecated since Python 3.3, and in 3.9 it will stop working":DeprecationWarning:: \
-		-Wdefault:"set_output_charset() is deprecated":DeprecationWarning:: \
-		-Wdefault:"parameter codeset is deprecated":DeprecationWarning:: \
-		-Wdefault:"'cgi' is deprecated and slated for removal in Python 3.13":DeprecationWarning:: \
-		-m unittest
+	$(PYTHON_ERROR_ON_WARN) -m unittest
 
 # DOC: Test the examples
 example-test:
@@ -80,14 +82,19 @@ lint:
 	$(ISORT) --check-only --diff $(EXAMPLES_DIR) $(PACKAGE) $(SETUP_PY) $(TESTS_DIR)
 	check-manifest
 
-coverage:
+coverage-clean:
 	$(COVERAGE) erase
-	$(COVERAGE) run --branch -m unittest
+	@rm -rf .coverage htmlcov/
+
+coverage-test:
+	$(PYTHON_ERROR_ON_WARN) $(COVERAGE_PATH) run --branch -m unittest
+
+coverage-report:
 	$(COVERAGE) report
 	$(COVERAGE) html
 
 
-.PHONY: test testall example-test lint coverage
+.PHONY: test testall example-test lint coverage-clean coverage-test coverage-report
 
 
 # Development

tox.ini

@@ -5,11 +5,11 @@ envlist =
     docs
     examples
     linkcheck
-    py{37,38,39,310,311,py37,py38,py39}-sqlite
-    py{37,38,39,310,311,py37,py38,py39}-django32-mongo-alchemy-{sqlite,postgres}
-    py{38,39,310,311,py38,py39}-django40-mongo-alchemy-{sqlite,postgres}
-    py{38,39,310,311,py38,py39}-django41-mongo-alchemy-{sqlite,postgres}
-    py310-djangomain-mongo-alchemy-{sqlite,postgres}
+    py{37,38,39,310,311,py37,py38,py39}-sqlite-{cov,nocov}
+    py{37,38,39,310,311,py37,py38,py39}-django32-mongo-alchemy-{sqlite,postgres}-{cov,nocov}
+    py{38,39,310,311,py38,py39}-django40-mongo-alchemy-{sqlite,postgres}-{cov,nocov}
+    py{38,39,310,311,py38,py39}-django41-mongo-alchemy-{sqlite,postgres}-{cov,nocov}
+    py310-djangomain-mongo-alchemy-{sqlite,postgres}-{cov,nocov}
 
 [gh-actions]
 python =
@@ -26,13 +26,17 @@ python =
 DATABASE_TYPE =
     sqlite: sqlite
     postgres: postgres
+RUN_COVERAGE =
+    yes: cov
+    no: nocov
 
 [testenv]
 passenv =
     MONGO_HOST
     POSTGRES_HOST
     POSTGRES_DATABASE
 deps =
+    cov: coverage
     alchemy: SQLAlchemy
     alchemy: sqlalchemy_utils
     mongo: mongoengine
@@ -45,11 +49,17 @@ deps =
     pypy{37,38,39}-postgres: psycopg2cffi
 
 setenv =
-    py: DJANGO_SETTINGS_MODULE=tests.djapp.settings
+    py-!postgres: DJANGO_SETTINGS_MODULE=tests.djapp.settings
     postgres: DJANGO_SETTINGS_MODULE=tests.djapp.settings_pg
 
 allowlist_externals = make
-commands = make test
+commands =
+    !cov: make test
+    cov: make coverage-test
+
+[testenv:cov-report]
+commands =
+    make coverage-report
 
 [testenv:docs]
 extras = doc