test.yml

name: Test suite

on:
  push:
    branches:
      - main
    tags:
      - '**'
  pull_request: {}

jobs:
  test:
    runs-on: ubuntu-latest
    strategy:
      matrix:
        python-version: ["3.8", "3.9", "3.10", "3.11", "3.12"]

    steps:
    - uses: actions/checkout@v4
    - name: Set up Python ${{ matrix.python-version }}
      uses: actions/setup-python@v5
      with:
        python-version: ${{ matrix.python-version }}

    - name: Install poetry
      run: make poetry-download

    - name: Set up cache
      uses: actions/cache@v4
      with:
        path: .venv
        key: venv-${{ matrix.python-version }}-${{ hashFiles('pyproject.toml') }}-${{ hashFiles('poetry.lock') }}
    - name: Install dependencies
      run: |
        poetry config virtualenvs.in-project true
        poetry install

    - name: Run style checks
      run: make lint

    - name: Run tests
      run: make test

    - name: Run code in docs/examples/
      run: make test-examples

    - name: Run safety checks
      run: make SAFETY_KEY=${{ secrets.SAFETY_API_KEY }} check-safety

    - name: Verify changed coverage badge
      uses: tj-actions/verify-changed-files@v20
      id: verify-changed-files
      with:
        files: assets/images/coverage.svg

    - name: Commit coverage badge
      if: steps.verify-changed-files.outputs.files_changed == 'true'
      run: |
        echo "::error::The code coverage measured in the CI differs from the one within the SVG. Please run 'make test' locally and push the coverage.svg"
        exit 1