ci.yml

name: CI

on:
  push:
    branches-ignore:
      # these branches always have another event associated
      - gh-readonly-queue/**        # GitHub's merge queue uses `merge_group`
      - autodeps/**                 # autodeps always makes a PR
      - pre-commit-ci-update-config # pre-commit.ci's updates always have a PR
  pull_request:
  merge_group:

concurrency:
  group: ${{ github.ref }}-${{ github.workflow }}-${{ github.event_name }}${{ github.ref == format('refs/heads/{0}', github.event.repository.default_branch) && format('-{0}', github.sha) || '' }}
  cancel-in-progress: true

jobs:
  Windows:
    name: 'Windows (${{ matrix.python }}, ${{ matrix.arch }}${{ matrix.extra_name }})'
    timeout-minutes: 20
    runs-on: 'windows-latest'
    strategy:
      fail-fast: false
      matrix:
        python: ['3.9', '3.10', '3.11', '3.12', '3.13']
        arch: ['x86', 'x64']
        lsp: ['']
        lsp_extract_file: ['']
        extra_name: ['']
        include:
          - python: '3.9'
            arch: 'x64'
            lsp: 'https://raw.githubusercontent.com/python-trio/trio-ci-assets/master/komodia-based-vpn-setup.zip'
            lsp_extract_file: 'komodia-based-vpn-setup.exe'
            extra_name: ', with Komodia LSP'
          - python: '3.9'
            arch: 'x64'
            lsp: 'https://www.proxifier.com/download/legacy/ProxifierSetup342.exe'
            lsp_extract_file: ''
            extra_name: ', with IFS LSP'
          - python: 'pypy-3.10'
            arch: 'x64'
            lsp: ''
            lsp_extract_file: ''
            extra_name: ''
          #- python: '3.9'
          #  arch: 'x64'
          #  lsp: 'http://download.pctools.com/mirror/updates/9.0.0.2308-SDavfree-lite_en.exe'
          #  lsp_extract_file: ''
          #  extra_name: ', with non-IFS LSP'
    continue-on-error: >-
      ${{
        (
          endsWith(matrix.python, '-dev')
          || endsWith(matrix.python, '-nightly')
        )
        && true
        || false
      }}
    steps:
      - name: Checkout
        uses: actions/checkout@v4
      - name: Setup python
        uses: actions/setup-python@v5
        with:
          # This allows the matrix to specify just the major.minor version while still
          # expanding it to get the latest patch version including alpha releases.
          # This avoids the need to update for each new alpha, beta, release candidate,
          # and then finally an actual release version.  actions/setup-python doesn't
          # support this for PyPy presently so we get no help there.
          #
          # 'CPython' -> '3.9.0-alpha - 3.9.X'
          # 'PyPy'    -> 'pypy-3.9'
          python-version: ${{ fromJSON(format('["{0}", "{1}"]', format('{0}.0-alpha - {0}.X', matrix.python), matrix.python))[startsWith(matrix.python, 'pypy')] }}
          architecture: '${{ matrix.arch }}'
          cache: pip
          cache-dependency-path: test-requirements.txt
      - name: Run tests
        run: ./ci.sh
        shell: bash
        env:
          LSP: '${{ matrix.lsp }}'
          LSP_EXTRACT_FILE: '${{ matrix.lsp_extract_file }}'
      - if: always()
        uses: codecov/codecov-action@v3
        with:
          directory: empty
          name: Windows (${{ matrix.python }}, ${{ matrix.arch }}${{ matrix.extra_name }})
          # multiple flags is marked as an error in codecov UI, but is actually fine
          # https://github.com/codecov/feedback/issues/567
          flags: Windows,${{ matrix.python }}
          # this option cannot be set in .codecov.yml
          fail_ci_if_error: true

  Ubuntu:
    name: 'Ubuntu (${{ matrix.python }}${{ matrix.extra_name }})'
    timeout-minutes: 10
    runs-on: 'ubuntu-latest'
    strategy:
      fail-fast: false
      matrix:
        python: ['pypy-3.10', '3.9', '3.10', '3.11', '3.12', '3.13']
        check_formatting: ['0']
        no_test_requirements: ['0']
        extra_name: ['']
        include:
          - python: '3.13'
            check_formatting: '1'
            extra_name: ', check formatting'
          # separate test run that doesn't install test-requirements.txt
          - python: '3.9'
            no_test_requirements: '1'
            extra_name: ', no test-requirements'
    continue-on-error: >-
      ${{
        (
          endsWith(matrix.python, '-dev')
          || endsWith(matrix.python, '-nightly')
        )
        && true
        || false
      }}
    steps:
      - name: Checkout
        uses: actions/checkout@v4
      - name: Setup python
        uses: actions/setup-python@v5
        with:
          python-version: ${{ fromJSON(format('["{0}", "{1}"]', format('{0}.0-alpha - {0}.X', matrix.python), matrix.python))[startsWith(matrix.python, 'pypy')] }}
          cache: pip
          cache-dependency-path: test-requirements.txt
      - name: Run tests
        run: ./ci.sh
        env:
          CHECK_FORMATTING: '${{ matrix.check_formatting }}'
          NO_TEST_REQUIREMENTS: '${{ matrix.no_test_requirements }}'
      - if: >-
          always()
          && matrix.check_formatting != '1'
        uses: codecov/codecov-action@v3
        with:
          directory: empty
          name: Ubuntu (${{ matrix.python }}${{ matrix.extra_name }})
          flags: Ubuntu,${{ matrix.python }}
          fail_ci_if_error: true

  macOS:
    name: 'macOS (${{ matrix.python }})'
    timeout-minutes: 15
    runs-on: 'macos-latest'
    strategy:
      fail-fast: false
      matrix:
        python: ['pypy-3.10', '3.9', '3.10', '3.11', '3.12', '3.13']
    continue-on-error: >-
      ${{
        (
          endsWith(matrix.python, '-dev')
          || endsWith(matrix.python, '-nightly')
        )
        && true
        || false
      }}
    steps:
      - name: Checkout
        uses: actions/checkout@v4
      - name: Setup python
        uses: actions/setup-python@v5
        with:
          python-version: ${{ fromJSON(format('["{0}", "{1}"]', format('{0}.0-alpha - {0}.X', matrix.python), matrix.python))[startsWith(matrix.python, 'pypy')] }}
          cache: pip
          cache-dependency-path: test-requirements.txt
      - name: Run tests
        run: ./ci.sh
      - if: always()
        uses: codecov/codecov-action@v3
        with:
          directory: empty
          name: macOS (${{ matrix.python }})
          flags: macOS,${{ matrix.python }}
          fail_ci_if_error: true

  # run CI on a musl linux
  Alpine:
    name: "Alpine"
    runs-on: ubuntu-latest
    container: alpine
    steps:
      - name: Checkout
        uses: actions/checkout@v4
      - name: Install necessary packages
        # can't use setup-python because that python doesn't seem to work;
        # `python3-dev` (rather than `python:alpine`) for some ctypes reason,
        # `nodejs` for pyright (`node-env` pulls in nodejs but that takes a while and can time out the test).
        # `perl` for a platform independent `sed -i` alternative
        run: apk update && apk add python3-dev bash nodejs perl
      - name: Enter virtual environment
        run: python -m venv .venv
      - name: Run tests
        run: source .venv/bin/activate && ./ci.sh
      - name: Get Python version for codecov flag
        id: get-version
        run: echo "version=$(python -V | cut -d' ' -f2 | cut -d'.' -f1,2)" >> "${GITHUB_OUTPUT}"
      - if: always()
        uses: codecov/codecov-action@v3
        with:
          directory: empty
          name: Alpine
          flags: Alpine,${{ steps.get-version.outputs.version }}
          fail_ci_if_error: true

  Cython:
    name: "Cython"
    runs-on: ubuntu-latest
    strategy:
      fail-fast: false
      matrix:
        include:
          - python: '3.9'  # We support running on cython 2 and 3 for 3.9
            cython: '<3'   # cython 2
          - python: '3.9'
            cython: '>=3'  # cython 3 (or greater)
          - python: '3.11' # 3.11 is the last version Cy2 supports
            cython: '<3'   # cython 2
          - python: '3.13' # We support running cython3 on 3.13
            cython: '>=3'  # cython 3 (or greater)
    steps:
      - name: Checkout
        uses: actions/checkout@v4
      - name: Setup python
        uses: actions/setup-python@v5
        with:
            python-version: '${{ matrix.python }}'
            cache: pip
        # setuptools is needed to get distutils on 3.12, which cythonize requires
      - name: install trio and setuptools
        run: python -m pip install --upgrade pip . setuptools

      - name: install cython & compile pyx file
        run: |
          python -m pip install "cython${{ matrix.cython }}"
          cythonize --inplace tests/cython/test_cython.pyx

      - name: import & run module
        run: python -c 'import tests.cython.test_cython'

  # https://github.com/marketplace/actions/alls-green#why
  check:  # This job does nothing and is only used for the branch protection

    if: always()

    needs:
      - Windows
      - Ubuntu
      - macOS
      - Alpine
      - Cython

    runs-on: ubuntu-latest

    steps:
      - name: Decide whether the needed jobs succeeded or failed
        uses: re-actors/alls-green@release/v1
        with:
          jobs: ${{ toJSON(needs) }}