关于 wordpress-testing-qa
面向 WordPress 插件和主题开发者的测试与质量保障指南,涵盖 PHPUnit、WP_Mock、PHPCS 和 CI 配置,帮助组织不同层次的测试与代码规范检查。
主要功能
- 01配置 PHPUnit 集成测试
- 02使用 WP_Mock 编写单元测试
- 03通过 PHPCS 检查编码规范
- 04设置 GitHub Actions 流水线
- 05规划测试覆盖与分层
适用场景
- 01测试插件数据库操作和钩子
- 02隔离测试业务逻辑与外部调用
- 03在 CI 中运行测试及规范检查
安装
复制下面的命令,在终端中运行。
npx skills add https:/ / github.com/ bobmatnyc/ claude-mpm-skills --skill wordpress-testing-qa安装后在 Claude Code 中输入/wordpress-testing-qa确认已加载。
附带文件metadata.jsonREADME.md
详细介绍
WordPress 测试与质量保障
progressive_disclosure: entry_point: summary: "使用 PHPUnit、WP_Mock、PHPCS 和 CI/CD 进行 WordPress 插件和主题测试,以保障质量" when_to_use: - "使用 PHPUnit 集成测试来测试 WordPress 插件" - "不加载 WordPress 核心进行单元测试(WP_Mock)" - "使用 PHPCS 强制执行编码标准" quick_start: - "使用 WordPress 测试套件设置 PHPUnit" - "使用 WP_Mock 编写单元测试" - "使用 WPCS 规则集配置 PHPCS"
测试策略
WordPress 测试金字塔
WordPress 测试层级:
/\
/ \ E2E Tests (Playwright)
/ \ - Full user workflows
/------\ - Browser automation
/ \
/ INTEG \ Integration Tests (PHPUnit + WordPress)
/ TESTS \ - Database operations
/ \ - Hook interactions
--------------
UNIT TESTS Unit Tests (WP_Mock)
- Pure logic
- No WordPress dependency
测试分布指南:
- 单元测试(60%): 快速、隔离,不加载 WordPress
- 纯 PHP 函数
- 输入和输出明确的类方法
- 无副作用的业务逻辑
- 集成测试(30%): 加载 WordPress 的测试
- 数据库操作
- 钩子/过滤器交互
- 自定义文章类型注册
- 设置 API 功能
- 端到端测试(10%): 浏览器自动化
- 关键用户工作流
- 管理面板交互
- 前端表单提交
何时使用 PHPUnit 与 WP_Mock
以下情况使用 PHPUnit(集成测试):
- ✅ 测试数据库操作(
$wpdb、文章创建、元数据) - ✅ 测试 WordPress 钩子(实际触发的操作/过滤器)
- ✅ 测试模板渲染和输出
- ✅ 测试插件启用/停用逻辑
- ✅ 使用实际的 WordPress 函数进行测试
以下情况使用 WP_Mock(单元测试):
- ✅ 测试纯业务逻辑
- ✅ 测试调用 WordPress 函数但逻辑独立的函数
- ✅ 需要快速执行测试(无需设置数据库)
- ✅ 在隔离环境中测试,不产生副作用
- ✅ 模拟外部 API 调用
测试覆盖率目标
最低覆盖率要求:
- 新代码: 最低覆盖率为 80%
- 关键路径: 覆盖率为 95%(支付处理、身份验证、数据验证)
- 遗留代码: 逐步提高覆盖率,优先处理高风险区域
- 公共 API: 所有公共方法的覆盖率达到 100%
测试内容(按优先级排序):
- 安全函数: Nonce 验证、清理、权限检查
- 数据操作: 数据库 CRUD、数据验证、数据转换
- 业务逻辑: 计算、工作流、状态转换
- 钩子回调: 操作/过滤器处理函数
- 公共 API: REST 端点、WP-CLI 命令
无需测试的内容:
- ❌ WordPress 核心函数(假定其正常工作)
- ❌ 第三方库的内部实现
- ❌ 没有逻辑的简单 getter/setter
- ❌ 配置文件(theme.json、block.json)
PHPUnit 集成测试
WordPress 测试套件设置
步骤 1:安装依赖项
# Install PHPUnit and WordPress polyfills
composer require --dev phpunit/phpunit "^9.6"
composer require --dev yoast/phpunit-polyfills "^2.0"
# Generate test scaffold with WP-CLI
wp scaffold plugin-tests my-plugin
# This creates:
# - tests/bootstrap.php
# - tests/test-sample.php
# - phpunit.xml.dist
# - bin/install-wp-tests.sh
步骤 2:安装 WordPress 测试库
# Install WordPress test suite and test database
# Syntax: bash bin/install-wp-tests.sh <db-name> <db-user> <db-pass> <db-host> <wp-version>
bash bin/install-wp-tests.sh wordpress_test root '' localhost latest
# For specific WordPress version:
bash bin/install-wp-tests.sh wordpress_test root '' localhost 6.7
步骤 3:配置 phpunit.xml.dist
<?xml version="1.0"?>
<phpunit
bootstrap="tests/bootstrap.php"
backupGlobals="false"
colors="true"
convertErrorsToExceptions="true"
convertNoticesToExceptions="true"
convertWarningsToExceptions="true"
stopOnFailure="false"
>
<testsuites>
<testsuite name="plugin">
<directory prefix="test-" suffix=".php">./tests/</directory>
<exclude>./tests/bootstrap.php</exclude>
</testsuite>
</testsuites>
<coverage includeUncoveredFiles="true">
<include>
<directory suffix=".php">./includes/</directory>
</include>
<exclude>
<directory>./vendor/</directory>
<directory>./tests/</directory>
</exclude>
<report>
<html outputDirectory="coverage-html"/>
<text outputFile="php://stdout" showOnlySummary="true"/>
</report>
</coverage>
<php>
<const name="WP_TESTS_PHPUNIT_POLYFILLS_PATH" value="vendor/yoast/phpunit-polyfills"/>
</php>
</phpunit>
WP_UnitTestCase 基类
tests/bootstrap.php:
<?php
/**
* PHPUnit bootstrap file
*/
// Composer autoloader
require_once dirname(__DIR__) . '/vendor/autoload.php';
// WordPress tests directory
$_tests_dir = getenv('WP_TESTS_DIR');
if (!$_tests_dir) {
$_tests_dir = rtrim(sys_get_temp_dir(), '/\\') . '/wordpress-tests-lib';
}
if (!file_exists("{$_tests_dir}/includes/functions.php")) {
throw new Exception("Could not find {$_tests_dir}/includes/functions.php");
}
// Give access to tests_add_filter() function
require_once "{$_tests_dir}/includes/functions.php";
/**
* Manually load the plugin being tested
*/
function _manually_load_plugin() {
require dirname(__DIR__) . '/my-plugin.php';
}
tests_add_filter('muplugins_loaded', '_manually_load_plugin');
// Start up the WordPress testing environment
require "{$_tests_dir}/includes/bootstrap.php";
用于测试数据的工厂对象
使用内置工厂:
<?php
class Test_Plugin_Integration extends WP_UnitTestCase {
/**
* Test creating posts with factory
*/
public function test_create_post_with_meta() {
// Create a post using factory
$post_id = $this->factory->post->create([
'post_title' => 'Test Post',
'post_content' => 'Test content for integration test',
'post_status' => 'publish',
'post_type' => 'post',
]);
$this->assertIsInt($post_id);
$this->assertGreaterThan(0, $post_id);
// Add post meta
add_post_meta($post_id, '_custom_field', 'custom_value');
// Verify meta was saved
$meta_value = get_post_meta($post_id, '_custom_field', true);
$this->assertEquals('custom_value', $meta_value);
}
/**
* Test creating users
*/
public function test_user_can_edit_post() {
// Create editor user
$editor_id = $this->factory->user->create([
'role' => 'editor',
'user_login' => 'test_editor',
'user_email' => '[email protected]',
]);
// Set as current user
wp_set_current_user($editor_id);
// Create post
$post_id = $this->factory->post->create([
'post_author' => $editor_id,
]);
// Test capabilities
$this->assertTrue(current_user_can('edit_post', $post_id));
$this->assertTrue(current_user_can('edit_posts'));
$this->assertFalse(current_user_can('manage_options'));
}
/**
* Test creating terms and taxonomy
*/
public function test_assign_categories() {
// Create category
$category_id = $this->factory->category->create([
'name' => 'Test Category',
'slug' => 'test-category',
]);
// Create post
$post_id = $this->factory->post->create();
// Assign category
wp_set_post_categories($post_id, [$category_id]);
// Verify assignment
$categories = wp_get_post_categories($post_id);
$this->assertContains($category_id, $categories);
}
/**
* Test creating comments
*/
public function test_post_has_comments() {
$post_id = $this->factory->post->create();
// Create multiple comments
$comment_ids = $this->factory->comment->create_many(3, [
'comment_post_ID' => $post_id,
'comment_approved' => 1,
]);
$this->assertCount(3, $comment_ids);
// Get comments for post
$comments = get_comments(['post_id' => $post_id]);
$this->assertCount(3, $comments);
}
}
可用的工厂对象:
$this->factory->post- 文章、页面、自定义文章类型$this->factory->user- 不同角色的用户$this->factory->term- 术语(分类、标签、自定义分类法)$this->factory->category- 分类$this->factory->tag- 标签$this->factory->comment- 评论$this->factory->blog- 多站点博客
数据库测试装置与清理
setUp() 和 tearDown() 方法:
<?php
class Test_Custom_Post_Type extends WP_UnitTestCase {
protected $post_ids = [];
/**
* Setup runs before EACH test method
*/
public function setUp(): void {
parent::setUp();
// Register custom post type
register_post_type('book', [
'public' => true,
'supports' => ['title', 'editor'],
]);
// Create test data
$this->post_ids = $this->factory->post->create_many(5, [
'post_type' => 'book',
]);
}
/**
* Teardown runs after EACH test method
*/
public function tearDown(): void {
// Clean up test data
foreach ($this->post_ids as $post_id) {
wp_delete_post($post_id, true); // Force delete
}
// Unregister post type
unregister_post_type('book');
parent::tearDown();
}
/**
* Test that books are created
*/
public function test_books_created() {
$this->assertCount(5, $this->post_ids);
$query = new WP_Query([
'post_type' => 'book',
'posts_per_page' => -1,
]);
$this->assertEquals(5, $query->found_posts);
}
}
setUpBeforeClass() 和 tearDownAfterClass():
<?php
class Test_Plugin_Database extends WP_UnitTestCase {
protected static $table_name;
/**
* Runs ONCE before all tests in class
*/
public static function setUpBeforeClass(): void {
parent::setUpBeforeClass();
global $wpdb;
self::$table_name = $wpdb->prefix . 'plugin_data';
// Create custom table
$charset_collate = $wpdb->get_charset_collate();
$sql = "CREATE TABLE " . self::$table_name . " (
id bigint(20) unsigned NOT NULL AUTO_INCREMENT,
user_id bigint(20) unsigned NOT NULL,
data_value varchar(255) NOT NULL,
created_at datetime DEFAULT CURRENT_TIMESTAMP,
PRIMARY KEY (id),
KEY user_id (user_id)
) $charset_collate;";
require_once ABSPATH . 'wp-admin/includes/upgrade.php';
dbDelta($sql);
}
/**
* Runs ONCE after all tests in class
*/
public static function tearDownAfterClass(): void {
global $wpdb;
$wpdb->query("DROP TABLE IF EXISTS " . self::$table_name);
parent::tearDownAfterClass();
}
/**
* Test table exists
*/
public function test_custom_table_exists() {
global $wpdb;
$table_exists = $wpdb->get_var(
"SHOW TABLES LIKE '" . self::$table_name . "'"
);
$this->assertEquals(self::$table_name, $table_exists);
}
/**
* Test insert data
*/
public function test_insert_data() {
global $wpdb;
$result = $wpdb->insert(
self::$table_name,
[
'user_id' => 1,
'data_value' => 'test_value',
],
['%d', '%s']
);
$this->assertEquals(1, $result);
$this->assertGreaterThan(0, $wpdb->insert_id);
}
}
完整的插件测试示例
tests/test-plugin-functionality.php:
<?php
/**
* Test plugin core functionality
*/
class Test_Plugin_Functionality extends WP_UnitTestCase {
/**
* Test plugin registers custom post type
*/
public function test_custom_post_type_registered() {
$this->assertTrue(post_type_exists('book'));
$post_type = get_post_type_object('book');
$this->assertTrue($post_type->public);
$this->assertTrue($post_type->show_in_rest);
}
/**
* Test custom taxonomy registration
*/
public function test_custom_taxonomy_registered() {
$this->assertTrue(taxonomy_exists('genre'));
$taxonomy = get_taxonomy('genre');
$this->assertTrue($taxonomy->hierarchical);
$this->assertContains('book', $taxonomy->object_type);
}
/**
* Test saving custom meta data
*/
public function test_save_book_metadata() {
$book_id = $this->factory->post->create([
'post_type' => 'book',
'post_title' => 'Test Book',
]);
// Simulate saving meta (as would happen in save_post hook)
update_post_meta($book_id, '_isbn', '978-3-16-148410-0');
update_post_meta($book_id, '_author', 'John Doe');
update_post_meta($book_id, '_publication_year', 2024);
// Verify meta saved correctly
$this->assertEquals('978-3-16-148410-0', get_post_meta($book_id, '_isbn', true));
$this->assertEquals('John Doe', get_post_meta($book_id, '_author', true));
$this->assertEquals(2024, get_post_meta($book_id, '_publication_year', true));
}
/**
* Test shortcode output
*/
public function test_book_shortcode_output() {
$book_id = $this->factory->post->create([
'post_type' => 'book',
'post_title' => 'The Great Gatsby',
]);
update_post_meta($book_id, '_author', 'F. Scott Fitzgerald');
// Test shortcode
$output = do_shortcode('[book id="' . $book_id . '"]');
$this->assertStringContainsString('The Great Gatsby', $output);
$this->assertStringContainsString('F. Scott Fitzgerald', $output);
}
/**
* Test action hook fires correctly
*/
public function test_book_published_action_fires() {
$action_fired = false;
// Add temporary hook to verify action fires
add_action('my_plugin_book_published', function($post_id) use (&$action_fired) {
$action_fired = true;
});
// Create published book (should trigger action)
$book_id = $this->factory->post->create([
'post_type' => 'book',
'post_status' => 'publish',
]);
// Manually trigger the action (simulating what plugin does)
do_action('my_plugin_book_published', $book_id);
$this->assertTrue($action_fired, 'Book published action did not fire');
}
/**
* Test filter modifies content
*/
public function test_reading_time_filter() {
$content = str_repeat('word ', 200); // 200 words
// Apply filter
$filtered = apply_filters('my_plugin_content_filter', $content);
$this->assertStringContainsString('reading time', strtolower($filtered));
$this->assertStringContainsString('1 min', $filtered);
}
}
WP_Mock 单元测试
WP_Mock 是什么,以及何时使用
WP_Mock 的用途:
- 无需加载 WordPress 即可测试 PHP 代码
- 模拟 WordPress 函数,使其返回预期值
- 验证调用 WordPress 函数时是否传入了正确的参数
- 比集成测试快得多(无需设置数据库)
何时使用 WP_Mock:
✅ 非常适合:
- 调用 WordPress 函数的纯业务逻辑
- 数据转换/验证函数
- 依赖 WordPress 的服务类
- 持续集成测试(加快 CI 构建)
❌ 不适合:
- 测试实际的数据库操作
- 测试插件之间的钩子交互
- 测试模板渲染
- 测试依赖 WordPress 状态的函数
安装和设置
# Install WP_Mock and Mockery
composer require --dev mockery/mockery "^1.6"
composer require --dev 10up/wp_mock "^1.0"
composer require --dev phpunit/phpunit "^9.6"
tests/bootstrap-wp-mock.php:
<?php
/**
* Bootstrap file for WP_Mock tests
*/
require_once __DIR__ . '/../vendor/autoload.php';
// WP_Mock setup
WP_Mock::bootstrap();
// Define WordPress constants if needed
if (!defined('ABSPATH')) {
define('ABSPATH', '/path/to/wordpress/');
}
phpunit-wp-mock.xml.dist:
<?xml version="1.0"?>
<phpunit
bootstrap="tests/bootstrap-wp-mock.php"
backupGlobals="false"
colors="true"
convertErrorsToExceptions="true"
convertNoticesToExceptions="true"
convertWarningsToExceptions="true"
>
<testsuites>
<testsuite name="unit">
<directory prefix="test-" suffix=".php">./tests/unit/</directory>
</testsuite>
</testsuites>
</phpunit>
模拟 WordPress 函数
tests/unit/test-data-processor.php:
<?php
use WP_Mock\Tools\TestCase;
class Test_Data_Processor extends TestCase {
public function setUp(): void {
WP_Mock::setUp();
}
public function tearDown(): void {
WP_Mock::tearDown();
}
/**
* Test sanitization function
*/
public function test_sanitize_input() {
// Mock sanitize_text_field
WP_Mock::userFunction('sanitize_text_field', [
'times' => 1,
'args' => ['<script>alert("xss")</script>'],
'return' => 'alert("xss")', // WordPress strips tags
]);
$processor = new MyPlugin\DataProcessor();
$result = $processor->sanitize_input('<script>alert("xss")</script>');
$this->assertEquals('alert("xss")', $result);
}
/**
* Test get_option is called
*/
public function test_get_setting() {
// Mock get_option call
WP_Mock::userFunction('get_option', [
'times' => 1,
'args' => ['my_plugin_api_key', ''],
'return' => 'test_api_key_12345',
]);
$processor = new MyPlugin\DataProcessor();
$api_key = $processor->get_api_key();
$this->assertEquals('test_api_key_12345', $api_key);
}
/**
* Test multiple function calls with different returns
*/
public function test_user_data_retrieval() {
$user_id = 42;
// Mock get_user_meta
WP_Mock::userFunction('get_user_meta', [
'times' => 1,
'args' => [$user_id, 'first_name', true],
'return' => 'John',
]);
WP_Mock::userFunction('get_user_meta', [
'times' => 1,
'args' => [$user_id, 'last_name', true],
'return' => 'Doe',
]);
$processor = new MyPlugin\DataProcessor();
$full_name = $processor->get_user_full_name($user_id);
$this->assertEquals('John Doe', $full_name);
}
/**
* Test function with type matcher
*/
public function test_save_data_with_array() {
// Accept any array as second argument
WP_Mock::userFunction('update_option', [
'times' => 1,
'args' => [
'my_plugin_settings',
WP_Mock\Functions::type('array'),
],
'return' => true,
]);
$processor = new MyPlugin\DataProcessor();
$result = $processor->save_settings(['api_key' => 'test123']);
$this->assertTrue($result);
}
}
模拟筛选器和操作
测试 add_filter() 调用:
<?php
class Test_Hook_Registration extends WP_Mock\Tools\TestCase {
public function setUp(): void {
WP_Mock::setUp();
}
public function tearDown(): void {
WP_Mock::tearDown();
}
/**
* Test that filter is registered
*/
public function test_content_filter_registered() {
// Expect filter to be added
WP_Mock::expectFilterAdded(
'the_content',
'MyPlugin\ContentFilter::add_reading_time',
10,
1
);
// Execute function that adds the filter
MyPlugin\Hooks::register_filters();
// Verify expectations met
$this->assertConditionsMet();
}
/**
* Test that action is registered
*/
public function test_init_action_registered() {
WP_Mock::expectActionAdded(
'init',
'MyPlugin\PostTypes::register_custom_post_types',
10,
0
);
MyPlugin\Hooks::register_actions();
$this->assertConditionsMet();
}
/**
* Test apply_filters modifies value
*/
public function test_apply_custom_filter() {
$original_value = 100;
$filtered_value = 150;
// Mock apply_filters
WP_Mock::onFilter('my_plugin_price')
->with($original_value)
->reply($filtered_value);
$processor = new MyPlugin\PriceCalculator();
$result = $processor->get_final_price($original_value);
$this->assertEquals($filtered_value, $result);
}
/**
* Test do_action is called
*/
public function test_custom_action_fired() {
$order_id = 12345;
// Expect action to be fired with specific arguments
WP_Mock::expectAction('my_plugin_order_processed', $order_id);
$processor = new MyPlugin\OrderProcessor();
$processor->process_order($order_id);
$this->assertConditionsMet();
}
}
隔离测试(不依赖 WordPress)
示例:电子邮件服务类:
<?php
namespace MyPlugin;
class EmailService {
public function send_notification(string $to, string $message): bool {
$subject = $this->get_email_subject();
$headers = $this->get_email_headers();
return wp_mail($to, $subject, $message, $headers);
}
protected function get_email_subject(): string {
$site_name = get_bloginfo('name');
return sprintf('[%s] Notification', $site_name);
}
protected function get_email_headers(): array {
$admin_email = get_option('admin_email');
return [
'From: ' . $admin_email,
'Content-Type: text/html; charset=UTF-8',
];
}
}
不依赖 WordPress 的单元测试:
<?php
use WP_Mock\Tools\TestCase;
class Test_Email_Service extends TestCase {
public function setUp(): void {
WP_Mock::setUp();
}
public function tearDown(): void {
WP_Mock::tearDown();
}
/**
* Test email sending logic
*/
public function test_send_notification_email() {
// Mock get_bloginfo
WP_Mock::userFunction('get_bloginfo', [
'args' => 'name',
'return' => 'My WordPress Site',
]);
// Mock get_option
WP_Mock::userFunction('get_option', [
'args' => 'admin_email',
'return' => '[email protected]',
]);
// Mock wp_mail and verify arguments
WP_Mock::userFunction('wp_mail', [
'times' => 1,
'args' => [
'[email protected]',
'[My WordPress Site] Notification',
'Test message content',
WP_Mock\Functions::type('array'),
],
'return' => true,
]);
$service = new MyPlugin\EmailService();
$result = $service->send_notification(
'[email protected]',
'Test message content'
);
$this->assertTrue($result);
}
/**
* Test email failure handling
*/
public function test_email_send_failure() {
WP_Mock::userFunction('get_bloginfo', [
'return' => 'Test Site',
]);
WP_Mock::userFunction('get_option', [
'return' => '[email protected]',
]);
// Simulate wp_mail failure
WP_Mock::userFunction('wp_mail', [
'return' => false,
]);
$service = new MyPlugin\EmailService();
$result = $service->send_notification('[email protected]', 'Message');
$this->assertFalse($result);
}
}
PHPCS 和编码标准
安装 PHPCS 和 WPCS
通过 Composer(推荐):
# Allow PHPCS composer installer plugin
composer config allow-plugins.dealerdirect/phpcodesniffer-composer-installer true
# Install WordPress Coding Standards
composer require --dev wp-coding-standards/wpcs:"^3.0"
# Install PHP Compatibility checker
composer require --dev phpcompatibility/phpcompatibility-wp:"*"
# Install PHPCS itself (if not already installed)
composer require --dev squizlabs/php_codesniffer:"^3.7"
# Verify installation
vendor/bin/phpcs -i
# Should show: WordPress, WordPress-Core, WordPress-Docs, WordPress-Extra
.phpcs.xml.dist 配置
完整配置文件:
<?xml version="1.0"?>
<ruleset xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
name="WordPress Plugin Coding Standards"
xsi:noNamespaceSchemaLocation="https://raw.githubusercontent.com/squizlabs/PHP_CodeSniffer/master/phpcs.xsd">
<description>Custom coding standards for WordPress plugin</description>
<file>./includes</file>
<file>./my-plugin.php</file>
<exclude-pattern>*/vendor/*</exclude-pattern>
<exclude-pattern>*/node_modules/*</exclude-pattern>
<exclude-pattern>*/tests/*</exclude-pattern>
<exclude-pattern>*/build/*</exclude-pattern>
<exclude-pattern>*/.git/*</exclude-pattern>
<arg value="ps"/>
<arg name="colors"/>
<arg name="extensions" value="php"/>
<arg name="parallel" value="8"/>
<rule ref="WordPress-Extra">
<exclude name="Generic.Arrays.DisallowShortArraySyntax"/>
<exclude name="Squiz.PHP.DisallowMultipleAssignments"/>
<exclude name="Squiz.Commenting.FileComment"/>
</rule>
<rule ref="WordPress.WP.I18n">
<properties>
<property name="text_domain" type="array">
<element value="my-plugin"/>
</property>
</properties>
</rule>
<rule ref="WordPress.NamingConventions.PrefixAllGlobals">
<properties>
<property name="prefixes" type="array">
<element value="my_plugin"/>
<element value="MyPlugin"/>
</property>
</properties>
</rule>
<config name="testVersion" value="8.1-"/>
<rule ref="PHPCompatibilityWP"/>
<config name="minimum_wp_version" value="6.4"/>
<rule ref="WordPress.Files.FileName">
<exclude-pattern>*/tests/*</exclude-pattern>
</rule>
<rule ref="Generic.Files.LineLength">
<properties>
<property name="lineLimit" value="120"/>
<property name="absoluteLineLimit" value="150"/>
</properties>
</rule>
<rule ref="WordPress.WP.GlobalVariablesOverride">
<type>error</type>
</rule>
</ruleset>
运行 PHPCS 和 PHPCBF
命令行用法:
# Check all files
vendor/bin/phpcs
# Check specific file
vendor/bin/phpcs includes/Core.php
# Show error codes
vendor/bin/phpcs -s
# Show only errors (hide warnings)
vendor/bin/phpcs -n
# Generate report summary
vendor/bin/phpcs --report=summary
# Check single file with detailed output
vendor/bin/phpcs -v includes/Admin/Settings.php
# Auto-fix fixable issues
vendor/bin/phpcbf
# Auto-fix specific file
vendor/bin/phpcbf includes/Core.php
# Dry run (show what would be fixed)
vendor/bin/phpcbf --dry-run
# Use specific standard
vendor/bin/phpcs --standard=WordPress-Core includes/
# Generate different report formats
vendor/bin/phpcs --report=json > phpcs-report.json
vendor/bin/phpcs --report=xml > phpcs-report.xml
vendor/bin/phpcs --report=csv > phpcs-report.csv
composer.json 脚本:
{
"scripts": {
"phpcs": "phpcs",
"phpcbf": "phpcbf",
"phpcs:check": "phpcs --report=summary",
"phpcs:fix": "phpcbf",
"test": [
"@phpcs",
"phpunit"
]
}
}
提交前钩子
安装提交前钩子(.git/hooks/pre-commit):
#!/bin/bash
# Run PHPCS on changed PHP files
FILES=$(git diff --cached --name-only --diff-filter=ACM | grep '.php$')
if [ -z "$FILES" ]; then
echo "No PHP files to check"
exit 0
fi
echo "Running PHPCS on changed files..."
vendor/bin/phpcs $FILES
PHPCS_EXIT=$?
if [ $PHPCS_EXIT -ne 0 ]; then
echo ""
echo "PHPCS found coding standard violations."
echo "Run 'composer phpcbf' to auto-fix issues."
echo ""
exit 1
fi
echo "PHPCS passed!"
exit 0
使钩子可执行:
chmod +x .git/hooks/pre-commit
IDE 集成
Visual Studio Code(.vscode/settings.json):
{
"phpcs.enable": true,
"phpcs.standard": "WordPress",
"phpcs.executablePath": "${workspaceFolder}/vendor/bin/phpcs",
"phpcbf.enable": true,
"phpcbf.executablePath": "${workspaceFolder}/vendor/bin/phpcbf",
"phpcbf.onsave": false,
"editor.formatOnSave": false,
"[php]": {
"editor.defaultFormatter": "bmewburn.vscode-intelephense-client",
"editor.formatOnSave": true
}
}
PHPStorm 配置:
- 前往 设置 → PHP → 质量工具 → PHP_CodeSniffer
- 设置配置路径:
{PROJECT_ROOT}/vendor/bin/phpcs - 前往 设置 → 编辑器 → 检查 → PHP → 质量工具
- 启用“PHP_CodeSniffer 验证”
- 设置编码标准:“自定义”
- 设置路径:
{PROJECT_ROOT}/.phpcs.xml.dist
GitHub Actions CI/CD
工作流文件结构
.github/workflows/tests.yml:
name: Test Suite
on:
push:
branches: [ main, develop ]
pull_request:
branches: [ main ]
jobs:
# Job 1: Coding Standards Check
phpcs:
name: PHPCS
runs-on: ubuntu-latest
steps:
- name: Checkout code
uses: actions/checkout@v4
- name: Setup PHP
uses: shivammathur/setup-php@v2
with:
php-version: '8.3'
tools: composer
coverage: none
- name: Install dependencies
run: composer install --prefer-dist --no-progress --no-suggest
- name: Run PHPCS
run: vendor/bin/phpcs --report=summary
# Job 2: PHPUnit Tests with Matrix
phpunit:
name: PHPUnit (PHP ${{ matrix.php }}, WP ${{ matrix.wordpress }})
runs-on: ubuntu-latest
strategy:
fail-fast: false
matrix:
php: ['8.1', '8.2', '8.3']
wordpress: ['6.4', '6.5', '6.6', '6.7', 'latest']
include:
- php: '8.3'
wordpress: 'trunk'
services:
mysql:
image: mysql:8.0
env:
MYSQL_ROOT_PASSWORD: root
MYSQL_DATABASE: wordpress_test
ports:
- 3306:3306
options: --health-cmd="mysqladmin ping" --health-interval=10s --health-timeout=5s --health-retries=3
steps:
- name: Checkout code
uses: actions/checkout@v4
- name: Setup PHP
uses: shivammathur/setup-php@v2
with:
php-version: ${{ matrix.php }}
extensions: mysqli, zip
tools: composer
coverage: xdebug
- name: Install Composer dependencies
run: composer install --prefer-dist --no-progress
- name: Install WordPress test suite
run: |
bash bin/install-wp-tests.sh wordpress_test root root 127.0.0.1:3306 ${{ matrix.wordpress }}
- name: Run PHPUnit tests
run: vendor/bin/phpunit --coverage-clover=coverage.xml
- name: Upload coverage to Codecov
if: matrix.php == '8.3' && matrix.wordpress == 'latest'
uses: codecov/codecov-action@v4
with:
files: ./coverage.xml
flags: unittests
name: codecov-umbrella
# Job 3: WP_Mock Unit Tests
wp-mock:
name: WP_Mock Unit Tests
runs-on: ubuntu-latest
steps:
- name: Checkout code
uses: actions/checkout@v4
- name: Setup PHP
uses: shivammathur/setup-php@v2
with:
php-version: '8.3'
tools: composer
coverage: none
- name: Install dependencies
run: composer install --prefer-dist --no-progress
- name: Run WP_Mock tests
run: vendor/bin/phpunit -c phpunit-wp-mock.xml.dist
矩阵测试(多个 PHP/WP 版本)
策略说明:
strategy:
fail-fast: false # Continue testing other versions even if one fails
matrix:
php: ['8.1', '8.2', '8.3'] # Test PHP versions
wordpress: ['6.4', '6.5', '6.6', '6.7', 'latest'] # Test WP versions
include:
# Add specific combination not in default matrix
- php: '8.3'
wordpress: 'trunk' # WordPress development version
exclude:
# Exclude incompatible combinations
- php: '8.1'
wordpress: 'trunk'
矩阵结果:
- 创建 18 个测试任务(3 个 PHP 版本 × 6 个 WordPress 版本)
- 确保在受支持的版本之间保持兼容
- 及早发现特定版本的问题
在 CI 中执行 PHPCS 检查
专用 PHPCS 任务:
phpcs-detailed:
name: Detailed PHPCS Report
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- name: Setup PHP
uses: shivammathur/setup-php@v2
with:
php-version: '8.3'
tools: composer, cs2pr
- name: Install dependencies
run: composer install --prefer-dist --no-progress
- name: Run PHPCS with annotations
run: vendor/bin/phpcs -q --report=checkstyle | cs2pr
- name: Generate PHPCS report
if: failure()
run: vendor/bin/phpcs --report=summary --report-file=phpcs-report.txt
- name: Upload PHPCS report
if: failure()
uses: actions/upload-artifact@v3
with:
name: phpcs-report
path: phpcs-report.txt
执行 PHPUnit 测试
包含代码覆盖率:
phpunit-coverage:
name: PHPUnit with Coverage
runs-on: ubuntu-latest
services:
mysql:
image: mysql:8.0
env:
MYSQL_ROOT_PASSWORD: root
MYSQL_DATABASE: wordpress_test
ports:
- 3306:3306
options: --health-cmd="mysqladmin ping" --health-interval=10s
steps:
- uses: actions/checkout@v4
- name: Setup PHP with Xdebug
uses: shivammathur/setup-php@v2
with:
php-version: '8.3'
extensions: mysqli, zip, gd
tools: composer
coverage: xdebug
ini-values: xdebug.mode=coverage
- name: Install dependencies
run: composer install --prefer-dist --no-progress
- name: Install WordPress test suite
run: bash bin/install-wp-tests.sh wordpress_test root root 127.0.0.1:3306 latest
- name: Run tests with coverage
run: vendor/bin/phpunit --coverage-html coverage-html --coverage-clover coverage.xml
- name: Upload coverage HTML report
uses: actions/upload-artifact@v3
with:
name: coverage-report
path: coverage-html
- name: Check coverage threshold
run: |
COVERAGE=$(vendor/bin/phpunit --coverage-text | grep "Lines:" | awk '{print $2}' | sed 's/%//')
if (( $(echo "$COVERAGE < 80" | bc -l) )); then
echo "Coverage $COVERAGE% is below 80% threshold"
exit 1
fi
覆盖率报告
Codecov 集成:
- name: Upload to Codecov
uses: codecov/codecov-action@v4
with:
files: ./coverage.xml
flags: unittests
name: codecov-umbrella
fail_ci_if_error: true
verbose: true
Coveralls 集成:
- name: Upload to Coveralls
uses: coverallsapp/github-action@v2
with:
github-token: ${{ secrets.GITHUB_TOKEN }}
path-to-lcov: ./coverage.xml
完整工作流示例
.github/workflows/ci.yml(可用于生产环境):
name: CI Pipeline
on:
push:
branches: [ main, develop ]
pull_request:
branches: [ main ]
schedule:
- cron: '0 0 * * 0' # Weekly on Sunday
jobs:
coding-standards:
name: Coding Standards
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: shivammathur/setup-php@v2
with:
php-version: '8.3'
tools: composer, cs2pr
- run: composer install --prefer-dist --no-progress
- run: vendor/bin/phpcs -q --report=checkstyle | cs2pr
unit-tests:
name: Unit Tests (WP_Mock)
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: shivammathur/setup-php@v2
with:
php-version: '8.3'
tools: composer
- run: composer install --prefer-dist --no-progress
- run: vendor/bin/phpunit -c phpunit-wp-mock.xml.dist --testdox
integration-tests:
name: Integration Tests
runs-on: ubuntu-latest
strategy:
matrix:
php: ['8.1', '8.3']
wordpress: ['6.5', 'latest']
services:
mysql:
image: mysql:8.0
env:
MYSQL_ROOT_PASSWORD: root
MYSQL_DATABASE: wordpress_test
ports:
- 3306:3306
options: --health-cmd="mysqladmin ping" --health-interval=10s
steps:
- uses: actions/checkout@v4
- uses: shivammathur/setup-php@v2
with:
php-version: ${{ matrix.php }}
extensions: mysqli
tools: composer
coverage: xdebug
- run: composer install --prefer-dist --no-progress
- run: bash bin/install-wp-tests.sh wordpress_test root root 127.0.0.1:3306 ${{ matrix.wordpress }}
- run: vendor/bin/phpunit --coverage-clover=coverage.xml
- uses: codecov/codecov-action@v4
if: matrix.php == '8.3' && matrix.wordpress == 'latest'
with:
files: ./coverage.xml
deploy-ready:
name: Deployment Check
needs: [coding-standards, unit-tests, integration-tests]
runs-on: ubuntu-latest
if: github.ref == 'refs/heads/main'
steps:
- run: echo "All checks passed - ready for deployment"
测试最佳实践
测试命名约定
方法命名模式:
test_[method_name]_[scenario]_[expected_result]
示例:
// ✅ GOOD: Descriptive test names
public function test_sanitize_email_with_valid_email_returns_email() {}
public function test_sanitize_email_with_invalid_email_returns_empty_string() {}
public function test_save_post_meta_with_valid_data_returns_true() {}
public function test_user_login_with_wrong_password_returns_wp_error() {}
// ❌ BAD: Vague test names
public function test_email() {}
public function test_function() {}
public function test_it_works() {}
类命名:
// Pattern: Test_[ClassName]
class Test_Email_Service extends WP_UnitTestCase {}
class Test_Data_Validator extends WP_Mock\Tools\TestCase {}
class Test_Post_Meta_Handler extends WP_UnitTestCase {}
准备—执行—断言模式
每个测试都按此结构编写:
public function test_calculate_discount() {
// ARRANGE: Set up test data and conditions
$original_price = 100;
$discount_percent = 20;
$calculator = new MyPlugin\PriceCalculator();
// ACT: Execute the code being tested
$discounted_price = $calculator->apply_discount($original_price, $discount_percent);
// ASSERT: Verify expected outcome
$this->assertEquals(80, $discounted_price);
}
完整示例:
public function test_save_user_preferences_updates_database() {
// ARRANGE
$user_id = $this->factory->user->create();
$preferences = [
'theme' => 'dark',
'notifications' => true,
];
$service = new MyPlugin\UserPreferences();
// ACT
$result = $service->save_preferences($user_id, $preferences);
// ASSERT
$this->assertTrue($result);
$saved_prefs = get_user_meta($user_id, 'preferences', true);
$this->assertEquals('dark', $saved_prefs['theme']);
$this->assertTrue($saved_prefs['notifications']);
}
数据提供器
用途: 使用多个输入测试同一逻辑
/**
* @dataProvider email_validation_provider
*/
public function test_email_validation($email, $expected) {
$validator = new MyPlugin\Validator();
$result = $validator->is_valid_email($email);
$this->assertEquals($expected, $result);
}
/**
* Data provider for email validation tests
*/
public function email_validation_provider(): array {
return [
'valid email' => ['[email protected]', true],
'invalid no at' => ['userexample.com', false],
'invalid no domain' => ['user@', false],
'invalid spaces' => ['user @example.com', false],
'valid subdomain' => ['[email protected]', true],
'invalid special chars' => ['user#@example.com', false],
];
}
复杂数据提供器:
/**
* @dataProvider discount_calculation_provider
*/
public function test_discount_calculation($price, $discount, $expected) {
$calculator = new MyPlugin\PriceCalculator();
$result = $calculator->apply_discount($price, $discount);
$this->assertEquals($expected, $result);
}
public function discount_calculation_provider(): array {
return [
'20% off 100' => [100, 20, 80],
'50% off 100' => [100, 50, 50],
'0% off 100' => [100, 0, 100],
'100% off 100' => [100, 100, 0],
'20% off 0' => [0, 20, 0],
];
}
测试钩子和筛选器
测试 add_action/add_filter:
public function test_init_hooks_registered() {
// Remove all hooks first
remove_all_actions('init');
// Register plugin hooks
MyPlugin\Hooks::register();
// Verify action was added
$this->assertTrue(has_action('init', 'MyPlugin\PostTypes::register'));
$this->assertEquals(10, has_action('init', 'MyPlugin\PostTypes::register'));
}
public function test_content_filter_registered() {
remove_all_filters('the_content');
MyPlugin\Hooks::register();
$this->assertTrue(has_filter('the_content', 'MyPlugin\Content::add_reading_time'));
}
测试钩子回调:
public function test_save_post_hook_saves_meta() {
$post_id = $this->factory->post->create([
'post_type' => 'book',
]);
$_POST['book_isbn'] = '978-3-16-148410-0';
$_POST['book_nonce'] = wp_create_nonce('save_book_meta');
// Manually trigger the hook callback
do_action('save_post', $post_id);
// Verify meta was saved
$isbn = get_post_meta($post_id, '_isbn', true);
$this->assertEquals('978-3-16-148410-0', $isbn);
}
测试 AJAX 处理程序
AJAX 测试设置:
public function test_ajax_load_more_posts() {
// Create test posts
$post_ids = $this->factory->post->create_many(5);
// Set up AJAX request
$_POST['action'] = 'load_more_posts';
$_POST['page'] = 1;
$_POST['nonce'] = wp_create_nonce('load_more_nonce');
// Set current user (if authentication required)
wp_set_current_user($this->factory->user->create(['role' => 'subscriber']));
// Capture output
try {
$this->_handleAjax('load_more_posts');
} catch (WPAjaxDieContinueException $e) {
// Expected exception
}
// Get response
$response = json_decode($this->_last_response, true);
$this->assertTrue($response['success']);
$this->assertCount(5, $response['data']['posts']);
}
常见测试模式
测试自定义文章类型
class Test_Book_Post_Type extends WP_UnitTestCase {
public function setUp(): void {
parent::setUp();
// Ensure CPT is registered
MyPlugin\PostTypes::register_book();
}
public function test_book_post_type_exists() {
$this->assertTrue(post_type_exists('book'));
}
public function test_book_supports_features() {
$post_type = get_post_type_object('book');
$this->assertTrue(post_type_supports('book', 'title'));
$this->assertTrue(post_type_supports('book', 'editor'));
$this->assertTrue(post_type_supports('book', 'thumbnail'));
$this->assertFalse(post_type_supports('book', 'comments'));
}
public function test_book_has_rest_support() {
$post_type = get_post_type_object('book');
$this->assertTrue($post_type->show_in_rest);
}
public function test_create_book_post() {
$book_id = $this->factory->post->create([
'post_type' => 'book',
'post_title' => 'The Great Gatsby',
]);
$book = get_post($book_id);
$this->assertEquals('book', $book->post_type);
$this->assertEquals('The Great Gatsby', $book->post_title);
}
}
测试设置/选项
class Test_Plugin_Settings extends WP_UnitTestCase {
public function tearDown(): void {
delete_option('my_plugin_settings');
parent::tearDown();
}
public function test_default_settings_created() {
$settings = MyPlugin\Settings::get_defaults();
$this->assertIsArray($settings);
$this->assertArrayHasKey('api_key', $settings);
$this->assertEquals('', $settings['api_key']);
}
public function test_save_settings() {
$new_settings = [
'api_key' => 'test_key_123',
'enabled' => true,
];
$result = MyPlugin\Settings::save($new_settings);
$this->assertTrue($result);
$saved = get_option('my_plugin_settings');
$this->assertEquals('test_key_123', $saved['api_key']);
$this->assertTrue($saved['enabled']);
}
public function test_sanitize_settings() {
$dirty_input = [
'api_key' => '<script>alert("xss")</script>',
'enabled' => 'yes',
];
$clean = MyPlugin\Settings::sanitize($dirty_input);
$this->assertEquals('alert("xss")', $clean['api_key']);
$this->assertTrue($clean['enabled']);
}
}
测试数据库操作
class Test_Database_Operations extends WP_UnitTestCase {
protected static $table_name;
public static function setUpBeforeClass(): void {
parent::setUpBeforeClass();
global $wpdb;
self::$table_name = $wpdb->prefix . 'plugin_logs';
$charset_collate = $wpdb->get_charset_collate();
$sql = "CREATE TABLE " . self::$table_name . " (
id bigint(20) unsigned NOT NULL AUTO_INCREMENT,
user_id bigint(20) unsigned NOT NULL,
action varchar(50) NOT NULL,
created_at datetime DEFAULT CURRENT_TIMESTAMP,
PRIMARY KEY (id)
) $charset_collate;";
require_once ABSPATH . 'wp-admin/includes/upgrade.php';
dbDelta($sql);
}
public static function tearDownAfterClass(): void {
global $wpdb;
$wpdb->query("DROP TABLE IF EXISTS " . self::$table_name);
parent::tearDownAfterClass();
}
public function test_insert_log_entry() {
global $wpdb;
$user_id = 1;
$action = 'user_login';
$result = $wpdb->insert(
self::$table_name,
[
'user_id' => $user_id,
'action' => $action,
],
['%d', '%s']
);
$this->assertEquals(1, $result);
$this->assertGreaterThan(0, $wpdb->insert_id);
// Verify data
$log = $wpdb->get_row(
$wpdb->prepare(
"SELECT * FROM " . self::$table_name . " WHERE id = %d",
$wpdb->insert_id
)
);
$this->assertEquals($user_id, $log->user_id);
$this->assertEquals($action, $log->action);
}
public function test_query_logs_by_user() {
global $wpdb;
$user_id = 42;
// Insert test data
$wpdb->insert(self::$table_name, ['user_id' => $user_id, 'action' => 'login'], ['%d', '%s']);
$wpdb->insert(self::$table_name, ['user_id' => $user_id, 'action' => 'logout'], ['%d', '%s']);
// Query logs
$logs = $wpdb->get_results(
$wpdb->prepare(
"SELECT * FROM " . self::$table_name . " WHERE user_id = %d",
$user_id
)
);
$this->assertCount(2, $logs);
}
}
测试 REST API 端点
class Test_REST_API extends WP_UnitTestCase {
protected $server;
public function setUp(): void {
parent::setUp();
global $wp_rest_server;
$this->server = $wp_rest_server = new WP_REST_Server();
do_action('rest_api_init');
}
public function test_endpoint_registered() {
$routes = $this->server->get_routes();
$this->assertArrayHasKey('/myplugin/v1/items', $routes);
}
public function test_get_items_endpoint() {
// Create test posts
$post_ids = $this->factory->post->create_many(3, ['post_type' => 'book']);
$request = new WP_REST_Request('GET', '/myplugin/v1/items');
$response = $this->server->dispatch($request);
$this->assertEquals(200, $response->get_status());
$data = $response->get_data();
$this->assertCount(3, $data);
}
public function test_create_item_requires_authentication() {
$request = new WP_REST_Request('POST', '/myplugin/v1/items');
$request->set_body_params([
'title' => 'New Item',
]);
$response = $this->server->dispatch($request);
$this->assertEquals(401, $response->get_status());
}
public function test_create_item_with_authentication() {
$user_id = $this->factory->user->create(['role' => 'editor']);
wp_set_current_user($user_id);
$request = new WP_REST_Request('POST', '/myplugin/v1/items');
$request->set_body_params([
'title' => 'New Item',
'content' => 'Item content',
]);
$response = $this->server->dispatch($request);
$this->assertEquals(201, $response->get_status());
$data = $response->get_data();
$this->assertEquals('New Item', $data['title']);
}
}
相关技能: 测试 WordPress 应用时,可考虑以下互补技能(可在技能库中找到):
- WordPress 插件基础知识:核心插件架构和钩子,是了解测试内容的基础
- WordPress 安全与验证:安全模式和数据验证,是制定安全测试策略的关键
- Python pytest 测试:现代测试模式,其概念适用于 WordPress 测试方法
- GitHub Actions CI/CD:CI/CD 自动化,可将 WordPress 测试集成到自动化流水线中
延伸阅读: