cibuildwheel/.github/workflows/test.yml

name: Test

on:
  push:
    branches:
      - main
      - 2.x
  pull_request:
    types:
      - opened
      - synchronize
      - reopened
      - labeled
    paths-ignore:
      - .ci*
      - bin/*
      - docs/**
      - examples/azure-pipelines-*
      - examples/ci*
      - examples/travis-ci-*
      - .pre-commit-config.yaml
      - .readthedocs.yml
      - .travis.yml
      - README.md
      - azure-pipelines.yml
      - mkdocs.yml
      - noxfile.py
  workflow_dispatch:
    # allow manual runs on branches without a PR

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

jobs:
  lint:
    name: Linters (mypy, ruff, etc.)
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@v4
    - uses: actions/setup-python@v5
      id: python
      with:
        python-version: "3.x"
    - uses: pre-commit/action@v3.0.1
    - name: PyLint checks
      run: pipx run --python "${{ steps.python.outputs.python-path }}" nox -s pylint -- --output-format=github

  test:
    name: Test on ${{ matrix.os }} (${{ matrix.python_version }})
    needs: lint
    runs-on: ${{ matrix.os }}
    strategy:
      matrix:
        os: [ubuntu-latest, ubuntu-24.04-arm, windows-latest, windows-11-arm, macos-13, macos-15]
        python_version: ['3.13']
        include:
        - os: ubuntu-latest
          python_version: '3.11'
        - os: ubuntu-latest
          python_version: '3.14'
    timeout-minutes: 180
    steps:
    - uses: actions/checkout@v4
    - uses: actions/setup-python@v5
      name: Install Python ${{ matrix.python_version }}
      with:
        python-version: ${{ matrix.python_version }}
        allow-prereleases: true

    - uses: astral-sh/setup-uv@v6

    - name: Free up disk space
      if: runner.os == 'Linux'
      run: |
        docker system prune -a -f
        sudo rm -rf $ANDROID_HOME/ndk/{26,28}.* /opt/hostedtoolcache/CodeQL \
          /usr/local/lib/node_modules /usr/local/share/chromium \
          /usr/local/share/powershell
        df -h

    # https://github.blog/changelog/2024-04-02-github-actions-hardware-accelerated-android-virtualization-now-available/
    - name: Enable KVM for Android emulator
      if: runner.os == 'Linux' && runner.arch == 'X64'
      run: |
          echo 'KERNEL=="kvm", GROUP="kvm", MODE="0666", OPTIONS+="static_node=kvm"' | sudo tee /etc/udev/rules.d/99-kvm4all.rules
          sudo udevadm control --reload-rules
          sudo udevadm trigger --name-match=kvm

    # for oci_container unit tests
    - name: Set up QEMU
      if: runner.os == 'Linux'
      uses: docker/setup-qemu-action@v3

    - name: Install dependencies
      run: |
        uv sync --no-dev --group test

    - uses: joerick/pr-labels-action@v1.0.9
    - name: Set CIBW_ENABLE
      shell: bash
      run: |
        if [[ "${{ github.ref_name }}" == "main" ]]; then
          CIBW_ENABLE=all
        else
          # get the default CIBW_ENABLE value from the test module
          CIBW_ENABLE=$(uv run --no-sync python -c 'import sys, test.utils as c; sys.stdout.write(c.DEFAULT_CIBW_ENABLE)')

          # if this is a PR, check for labels
          if [[ -n "$GITHUB_PR_LABEL_CI_PYPY" ]]; then
            CIBW_ENABLE+=" pypy"
          fi
          if [[ -n "$GITHUB_PR_LABEL_CI_GRAALPY" ]]; then
            CIBW_ENABLE+=" graalpy"
          fi
        fi
        echo "CIBW_ENABLE=${CIBW_ENABLE}" >> $GITHUB_ENV

    - name: Generate a sample project
      run: |
        uv run --no-sync -m test.test_projects test.test_0_basic.basic_project sample_proj

    - name: Run a sample build (GitHub Action)
      uses: ./
      with:
        package-dir: sample_proj
        output-dir: wheelhouse
      env:
        CIBW_ARCHS_MACOS: x86_64 universal2 arm64
        CIBW_BUILD_FRONTEND: 'build[uv]'

    - name: Run a sample build (GitHub Action, only)
      uses: ./
      with:
        package-dir: sample_proj
        output-dir: wheelhouse_only
        only: cp312-${{ runner.os == 'Linux' && (runner.arch == 'ARM64' && 'manylinux_aarch64' || 'manylinux_x86_64') || (runner.os == 'Windows' && 'win_amd64' || 'macosx_x86_64') }}

    - name: Create custom configuration file
      shell: bash
      run: |
        cat > sample_proj/cibw.toml <<EOF
        [tool.cibuildwheel]
        # Only build on CPython 3.12 on native arch
        archs = ["native"]
        build = "cp312-*"
        # Skip musllinux
        skip = "*-musllinux*"
        EOF

    - name: Run a sample build (GitHub Action, config-file)
      uses: ./
      with:
        package-dir: sample_proj
        output-dir: wheelhouse_config_file
        config-file: sample_proj/cibw.toml

    - name: Check Action artifacts
      shell: bash
      run: |
        test $(find wheelhouse -name '*.whl' | wc -l) -ge 1
        test $(find wheelhouse_only -name '*.whl' | wc -l) -eq 1
        test $(find wheelhouse_config_file -name '*.whl' | wc -l) -eq 1

    - uses: actions/upload-artifact@v4
      with:
        name: cibw-wheels-${{ matrix.os }}-${{ strategy.job-index }}
        path: wheelhouse/*.whl

    - name: Test cibuildwheel
      run: |
        uv run --no-sync bin/run_tests.py ${{ (runner.os == 'Linux' && runner.arch == 'X64') && '--run-podman' || '' }}

  emulated-archs:
    name: Get qemu emulated architectures
    needs: lint
    runs-on: ubuntu-latest
    outputs:
      archs: ${{ steps.archs.outputs.archs }}
    steps:
    - uses: actions/checkout@v4
    - uses: actions/setup-python@v5
      with:
        python-version: "3.x"
    - uses: astral-sh/setup-uv@v6
    - name: Install dependencies
      run: uv sync --no-dev --group test
    - name: Get qemu emulated architectures
      id: archs
      run: |
        OUTPUT=$(uv run --no-sync python -c "from json import dumps; from test.utils import EMULATED_ARCHS; print(dumps(EMULATED_ARCHS))")
        echo "${OUTPUT}"
        echo "archs=${OUTPUT}" >> "$GITHUB_OUTPUT"

  test-emulated:
    name: Test Linux ${{ matrix.arch }} using qemu
    needs: emulated-archs
    runs-on: ubuntu-latest
    timeout-minutes: 180
    strategy:
      matrix:
        arch: ${{ fromJSON(needs.emulated-archs.outputs.archs) }}
    steps:
    - uses: actions/checkout@v4
    - uses: actions/setup-python@v5
      with:
        python-version: "3.x"
    - uses: astral-sh/setup-uv@v6
    - name: Install dependencies
      run: uv sync --no-dev --group test

    - name: Set up QEMU
      uses: docker/setup-qemu-action@v3

    - name: Run the emulation tests
      run: uv run --no-sync pytest --run-emulation ${{ matrix.arch }} test/test_emulation.py

  test-pyodide:
    name: Test pyodide
    needs: lint
    runs-on: ubuntu-24.04
    timeout-minutes: 180
    steps:
    - uses: actions/checkout@v4
    - uses: actions/setup-python@v5
      name: Install Python 3.12
      with:
        python-version: '3.12'
    - uses: astral-sh/setup-uv@v6

    - name: Install dependencies
      run: uv sync --no-dev --group test

    - name: Generate a sample project
      run: |
        uv run --no-sync -m test.test_projects test.test_0_basic.basic_project sample_proj

    - name: Run a sample build (GitHub Action)
      uses: ./
      with:
        package-dir: sample_proj
        output-dir: wheelhouse
      env:
        CIBW_PLATFORM: pyodide

    - name: Run tests with 'CIBW_PLATFORM' set to 'pyodide'
      run: |
        uv run --no-sync ./bin/run_tests.py
      env:
        CIBW_PLATFORM: pyodide