[SYSE-385 main] July Template application #13
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: Test² | |
| on: | |
| workflow_dispatch: | |
| workflow_call: | |
| pull_request: | |
| push: | |
| tags: | |
| - 'v*' | |
| branches: | |
| - master | |
| - release-* | |
| jobs: | |
| test-controller-api: | |
| runs-on: ubuntu-latest | |
| outputs: | |
| envfiles: ${{ steps.params.outputs.envfiles }} | |
| pump: ${{ steps.params.outputs.pump }} | |
| sink: ${{ steps.params.outputs.sink }} | |
| steps: | |
| - name: set params | |
| id: params | |
| shell: bash | |
| env: | |
| # startsWith covers pull_request_target too | |
| BASE_REF: ${{startsWith(github.event_name, 'pull_request') && github.base_ref || github.ref_name}} | |
| VARIATION: test | |
| run: | | |
| set -eo pipefail | |
| curl -s --retry 5 --retry-delay 10 --fail-with-body "http://tui.internal.dev.tyk.technology/v2/$VARIATION/tyk-pro/$BASE_REF/${{ github.event_name}}/api.gho" | tee -a "$GITHUB_OUTPUT" | |
| [[ $VARIATION =~ test ]] && { | |
| echo "::warning file=release.yml,line=100,col=5,endColumn=7::Using test variation" | |
| echo "### :warning: You are using VARIATION with test in test-controller-api" >> $GITHUB_STEP_SUMMARY | |
| } | |
| api-tests: | |
| needs: | |
| - test-controller-api | |
| runs-on: ubuntu-latest | |
| env: | |
| XUNIT_REPORT_PATH: /tmp/xunit-results.xml | |
| permissions: | |
| id-token: write # This is required for requesting the Github JWT | |
| contents: read # This is required for actions/checkout | |
| strategy: | |
| fail-fast: false | |
| matrix: | |
| envfiles: ${{ fromJson(needs.test-controller-api.outputs.envfiles) }} | |
| pump: ${{ fromJson(needs.test-controller-api.outputs.pump) }} | |
| sink: ${{ fromJson(needs.test-controller-api.outputs.sink) }} | |
| exclude: | |
| - pump: tykio/tyk-pump-docker-pub:v1.8 | |
| sink: $ECR/tyk-sink:master | |
| - pump: $ECR/tyk-pump:master | |
| sink: tykio/tyk-mdcb-docker:v2.4 | |
| steps: | |
| - uses: aws-actions/configure-aws-credentials@v4 | |
| with: | |
| role-to-assume: arn:aws:iam::754489498669:role/ecr_rw_tyk | |
| role-session-name: cipush | |
| aws-region: eu-central-1 | |
| - id: ecr | |
| uses: aws-actions/amazon-ecr-login@v2 | |
| with: | |
| mask-password: 'true' | |
| - name: Setup tmate session only in debug mode | |
| uses: mxschmitt/action-tmate@v3 | |
| if: runner.debug == '1' | |
| with: | |
| detached: true | |
| limit-access-to-actor: true | |
| # Only ${{ github.actor }} has access | |
| # See https://github.com/mxschmitt/action-tmate#use-registered-public-ssh-keys | |
| - uses: actions/checkout@v4 | |
| with: | |
| path: auto | |
| fetch-depth: 1 | |
| - name: env up | |
| shell: bash | |
| working-directory: auto | |
| id: env_up | |
| env: | |
| pull_policy: 'if_not_present' | |
| GH_TOKEN: ${{ secrets.ORG_GH_TOKEN }} | |
| TYK_DB_LICENSEKEY: ${{ secrets.DASH_LICENSE }} | |
| TYK_MDCB_LICENSE: ${{ secrets.MDCB_LICENSE }} | |
| BASE_REF: ${{startsWith(github.event_name, 'pull_request') && github.base_ref || github.ref_name}} | |
| run: "match_tag=${{steps.ecr.outputs.registry}}/tyk-pro:$BASE_REF\ntags=($match_tag)\n\nset -eaxo pipefail\ndocker run -q --rm -v ~/.docker/config.json:/root/.docker/config.json tykio/gromit policy match ${tags[0]} ${match_tag} 2>versions.env\necho '# alfa and beta have to come after the override\ntyk_alfa_image=$tyk_image\ntyk_beta_image=$tyk_image\nECR=${{steps.ecr.outputs.registry}}\ntyk_pump_image=${{matrix.pump}}\ntyk_sink_image=${{matrix.sink}}\nconfs_dir=./pro-ha\nenv_file=local.env' >> versions.env\ncat ./confs/${{ matrix.envfiles.config }}.env local-${{ matrix.envfiles.db }}.env > local.env\necho \"::group::versions\"\ncat versions.env local.env\necho \"::endgroup::\"\n# bring up env, the project name is important\ndocker compose -p auto -f pro-ha.yml -f deps_pro-ha.yml -f ${{ matrix.envfiles.db }}.yml -f ${{ matrix.envfiles.cache }}.yml --env-file versions.env --profile master-datacenter up --quiet-pull -d\n./dash-bootstrap.sh http://localhost:3000\ndocker compose -p auto -f pro-ha.yml -f deps_pro-ha.yml -f ${{ matrix.envfiles.db }}.yml -f ${{ matrix.envfiles.cache }}.yml --env-file versions.env --profile slave-datacenter up --quiet-pull -d \n" | |
| - name: Run API tests | |
| id: test_execution | |
| env: | |
| # Cover pull_request_target too | |
| BASE_REF: master | |
| run: "# Generate report id\necho \"id=$(date +%s%N)\" >> $GITHUB_OUTPUT\npytest=\"pytest -c pytest_ci.ini --junitxml=${XUNIT_REPORT_PATH} --ci -m ${{ matrix.envfiles.apimarkers }}\"\ncmd=\"docker run --rm --network auto_default -v $XUNIT_REPORT_PATH:$XUNIT_REPORT_PATH ${{ steps.ecr.outputs.registry }}/tyk-automated-tests:$BASE_REF $pytest\" \n# Run tests\neval $cmd \n" | |
| - name: Generate metadata and upload test reports | |
| if: always() && steps.test_execution.outcome != 'skipped' | |
| id: metadata_report | |
| env: | |
| BASE_REF: ${{startsWith(github.event_name, 'pull_request') && github.base_ref || github.ref}} | |
| REPORT_NAME: ${{ github.repository }}_${{ github.run_id }}_${{ github.run_attempt }}-${{steps.test_execution.outputs.id}} | |
| METADATA_REPORT_PATH: /tmp/metadata.toml | |
| run: | | |
| # Generate metadata report | |
| echo "[metadata] | |
| repo = ${{ github.repository }} | |
| branch = ${{ github.ref }} | |
| commit = ${{ github.sha }} | |
| test_suite_version = $BASE_REF | |
| test_suite_name = ${{ github.job }} | |
| test_suite_run = ${{ github.run_id }}-${{ github.run_attempt }} | |
| db = ${{ matrix.envfiles.db }} | |
| conf = ${{ matrix.envfiles.config }} | |
| cache = ${{ matrix.envfiles.cache }} | |
| pump_compatibility = ${{ matrix.pump }} | |
| sink_compatibility = ${{ matrix.sink }} | |
| " > ${METADATA_REPORT_PATH} | |
| # Print metadata report | |
| if [[ "${{ runner.debug }}" == "1" ]]; then | |
| echo "::group::metadata report" | |
| cat ${METADATA_REPORT_PATH} | |
| echo "::endgroup::" | |
| fi | |
| #Upload xunit report | |
| aws s3 cp ${XUNIT_REPORT_PATH} s3://assets.dev.tyk.technology/testreports/${REPORT_NAME#*/}.xml | |
| #Upload metadata report | |
| aws s3 cp ${METADATA_REPORT_PATH} s3://assets.dev.tyk.technology/testreports/${REPORT_NAME#*/}.metadata.toml | |
| - name: Docker logs for all components | |
| if: failure() && (steps.test_execution.outcome != 'success' || steps.env_up.outcome != 'success') | |
| working-directory: auto | |
| env: | |
| pull_policy: 'if_not_present' | |
| GH_TOKEN: ${{ secrets.ORG_GH_TOKEN }} | |
| TYK_DB_LICENSEKEY: ${{ secrets.DASH_LICENSE }} | |
| TYK_MDCB_LICENSE: ${{ secrets.MDCB_LICENSE }} | |
| ECR: ${{ steps.ecr.outputs.registry }} | |
| run: | | |
| docker compose -p auto -f pro-ha.yml -f deps_pro-ha.yml -f ${{ matrix.envfiles.db }}.yml -f ${{ matrix.envfiles.cache }}.yml --env-file versions.env --profile all logs | sort > ${{ github.workspace }}/docker-compose.log | |
| echo "::group::DockerLogs" | |
| cat ${{ github.workspace }}/docker-compose.log | |
| echo "::endgroup::" | |
| - name: Upload compose logs | |
| uses: actions/upload-artifact@v4 | |
| if: failure() && (steps.test_execution.outcome != 'success' || steps.env_up.outcome != 'success') | |
| with: | |
| name: docker-compose-logs-${{ github.job }}-${{ matrix.envfiles.db }}-${{ matrix.envfiles.conf }}-${{ github.run_id }} | |
| path: ${{ github.workspace }}/docker-compose.log | |
| retention-days: 3 | |
| overwrite: true | |
| test-controller-ui: | |
| runs-on: ubuntu-latest | |
| outputs: | |
| envfiles: ${{ steps.params.outputs.envfiles }} | |
| pump: ${{ steps.params.outputs.pump }} | |
| sink: ${{ steps.params.outputs.sink }} | |
| steps: | |
| - name: set params | |
| id: params | |
| shell: bash | |
| env: | |
| # startsWith covers pull_request_target too | |
| BASE_REF: ${{startsWith(github.event_name, 'pull_request') && github.base_ref || github.ref_name}} | |
| VARIATION: test | |
| run: | | |
| set -eo pipefail | |
| curl -s --retry 5 --retry-delay 10 --fail-with-body "http://tui.internal.dev.tyk.technology/v2/$VARIATION/tyk-pro/$BASE_REF/${{ github.event_name}}/ui.gho" | tee -a "$GITHUB_OUTPUT" | |
| [[ $VARIATION =~ test ]] && { | |
| echo "::warning file=release.yml,line=100,col=5,endColumn=7::Using test variation" | |
| echo "### :warning: You are using VARIATION with test in test-controller-ui" >> $GITHUB_STEP_SUMMARY | |
| } | |
| ui-tests: | |
| needs: | |
| - test-controller-ui | |
| runs-on: ubuntu-latest | |
| env: | |
| XUNIT_REPORT_PATH: /tmp/xunit-results.xml | |
| permissions: | |
| id-token: write # This is required for requesting the Github JWT | |
| contents: read # This is required for actions/checkout | |
| strategy: | |
| fail-fast: false | |
| matrix: | |
| envfiles: ${{ fromJson(needs.test-controller-ui.outputs.envfiles) }} | |
| pump: ${{ fromJson(needs.test-controller-ui.outputs.pump) }} | |
| sink: ${{ fromJson(needs.test-controller-ui.outputs.sink) }} | |
| exclude: | |
| - pump: tykio/tyk-pump-docker-pub:v1.8 | |
| sink: $ECR/tyk-sink:master | |
| - pump: $ECR/tyk-pump:master | |
| sink: tykio/tyk-mdcb-docker:v2.4 | |
| steps: | |
| - uses: aws-actions/configure-aws-credentials@v4 | |
| with: | |
| role-to-assume: arn:aws:iam::754489498669:role/ecr_rw_tyk | |
| role-session-name: cipush | |
| aws-region: eu-central-1 | |
| - id: ecr | |
| uses: aws-actions/amazon-ecr-login@v2 | |
| with: | |
| mask-password: 'true' | |
| - name: Setup tmate session only in debug mode | |
| uses: mxschmitt/action-tmate@v3 | |
| if: runner.debug == '1' | |
| with: | |
| detached: true | |
| limit-access-to-actor: true | |
| # Only ${{ github.actor }} has access | |
| # See https://github.com/mxschmitt/action-tmate#use-registered-public-ssh-keys | |
| - uses: actions/checkout@v4 | |
| with: | |
| path: auto | |
| fetch-depth: 1 | |
| - name: env up | |
| shell: bash | |
| working-directory: auto | |
| id: env_up | |
| env: | |
| pull_policy: 'if_not_present' | |
| GH_TOKEN: ${{ secrets.ORG_GH_TOKEN }} | |
| TYK_DB_LICENSEKEY: ${{ secrets.DASH_LICENSE }} | |
| TYK_MDCB_LICENSE: ${{ secrets.MDCB_LICENSE }} | |
| BASE_REF: ${{startsWith(github.event_name, 'pull_request') && github.base_ref || github.ref_name}} | |
| run: | | |
| match_tag=${{steps.ecr.outputs.registry}}/tyk-pro:$BASE_REF | |
| tags=($match_tag) | |
| set -eaxo pipefail | |
| docker run -q --rm -v ~/.docker/config.json:/root/.docker/config.json tykio/gromit policy match ${tags[0]} ${match_tag} 2>versions.env | |
| echo '# alfa and beta have to come after the override | |
| tyk_alfa_image=$tyk_image | |
| tyk_beta_image=$tyk_image | |
| ECR=${{steps.ecr.outputs.registry}} | |
| tyk_pump_image=${{matrix.pump}} | |
| tyk_sink_image=${{matrix.sink}} | |
| confs_dir=./pro-ha | |
| env_file=local.env' >> versions.env | |
| cat ./confs/${{ matrix.envfiles.config }}.env local-${{ matrix.envfiles.db }}.env > local.env | |
| echo "::group::versions" | |
| cat versions.env local.env | |
| echo "::endgroup::" | |
| # bring up env, the project name is important | |
| docker compose -p auto -f pro-ha.yml -f deps_pro-ha.yml -f ${{ matrix.envfiles.db }}.yml -f ${{ matrix.envfiles.cache }}.yml --env-file versions.env --profile master-datacenter up --quiet-pull -d | |
| ./dash-bootstrap.sh http://localhost:3000 | |
| docker compose -p auto -f pro-ha.yml -f deps_pro-ha.yml -f ${{ matrix.envfiles.db }}.yml -f ${{ matrix.envfiles.cache }}.yml --env-file versions.env --profile slave-datacenter up --quiet-pull -d | |
| - uses: actions/checkout@v4 | |
| with: | |
| repository: TykTechnologies/tyk-analytics | |
| token: ${{ secrets.ORG_GH_TOKEN }} | |
| fetch-depth: 1 | |
| sparse-checkout: tests/ui | |
| path: tyk-analytics | |
| - name: Install Node.js 18.16 | |
| uses: actions/setup-node@v4 | |
| with: | |
| node-version: "18.16" | |
| - name: Execute UI tests | |
| id: test_execution | |
| run: | | |
| # Generate report id | |
| echo "id=$(date +%s%N)" >> $GITHUB_OUTPUT | |
| npx playwright install --with-deps chromium | |
| PLAYWRIGHT_JUNIT_OUTPUT_NAME=$(XUNIT_REPORT_PATH} npx playwright test --project=chromium --reporter=junit | |
| working-directory: tyk-analytics/tests/ui | |
| env: | |
| GW_URL: 'https://localhost:8080/' | |
| NODE_TLS_REJECT_UNAUTHORIZED: 0 | |
| - name: Generate metadata and upload test reports | |
| if: always() && steps.test_execution.outcome != 'skipped' | |
| id: metadata_report | |
| env: | |
| BASE_REF: ${{startsWith(github.event_name, 'pull_request') && github.base_ref || github.ref}} | |
| REPORT_NAME: ${{ github.repository }}_${{ github.run_id }}_${{ github.run_attempt }}-${{steps.test_execution.outputs.id}} | |
| METADATA_REPORT_PATH: /tmp/metadata.toml | |
| run: | | |
| # Generate metadata report | |
| echo "[metadata] | |
| repo = ${{ github.repository }} | |
| branch = ${{ github.ref }} | |
| commit = ${{ github.sha }} | |
| test_suite_version = $BASE_REF | |
| test_suite_name = ${{ github.job }} | |
| test_suite_run = ${{ github.run_id }}-${{ github.run_attempt }} | |
| db = ${{ matrix.envfiles.db }} | |
| conf = ${{ matrix.envfiles.config }} | |
| cache = ${{ matrix.envfiles.cache }} | |
| pump_compatibility = ${{ matrix.pump }} | |
| sink_compatibility = ${{ matrix.sink }} | |
| " > ${METADATA_REPORT_PATH} | |
| # Print metadata report | |
| if [[ "${{ runner.debug }}" == "1" ]]; then | |
| echo "::group::metadata report" | |
| cat ${METADATA_REPORT_PATH} | |
| echo "::endgroup::" | |
| fi | |
| #Upload xunit report | |
| aws s3 cp ${XUNIT_REPORT_PATH} s3://assets.dev.tyk.technology/testreports/${REPORT_NAME#*/}.xml | |
| #Upload metadata report | |
| aws s3 cp ${METADATA_REPORT_PATH} s3://assets.dev.tyk.technology/testreports/${REPORT_NAME#*/}.metadata.toml | |
| - name: Docker logs for all components | |
| if: failure() && (steps.test_execution.outcome != 'success' || steps.env_up.outcome != 'success') | |
| working-directory: auto | |
| env: | |
| pull_policy: 'if_not_present' | |
| GH_TOKEN: ${{ secrets.ORG_GH_TOKEN }} | |
| TYK_DB_LICENSEKEY: ${{ secrets.DASH_LICENSE }} | |
| TYK_MDCB_LICENSE: ${{ secrets.MDCB_LICENSE }} | |
| ECR: ${{ steps.ecr.outputs.registry }} | |
| run: | | |
| docker compose -p auto -f pro-ha.yml -f deps_pro-ha.yml -f ${{ matrix.envfiles.db }}.yml -f ${{ matrix.envfiles.cache }}.yml --env-file versions.env --profile all logs | sort > ${{ github.workspace }}/docker-compose.log | |
| echo "::group::DockerLogs" | |
| cat ${{ github.workspace }}/docker-compose.log | |
| echo "::endgroup::" | |
| - name: Upload compose logs | |
| uses: actions/upload-artifact@v4 | |
| if: failure() && (steps.test_execution.outcome != 'success' || steps.env_up.outcome != 'success') | |
| with: | |
| name: docker-compose-logs-${{ github.job }}-${{ matrix.envfiles.db }}-${{ matrix.envfiles.conf }}-${{ github.run_id }} | |
| path: ${{ github.workspace }}/docker-compose.log | |
| retention-days: 3 | |
| overwrite: true | |
| release: | |
| if: ${{ startsWith(github.ref, 'refs/tags') }} | |
| runs-on: ubuntu-latest | |
| needs: | |
| - api-tests | |
| - ui-tests | |
| permissions: | |
| contents: write | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - uses: softprops/action-gh-release@v1 | |
| with: | |
| token: ${{ secrets.ORG_GH_TOKEN }} | |
| name: ${{ github.ref_name }} | |
| tag_name: ${{ github.ref_name }} | |
| body_path: release.md |