ci.yml

name: CI

on:
  pull_request:

jobs:
  pytest:
    runs-on: ubuntu-22.04

    strategy:
      fail-fast: false
      matrix:
        python-version: ['py312']
        django-version: ['django42']
        db-version: ['mysql80']
        pytest-split-group: [1, 2, 3, 4, 5, 6]
        status: ['']

    steps:
      - uses: actions/checkout@v3
      - name: Format Python Version
        id: format_python_version
        shell: bash
        run: |
          # Remove 'py' and insert a dot to format the version
          FORMATTED_VERSION=${{ matrix.python-version }}  # e.g., py312
          FORMATTED_VERSION=${FORMATTED_VERSION/py3/3.}    # becomes 3.12
          
          # Set environment variables
          echo "PYTHON_VERSION=$FORMATTED_VERSION" >> $GITHUB_ENV
          
          # Output formatted version for use in subsequent steps
          echo "Using Python Version: $FORMATTED_VERSION"

      - run: make ci_up
      - name: run tests
        env:
          DB_HOST: ${{ matrix.db-version }}
          PYTEST_SPLIT_GROUP: ${{ matrix.pytest-split-group }}
        run: make ci_test TOXENV=${{ matrix.python-version }}-${{ matrix.django-version }}
        # Unfortunately, continue-on-error marks the job as successful. We really want something like "allow failure"
        # that would note the failure, but not fail the entire workflow and not email the author about it.
        # See https://github.com/actions/toolkit/issues/399
        continue-on-error: ${{ matrix.status == 'ignored' }}
      - name: Upload coverage
        if: matrix.db-version == 'mysql80'
        uses: actions/upload-artifact@v4
        with:
          name: coverage${{ matrix.pytest-split-group }}
          path: .coverage
          include-hidden-files: true

  # Combine and upload coverage reports.
  coverage:
    needs: pytest
    runs-on: ubuntu-22.04
    steps:
      - uses: actions/checkout@v3
      - run: make ci_up
        env:
          PYTHON_VERSION: 3.12
      - name: Download all artifacts
        # Downloads coverage1, coverage2, etc.
        uses: actions/download-artifact@v4
      - name: Run coverage
        run: make ci_coverage
      - uses: codecov/codecov-action@v4
        with:
          token: ${{ secrets.CODECOV_TOKEN }}
          fail_ci_if_error: true

  quality:
    runs-on: ubuntu-22.04
    steps:
      - uses: actions/checkout@v3
      - run: make ci_up
        env:
          PYTHON_VERSION: 3.12
      - run: make ci_quality

  semgrep:
    runs-on: ubuntu-22.04
    strategy:
      matrix:
        python-version: ['3.12']
    steps:
      - uses: actions/checkout@v3
      - run: make ci_up
        env:
          PYTHON_VERSION: ${{ matrix.python-version }}
      - name: Run semgrep Django rules
        run: make ci_semgrep