python_pytest.yml

# This workflow will run pytest.
#
# There are three jobs which run in parallel:
# 1. pytest-fast: Run fast tests only, and fail fast so the dev knows asap if they broke something.
# 2. pytest-no-creds: Run tests only if they don't require creds. The main use case is to run tests
#    on forks, where secrets are not available. We flush the GCP_GSM_CREDENTIALS env var to an
#    invalid value to ensure that tests that require creds are not run.
# 3. pytest: Run all tests, across multiple python versions.
#
# Note that pytest-fast also skips tests that require credentials, allowing it to run on forks.
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-fast:
    name: Pytest (Fast)
    runs-on: ubuntu-latest
    permissions:
      checks: write
      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

    - name: Run Pytest with Coverage (Fast Tests Only)
      timeout-minutes: 60
      env:
        GCP_GSM_CREDENTIALS: ${{ secrets.GCP_GSM_CREDENTIALS }}
      run: >
        uv run coverage run -m pytest
        --durations=5 --exitfirst
        -m "not slow and not requires_creds and not linting 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: fasttest-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-fast
        fail-on-error: false

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

    - name: Publish Test Results
      uses: EnricoMi/publish-unit-test-result-action@v2
      if: always() && !cancelled()
      continue-on-error: true
      with:
        check_name: "PyTest Results (Fast Tests Only, No Creds)"
        large_files: true
        files: |
          build/test-results/**/*.xml

  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:
    name: Pytest (All, 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 [all]
      if: matrix.os != 'Windows'
      timeout-minutes: 60
      env:
        GCP_GSM_CREDENTIALS: ${{ secrets.GCP_GSM_CREDENTIALS }}
      run: >
        uv run coverage run -m pytest
        --verbose
        -m "not linting and not super_slow and not flaky"

    - name: Run Pytest [unit tests only]
      if: matrix.os == 'Windows'
      timeout-minutes: 60
      env:
        GCP_GSM_CREDENTIALS: ${{ secrets.GCP_GSM_CREDENTIALS }}
      run: >
        uv run coverage run -m pytest
        --verbose
        tests/unit_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 }}-test-coverage
        path: htmlcov/

    - 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
        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 }}-test-logs
        path: /tmp/airbyte/logs/

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

  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 .