fix: enhance Playwright test workflow and add wpCli helper for WP-CLI commands

Author: imantsk

.github/workflows/playwright-test.yml

@@ -204,6 +204,11 @@ jobs:
           npx playwright install chromium
 
       - name: Run Playwright tests
+        env:
+          WP_E2E_WPCLI_MODE: gh-actions-ci
+          WP_E2E_WP_CONTAINER: ${{ job.services.wordpress.id }}
+          WP_E2E_WPCLI_PHAR: /tmp/wp-cli.phar
+          WP_E2E_WPCLI_URL: http://localhost:8888
         run: npm run test:playwright -- --project=${{ inputs.project-name }}
 
       - name: Print WordPress logs on failure

tests/e2e/code-snippets-evaluation.spec.ts

@@ -1,8 +1,7 @@
-import util from 'util'
-import { exec } from 'child_process'
 import { expect, test } from '@playwright/test'
 import { SnippetsTestHelper } from './helpers/SnippetsTestHelper'
 import { SELECTORS } from './helpers/constants'
+import { wpCli } from './helpers/wpCli'
 import type { Page } from '@playwright/test'
 
 const TEST_SNIPPET_NAME = 'E2E Snippet Test'
@@ -34,27 +33,22 @@ const verifyShortcodeRendersCorrectly = async (
 }
 
 const createPageWithShortcode = async (snippetId: string): Promise<string> => {
-	const execAsync = util.promisify(exec)
-
 	const shortcode = `[code_snippet id=${snippetId} format name="${TEST_SNIPPET_NAME}"]`
 	const pageContent = `<p>Page content before shortcode.</p>\n\n${shortcode}\n\n<p>Page content after shortcode.</p>`
 
 	try {
-		const createPageCmd = [
-			'npx wp-env run cli wp post create',
+		const pageId = (await wpCli([
+			'post',
+			'create',
 			'--post_type=page',
-			'--post_title="Test Page for Snippet Shortcode"',
-			`--post_content='${pageContent}'`,
+			'--post_title=Test Page for Snippet Shortcode',
+			`--post_content=${pageContent}`,
 			'--post_status=publish',
 			'--porcelain'
-		].join(' ')
-
-		const { stdout } = await execAsync(createPageCmd)
-		const pageId = stdout.trim()
+		])).trim()
 
-		const getUrlCmd = `npx wp-env run cli wp post url ${pageId}`
-		const { stdout: pageUrl } = await execAsync(getUrlCmd)
-		return pageUrl.trim()
+		const pageUrl = (await wpCli(['post', 'url', pageId])).trim()
+		return pageUrl
 	} catch (error) {
 		console.error('Failed to create page via WP-CLI:', error)
 		throw error

tests/e2e/helpers/wpCli.ts

@@ -0,0 +1,49 @@
+import util from 'util'
+import { execFile } from 'child_process'
+
+export interface WpCliOptions {
+	url?: string
+}
+
+const execFileAsync = util.promisify(execFile)
+
+const hasArg = (args: string[], prefix: string): boolean =>
+	args.some(arg => arg === prefix || arg.startsWith(`${prefix}=`))
+
+export const wpCli = async (args: string[], options: WpCliOptions = {}): Promise<string> => {
+	const mode = (process.env.WP_E2E_WPCLI_MODE ?? '').toLowerCase()
+	const dockerContainer = process.env.WP_E2E_WP_CONTAINER
+
+	const url = options.url ?? process.env.WP_E2E_WPCLI_URL
+	const urlArgs = url && !hasArg(args, '--url') ? [`--url=${url}`] : []
+
+	if (dockerContainer || 'gh-actions-ci' === mode) {
+		if (!dockerContainer) {
+			throw new Error('WP_E2E_WP_CONTAINER must be set when WP_E2E_WPCLI_MODE is gh-actions-ci.')
+		}
+
+		const pharPath = process.env.WP_E2E_WPCLI_PHAR ?? '/tmp/wp-cli.phar'
+		const allowRootArgs = hasArg(args, '--allow-root') ? [] : ['--allow-root']
+
+		const { stdout } = await execFileAsync('docker', [
+			'exec',
+			'-u',
+			'root',
+			'-w',
+			'/var/www/html',
+			dockerContainer,
+			'php',
+			pharPath,
+			...urlArgs,
+			...allowRootArgs,
+			...args
+		])
+
+		return stdout
+	}
+
+	// Default to wp-env (local dev) for backwards compatibility.
+	const { stdout } = await execFileAsync('npx', ['wp-env', 'run', 'cli', 'wp', ...urlArgs, ...args])
+
+	return stdout
+}