wp-envでWordPressテーマ/プラグインのユニットテストやE2Eテストを構築

# グローバル環境にインストール
$ npm -g i @wordpress/env

# プロジェクト内にインストール
$ npm i @wordpress/env --save-dev

wp-env start

{
	"plugins": [ "." ],
	"config": {
		"WP_DEBUG": true
	}
}

composer require --dev yoast/wp-test-utils
composer require --dev phpunit/phpunit yoast/phpunit-polyfills

{
    "require-dev": {
        "yoast/wp-test-utils": "^1.2",
        "phpunit/phpunit": "^9.6",
        "yoast/phpunit-polyfills": "^1.1"
    }
}

<?xml version="1.0"?>
<phpunit
	bootstrap="phpunit/bootstrap.php"
	backupGlobals="false"
	colors="true"
	convertErrorsToExceptions="true"
	convertNoticesToExceptions="true"
	convertWarningsToExceptions="true"
	>

	<testsuites>
		<testsuite name="testing">
			<directory suffix="-test.php">./phpunit/</directory>
		</testsuite>
	</testsuites>
</phpunit>

<?php

# サンプルのbootstrapを適応 https://github.com/Yoast/wp-test-utils#using-the-bootstrap-utilities
# プラグインのパスを置換 plugin-name/main-file.php -> example-plugin/example-plugin.php

use Yoast\WPTestUtils\WPIntegration;

if ( getenv( 'WP_PLUGIN_DIR' ) !== false ) {
    define( 'WP_PLUGIN_DIR', getenv( 'WP_PLUGIN_DIR' ) );
}

$GLOBALS['wp_tests_options'] = [
    'active_plugins' => [ 'plugin-name/main-file.php' ],
];

require_once dirname( __DIR__ ) . '/vendor/yoast/wp-test-utils/src/WPIntegration/bootstrap-functions.php';

/*
 * Bootstrap WordPress. This will also load the Composer autoload file, the PHPUnit Polyfills
 * and the custom autoloader for the TestCase and the mock object classes.
 */
WPIntegration\bootstrap_it();

if ( ! defined( 'WP_PLUGIN_DIR' ) || file_exists( WP_PLUGIN_DIR . '/plugin-name/main-file.php' ) === false ) {
    echo PHP_EOL, 'ERROR: Please check whether the WP_PLUGIN_DIR environment variable is set and set to the correct value. The integration test suite won\'t be able to run without it.', PHP_EOL;
    exit( 1 );
}

<?php

use Yoast\WPTestUtils\BrainMonkey\TestCase;

class ExampleTest extends TestCase {

	/**
	 * @test
	 */
	public function example() {
		$this->assertTrue( true );
	}
}

$ wp-env run tests-cli --env-cwd='wp-content/plugins/example-plugin/' vendor/bin/phpunit
ℹ Starting 'vendor/bin/phpunit' on the tests-cli container. 

Installing...
Running as single site... To run multisite, use -c tests/phpunit/multisite.xml
Not running ajax tests. To execute these, use --group ajax.
Not running ms-files tests. To execute these, use --group ms-files.
Not running external-http tests. To execute these, use --group external-http.
PHPUnit 9.6.15 by Sebastian Bergmann and contributors.

.                                                                   1 / 1 (100%)

Time: 00:00.175, Memory: 40.50 MB

OK (1 test, 1 assertion)
✔ Ran `vendor/bin/phpunit` in 'tests-cli'. (in 1s 834ms)

{
	"scripts": {
		"test:php": "wp-env run tests-cli --env-cwd='wp-content/plugins/example-plugin/' vendor/bin/phpunit"
	}
}

$ wp-scripts test-e2e

# ドキュメントで指定される package.json での導入済みであれば以下と同様
$ npm run test:e2e

% npm run test:e2e 

> example-plugin@0.1.0 test:e2e
> wp-scripts test-e2e

Downloading Chromium r982053 - 117.4 Mb [====================] 100% 0.0s 
No tests found, exiting with code 1
Run with `--passWithNoTests` to exit with code 0
In /path/to/example-plugin
  162 files checked.
  testMatch: **/specs/**/*.[jt]s?(x), **/?(*.)spec.[jt]s?(x) - 0 matches
  testPathIgnorePatterns: /node_modules/ - 162 matches
  testRegex:  - 0 matches
Pattern:  - 0 matches

npm i -D @wordpress/e2e-test-utils

import { loginUser, visitAdminPage } from "@wordpress/e2e-test-utils";

describe("plugin active", () => {
	it("verifies the plugin is active", async () => {
		await loginUser();
		await visitAdminPage("plugins.php");

		const pluginSlug = "example-plugin";
		const activePlugin = await page.$x(
			'//tr[contains(@class, "active") and contains(@data-slug, "' +
				pluginSlug +
				'")]',
		);

		expect(activePlugin?.length).toBe(1);
	});
});

$ npm run test:e2e

> example-plugin@0.1.0 test:e2e
> wp-scripts test-e2e

Chromium is already in /path/to/example-plugin/node_modules/puppeteer-core/.local-chromium/mac-982053; skipping download.
 PASS  specs/plugin-active.js (8.973 s)
  plugin active
    ✓ verifies the plugin is active (8602 ms)

Test Suites: 1 passed, 1 total
Tests:       1 passed, 1 total
Snapshots:   0 total
Time:        9.007 s
Ran all test suites.