|
11 | 11 | required: true |
12 | 12 | type: string |
13 | 13 | description: 'Playwright project name to run' |
| 14 | + multisite: |
| 15 | + required: false |
| 16 | + type: boolean |
| 17 | + default: false |
| 18 | + description: 'If true, convert the site to multisite and create a subsite.' |
14 | 19 |
|
15 | 20 | jobs: |
16 | 21 | playwright-test: |
17 | 22 | name: Playwright tests (${{ inputs.test-mode == 'default' && 'Default Mode' || 'File-based Execution' }}) |
18 | 23 | runs-on: ubuntu-22.04 |
| 24 | + services: |
| 25 | + mysql: |
| 26 | + image: mysql:8.0 |
| 27 | + env: |
| 28 | + MYSQL_DATABASE: wordpress |
| 29 | + MYSQL_USER: wordpress |
| 30 | + MYSQL_PASSWORD: wordpress |
| 31 | + MYSQL_ROOT_PASSWORD: root |
| 32 | + options: >- |
| 33 | + --health-cmd="mysqladmin ping -h localhost -proot" |
| 34 | + --health-interval=10s |
| 35 | + --health-timeout=5s |
| 36 | + --health-retries=10 |
| 37 | +
|
| 38 | + wordpress: |
| 39 | + image: wordpress:php8.1-apache |
| 40 | + env: |
| 41 | + WORDPRESS_DB_HOST: mysql:3306 |
| 42 | + WORDPRESS_DB_USER: wordpress |
| 43 | + WORDPRESS_DB_PASSWORD: wordpress |
| 44 | + WORDPRESS_DB_NAME: wordpress |
| 45 | + WORDPRESS_DEBUG: 1 |
| 46 | + WORDPRESS_CONFIG_EXTRA: | |
| 47 | + define( 'FS_METHOD', 'direct' ); |
| 48 | + define( 'WP_DEBUG_LOG', true ); |
| 49 | + define( 'WP_DEBUG_DISPLAY', false ); |
| 50 | + define( 'SCRIPT_DEBUG', true ); |
| 51 | + define( 'WP_ENVIRONMENT_TYPE', 'local' ); |
| 52 | + ports: |
| 53 | + - 8888:80 |
19 | 54 | steps: |
20 | 55 | - name: Checkout source code |
21 | 56 | uses: actions/checkout@v4 |
@@ -55,45 +90,153 @@ jobs: |
55 | 90 | path: | |
56 | 91 | node_modules |
57 | 92 | src/vendor |
58 | | - key: ${{ runner.os }}-deps-${{ steps.deps-hash.outputs.deps_hash }} |
| 93 | + key: ${{ runner.os }}-${{ inputs.test-mode }}-deps-${{ steps.deps-hash.outputs.deps_hash }}-${{ github.run_id }}-${{ github.job }} |
59 | 94 | restore-keys: | |
60 | | - ${{ runner.os }}-deps- |
| 95 | + ${{ runner.os }}-${{ inputs.test-mode }}-deps-${{ steps.deps-hash.outputs.deps_hash }}- |
61 | 96 |
|
62 | | - - name: Install workflow dependencies (wp-env, playwright) |
63 | | - if: steps.deps-cache.outputs.cache-hit != 'true' |
| 97 | + - name: Install workflow dependencies |
| 98 | + if: steps.deps-cache.outputs.cache-matched-key == '' |
64 | 99 | run: npm run prepare-environment:ci && npm run bundle |
65 | 100 |
|
66 | 101 | - name: Save vendor and node_modules cache |
67 | | - if: steps.deps-cache.outputs.cache-hit != 'true' |
| 102 | + if: steps.deps-cache.outputs.cache-matched-key == '' |
68 | 103 | uses: actions/cache/save@v4 |
69 | 104 | with: |
70 | 105 | path: | |
71 | 106 | src/vendor |
72 | 107 | node_modules |
73 | | - key: ${{ runner.os }}-deps-${{ steps.deps-hash.outputs.deps_hash }} |
| 108 | + key: ${{ steps.deps-cache.outputs.cache-primary-key }} |
74 | 109 |
|
75 | | - - name: Start WordPress environment |
| 110 | + - name: Wait for WordPress to be reachable |
| 111 | + run: | |
| 112 | + for i in $(seq 1 60); do |
| 113 | + if curl -fsS http://localhost:8888/wp-login.php >/dev/null; then |
| 114 | + echo "WordPress is reachable." |
| 115 | + exit 0 |
| 116 | + fi |
| 117 | + echo "Waiting for WordPress... ($i/60)" |
| 118 | + sleep 2 |
| 119 | + done |
| 120 | +
|
| 121 | + echo "WordPress did not start in time." |
| 122 | + echo "::group::WordPress container logs" |
| 123 | + docker logs "${{ job.services.wordpress.id }}" || true |
| 124 | + echo "::endgroup::" |
| 125 | + exit 1 |
| 126 | +
|
| 127 | + - name: Download WP-CLI |
| 128 | + run: | |
| 129 | + curl -fsSL -o "${RUNNER_TEMP}/wp-cli.phar" https://raw.githubusercontent.com/wp-cli/builds/gh-pages/phar/wp-cli.phar |
| 130 | +
|
| 131 | + - name: "Install WordPress: ${{ inputs.multisite && 'Multisite' || 'Single Site' }}" |
| 132 | + env: |
| 133 | + WP_CONTAINER: ${{ job.services.wordpress.id }} |
| 134 | + WP_URL: http://localhost:8888 |
| 135 | + WP_ADMIN_USER: admin |
| 136 | + WP_ADMIN_PASSWORD: password |
| 137 | + WP_ADMIN_EMAIL: admin@example.org |
76 | 138 | run: | |
77 | | - npx wp-env start |
| 139 | + set -euo pipefail |
| 140 | +
|
| 141 | + docker cp "${RUNNER_TEMP}/wp-cli.phar" "$WP_CONTAINER:/tmp/wp-cli.phar" |
| 142 | +
|
| 143 | + # Install WordPress if it isn't already installed. |
| 144 | + if ! docker exec -u root -w /var/www/html "$WP_CONTAINER" php /tmp/wp-cli.phar core is-installed --allow-root >/dev/null 2>&1; then |
| 145 | + docker exec -u root -w /var/www/html "$WP_CONTAINER" php /tmp/wp-cli.phar core install \ |
| 146 | + --url="$WP_URL" \ |
| 147 | + --title="Test Blog" \ |
| 148 | + --admin_user="$WP_ADMIN_USER" \ |
| 149 | + --admin_password="$WP_ADMIN_PASSWORD" \ |
| 150 | + --admin_email="$WP_ADMIN_EMAIL" \ |
| 151 | + --skip-email \ |
| 152 | + --allow-root |
| 153 | + fi |
| 154 | +
|
| 155 | + if [ "${{ inputs.multisite }}" = "true" ]; then |
| 156 | + # Convert single site -> multisite (subdirectory). Subdomains don't work with localhost. |
| 157 | + if ! docker exec -u root -w /var/www/html "$WP_CONTAINER" php /tmp/wp-cli.phar core is-installed --network --allow-root >/dev/null 2>&1; then |
| 158 | + docker exec -u root -w /var/www/html "$WP_CONTAINER" php /tmp/wp-cli.phar core multisite-convert \ |
| 159 | + --title="Test Network" \ |
| 160 | + --base=/ \ |
| 161 | + --allow-root |
| 162 | + fi |
| 163 | +
|
| 164 | + # Create a subsite for future multisite test coverage. |
| 165 | + if ! docker exec -u root -w /var/www/html "$WP_CONTAINER" php /tmp/wp-cli.phar site list --field=path --allow-root | grep -qx "/subsite/"; then |
| 166 | + docker exec -u root -w /var/www/html "$WP_CONTAINER" php /tmp/wp-cli.phar site create \ |
| 167 | + --slug=subsite \ |
| 168 | + --title="Subsite" \ |
| 169 | + --email="$WP_ADMIN_EMAIL" \ |
| 170 | + --allow-root |
| 171 | + fi |
| 172 | + fi |
| 173 | +
|
| 174 | + - name: Install plugin into WordPress container |
| 175 | + env: |
| 176 | + WP_CONTAINER: ${{ job.services.wordpress.id }} |
| 177 | + run: | |
| 178 | + set -euo pipefail |
| 179 | +
|
| 180 | + docker exec -u root -w /var/www/html "$WP_CONTAINER" rm -rf wp-content/plugins/code-snippets |
| 181 | + docker cp src "$WP_CONTAINER:/var/www/html/wp-content/plugins/code-snippets" |
| 182 | + docker exec -u root -w /var/www/html "$WP_CONTAINER" chown -R www-data:www-data wp-content/plugins/code-snippets |
78 | 183 |
|
79 | 184 | - name: Activate code-snippets plugin |
80 | | - run: npx wp-env run cli wp plugin activate code-snippets |
| 185 | + env: |
| 186 | + WP_CONTAINER: ${{ job.services.wordpress.id }} |
| 187 | + run: | |
| 188 | + set -euo pipefail |
| 189 | + if [ "${{ inputs.multisite }}" = "true" ]; then |
| 190 | + docker exec -u root -w /var/www/html "$WP_CONTAINER" php /tmp/wp-cli.phar plugin activate code-snippets --network --allow-root |
| 191 | + else |
| 192 | + docker exec -u root -w /var/www/html "$WP_CONTAINER" php /tmp/wp-cli.phar plugin activate code-snippets --allow-root |
| 193 | + fi |
81 | 194 |
|
82 | 195 | - name: WordPress debug information |
| 196 | + env: |
| 197 | + WP_CONTAINER: ${{ job.services.wordpress.id }} |
83 | 198 | run: | |
84 | | - npx wp-env run cli wp core version |
85 | | - npx wp-env run cli wp --info |
| 199 | + docker exec -u root -w /var/www/html "$WP_CONTAINER" php /tmp/wp-cli.phar core version --allow-root |
| 200 | + docker exec -u root -w /var/www/html "$WP_CONTAINER" php /tmp/wp-cli.phar --allow-root --info |
| 201 | +
|
| 202 | + - name: Restore Playwright browsers cache |
| 203 | + id: playwright-browsers-cache |
| 204 | + uses: actions/cache/restore@v4 |
| 205 | + with: |
| 206 | + path: | |
| 207 | + ~/.cache/ms-playwright |
| 208 | + key: ${{ runner.os }}-playwright-browsers-${{ hashFiles('package-lock.json') }}-${{ github.run_id }}-${{ github.job }} |
| 209 | + restore-keys: | |
| 210 | + ${{ runner.os }}-playwright-browsers-${{ hashFiles('package-lock.json') }}- |
86 | 211 |
|
87 | 212 | - name: Install playwright/test |
| 213 | + if: steps.playwright-browsers-cache.outputs.cache-matched-key == '' |
88 | 214 | run: | |
89 | 215 | npx playwright install chromium |
90 | 216 |
|
| 217 | + - name: Save Playwright browsers cache |
| 218 | + if: steps.playwright-browsers-cache.outputs.cache-matched-key == '' |
| 219 | + uses: actions/cache/save@v4 |
| 220 | + with: |
| 221 | + path: | |
| 222 | + ~/.cache/ms-playwright |
| 223 | + key: ${{ steps.playwright-browsers-cache.outputs.cache-primary-key }} |
| 224 | + |
91 | 225 | - name: Run Playwright tests |
| 226 | + env: |
| 227 | + WP_E2E_WPCLI_MODE: gh-actions-ci |
| 228 | + WP_E2E_WPCLI_PHAR: /tmp/wp-cli.phar |
| 229 | + WP_E2E_WPCLI_URL: http://localhost:8888 |
| 230 | + WP_E2E_WP_CONTAINER: ${{ job.services.wordpress.id }} |
| 231 | + WP_E2E_MULTISITE_MODE: ${{ inputs.multisite }} |
92 | 232 | run: npm run test:playwright -- --project=${{ inputs.project-name }} |
93 | | - |
94 | | - - name: Stop WordPress environment |
95 | | - if: always() |
96 | | - run: npx wp-env stop |
| 233 | + |
| 234 | + - name: Print WordPress logs on failure |
| 235 | + if: failure() |
| 236 | + run: | |
| 237 | + echo "::group::WordPress container logs" |
| 238 | + docker logs "${{ job.services.wordpress.id }}" || true |
| 239 | + echo "::endgroup::" |
97 | 240 |
|
98 | 241 | - uses: actions/upload-artifact@v4 |
99 | 242 | if: always() |
|
0 commit comments