ci: Switch coverage to gcovr

.github/workflows/step_coverage.yaml

@@ -23,22 +23,21 @@ jobs:
         with:
           fetch-depth: 0
       - uses: lukka/get-cmake@latest
-      - name: Get test coverage for ${{ matrix.coverage }}
+      - name: Run CMake workflow
         uses: lukka/run-cmake@v10.3
         with:
           workflowPreset: "ci-coverage-${{ matrix.coverage }}"
-      - name: Get lcov data
-        uses: danielealbano/lcov-action@v3
-        with:
-          # Note lcov-action prepends and appends wild-cards *. Account for those
-          # https://github.com/danielealbano/lcov-action/issues/11
-          remove_patterns: /test/,/cmake-build*/
+      - name: Get coverage data
+        # TODO: Switch to tagged release
+        uses: threeal/gcovr-action@xml-out
       - name: Upload coverage to Codecov
         uses: codecov/codecov-action@v4
         with:
           token: ${{ secrets.CODECOV_TOKEN }}
           name: ${{ matrix.coverage }} coverage
-          files: coverage.info
+          disable_search: true
+          plugin: noop
+          files: coverage-gcovr.xml
           flags: ${{ matrix.coverage }}
           verbose: true
 
@@ -52,27 +51,25 @@ jobs:
       - uses: actions/setup-python@v4
         with:
           python-version: 3.x
-      - name: Setup spglib
+      - name: Build spglib
         run: |
-          python -m pip install --upgrade pip
           pip install -e .[test-cov] \
              --config-settings=cmake.define.CMAKE_C_COMPILER=gcc \
              --config-settings=cmake.define.SPGLIB_WITH_TESTS=ON \
              --config-settings=cmake.define.SPGLIB_TEST_COVERAGE=ON \
-             --config-settings=build-dir=build
+             --config-settings=build-dir=cmake-build-coverage
       - name: Test pytest with coverage
-        run: pytest --cov=spglib
-      - name: Get lcov data
-        uses: danielealbano/lcov-action@v3
-        with:
-          # Note lcov-action prepends and appends wild-cards *. Account for those
-          # https://github.com/danielealbano/lcov-action/issues/11
-          remove_patterns: /test/,/cmake-build*/,/tmp/
+        run: pytest --cov --cov-report=xml:coverage-pytest.xml
+      - name: Get coverage data
+        # TODO: Switch to tagged release
+        uses: threeal/gcovr-action@xml-out
       - name: Upload coverage to Codecov
         uses: codecov/codecov-action@v4
         with:
           token: ${{ secrets.CODECOV_TOKEN }}
           name: python_api coverage
-          files: coverage.info,.coverage
+          disable_search: true
+          plugin: noop
+          files: coverage-gcovr.xml,coverage-pytest.xml
           flags: python_api
           verbose: true

.gitignore

@@ -86,3 +86,5 @@ venv
 env
 .venv
 .env
+
+coverage.xml

pyproject.toml

@@ -16,12 +16,12 @@ dependencies = [
     "importlib-resources; python_version<'3.10'",
 ]
 authors = [
-    {name="Atsushi Togo", email="atz.togo@gmail.com"},
+    { name = "Atsushi Togo", email = "atz.togo@gmail.com" },
 ]
 maintainers = [
-    {name="Atsushi Togo", email="atz.togo@gmail.com"},
-    {name="Cristian Le", email="git@lecris.dev"},
-    {name="Kohei Shinohara", email="kshinohara0508@gmail.com"},
+    { name = "Atsushi Togo", email = "atz.togo@gmail.com" },
+    { name = "Cristian Le", email = "git@lecris.dev" },
+    { name = "Kohei Shinohara", email = "kshinohara0508@gmail.com" },
 ]
 classifiers = [
     "Topic :: Scientific/Engineering :: Physics",
@@ -124,20 +124,20 @@ markers = [
 
 [tool.coverage.run]
 command_line = '-m pytest'
-# TODO: Cannot report relative to project path because we cannot do editable installs yet
-#source = ['python/spglib']
-source = ['spglib']
+source = [
+    "python/spglib",
+]
 
 [tool.ruff]
 line-length = 88
 extend-select = [
-    "F",           # pyflakes
+    "F", # pyflakes
     # "W",           # pycodestyle-warnings
-    "E",           # pycodestyle-errors
+    "E", # pycodestyle-errors
     # "C90",         # mccabe
-    "I",           # isort
+    "I", # isort
     # "N",           # pep8-naming
-    "D",           # pydocstyle
+    "D", # pydocstyle
     # "UP",          # pyupgrade
     # "YTT",         # flake8-2020
     # "ANN",         # flake8-annotations
@@ -184,9 +184,9 @@ extend-ignore = [
     "D101",
     "D102",
     "D103",
-    "D203",  # Confilct with D211
+    "D203", # Confilct with D211
     "D205",
-    "D213",  # Conflict with D212
+    "D213", # Conflict with D212
 ]
 exclude = [
     "database",
@@ -209,3 +209,13 @@ skip = "doc/references.bib"
 
 [tool.check-wheel-contents]
 ignore = "W002"
+
+[tool.gcovr]
+cobertura = "coverage-gcovr.xml"
+exclude = [
+    "src/msg_database.c",
+    "src/spg_database.c",
+]
+gcov-ignore-errors = [
+    "source_not_found",
+]