chore: Add visual regression testing #4509
There are no files selected for viewing
This file contains hidden or 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
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,153 @@ | ||
| name: Visual Regression Tests | ||
|
|
||
| on: | ||
| workflow_call: | ||
| inputs: | ||
| test-utils-artifact-name: | ||
| description: 'Name of the artifact containing test-utils selectors.' | ||
| required: true | ||
| type: string | ||
| caller-run-id: | ||
| description: 'The run ID of the calling workflow, used to download artifacts it uploaded.' | ||
| required: true | ||
| type: string | ||
| baseline-artifact-name: | ||
| description: 'Name of the artifact containing baseline pages (built by the caller workflow).' | ||
| required: true | ||
| type: string | ||
|
|
||
| defaults: | ||
| run: | ||
| shell: bash | ||
|
|
||
| permissions: | ||
| id-token: write | ||
| contents: read | ||
| actions: read | ||
| deployments: write | ||
|
|
||
| jobs: | ||
| visual: | ||
| name: Visual regression (shard ${{ matrix.shard }}) | ||
| runs-on: ubuntu-latest | ||
| strategy: | ||
| fail-fast: false | ||
| matrix: | ||
| shard: [1, 2] | ||
|
Member
Author
There was a problem hiding this comment. I will be adding more shards as I add more test definitions for more components |
||
| steps: | ||
| - uses: actions/checkout@v4 | ||
|
|
||
| - name: Setup Node.js | ||
| uses: actions/setup-node@v4 | ||
| with: | ||
| node-version: 20 | ||
| cache: npm | ||
|
|
||
| - name: Set up Chrome and ChromeDriver | ||
| uses: browser-actions/setup-chrome@v1 | ||
| with: | ||
| chrome-version: stable | ||
|
|
||
| - name: Install dependencies | ||
| run: npm i | ||
|
|
||
| - name: Download baseline artifact | ||
| uses: actions/download-artifact@v4 | ||
| with: | ||
| name: ${{ inputs.baseline-artifact-name }} | ||
| path: pages/lib/static-visual-baseline | ||
| github-token: ${{ github.token }} | ||
| run-id: ${{ inputs.caller-run-id }} | ||
|
|
||
| - name: Download test utils artifact | ||
| uses: actions/download-artifact@v4 | ||
| with: | ||
| name: ${{ inputs.test-utils-artifact-name }} | ||
| path: lib/components | ||
| github-token: ${{ github.token }} | ||
| run-id: ${{ inputs.caller-run-id }} | ||
|
|
||
| - name: Resolve PR deployment URL | ||
| id: hosts | ||
| run: | | ||
| DEPLOY_ENV="dev-pages-react18" | ||
| echo "Looking for deployment with environment '${DEPLOY_ENV}'..." | ||
| DEPLOY_ID=$(gh api \ | ||
| "repos/${REPO}/deployments?environment=${DEPLOY_ENV}&per_page=5" \ | ||
| --jq '.[0].id // empty' 2>/dev/null || true) | ||
| NEW_URL="" | ||
| if [ -n "$DEPLOY_ID" ]; then | ||
| NEW_URL=$(gh api \ | ||
| "repos/${REPO}/deployments/${DEPLOY_ID}/statuses" \ | ||
| --jq '[.[] | select(.state == "success")] | first | .environment_url // empty' 2>/dev/null || true) | ||
| echo "Found PR deployment: ID=${DEPLOY_ID}, URL=${NEW_URL}" | ||
| fi | ||
| if [ -z "$NEW_URL" ]; then | ||
| echo "::error::Could not resolve PR deployment URL" | ||
| exit 1 | ||
| fi | ||
| echo "new=${NEW_URL}" >> "$GITHUB_OUTPUT" | ||
| env: | ||
| GH_TOKEN: ${{ github.token }} | ||
| REPO: ${{ github.repository }} | ||
|
|
||
| - name: Start baseline server | ||
| run: npx --yes serve --no-clipboard --listen 8080 pages/lib/static-visual-baseline & | ||
|
|
||
| - name: Wait for baseline server | ||
| run: node_modules/.bin/wait-on http://localhost:8080 | ||
|
|
||
| - name: Run visual regression tests | ||
| run: | | ||
| echo "NEW_HOST=${NEW_HOST}" | ||
| NODE_OPTIONS=--experimental-vm-modules node_modules/.bin/jest -c jest.visual.config.js --shard="${SHARD}/2" | ||
| env: | ||
| TZ: UTC | ||
| SHARD: ${{ matrix.shard }} | ||
| NEW_HOST: ${{ steps.hosts.outputs.new }} | ||
|
|
||
| - name: Upload Allure results | ||
| if: always() | ||
| uses: actions/upload-artifact@v4 | ||
| with: | ||
| name: allure-results-shard-${{ matrix.shard }} | ||
| path: allure-results/ | ||
| retention-days: 3 | ||
|
|
||
| report: | ||
| name: Generate Allure Report | ||
| if: always() | ||
| needs: [visual] | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
| - name: Setup Node.js | ||
| uses: actions/setup-node@v4 | ||
| with: | ||
| node-version: 20 | ||
|
|
||
| - name: Download all Allure results | ||
| uses: actions/download-artifact@v4 | ||
| with: | ||
| pattern: allure-results-shard-* | ||
| path: allure-results | ||
| merge-multiple: true | ||
|
|
||
| - name: Generate Allure HTML report | ||
| run: npx --yes allure generate allure-results -o allure-report | ||
|
|
||
| - name: Upload Allure report artifact | ||
| uses: actions/upload-artifact@v4 | ||
| with: | ||
| name: allure-report | ||
| path: allure-report/ | ||
| retention-days: 14 | ||
|
|
||
| deploy-report: | ||
| name: Deploy Allure Report | ||
| if: always() | ||
| needs: [report] | ||
| uses: cloudscape-design/actions/.github/workflows/deploy.yml@main | ||
| secrets: inherit | ||
| with: | ||
| artifact-name: allure-report | ||
| deployment-path: allure-report | ||
This file contains hidden or 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
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,7 @@ | ||
| // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. | ||
| // SPDX-License-Identifier: Apache-2.0 | ||
|
|
||
| module.exports = async () => { | ||
| const { startWebdriver } = require('@cloudscape-design/browser-test-tools/chrome-launcher'); | ||
| await startWebdriver(); | ||
| }; |
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,7 @@ | ||
| // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. | ||
| // SPDX-License-Identifier: Apache-2.0 | ||
|
|
||
| module.exports = () => { | ||
| const { shutdownWebdriver } = require('@cloudscape-design/browser-test-tools/chrome-launcher'); | ||
| shutdownWebdriver(); | ||
| }; |
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,16 @@ | ||
| // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. | ||
| // SPDX-License-Identifier: Apache-2.0 | ||
| /* global jest */ | ||
| const { configure } = require('@cloudscape-design/browser-test-tools/use-browser'); | ||
|
|
||
| configure({ | ||
| browserName: 'ChromeHeadlessIntegration', | ||
| browserCreatorOptions: { | ||
| seleniumUrl: 'http://localhost:9515', | ||
| }, | ||
| webdriverOptions: { | ||
| baseUrl: 'http://localhost:8080', | ||
| }, | ||
| }); | ||
|
|
||
| jest.retryTimes(2, { logErrorsBeforeRetry: true }); |
This file contains hidden or 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
This file contains hidden or 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
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,28 @@ | ||
| // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. | ||
| // SPDX-License-Identifier: Apache-2.0 | ||
| const path = require('path'); | ||
| const os = require('os'); | ||
|
|
||
| module.exports = { | ||
| verbose: true, | ||
| testEnvironment: 'allure-jest/node', | ||
| testEnvironmentOptions: { | ||
| resultsDir: 'allure-results', | ||
| }, | ||
| transform: { | ||
| '^.+\\.tsx?$': [ | ||
| 'ts-jest', | ||
| { | ||
| tsconfig: 'tsconfig.visual.json', | ||
| }, | ||
| ], | ||
| }, | ||
| reporters: ['default', 'github-actions'], | ||
| testTimeout: 240_000, // 4min — pages can be tall and slow to capture | ||
| maxWorkers: os.cpus().length * (process.env.GITHUB_ACTION ? 3 : 1), | ||
| globalSetup: '<rootDir>/build-tools/visual/global-setup.js', | ||
| globalTeardown: '<rootDir>/build-tools/visual/global-teardown.js', | ||
| setupFilesAfterEnv: [path.join(__dirname, 'build-tools', 'visual', 'setup.js')], | ||
| moduleFileExtensions: ['js', 'ts'], | ||
| testMatch: ['<rootDir>/test/visual/**/*.test.ts'], | ||
| }; |
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The visual regression workflow is triggered by the deploy workflow because the former needs outputs from the latter. Otherwise, workflows cannot read outputs from jobs defined in other workflows.