tests.yml

name: "Tests: PR"

on:
  push:
    branches: [ main ]
  pull_request: ~
  workflow_dispatch:

concurrency:
  group: ${{ github.workflow }}-${{ github.ref }}
  cancel-in-progress: true

jobs:
  test:
    name: "
    Python: ${{ matrix.python-version }}
    SQLAlchemy: ${{ matrix.sqla-version }}
    "
    runs-on: ${{ matrix.os }}
    strategy:
      matrix:
        os: ['ubuntu-22.04']
        python-version: ['3.7', '3.8', '3.9', '3.10', '3.11', '3.12', '3.13']
        cratedb-version: ['5.5.1']
        sqla-version: ['<1.4', '<1.5', '<2.1']
        pip-allow-prerelease: ['false']

        exclude:
          # SQLAlchemy 1.3 is not supported on Python 3.12 and higher.
          - python-version: '3.12'
            sqla-version: '<1.4'
          - python-version: '3.13'
            sqla-version: '<1.4'

        # Another CI test matrix slot to test against prerelease versions of Python packages.
        include:
          - os: 'ubuntu-latest'
            python-version: '3.13'
            cratedb-version: '5.5.1'
            sqla-version: 'latest'
            pip-allow-prerelease: 'true'

      fail-fast: false

    env:
      CRATEDB_VERSION: ${{ matrix.cratedb-version }}
      SQLALCHEMY_VERSION: ${{ matrix.sqla-version }}
      PIP_ALLOW_PRERELEASE: ${{ matrix.pip-allow-prerelease }}
      CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}

    steps:

      - name: Acquire sources
        uses: actions/checkout@v4

      - name: Run CrateDB
        run: docker compose -f tests/docker-compose.yml up -d

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

      - name: Update setuptools
        run: |

          # `setuptools 0.64.0` adds support for editable install hooks (PEP 660).
          # https://github.com/pypa/setuptools/blob/main/CHANGES.rst#v6400
          pip install "setuptools>=64" --upgrade

      - name: Invoke tests
        run: |

          # Bootstrap environment.
          source bootstrap.sh

          # Report about the test matrix slot.
          echo "Invoking tests with CrateDB ${CRATEDB_VERSION} and SQLAlchemy ${SQLALCHEMY_VERSION}"

          # Run linters and software tests.
          export SQLALCHEMY_WARN_20=1
          poe check

      # https://github.com/codecov/codecov-action
      - name: Upload coverage results to Codecov
        uses: codecov/codecov-action@v4
        env:
          CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
        with:
          files: ./coverage.xml
          flags: main
          env_vars: OS,PYTHON
          name: codecov-umbrella
          fail_ci_if_error: true