ci.yml

name: CI

on:
    pull_request:
    push:
    workflow_dispatch:

permissions:
  checks: write
  contents: write
  pull-requests: write


jobs:
    python-unit:
        runs-on: ubuntu-latest
        strategy:
            matrix:
                python-version: ["3.8", "3.9", "3.10", "3.11", "3.12"]
        defaults:
            run:
                working-directory: .

        steps:
            - uses: actions/checkout@v4

            - name: Set up Python ${{ matrix.python-version }}
              uses: actions/setup-python@v5
              with:
                python-version: ${{ matrix.python-version }}
                cache: 'pip'
                cache-dependency-path: '**/pyproject.toml'

            - name: Install dependencies
              run: |
                  python -m pip install --upgrade pip
                  pip install .[test]

            - name: Check Python linting (Ruff)
              run: ruff check --output-format=github

            - name: Check Python formatting (Ruff)
              run: ruff format --check

            - name: Run unit tests
              run: |
                pytest
                mv .coverage .coverage_main

            - name: Run Django integration tests
              working-directory: ./edtf_django_tests
              run: |
                coverage run manage.py test edtf_integration
                mv .coverage ../.coverage_django

            - name: Combine coverage reports
              run: |
                coverage combine .coverage_main .coverage_django
                coverage report --omit="edtf_django_tests/*"
                coverage xml -o coverage_combined.xml --omit="edtf_django_tests/*"

            - name: Pytest coverage comment
              id: coverageComment
              uses: MishaKav/pytest-coverage-comment@main
              with:
                pytest-xml-coverage-path: ./coverage_combined.xml
                unique-id-for-comment: ${{ matrix.python-version }}
                github-token: ${{ secrets.GITHUB_TOKEN }}

            - name: Check the output coverage
              run: |
                echo "Coverage Percentage - ${{ steps.coverageComment.outputs.coverage }}"
                echo "Coverage Color - ${{ steps.coverageComment.outputs.color }}"
                echo "Coverage Warnings - ${{ steps.coverageComment.outputs.warnings }}"