python_pytest.yml

# This workflow will run pytest.
#
# There are four jobs which run in parallel:
# 1. pytest-no-creds: Run all tests that don't require credentials, with credentials blanked, so
#    missing `requires_creds` markers are caught. Also runs on forks.
# 2. pytest-unit: Run unit and docs tests across multiple Python versions and operating systems, failing fast.
# 3. pytest-integration: Run integration tests on a single Python version across four shards.
# 4. pytest-coverage-combined: Combine coverage from pytest-unit (3.10/Ubuntu) and the integration shards into one report.
#
name: Run Tests

on:
    push:
      branches:
      - main
    pull_request: {}
    workflow_dispatch: {}

env:
  AIRBYTE_ANALYTICS_ID: ${{ vars.AIRBYTE_ANALYTICS_ID }}

permissions:
  contents: read
  pull-requests: read

jobs:
  pytest-no-creds:
    name: Pytest (No Creds)
    runs-on: ubuntu-latest
    permissions:
      contents: read
      code-quality: write
      pull-requests: read
    steps:
    # Common steps:
    - name: Checkout code
      uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # v6
      with:
        ref: ${{ github.event.pull_request.head.sha || github.sha }}
    - name: Install uv
      uses: astral-sh/setup-uv@f06b870e0a91d23284a3013acc55e6f88ab4b904 # v7
      with:
        version: "latest"
        python-version: '3.10'
    - name: Install dev dependencies
      # We only need helper libraries
      run: uv sync --group dev

    # Job-specific step(s):
    - name: Run Pytest (No-Creds)
      timeout-minutes: 60
      env:
        # Force this to a blank value.
        GCP_GSM_CREDENTIALS: ""
      run: >
        uv run coverage run -m pytest
        --durations=5 --exitfirst
        -m "not requires_creds and not linting and not super_slow and not flaky"

    - name: Print Coverage Report
      if: always()
      run: uv run coverage report

    - name: Create Coverage Artifacts
      if: always()
      run: |
        uv run coverage html -d htmlcov
        uv run coverage xml --include="airbyte/*" -o htmlcov/coverage.xml

    - name: Upload coverage to GitHub Artifacts
      if: always()
      uses: actions/upload-artifact@b7c566a772e6b6bfb58ed0dc250532a479d7789f # v6
      with:
        name: nocreds-test-coverage
        path: htmlcov/

    - name: Upload coverage to GitHub Code Quality
      if: always()
      uses: actions/upload-code-coverage@b51da2c3c1b23e04d2d6477cfc34350b1f5cd3e9 # v1
      with:
        file: htmlcov/coverage.xml
        language: Python
        label: code-coverage/pytest-no-creds
        fail-on-error: false

    - name: Upload logs to GitHub Artifacts
      if: failure()
      uses: actions/upload-artifact@b7c566a772e6b6bfb58ed0dc250532a479d7789f # v6
      with:
        name: pytest-no-creds-test-logs
        path: /tmp/airbyte/logs/

  pytest-unit:
    name: Pytest (Unit, Python ${{ matrix.python-version }}, ${{ matrix.os }})
    # Don't run on forks. Run on pushes to main, and on PRs that are not from forks.
    if: >
      (github.event_name == 'push' && github.ref == 'refs/heads/main') ||
      github.event_name == 'workflow_dispatch' ||
      (github.event.pull_request.head.repo.fork == false)
    strategy:
      matrix:
        python-version: [
          '3.10',
          '3.11',
          # '3.12', # Commented out: Certain tests don't work in Python 3.12, although PyAirbyte itself does work on 3.12
        ]
        os: [
          Ubuntu,
          Windows,
        ]
      fail-fast: false

    runs-on: "${{ matrix.os }}-latest"
    permissions:
      checks: write
      contents: read
      code-quality: write
      pull-requests: read
    env:
      # Enforce UTF-8 encoding so Windows runners don't fail inside the connector code.
      # TODO: See if we can fully enforce this within PyAirbyte itself.
      PYTHONIOENCODING: utf-8
    steps:
    # Common steps:
    - name: Checkout code
      uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # v6
      with:
        ref: ${{ github.event.pull_request.head.sha || github.sha }}
    - name: Install uv
      uses: astral-sh/setup-uv@f06b870e0a91d23284a3013acc55e6f88ab4b904 # v7
      with:
        version: "latest"
        python-version: ${{ matrix.python-version }}
    - name: Install dev dependencies
      # We only need helper libraries
      run: uv sync --group dev

    # Job-specific step(s):
    - name: Run Pytest [unit tests]
      timeout-minutes: 60
      env:
        GCP_GSM_CREDENTIALS: ${{ secrets.GCP_GSM_CREDENTIALS }}
      run: >
        uv run coverage run -m pytest
        --verbose --exitfirst
        tests/unit_tests/
        tests/docs_tests/
        -m "not linting and not super_slow and not flaky"

    - name: Print Coverage Report
      if: always()
      run: uv run coverage report

    - name: Create Coverage Artifacts
      if: always()
      run: |
        uv run coverage html -d htmlcov
        uv run coverage xml --include="airbyte/*" -o htmlcov/coverage.xml

    - name: Upload coverage to GitHub Artifacts
      if: always()
      uses: actions/upload-artifact@b7c566a772e6b6bfb58ed0dc250532a479d7789f # v6
      with:
        name: py${{ matrix.python-version }}-${{ matrix.os }}-unit-test-coverage
        path: htmlcov/

    - name: Upload coverage data for combined report
      if: always() && matrix.python-version == '3.10' && matrix.os == 'Ubuntu'
      uses: actions/upload-artifact@b7c566a772e6b6bfb58ed0dc250532a479d7789f # v6
      with:
        name: coverage-data-unit
        path: .coverage
        include-hidden-files: true
        if-no-files-found: error

    - name: Upload coverage to GitHub Code Quality
      if: always() && matrix.python-version == '3.10' && matrix.os == 'Ubuntu'
      uses: actions/upload-code-coverage@b51da2c3c1b23e04d2d6477cfc34350b1f5cd3e9 # v1
      with:
        file: htmlcov/coverage.xml
        language: Python
        label: code-coverage/pytest-unit
        fail-on-error: false

    - name: Upload logs to GitHub Artifacts
      if: failure()
      uses: actions/upload-artifact@b7c566a772e6b6bfb58ed0dc250532a479d7789f # v6
      with:
        name: py${{ matrix.python-version }}-${{ matrix.os }}-unit-test-logs
        path: /tmp/airbyte/logs/

    - name: Publish Test Results
      uses: EnricoMi/publish-unit-test-result-action@d0a4676d0e0b938bc201470d88276b7c74c712b3 # v2.24.0
      if: always() && !cancelled() && matrix.python-version == '3.10' && matrix.os == 'Ubuntu'
      continue-on-error: true
      with:
        check_name: "PyTest Results (Unit)"
        large_files: true
        files: |
          build/test-results/**/*.xml

  pytest-integration:
    name: Pytest (Integration, ${{ matrix.shard }})
    # Don't run on forks. Run on pushes to main, and on PRs that are not from forks.
    if: >
      (github.event_name == 'push' && github.ref == 'refs/heads/main') ||
      github.event_name == 'workflow_dispatch' ||
      (github.event.pull_request.head.repo.fork == false)
    strategy:
      fail-fast: false
      matrix:
        include:
          - shard: cache-types-cloud
            pytest-args: tests/integration_tests/test_all_cache_types.py -k "BigQuery or Snowflake"
          - shard: cache-types-local
            pytest-args: tests/integration_tests/test_all_cache_types.py -k "not BigQuery and not Snowflake"
          - shard: cloud
            pytest-args: tests/integration_tests/cloud/
          - shard: other
            pytest-args: tests/integration_tests/ --ignore=tests/integration_tests/test_all_cache_types.py --ignore=tests/integration_tests/cloud/
    runs-on: ubuntu-latest
    permissions:
      checks: write
      contents: read
      pull-requests: read
    steps:
    # Common steps:
    - name: Checkout code
      uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # v6
      with:
        ref: ${{ github.event.pull_request.head.sha || github.sha }}
    - name: Install uv
      uses: astral-sh/setup-uv@f06b870e0a91d23284a3013acc55e6f88ab4b904 # v7
      with:
        version: "latest"
        python-version: '3.10'
    - name: Install dev dependencies
      # We only need helper libraries
      run: uv sync --group dev

    # Job-specific step(s):
    - name: Run Pytest [integration tests]
      timeout-minutes: 60
      env:
        GCP_GSM_CREDENTIALS: ${{ secrets.GCP_GSM_CREDENTIALS }}
      run: >
        uv run coverage run -m pytest
        --verbose --durations=10
        ${{ matrix.pytest-args }}
        -m "not linting and not super_slow and not flaky"

    - name: Print Coverage Report
      if: always()
      run: uv run coverage report

    - name: Create Coverage Artifacts
      if: always()
      run: |
        uv run coverage html -d htmlcov
        uv run coverage xml --include="airbyte/*" -o htmlcov/coverage.xml

    - name: Upload coverage to GitHub Artifacts
      if: always()
      uses: actions/upload-artifact@b7c566a772e6b6bfb58ed0dc250532a479d7789f # v6
      with:
        name: integration-${{ matrix.shard }}-test-coverage
        path: htmlcov/

    - name: Upload coverage data for combined report
      if: always()
      uses: actions/upload-artifact@b7c566a772e6b6bfb58ed0dc250532a479d7789f # v6
      with:
        name: coverage-data-integration-${{ matrix.shard }}
        path: .coverage
        include-hidden-files: true
        if-no-files-found: error

    - name: Upload logs to GitHub Artifacts
      if: failure()
      uses: actions/upload-artifact@b7c566a772e6b6bfb58ed0dc250532a479d7789f # v6
      with:
        name: integration-${{ matrix.shard }}-test-logs
        path: /tmp/airbyte/logs/

    - name: Publish Test Results
      uses: EnricoMi/publish-unit-test-result-action@d0a4676d0e0b938bc201470d88276b7c74c712b3 # v2.24.0
      if: always() && !cancelled()
      continue-on-error: true
      with:
        check_name: "PyTest Results (Integration, ${{ matrix.shard }})"
        large_files: true
        files: |
          build/test-results/**/*.xml

  pytest-coverage-combined:
    name: Pytest (Combined Coverage)
    needs: [pytest-unit, pytest-integration]
    # Runs whenever the upstream jobs ran (even if some tests failed); skipped on forks with them.
    if: always() && needs.pytest-integration.result != 'skipped'
    runs-on: ubuntu-latest
    permissions:
      contents: read
      code-quality: write
      pull-requests: read
    steps:
    - name: Checkout code
      uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # v6
      with:
        ref: ${{ github.event.pull_request.head.sha || github.sha }}
    - name: Install uv
      uses: astral-sh/setup-uv@f06b870e0a91d23284a3013acc55e6f88ab4b904 # v7
      with:
        version: "latest"
        python-version: '3.10'
    - name: Install dev dependencies
      # We only need helper libraries
      run: uv sync --group dev

    - name: Download coverage data
      uses: actions/download-artifact@018cc2cf5baa6db3ef3c5f8a56943fffe632ef53 # v6
      with:
        pattern: coverage-data-*
        path: coverage-data/

    - name: Combine coverage data
      run: uv run coverage combine --keep coverage-data/*/.coverage

    - name: Print Coverage Report
      run: uv run coverage report

    - name: Create Coverage Artifacts
      run: |
        uv run coverage html -d htmlcov
        uv run coverage xml --include="airbyte/*" -o htmlcov/coverage.xml

    - name: Upload coverage to GitHub Artifacts
      uses: actions/upload-artifact@b7c566a772e6b6bfb58ed0dc250532a479d7789f # v6
      with:
        name: combined-test-coverage
        path: htmlcov/

    - name: Upload coverage to GitHub Code Quality
      uses: actions/upload-code-coverage@b51da2c3c1b23e04d2d6477cfc34350b1f5cd3e9 # v1
      with:
        file: htmlcov/coverage.xml
        language: Python
        label: code-coverage/pytest
        fail-on-error: false

  dependency-analysis:
    name: Dependency Analysis with Deptry
    runs-on: ubuntu-latest
    steps:
    - name: Checkout code
      uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # v6
    - name: Install uv
      uses: astral-sh/setup-uv@f06b870e0a91d23284a3013acc55e6f88ab4b904 # v7
      with:
        version: "latest"
        python-version: '3.10'
    - name: Install dev dependencies
      # We only need helper libraries
      run: uv sync --group dev

    # Job-specific step(s):
    - name: Run Deptry
      run: |
        uv run deptry .