Add support for user input and documentation improvements to smoke testing workflow #204
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
| name: Run Smoke Test | |
| on: | |
| pull_request: | |
| types: [opened, reopened] | |
| branches: | |
| - "main" | |
| push: | |
| # Uncomment when testing locally | |
| paths: | |
| - ".github/workflows/run_smoke_test.yml" | |
| # - ".github/actions/setup-dependencies-windows/action.yml" | |
| # - ".github/actions/setup-dependencies-macos/action.yml" | |
| branches: | |
| - "main" | |
| - "*smoketest*" | |
| workflow_call: | |
| workflow_dispatch: | |
| inputs: | |
| os: | |
| description: "Choose operating system(s), format must be an array of strings:" | |
| required: true | |
| type: string | |
| default: "['windows-latest', 'macos-latest']" | |
| python-version: | |
| description: "Choose python version(s), format must be an array of strings:" | |
| required: true | |
| type: string | |
| default: "['3.10']" | |
| opa-version: | |
| description: "Choose OPA version" | |
| required: true | |
| type: string | |
| default: "0.60.0" | |
| jobs: | |
| configuration: | |
| runs-on: ubuntu-latest | |
| outputs: | |
| os: ${{ steps.variables.outputs.os }} | |
| python-version: ${{ steps.variables.outputs.python-version }} | |
| opa-version: ${{ steps.variables.outputs.opa-version }} | |
| steps: | |
| - name: Configure variable outputs | |
| id: variables | |
| run: | | |
| # For manual runs | |
| if [[ "${{ github.event_name }}" == "workflow_dispatch" ]]; then | |
| os_val="${{ inputs.os }}" | |
| pythonversion_val="${{ inputs.python-version }}" | |
| opaversion_val="${{ inputs.opa-version }}" | |
| # Default values for other events | |
| else | |
| os_val="['windows-latest', 'macos-latest']" | |
| pythonversion_val="['3.10']" | |
| opaversion_val="0.60.0" | |
| fi | |
| echo "os=$os_val" >> "$GITHUB_OUTPUT" | |
| echo "python-version=$pythonversion_val" >> "$GITHUB_OUTPUT" | |
| echo "opa-version=$opaversion_val" >> "$GITHUB_OUTPUT" | |
| smoke-test: | |
| needs: configuration | |
| strategy: | |
| fail-fast: false | |
| matrix: | |
| os: ${{ fromJSON(needs.configuration.outputs.os) }} | |
| # See https://raw.githubusercontent.com/actions/python-versions/main/versions-manifest.json, | |
| # ctrl + f and search "python-3.<minor>.<patch>-<darwin-arm64/win32/linux>" for supported versions | |
| python-version: ${{ fromJSON(needs.configuration.outputs.python-version) }} | |
| runs-on: ${{ matrix.os }} | |
| environment: Development | |
| steps: | |
| - name: Checkout Repository | |
| uses: actions/checkout@v4 | |
| - name: Setup Python v${{ matrix.python-version }} | |
| uses: actions/setup-python@v5 | |
| with: | |
| python-version: ${{ matrix.python-version }} | |
| cache: "pip" | |
| cache-dependency-path: "requirements.txt" | |
| - name: Setup Dependencies (Windows) | |
| if: ${{ matrix.os == 'windows-latest' }} | |
| uses: ./.github/actions/setup-dependencies-windows | |
| with: | |
| os: "windows" | |
| opa-version: ${{ needs.configuration.outputs.opa-version }} | |
| python-version: ${{ matrix.python-version }} | |
| - name: Setup Dependencies (macOS) | |
| if: ${{ matrix.os == 'macos-latest' }} | |
| uses: ./.github/actions/setup-dependencies-macos | |
| with: | |
| os: "macos" | |
| opa-version: ${{ needs.configuration.outputs.opa-version }} | |
| python-version: ${{ matrix.python-version }} | |
| - name: Setup credentials for service account | |
| id: create-json | |
| uses: jsdaniell/create-json@v1.2.3 | |
| with: | |
| name: "credentials.json" | |
| json: ${{ secrets.GWS_GITHUB_AUTOMATION_CREDS }} | |
| - name: Run ScubaGoggles and check for correct output | |
| run: pytest -s -vvv ./Testing/Functional/SmokeTests/ --subjectemail="${{ secrets.GWS_SUBJECT_EMAIL }}" --domain="${{ secrets.GWS_DOMAIN }}" |