docs: add steps for testing the connector #2577
Workflow file for this run
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| # Copyright 2023 Google LLC | |
| # | |
| # Licensed under the Apache License, Version 2.0 (the "License"); | |
| # you may not use this file except in compliance with the License. | |
| # You may obtain a copy of the License at | |
| # | |
| # http://www.apache.org/licenses/LICENSE-2.0 | |
| # | |
| # Unless required by applicable law or agreed to in writing, software | |
| # distributed under the License is distributed on an "AS IS" BASIS, | |
| # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | |
| # See the License for the specific language governing permissions and | |
| # limitations under the License. | |
| name: tests | |
| on: | |
| pull_request: | |
| branches: | |
| - main | |
| push: | |
| branches: | |
| - main | |
| schedule: | |
| - cron: '0 2 * * *' | |
| # Declare default permissions as read only. | |
| permissions: read-all | |
| jobs: | |
| unit: | |
| name: unit tests | |
| runs-on: ${{ matrix.os }} | |
| permissions: | |
| contents: read | |
| id-token: write | |
| issues: write | |
| pull-requests: write | |
| strategy: | |
| matrix: | |
| os: [macos-latest, windows-latest, ubuntu-latest] | |
| python-version: ["3.8", "3.12"] | |
| fail-fast: false | |
| steps: | |
| - name: Checkout code | |
| uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 # v4.1.7 | |
| with: | |
| ref: ${{ github.event.pull_request.head.sha }} | |
| repository: ${{ github.event.pull_request.head.repo.full_name }} | |
| - name: Setup Python ${{ matrix.python-version }} | |
| uses: actions/setup-python@f677139bbe7f9c59b41e40162b753c062f5d49a3 # v5.2.0 | |
| with: | |
| python-version: ${{ matrix.python-version }} | |
| - name: Install nox | |
| run: pip install nox | |
| - id: 'auth' | |
| name: Authenticate to Google Cloud | |
| # only needed for Flakybot on periodic (schedule) and continuous (push) events | |
| if: ${{ github.event_name == 'schedule' || github.event_name == 'push' }} | |
| uses: google-github-actions/auth@62cf5bd3e4211a0a0b51f2c6d6a37129d828611d # v2.1.5 | |
| with: | |
| workload_identity_provider: ${{ vars.PROVIDER_NAME }} | |
| service_account: ${{ vars.SERVICE_ACCOUNT }} | |
| access_token_lifetime: 600s | |
| - name: Run tests | |
| run: nox -s unit-${{ matrix.python-version }} | |
| - name: FlakyBot (Linux) | |
| # only run flakybot on periodic (schedule) and continuous (push) events | |
| if: ${{ (github.event_name == 'schedule' || github.event_name == 'push') && runner.os == 'Linux' && always() }} | |
| run: | | |
| curl https://github.com/googleapis/repo-automation-bots/releases/download/flakybot-1.1.0/flakybot -o flakybot -s -L | |
| chmod +x ./flakybot | |
| ./flakybot --repo ${{github.repository}} --commit_hash ${{github.sha}} --build_url https://github.com/${{github.repository}}/actions/runs/${{github.run_id}} | |
| - name: FlakyBot (Windows) | |
| # only run flakybot on periodic (schedule) and continuous (push) events | |
| if: ${{ (github.event_name == 'schedule' || github.event_name == 'push') && runner.os == 'Windows' && always() }} | |
| run: | | |
| curl https://github.com/googleapis/repo-automation-bots/releases/download/flakybot-1.1.0/flakybot.exe -o flakybot.exe -s -L | |
| ./flakybot.exe --repo ${{github.repository}} --commit_hash ${{github.sha}} --build_url https://github.com/${{github.repository}}/actions/runs/${{github.run_id}} | |
| - name: FlakyBot (macOS) | |
| # only run flakybot on periodic (schedule) and continuous (push) events | |
| if: ${{ (github.event_name == 'schedule' || github.event_name == 'push') && runner.os == 'macOS' && always() }} | |
| run: | | |
| curl https://github.com/googleapis/repo-automation-bots/releases/download/flakybot-1.1.0/flakybot-darwin-amd64 -o flakybot -s -L | |
| chmod +x ./flakybot | |
| ./flakybot --repo ${{github.repository}} --commit_hash ${{github.sha}} --build_url https://github.com/${{github.repository}}/actions/runs/${{github.run_id}} | |
| integration: | |
| name: integration tests | |
| runs-on: [self-hosted, linux, x64] | |
| # run integration tests on all builds except pull requests from forks or | |
| # dependabot | |
| if: | | |
| github.event_name != 'pull_request' || | |
| (github.event.pull_request.head.repo.full_name == github.repository && github.actor != 'dependabot[bot]') | |
| strategy: | |
| matrix: | |
| python-version: ["3.8", "3.12"] | |
| fail-fast: false | |
| permissions: | |
| contents: read | |
| id-token: write | |
| issues: write | |
| pull-requests: write | |
| steps: | |
| - name: Checkout code | |
| uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 # v4.1.7 | |
| with: | |
| ref: ${{ github.event.pull_request.head.sha }} | |
| repository: ${{ github.event.pull_request.head.repo.full_name }} | |
| - name: Setup Python ${{ matrix.python-version }} | |
| uses: actions/setup-python@f677139bbe7f9c59b41e40162b753c062f5d49a3 # v5.2.0 | |
| with: | |
| python-version: ${{ matrix.python-version }} | |
| - name: Install nox | |
| run: pip install nox | |
| - id: 'auth' | |
| name: 'Authenticate to Google Cloud' | |
| uses: google-github-actions/auth@62cf5bd3e4211a0a0b51f2c6d6a37129d828611d # v2.1.5 | |
| with: | |
| workload_identity_provider: ${{ vars.PROVIDER_NAME }} | |
| service_account: ${{ vars.SERVICE_ACCOUNT }} | |
| access_token_lifetime: 600s | |
| - id: 'secrets' | |
| name: Get secrets | |
| uses: google-github-actions/get-secretmanager-secrets@95a0b09b8348ef3d02c68c6ba5662a037e78d713 # v2.1.4 | |
| with: | |
| secrets: |- | |
| ALLOYDB_INSTANCE_URI:${{ vars.GOOGLE_CLOUD_PROJECT }}/ALLOYDB_INSTANCE_URI | |
| ALLOYDB_CLUSTER_PASS:${{ vars.GOOGLE_CLOUD_PROJECT }}/ALLOYDB_CLUSTER_PASS | |
| ALLOYDB_IAM_USER:${{ vars.GOOGLE_CLOUD_PROJECT }}/ALLOYDB_PYTHON_IAM_USER | |
| ALLOYDB_INSTANCE_IP:${{ vars.GOOGLE_CLOUD_PROJECT }}/ALLOYDB_INSTANCE_IP | |
| ALLOYDB_PSC_INSTANCE_URI:${{ vars.GOOGLE_CLOUD_PROJECT }}/ALLOYDB_PSC_INSTANCE_URI | |
| - name: Run tests | |
| env: | |
| ALLOYDB_DB: 'postgres' | |
| ALLOYDB_USER: 'postgres' | |
| ALLOYDB_PASS: '${{ steps.secrets.outputs.ALLOYDB_CLUSTER_PASS }}' | |
| ALLOYDB_IAM_USER: '${{ steps.secrets.outputs.ALLOYDB_IAM_USER }}' | |
| ALLOYDB_INSTANCE_IP: '${{ steps.secrets.outputs.ALLOYDB_INSTANCE_IP }}' | |
| ALLOYDB_INSTANCE_URI: '${{ steps.secrets.outputs.ALLOYDB_INSTANCE_URI }}' | |
| ALLOYDB_PSC_INSTANCE_URI: '${{ steps.secrets.outputs.ALLOYDB_PSC_INSTANCE_URI }}' | |
| run: nox -s system-${{ matrix.python-version }} | |
| - name: FlakyBot (Linux) | |
| # only run flakybot on periodic (schedule) and continuous (push) events | |
| if: ${{ (github.event_name == 'schedule' || github.event_name == 'push') && always() }} | |
| run: | | |
| curl https://github.com/googleapis/repo-automation-bots/releases/download/flakybot-1.1.0/flakybot -o flakybot -s -L | |
| chmod +x ./flakybot | |
| ./flakybot --repo ${{github.repository}} --commit_hash ${{github.sha}} --build_url https://github.com/${{github.repository}}/actions/runs/${{github.run_id}} |