Merge branch 'maintenance/gha-cython-coverage'

PR #561

Author: webknjaz

.codecov.yml

@@ -0,0 +1,55 @@
+---
+
+codecov:
+  notify:
+    after_n_builds: 23  # The number of test matrix jobs uploading coverage
+    wait_for_ci: false
+
+  require_ci_to_pass: false
+
+comment:
+  require_changes: true
+
+coverage:
+  range: 99.09..100
+  status:
+    project:
+      default:
+        target: 100%
+      lib:
+        paths:
+        - frozenlist/
+        target: 97.79%
+      tests:
+        paths:
+        - tests/
+        target: 100%
+
+flags:
+  library:
+    paths:
+    - frozenlist/
+  configs:
+    paths:
+    - requirements/
+    - ".git*"
+    - "*.toml"
+    - "*.yml"
+  changelog:
+    paths:
+    - CHANGES/
+    - CHANGES.rst
+  docs:
+    paths:
+    - docs/
+    - "*.md"
+    - "*.rst"
+    - "*.txt"
+  tests:
+    paths:
+    - tests/
+  tools:
+    paths:
+    - tools/
+
+...

.coveragerc

@@ -0,0 +1,21 @@
+[paths]
+source =
+  frozenlist
+  */lib/pypy*/site-packages/frozenlist
+  */lib/python*/site-packages/frozenlist
+  */Lib/site-packages/frozenlist
+
+[report]
+skip_covered = true
+skip_empty = true
+show_missing = true
+
+[run]
+branch = true
+cover_pylib = false
+plugins = Cython.Coverage
+relative_files = true
+source =
+  tests
+source_pkgs =
+  frozenlist

.github/workflows/ci-cd.yml

@@ -236,6 +236,32 @@ jobs:
       shell: bash
     - name: Self-install
       run: python -Im pip install '${{ steps.wheel-file.outputs.path }}'
+    - name: Produce the C-files for the Coverage.py Cython plugin
+      if: >-  # Only works if the dists were built with line tracing
+        !matrix.no-extensions
+        && (
+          github.event_name != 'push'
+          || !contains(github.ref, 'refs/tags/')
+        )
+      env:
+        PYTHONPATH: packaging/
+      run: |
+        set -eEuo pipefail
+
+        python -Im pip install expandvars
+        python -m pep517_backend.cli translate-cython
+      shell: bash
+    - name: Disable the Cython.Coverage Produce plugin
+      if: >-  # Only works if the dists were built with line tracing
+        matrix.no-extensions
+        || (
+          github.event_name == 'push'
+          && contains(github.ref, 'refs/tags/')
+        )
+      run: |
+        set -eEuo pipefail
+        sed -i.bak 's/^plugins = .*//g' .coveragerc
+      shell: bash
     - name: Run unittests
       env:
         COLOR: 'yes'

CHANGES/560.contrib.rst

@@ -14,3 +14,13 @@ Here's a usage example:
 
 For editable installs, this setting is on by default. Otherwise, it's
 off unless requested explicitly.
+
+The following produces C-files required for the Cython coverage
+plugin to map the measurements back to the PYX-files:
+
+.. code-block:: console
+
+    $ python -Im pip install -e .
+
+Alternatively, the `FROZENLIST_CYTHON_TRACING=1` environment variable
+can be set to do the same as the :pep:`517` config setting.

CHANGES/561.contrib.rst

@@ -0,0 +1,4 @@
+Coverage collection has been implemented for the Cython modules
+-- by :user:`webknjaz`.
+
+It will also be reported to Codecov from any non-release CI jobs.

MANIFEST.in

@@ -1,3 +1,4 @@
+include .coveragerc
 include pyproject.toml
 include pytest.ini
 include pytest.ci.ini

codecov.yml

@@ -50,6 +50,7 @@ ClientSession
 cls
 cmd
 codec
+Codecov
 Codings
 committer
 committers