python-ci.yml

name: Python CI
on:
  pull_request:
    paths:
      - python/**
      - .github/workflows/python-ci.yml
      - Pipfile
      - Pipfile.lock

  push:
    branches:
      - main
    paths:
      - python/**
      - .github/workflows/python-ci.yml
      - Pipfile
      - Pipfile.lock

  workflow_dispatch:

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

env:
  LOOKERSDK_BASE_URL: https://localhost:20000
  LOOKERSDK_VERIFY_SSL: false
  TOX_JUNIT_OUTPUT_DIR: results

permissions:
  contents: read

jobs:
  typecheck:
    name: Mypy
    runs-on: ubuntu-latest
    defaults:
      run:
        shell: bash
        working-directory: python/

    steps:
      - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
        with:
          persist-credentials: false
      - uses: actions/setup-python@6d4fd22b20465ccc0f7354476588e8df7c9ca0e0 # v7.1.0
        with:
          python-version: '3.14'
      - run: pip install -e .
      - run: pip install mypy types-requests
      - run: mypy looker_sdk/

  unit:
    needs: typecheck
    name: Unit - ${{ matrix.os }} / py${{ matrix.python-version }}
    env:
      TOX_JUNIT_OUTPUT_NAME: ${{ matrix.os }}.py${{ matrix.python-version }}
    runs-on: ${{ matrix.os }}-latest
    defaults:
      run:
        shell: bash
        working-directory: python/

    strategy:
      # run all supported python versions on ubuntu
      # run only latest supported python version on windows/mac
      matrix:
        os:
          - ubuntu
            # - macos # Temporary disable since runners down
          - windows
        python-version:
          - '3.14'
        include:
          - python-version: '3.10'
            os: ubuntu
          - python-version: '3.11'
            os: ubuntu
          - python-version: '3.12'
            os: ubuntu
          - python-version: '3.13'
            os: ubuntu

    steps:
      - name: Repo Checkout
        uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
        with:
          persist-credentials: false

      - name: Set up Python ${{ matrix.python-version }}
        uses: actions/setup-python@6d4fd22b20465ccc0f7354476588e8df7c9ca0e0 # v7.1.0
        with:
          python-version: ${{ matrix.python-version }}

      - name: Install Tox and any other packages
        run: |
          python -m pip install --upgrade pip
          pip install tox

      - name: Run Unit Tests
        run: tox -e unit

      - name: Upload pytest test results
        if: ${{ always() }}
        uses: actions/upload-artifact@cf430e030ddbb5b0abf93d22962f4752f3646cd9 # v7.0.2
        with:
          name: python-test-results-${{ matrix.os }}-${{ matrix.python-version }}
          path: python/results/

  integration:
    needs: [unit]
    name: Integration - ${{ matrix.os }} / Looker.${{ matrix.looker }}
    env:
      TOX_JUNIT_OUTPUT_NAME: ${{ matrix.os }}.Looker-${{ matrix.looker }}.py3.x
      LOOKERSDK_CLIENT_ID: ${{ secrets.LOOKERSDK_CLIENT_ID }}
      LOOKERSDK_CLIENT_SECRET: ${{ secrets.LOOKERSDK_CLIENT_SECRET }}
      LOOKERSDK_TIMEOUT: 600
    runs-on:
      group: ${{ matrix.os }}
    #runs-on: Ubuntu20.04-4core-16gb
    defaults:
      run:
        shell: bash
        working-directory: python/

    strategy:
      matrix:
        os:
          - large-ubuntu
        looker:
          ${{ fromJson(vars.SUPPORTED_LOOKER_VERSIONS) }}

          # TODO uncomment `include:` when either macos or windows works to satisfaction.
          #include:
          # TODO: macos matrix leg is functional but it takes ~20 minutes (compared
          # to ~4 minutes for ubuntu) because docker install takes ~5 minutes
          # and docker pull takes ~10 minutes. We can probably figure out how to
          # cache the docker install but hopefully github will soon have docker
          # available pre-installed on macos so not worth the effort now.
          # Regarding docker pull ... it would be nice if there's a way to cache
          # only some layers of the image on the runner but we don't want to cache
          # the final layer(s) with Looker IP. This would speed up docker pull on
          # all OSs.
          #- os: macos
          #  python-version: 3.9
          #  looker: '7_20'
          # TODO: currently can't run linux containers on windows.
          # Pending new windows server version
          # https://github.com/actions/virtual-environments/issues/1143#issuecomment-698797524
          #- os: windows
          #  python-version: 3.9
          #  looker: '7_20'
    steps:
      - name: Repo Checkout
        uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
        with:
          persist-credentials: false

      - name: Set up Python 3.14
        uses: actions/setup-python@6d4fd22b20465ccc0f7354476588e8df7c9ca0e0 # v7.1.0
        with:
          python-version: '3.14'

      - name: Authenticate to Google Cloud
        uses: google-github-actions/auth@7c6bc770dae815cd3e89ee6cdf493a5fab2cc093 # v3.0.0
        with:
          credentials_json: ${{ secrets.GCP_AR_READER_SA_KEY }}
          project_id: ${{ secrets.GCP_PROJECT_ID }}
          create_credentials_file: true
          export_environment_variables: true

      - name: Set up Cloud SDK
        uses: google-github-actions/setup-gcloud@aa5489c8933f4cc7a4f7d45035b3b1440c9c10db # v3.0.1

      - name: Authenticate Artifact Repository
        run: gcloud auth configure-docker us-west1-docker.pkg.dev --quiet

      - name: Install docker on macos
        if: ${{ matrix.os == 'macos' }}
        uses: docker-practice/actions-setup-docker@fd7ecdac7caf8e2c541a48c9bcc280aae59a8461 # v1
        with:
          docker_channel: stable
          docker_buildx: false
          docker_cli_experimental: disabled

      - name: Bump docker for mac memory
        if: ${{ matrix.os == 'macos' }}
        run: |
          osascript -e 'quit app "Docker"'
          sed -i'.original' -e's/  "memoryMiB" : 2048/  "memoryMiB" : 8192/' ~/Library/Group\ Containers/group.com.docker/settings.json
          open -g /Applications/Docker.app
          # re-run docker startup logic from docker-practice/actions-setup-docker action
          sleep 60
          i=0
          while ! docker system info &>/dev/null; do
          (( i++ == 0 )) && printf %s '-- Waiting for Docker to finish starting up...' || printf '.'
          sleep 1
          done
          (( i )) && printf '\n'
          echo "-- Docker is ready."

      - name: Pull and run Looker docker image
        # TODO: can we cache some layers of the image for faster download?
        # we probably don't want to cache the final image for IP security...
        run: |
          docker pull --quiet us-west1-docker.pkg.dev/cloud-looker-sdk-codegen-cicd/looker/${MATRIX_LOOKER}
          # set $LOOKER_OPTS to --no-ssl if we want to turn off ssl
          docker run --name looker-sdk-codegen-ci -d -p 10000:9999 -p 20000:19999 us-west1-docker.pkg.dev/cloud-looker-sdk-codegen-cicd/looker/${MATRIX_LOOKER}
          docker logs -f looker-sdk-codegen-ci --until=30s &
        env:
          MATRIX_LOOKER: ${{ matrix.looker }}

      - name: Install Tox and any other packages
        run: |
          python -m pip install --upgrade pip
          pip install tox

      - name: Check that Looker is ready
        run: |
          ${{ github.workspace }}/.github/scripts/wait_for_looker.sh

      - name: Run Integration Tests
        run: tox -e integration

      - name: Upload pytest test results
        if: ${{ always() }}
        uses: actions/upload-artifact@cf430e030ddbb5b0abf93d22962f4752f3646cd9 # v7.0.2
        with:
          name: python-test-results-${{ matrix.os }}-${{ matrix.looker }}
          path: python/results/

  twine:
    needs: [unit, integration]
    runs-on: ubuntu-latest
    defaults:
      run:
        shell: bash
        working-directory: python/

    steps:
      - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
        with:
          persist-credentials: false
      - uses: actions/setup-python@6d4fd22b20465ccc0f7354476588e8df7c9ca0e0 # v7.1.0
        with:
          python-version: '3.14'
      - name: Twine upload check
        run: |
          pip install wheel twine setuptools
          python setup.py sdist bdist_wheel
          twine check dist/*

  publish-test-results:
    needs: [unit, integration, twine]
    if: success() || failure()
    runs-on: ubuntu-latest

    permissions:
      pull-requests: write
      checks: write

    steps:
      - name: Download Artifacts
        uses: actions/download-artifact@9000827ccba6bdab643e8b6fd33ac0654aef8333 # v8.0.2
        with:
          path: artifacts

      # If there are no test result files the test is reported as passing!
      # That allows for some weird failure modes, where an early failure
      # is not distinguished from a pass.
      - name: Check Results Files Exist
        id: check-results-exist
        run: |
          if [[ $(ls -l artifacts/python-test-results*/*.xml 2> /dev/null | wc -l) -ge "1" ]]; then
            exit 0
          else
            curl --request POST \
            --url https://api.github.com/repos/looker-open-source/sdk-codegen/check-runs \
            --header "authorization: Bearer ${{ secrets.GITHUB_TOKEN }}" \
            --header "content-type: application/json" \
            --header "Accept: application/vnd.github.v3+json" \
            --data '{
              "name": "Python Tests",
              "head_sha": "${{ github.event.pull_request.head.sha || github.sha }}",
              "conclusion": "failure"
            }' \
            --fail \
            -o /dev/null \
            --silent
            exit 1
          fi

      - name: Publish Unit Test Results
        if: steps.check-results-exist.outcome == 'success'
        uses: EnricoMi/publish-unit-test-result-action@7622c5bf3d112a72ab4fa3951c2aa5723d8ab92d # v2.25.0
        with:
          # Cosmetic issue with `check_name` being associated to the wrong
          # workflow: https://github.com/EnricoMi/publish-unit-test-result-action/issues/12
          check_name: Python Tests
          github_token: ${{ secrets.GITHUB_TOKEN }}
          report_individual_runs: true
          check_run_annotations_branch: '*'
          files: 'artifacts/python-test-results*/*.xml'