Merge pull request #72 from mts-ai/feature/codecov

Add Codecov

Author: mahenzon

.github/workflows/testing.yml

@@ -2,12 +2,23 @@ name: Python testing
 
 on:
   push:
-#  pull_request:
+    branches:
+      - main
+    paths:
+      - ".github/workflows/testing.yml"
+      - "fastapi_jsonapi/**"
+      - "tests/**"
+      - "codecov.yaml"
+      - "pyproject.toml"
+  pull_request:
+    branches:
+      - main
+    paths:
+      - ".github/workflows/testing.yml"
+      - "fastapi_jsonapi/**"
+      - "tests/**"
+      - "pyproject.toml"
 
-# is there a way to fix doubled pipelines?
-# only XXX
-# https://github.com/orgs/community/discussions/25654
-# https://github.com/orgs/community/discussions/26276
 
 jobs:
   lint:
@@ -16,6 +27,7 @@ jobs:
       matrix:
         python-version:
           - "3.9"
+          - "3.10"
           - "3.11"
 
     steps:
@@ -79,6 +91,17 @@ jobs:
       - name: Install dependencies
         run: poetry install --all-extras
       - name: Test with pytest
-        run: pytest -s -vv tests/
+        run: |
+          flags="-s -vv --cov=fastapi_jsonapi --cov-config .coveragerc --cov-report=xml"
+          pytest $flags tests/
         env:
           TESTING_DB_URL: ${{ matrix.db-url }}
+
+      - name: Upload coverage data to Codecov
+        uses: codecov/codecov-action@v3
+        with:
+          token: ${{ secrets.CODECOV_TOKEN }}
+          files: coverage.xml
+          flags: unittests
+          name: py-${{ matrix.python-version }}-db-${{ startsWith(matrix.db-url, 'sqlite') && 'sqlite' || startsWith(matrix.db-url, 'postgres') && 'postgres' || 'unknown' }} }}
+          fail_ci_if_error: true

README.md

@@ -4,6 +4,7 @@
 [![](https://img.shields.io/github/license/ycd/manage-fastapi?style=for-the-badge)](https://pypi.org/project/FastAPI-JSONAPI/)
 ![GitHub Actions](https://img.shields.io/github/actions/workflow/status/mts-ai/FastAPI-JSONAPI/testing.yml?style=for-the-badge)
 [![Read the Docs](https://img.shields.io/readthedocs/fastapi-jsonapi?style=for-the-badge)](https://fastapi-jsonapi.readthedocs.io/en/latest/)
+![Codecov](https://img.shields.io/codecov/c/github/mts-ai/FastAPI-JSONAPI?style=for-the-badge)
 
 [![📖 Docs (gh-pages)](https://github.com/mts-ai/FastAPI-JSONAPI/actions/workflows/documentation.yaml/badge.svg)](https://mts-ai.github.io/FastAPI-JSONAPI/)
 

codecov.yaml

@@ -0,0 +1,24 @@
+codecov:
+  require_ci_to_pass: yes
+  branch: main
+
+coverage:
+  precision: 2
+  round: down
+  range: "90..100"
+
+parsers:
+  gcov:
+    branch_detection:
+      conditional: yes
+      loop: yes
+      method: no
+      macro: no
+
+comment:
+  layout: "reach,diff,flags,tree"
+  behavior: default
+  require_changes: no
+  branches:
+    - main
+  after_n_builds: 6  # 3 python versions by 2 dbs

docs/index.rst

@@ -12,6 +12,10 @@ FastAPI-JSONAPI
    :alt: GitHub
    :target: https://github.com/mts-ai/FastAPI-JSONAPI
 
+.. image:: https://img.shields.io/codecov/c/github/mts-ai/FASTAPI-JSONAPI?style=for-the-badge
+   :alt: Codecov
+   :target: https://codecov.io/gh/mts-ai/FastAPI-JSONAPI
+
 
 **FastAPI-JSONAPI** is an extension for FastAPI that adds support for quickly building REST APIs
 with huge flexibility around the JSON:API 1.0 specification.