feat: add visual regression testing workflow #21
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,210 @@ | ||
| name: Reusable WP Visual Regression | ||
|
|
||
| on: | ||
| workflow_call: | ||
| inputs: | ||
| node-version: | ||
| description: 'Node.js version' | ||
| required: false | ||
| type: string | ||
| default: '22' | ||
| wp-versions: | ||
| description: 'JSON array of WP versions (e.g. "latest", "6.7")' | ||
| required: false | ||
| type: string | ||
| default: '["latest"]' | ||
| multisite: | ||
| description: 'Multisite mode: "none", "both", or "only"' | ||
| required: false | ||
| type: string | ||
| default: 'none' | ||
| mailpit: | ||
| description: 'Run Mailpit mail catcher (SMTP on :1025, UI on :8025)' | ||
| required: false | ||
| type: boolean | ||
| default: false | ||
| update-snapshots: | ||
| description: 'Regenerate baseline screenshots' | ||
| required: false | ||
| type: boolean | ||
| default: false | ||
| threshold: | ||
| description: 'Pixel diff tolerance as maxDiffPixelRatio (0-1)' | ||
| required: false | ||
| type: string | ||
| default: '0.2' | ||
| viewports: | ||
| description: 'JSON array of viewport presets (e.g. ["desktop", "mobile"])' | ||
| required: false | ||
| type: string | ||
| default: '["desktop", "mobile"]' | ||
| color-schemes: | ||
| description: 'JSON array of color scheme presets (e.g. ["light", "dark"])' | ||
| required: false | ||
| type: string | ||
| default: '["light"]' | ||
|
|
||
| jobs: | ||
| matrix-prep: | ||
| name: Prepare matrix | ||
| runs-on: ubuntu-latest | ||
| outputs: | ||
| wp-versions: ${{ steps.wp-versions.outputs.matrix }} | ||
| multisite: ${{ steps.multisite.outputs.matrix }} | ||
| steps: | ||
| - id: wp-versions | ||
| run: | | ||
| MATRIX=$(echo '${{ inputs.wp-versions }}' | jq -c '[.[] | if . == "latest" then {"input": "latest", "core": "null"} else {"input": ., "core": ("WordPress/WordPress#" + .)} end]') | ||
| echo "matrix=${MATRIX}" >> "$GITHUB_OUTPUT" | ||
|
|
||
| - id: multisite | ||
| run: | | ||
| case "${{ inputs.multisite }}" in | ||
| both) echo "matrix=[false, true]" >> "$GITHUB_OUTPUT" ;; | ||
| only) echo "matrix=[true]" >> "$GITHUB_OUTPUT" ;; | ||
| *) echo "matrix=[false]" >> "$GITHUB_OUTPUT" ;; | ||
| esac | ||
|
|
||
| visual-regression: | ||
| name: WP ${{ matrix.wp.input }}${{ matrix.multisite && ' / multisite' || '' }} | ||
| needs: matrix-prep | ||
| runs-on: ubuntu-latest | ||
| strategy: | ||
| fail-fast: false | ||
| matrix: | ||
| wp: ${{ fromJson(needs.matrix-prep.outputs.wp-versions) }} | ||
| multisite: ${{ fromJson(needs.matrix-prep.outputs.multisite) }} | ||
| steps: | ||
| - uses: actions/checkout@v4 | ||
| with: | ||
| lfs: true | ||
|
|
||
| - uses: shivammathur/setup-php@v2 | ||
| with: | ||
| php-version: '8.4' | ||
| coverage: none | ||
|
|
||
| - name: Install Composer dependencies | ||
| if: hashFiles('composer.json') != '' | ||
| run: composer install --no-interaction --prefer-dist | ||
|
|
||
| - uses: actions/setup-node@v4 | ||
| with: | ||
| node-version: ${{ inputs.node-version }} | ||
| cache: npm | ||
|
|
||
| - name: Install Node.js dependencies | ||
| run: | | ||
| if [ -f package-lock.json ]; then | ||
| npm ci | ||
| else | ||
| npm install | ||
| fi | ||
|
|
||
| - name: Install wp-env | ||
| run: npm install -g @wordpress/env | ||
|
|
||
| - name: Validate wp-env configuration | ||
| run: | | ||
| if [ ! -f .wp-env.json ]; then | ||
| echo "::error::Missing .wp-env.json in repository root. See https://developer.wordpress.org/block-editor/reference-guides/packages/packages-env/" | ||
| exit 1 | ||
| fi | ||
|
|
||
| - name: Configure wp-env override | ||
| if: matrix.wp.core != 'null' | ||
| run: | | ||
| echo '{ "core": "${{ matrix.wp.core }}" }' > .wp-env.override.json | ||
|
|
||
| - name: Start wp-env | ||
| run: npx wp-env start | ||
|
|
||
| - name: Convert to multisite | ||
| if: matrix.multisite | ||
| run: npx wp-env run cli wp core multisite-convert --title="Test Site" | ||
|
|
||
| - name: Start Mailpit | ||
| if: inputs.mailpit | ||
| run: | | ||
| docker run -d --name mailpit \ | ||
| -p 1025:1025 \ | ||
| -p 8025:8025 \ | ||
| axllent/mailpit:latest | ||
|
|
||
| WP_CONTAINER=$(docker ps --format '{{.ID}}' --filter "name=wordpress" --no-trunc | head -1) | ||
| if [ -z "$WP_CONTAINER" ]; then | ||
| echo "::error::Could not find wp-env WordPress container" | ||
| exit 1 | ||
| fi | ||
| WP_NETWORK=$(docker inspect -f '{{range $k, $_ := .NetworkSettings.Networks}}{{$k}} {{end}}' "$WP_CONTAINER" | awk '{print $1}') | ||
| docker network connect "$WP_NETWORK" mailpit | ||
|
|
||
| - name: Configure WordPress SMTP for Mailpit | ||
| if: inputs.mailpit | ||
| run: | | ||
|
Check warning on line 144 in .github/workflows/reusable-wp-visual-regression.yml
|
||
| npx wp-env run cli wp eval ' | ||
| $dir = ABSPATH . "wp-content/mu-plugins"; | ||
| if (!is_dir($dir)) { mkdir($dir, 0755, true); } | ||
| file_put_contents($dir . "/mailpit-smtp.php", | ||
| "<?php\n" | ||
| . "add_filter(\"wp_mail_from\", function(\$email) {\n" | ||
| . " if (strpos(\$email, \"@localhost\") !== false) {\n" | ||
| . " return \"wordpress@example.tld\";\n" | ||
| . " }\n" | ||
| . " return \$email;\n" | ||
| . "});\n" | ||
| . "add_action(\"phpmailer_init\", function(\$phpmailer) {\n" | ||
| . " \$phpmailer->isSMTP();\n" | ||
| . " \$phpmailer->Host = \"mailpit\";\n" | ||
| . " \$phpmailer->Port = 1025;\n" | ||
| . " \$phpmailer->SMTPAutoTLS = false;\n" | ||
| . " \$phpmailer->SMTPAuth = false;\n" | ||
| . "});\n" | ||
| ); | ||
| ' | ||
|
|
||
| - name: Install Playwright browsers | ||
| run: npx playwright install --with-deps chromium | ||
|
|
||
| - name: Run visual regression tests | ||
| run: | | ||
| ARGS="" | ||
| if [ "${{ inputs.update-snapshots }}" = "true" ]; then | ||
| ARGS="--update-snapshots" | ||
| fi | ||
| npx playwright test $ARGS | ||
| env: | ||
| WP_BASE_URL: http://localhost:8888 | ||
| WP_ADMIN_USER: admin | ||
| WP_ADMIN_PASSWORD: password | ||
| VRT_THRESHOLD: ${{ inputs.threshold }} | ||
| VRT_VIEWPORTS: ${{ inputs.viewports }} | ||
| VRT_COLOR_SCHEMES: ${{ inputs.color-schemes }} | ||
| MAILPIT_API_URL: ${{ inputs.mailpit && 'http://localhost:8025' || '' }} | ||
|
|
||
| - name: Upload visual diff artifacts | ||
| uses: actions/upload-artifact@v4 | ||
| if: failure() | ||
| with: | ||
| name: visual-regression-diffs-wp${{ matrix.wp.input }}${{ matrix.multisite && '-multisite' || '' }} | ||
| path: test-results/ | ||
| retention-days: 14 | ||
|
|
||
| - name: Upload updated snapshots | ||
| uses: actions/upload-artifact@v4 | ||
| if: inputs.update-snapshots | ||
| with: | ||
| name: updated-snapshots-wp${{ matrix.wp.input }}${{ matrix.multisite && '-multisite' || '' }} | ||
| path: | | ||
| **/__screenshots__/ | ||
| **/screenshots/ | ||
| retention-days: 7 | ||
|
|
||
| - uses: actions/upload-artifact@v4 | ||
| if: always() | ||
| with: | ||
| name: vrt-report-wp${{ matrix.wp.input }}${{ matrix.multisite && '-multisite' || '' }} | ||
| path: | | ||
| playwright-report/ | ||
| test-results/ | ||
| retention-days: 7 | ||
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
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 workflow file
reusable-wp-visual-regression.ymlis documented and added to the changelog, but the file itself is missing from the pull request. Please ensure the new workflow file is included in the commit.