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: {}

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

jobs:
  pytest-fast:
    name: Pytest (Fast)
    runs-on: ubuntu-latest
    permissions:
      checks: write
      pull-requests: write
      contents: read
    steps:
    # Common steps:
    - name: Checkout code
      uses: actions/checkout@v4
    - name: Set up Poetry
      uses: Gr1N/setup-poetry@v9
      with:
        poetry-version: "2.0.1"
    - name: Set up Python
      uses: actions/setup-python@v5
      with:
        python-version: '3.10'
        cache: 'poetry'
    - name: Install dependencies
      run: poetry install

    - name: Run Pytest with Coverage (Fast Tests Only)
      timeout-minutes: 60
      env:
        GCP_GSM_CREDENTIALS: ${{ secrets.GCP_GSM_CREDENTIALS }}
      run: >
        poetry 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: poetry run coverage report

    - name: Create Coverage Artifacts
      if: always()
      run: |
        poetry run coverage html -d htmlcov
        poetry run coverage xml -o htmlcov/coverage.xml

    - name: Upload coverage to GitHub Artifacts
      if: always()
      uses: actions/upload-artifact@v4
      with:
        name: fasttest-coverage
        path: htmlcov/

    - name: Publish Test Results (dorny)
      uses: dorny/test-reporter@v2
      if: always()
      with:
        name: PyAirbyte Test Results (dorny)
        path: build/test-results/**/*.xml
        reporter: java-junit
        fail-on-error: false
        list-suites: all
        list-tests: all
        max-annotations: 50
        only-summary: false

    - name: Upload logs to GitHub Artifacts
      if: failure()
      uses: actions/upload-artifact@v4
      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
    steps:
    # Common steps:
    - name: Checkout code
      uses: actions/checkout@v4
    - name: Set up Poetry
      uses: Gr1N/setup-poetry@v9
      with:
        poetry-version: "2.0.1"
    - name: Set up Python
      uses: actions/setup-python@v5
      with:
        python-version: '3.10'
        cache: 'poetry'
    - name: Install dependencies
      run: poetry install

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

    - name: Publish Test Results (mikepenz)
      uses: mikepenz/action-junit-report@v5
      if: always()
      with:
        report_paths: 'build/test-results/**/*.xml'
        check_name: 'PyAirbyte Test Results (mikepenz)'
        fail_on_failure: false
        require_tests: true
        include_passed: true
        detailed_summary: false
        check_retries: true
        include_time_in_summary: true
        verbose_summary: false
        comment: true

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

    - name: Create Coverage Artifacts
      if: always()
      run: |
        poetry run coverage html -d htmlcov
        poetry run coverage xml -o htmlcov/coverage.xml

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

    - name: Upload logs to GitHub Artifacts
      if: failure()
      uses: actions/upload-artifact@v4
      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.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"
    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@v4
    - name: Set up Poetry
      uses: Gr1N/setup-poetry@v9
      with:
        poetry-version: "2.0.1"
    - name: Set up Python
      uses: actions/setup-python@v5
      with:
        python-version: ${{ matrix.python-version }}
        cache: 'poetry'
    - name: Install dependencies
      run: poetry install

    # Job-specific step(s):
    - name: Run Pytest
      timeout-minutes: 60
      env:
        GCP_GSM_CREDENTIALS: ${{ secrets.GCP_GSM_CREDENTIALS }}
      run: >
        poetry run coverage run -m pytest
        --verbose
        -m "not linting and not super_slow and not flaky"

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

    - name: Create Coverage Artifacts
      if: always()
      run: |
        poetry run coverage html -d htmlcov
        poetry run coverage xml -o htmlcov/coverage.xml

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

    - name: Upload logs to GitHub Artifacts
      if: failure()
      uses: actions/upload-artifact@v4
      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@v4
    - name: Set up Python
      uses: actions/setup-python@v5
      with:
        python-version: '3.10'
    - name: Set up Poetry
      uses: Gr1N/setup-poetry@v9
      with:
        poetry-version: "2.0.1"
    - name: Install dependencies
      run: poetry install

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