Update tox and github actions

- Convert .coverage file into a folder for parallel mode. You may will need to delete the file if it exists before running tox tests.
- Enable parallel coverage mode.
- Test python versions 3.7 - 3.11
- Work around the removal of 3.7 from Ubuntu in github actions
- Attach coverage data to the github action report

Author: MHendricks

.coveragerc

@@ -9,4 +9,9 @@ skip_empty = true
 source = preditor
 omit =
     */site-packages/*
+    tests/*
+    # This file is automatically generated by setuptools_scm
+    preditor/version.py
+parallel=True
 relative_files=True
+data_file=.coverage/.coverage

.github/workflows/static-analysis-and-test.yml

@@ -35,12 +35,12 @@ jobs:
     strategy:
       matrix:
         os: ['ubuntu-latest']
-        python: [3.7, 3.8, 3.9]
-        # Works around the depreciation of python 3.6 for ubuntu
+        python: ['3.8', '3.9', '3.10', '3.11']
+        # Works around the depreciation of python 3.6, 3.7 for ubuntu
         # https://github.com/actions/setup-python/issues/544
         include:
-          - os: 'ubuntu-20.04'
-            python: 3.6
+          - os: 'ubuntu-22.04'
+            python: '3.7'
 
     runs-on: ${{ matrix.os }}
 
@@ -60,4 +60,101 @@ jobs:
 
       - name: Run Tox
         run: |
-          tox -e py
+          tox -e begin,py -- --tb short
+
+      - name: Upload coverage
+        uses: actions/upload-artifact@v4
+        with:
+          name: coverage-${{ matrix.os }}-${{ matrix.python }}
+          path: .coverage/*
+          include-hidden-files: true
+          retention-days: 1
+
+
+  coverage:
+    needs: test
+
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Setup Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.x"
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          python -m pip install tox coverage[toml]
+
+      # Ensure version.py is created so coverage can read it's source
+      - name: Run begin
+        run: |
+          tox -e begin
+
+      - name: Download coverage artifacts
+        uses: actions/download-artifact@v4
+        with:
+          path: .coverage/
+          pattern: coverage-*
+          merge-multiple: true
+
+      # Tox runs `coverage combine` and `coverage xml`
+      - name: Combine coverage and report
+        run: |
+          tox -e end
+
+          # Report and write to summary.
+          python -m coverage report --format=markdown >> $GITHUB_STEP_SUMMARY
+
+          # Write html coverage report to upload as an artifact
+          python -m coverage html
+
+          # # Report again and fail if under 100%.
+          # python -m coverage report --fail-under=100
+
+      - name: Upload HTML report if check failed.
+        uses: actions/upload-artifact@v4
+        with:
+          name: html-report
+          path: htmlcov
+          # # TODO: If we get 100% coverage we can re-enable this and the
+          # # `--fail-under` check so pull requests fail if the dev doesn't
+          # # add tests for new code.
+          # if: ${{ failure() }}
+
+
+  pip-package:
+    # Build and upload pip packages as artifacts so we can inspect them and
+    # ensure they are correct for actual release
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Setup Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.x"
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          python -m pip install --upgrade build setuptools wheel twine
+
+      - name: Build wheel
+        run: |
+          python -m build --wheel --sdist
+
+      - name: Upload packages.
+        uses: actions/upload-artifact@v4
+        with:
+          name: pip-packages
+          path: |
+            dist/preditor-*.whl
+            dist/preditor-*.tar.gz

tox.ini

@@ -1,5 +1,5 @@
 [tox]
-envlist = begin,py{27,36,37,38,39},modernize,black,flake8
+envlist = modernize,begin,py{27,36,37,38,39,310,311},end,black,flake8
 skip_missing_interpreters = True
 skipsdist = True
 
@@ -23,8 +23,7 @@ commands =
     # Ensure the version.py file is created
     python setup.py egg_info
 
-    python -m coverage run -m pytest {posargs:tests/}
-    python -m coverage report
+    coverage run -m pytest {tty:--color=yes} {posargs:tests/}
 
 [testenv:modernize]
 # Test compatibility with python 2 and 3
@@ -37,12 +36,28 @@ commands =
     # in this test.
     python -m modernize -f print -f import -f basestring -f unicode_type --enforce ./preditor
 
-
 [testenv:begin]
 basepython = python3
+deps =
+    coverage[toml]
+    build
+commands =
+    coverage erase
+
+[testenv:py{27,36,37,38,39,310,311}]
+depends = begin
+
+[testenv:end]
+basepython = python3
+depends =
+    begin
+    py{27,36,37,38,39,310,311}
+parallel_show_output = True
 deps =
     coverage
-commands = coverage erase
+commands =
+    coverage combine
+    coverage report
 
 [testenv:black]
 basepython = python3