Codacy code coverage reporting

.github/workflows/continuous-integration.yml

@@ -30,6 +30,10 @@ jobs:
 
     name: ${{ matrix.os }} / Python ${{ matrix.python-version }}
 
+    env:
+      PSYDAC_MESH_DIR: ${{ github.workspace }}/mesh
+      OMP_NUM_THREADS: 2
+
     steps:
       - uses: actions/checkout@v4
 
@@ -104,7 +108,7 @@ jobs:
           cache-name: cache-PETSc
         with:
           path: "./petsc"
-          key: cache-${{ matrix.os }}-${{ matrix.python-version }}
+          key: petsc-${{ matrix.os }}-${{ matrix.python-version }}
 
       - if: steps.cache-petsc.outputs.cache-hit != 'true'
         name: Download a specific release of PETSc
@@ -157,7 +161,7 @@ jobs:
 
       - name: Install project
         run: |
-          python -m pip install .
+          python -m pip install .[test]
           python -m pip freeze
 
       - name: Test Pyccel optimization flags
@@ -169,35 +173,51 @@ jobs:
           mkdir pytest
           cp mpi_tester.py pytest
 
-      - name: Run single-process tests with Pytest
+      - name: Run coverage tests on macOS
+        if: matrix.os == 'macos-latest'
+        working-directory: ./pytest
+        run: >- 
+          python -m pytest -n auto
+          --cov psydac
+          --cov-config $GITHUB_WORKSPACE/pyproject.toml
+          --cov-report xml
+          --pyargs psydac -m "not parallel and not petsc"
+
+      - name: Run single-process tests with Pytest on Ubuntu
+        if: matrix.os == 'ubuntu-latest'
         working-directory: ./pytest
         run: |
-          export PSYDAC_MESH_DIR=$GITHUB_WORKSPACE/mesh
-          export OMP_NUM_THREADS=2
           python -m pytest -n auto --pyargs psydac -m "not parallel and not petsc"
 
+      - name: Upload coverage report to Codacy
+        if: matrix.os == 'macos-latest'
+        uses: codacy/codacy-coverage-reporter-action@v1.3.0
+        with:
+          project-token: ${{ secrets.CODACY_PROJECT_TOKEN }}
+          coverage-reports: ./pytest/coverage.xml
+
+      - name: Print detailed coverage results on macOS
+        if: matrix.os == 'macos-latest'
+        working-directory: ./pytest
+        run: |
+          coverage report --ignore-errors --show-missing --sort=cover
+
       - name: Run MPI tests with Pytest
         working-directory: ./pytest
         run: |
-          export PSYDAC_MESH_DIR=$GITHUB_WORKSPACE/mesh
-          export OMP_NUM_THREADS=2
           python mpi_tester.py --mpirun="mpiexec -n 4 ${MPI_OPTS}" --pyargs psydac -m "parallel and not petsc"
 
       - name: Run single-process PETSc tests with Pytest
         working-directory: ./pytest
         run: |
-          export PSYDAC_MESH_DIR=$GITHUB_WORKSPACE/mesh
-          export OMP_NUM_THREADS=2
           python -m pytest -n auto --pyargs psydac -m "not parallel and petsc"
 
       - name: Run MPI PETSc tests with Pytest
         working-directory: ./pytest
         run: |
-          export PSYDAC_MESH_DIR=$GITHUB_WORKSPACE/mesh
-          export OMP_NUM_THREADS=2
           python mpi_tester.py --mpirun="mpiexec -n 4 ${MPI_OPTS}" --pyargs psydac -m "parallel and petsc"
 
       - name: Remove test directory
-        if: ${{ always() }}
+        if: always()
         run: |
           rm -rf pytest

pyproject.toml

@@ -53,6 +53,11 @@ dependencies = [
     'igakit @ https://github.com/dalcinl/igakit/archive/refs/heads/master.zip'
 ]
 
+[project.optional-dependencies]
+test = [
+    "pytest-cov >= 5.0.0",
+]
+
 [project.urls]
 Homepage      = "https://github.com/pyccel/psydac"
 Documentation = "https://pyccel.github.io/psydac"
@@ -68,3 +73,41 @@ namespaces = false
 
 [tool.setuptools.package-data]
 "*" = ["*.txt"]
+
+[tool.coverage.run]
+branch = true
+omit = [
+    # Exclude pyccelised kernels
+    "*/__psydac__/*",
+
+    # Examples don't need to be covered
+    "*/examples/*",
+
+    # Unit tests shouldn't be included
+    "*/tests/*",
+    ]
+
+[tool.coverage.report]
+# Regexes for lines to exclude from consideration
+exclude_also = [
+    # Don't complain about missing debug-only code:
+    "def __repr__",
+    "if self\\.debug",
+
+    # Don't complain if tests don't hit defensive assertion code:
+    "raise AssertionError",
+    "raise NotImplementedError",
+
+    # Don't complain if non-runnable code isn't run:
+    "if 0:",
+    "if __name__ == .__main__.:",
+
+    # Don't complain about abstract methods, they aren't run:
+    "@(abc\\.)?abstractmethod",
+    ]
+
+# Ignore source code that can’t be found, emitting a warning instead of an exception.
+ignore_errors = true
+
+[tool.coverage.html]
+directory = "coverage_html_report"