test.yml

name: test

on:
  push:
    branches:
      - master
  pull_request:
  workflow_dispatch:

permissions:
  contents: read

concurrency:
  group: ${{ github.workflow }}-${{ github.head_ref || github.run_id }}
  cancel-in-progress: true

jobs:
  mypy-self-check:
    timeout-minutes: 10
    runs-on: ubuntu-latest
    strategy:
      matrix:
        python-version: ['3.8', '3.9', '3.10', '3.11', '3.12']
      fail-fast: false
    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 dependencies
        run: |
          pip install -U pip setuptools wheel
          SETUPTOOLS_ENABLE_FEATURES=legacy-editable pip install -r ./requirements.txt

      - name: Run mypy on plugin code
        run: mypy --strict mypy_django_plugin

      - name: Run mypy on ext code
        run: mypy --strict ext
      - name: Run mypy on scripts and utils
        run: mypy --strict scripts
      - name: Run mypy on stubs
        run: mypy --cache-dir=/dev/null --no-incremental django-stubs

  test:
    timeout-minutes: 15
    runs-on: ubuntu-latest
    strategy:
      matrix:
        python-version: ['3.8', '3.9', '3.10', '3.11', '3.12']
        shard: [0, 1, 2, 3]
      fail-fast: false
    steps:
      - uses: actions/checkout@v4
      - name: Setup system dependencies
        run: |
          sudo apt-get update
          sudo apt-get install binutils libproj-dev gdal-bin
      - name: Set up Python ${{ matrix.python-version }}
        uses: actions/setup-python@v5
        with:
          python-version: ${{ matrix.python-version }}
      - name: Install dependencies
        run: |
          pip install -U pip setuptools wheel
          SETUPTOOLS_ENABLE_FEATURES=legacy-editable pip install -r ./requirements.txt

      # Must match `shard` definition in the test matrix:
      - name: Run pytest tests
        run: PYTHONPATH='.' pytest --num-shards=4 --shard-id=${{ matrix.shard }} tests
      - name: Run mypy on the test cases
        run: mypy --strict tests/assert_type

  stubtest:
    timeout-minutes: 10
    runs-on: ubuntu-latest
    strategy:
      matrix:
        python-version: ['3.12']
      fail-fast: false
    steps:
      - uses: actions/checkout@v4
      - name: Setup system dependencies
        run: |
          sudo apt-get update
          sudo apt-get install binutils libproj-dev gdal-bin
      - name: Set up Python ${{ matrix.python-version }}
        uses: actions/setup-python@v5
        with:
          python-version: ${{ matrix.python-version }}
      - name: Install dependencies
        run: |
          pip install -U pip setuptools wheel
          SETUPTOOLS_ENABLE_FEATURES=legacy-editable pip install -r ./requirements.txt

      - name: Run stubtest
        run: bash ./scripts/stubtest.sh

  run-pyright:
    timeout-minutes: 10
    runs-on: ubuntu-latest
    strategy:
      matrix:
        python-version: ['3.12']  # TODO: enable on other versions
      fail-fast: false
    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 dependencies
        run: |
          pip install -U pip setuptools wheel
          SETUPTOOLS_ENABLE_FEATURES=legacy-editable pip install -r ./requirements.txt
      - name: Run pyright on the stubs
        uses: jakebailey/pyright-action@v2
        with:
          version: PATH
          annotate: false
        continue-on-error: true  # TODO: remove this part
      - name: Run pyright on the test cases
        uses: jakebailey/pyright-action@v2
        with:
          version: PATH
          project: ./pyrightconfig.testcases.json

  matrix-test:
    timeout-minutes: 10
    runs-on: ubuntu-latest
    strategy:
      fail-fast: false
      matrix:
        python-version: ['3.11', '3.12']
        django-version: ['4.2', '5.0']
        include:
          - python-version: '3.8'
            django-version: '4.2'
          - python-version: '3.9'
            django-version: '4.2'
          - python-version: '3.10'
            django-version: '4.2'
    steps:
      - uses: actions/checkout@v4
      - name: Setup system dependencies
        run: |
          sudo apt-get update
          sudo apt-get install binutils libproj-dev gdal-bin
      - name: Set up Python ${{ matrix.python-version }}
        uses: actions/setup-python@v5
        with:
          python-version: ${{ matrix.python-version }}
      - name: Install dependencies
        run: |
          pip install -U pip setuptools wheel
          SETUPTOOLS_ENABLE_FEATURES=legacy-editable pip install -r ./requirements.txt
          pip install "Django==${{ matrix.django-version }}"
          pip check

      - name: Run django-stubs-ext tests
        run: PYTHONPATH='.' pytest ext

  build-and-check:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
        with:
          fetch-tags: true
      - uses: actions/setup-python@v5
        with:
          python-version: '3.12'
      - name: Install dependencies
        run: python3 -m pip install --upgrade build twine
      - name: Build
        run: |
          python3 -m build --sdist --wheel .
          python3 -m build --sdist --wheel ext/
      - name: Check package metadata
        run: |
          twine check --strict dist/*
          twine check --strict ext/dist/*