🧪 Add code coverage to CI testing (#1067)

.github/workflows/ci.yaml

@@ -42,7 +42,17 @@ jobs:
           python -m pip freeze
       - name: Run pytest
         run: |
-          python -m pytest -v --ignore=tests/benchmarks -m "not jstest" tests
+          python -m pytest -v --ignore=tests/benchmarks -m "not jstest" --cov=sphinx_needs --cov-report=xml --cov-report=term-missing tests
+          coverage xml
+      - name: Upload to Codecov
+        if: github.repository == 'useblocks/sphinx-needs' && matrix.os == 'ubuntu-latest'
+        uses: codecov/codecov-action@v3
+        with:
+          token: ${{ secrets.CODECOV_TOKEN }}
+          name: sphinx-need-pytests
+          flags: pytests
+          file: ./coverage.xml
+          fail_ci_if_error: true
 
   tests-js:
     name: "JS py${{ matrix.python-version }} sphinx~=${{ matrix.sphinx-version }} ${{ matrix.os }}"

.gitignore

@@ -17,6 +17,7 @@ _build
 .cache/
 .pytest_cache
 .coverage
+coverage.xml
 .doctrees
 docs/github_images/
 .eggs/

pyproject.toml

@@ -46,6 +46,7 @@ matplotlib = { version = ">=3.3.0", optional = true }
 
 # [project.optional-dependencies.test]
 pytest = { version = "^7", optional = true }
+pytest-cov = { version = "^4", optional = true }
 lxml = { version = "^4.6.5", optional = true }
 requests-mock = { version = ">=1.9.3", optional = true }
 responses = { version = "^0.22.0", optional = true }
@@ -68,7 +69,17 @@ sphinx-immaterial = { version="0.11.7", optional = true }
 
 [tool.poetry.extras]
 plotting = ["matplotlib"]
-test = ["matplotlib", "pytest", "syrupy", "sphinxcontrib-plantuml", "requests-mock", "lxml", "responses", "pytest-xprocess"]
+test = [
+  "matplotlib",
+  "pytest",
+  "pytest-cov",
+  "syrupy",
+  "sphinxcontrib-plantuml",
+  "requests-mock",
+  "lxml",
+  "responses",
+  "pytest-xprocess"
+]
 test-parallel = ["pytest-xdist"]
 benchmark = ["pytest-benchmark", "memray"]
 docs = [