在 WordPress 项目的开发和维护过程中,对生成的 HTML 代码进行测试至关重要。然而,由于 WordPress 的动态特性,生成的 HTML 经常包含一些时间敏感或者环境依赖的值,例如 nonce、URL 等。这些值在不同的运行环境中可能不同,导致传统的快照测试经常失败,即使代码逻辑本身没有问题。为了解决这个问题,
提供了一套专门针对 WordPress 的快照测试工具。
composer
在线学习地址:
学习地址
基于 Spatie 的
包,专门为 WordPress 环境定制,它提供了一个
,可以帮助我们忽略 HTML 中那些时间敏感或者环境依赖的差异,从而使得快照测试更加稳定可靠。
安装
使用 Composer 安装非常简单:
使用方法
以下是一个使用
的例子:
在这个例子中,我们首先创建了一个
实例,并指定了当前 WordPress 的 URL 和快照 URL。然后,我们创建了一个随机的 post,并使用
渲染了 HTML。
Composer 2.9.6
Composer 2.9.6 是 PHP 生态中高效、稳定的依赖管理工具。此版本在性能与兼容性上进一步优化,改进了依赖解析算法,提升大型项目中的安装与更新速度。它支持并行下载任务,显著减少等待时间,并增强了与私有仓库及镜像源的交互稳定性。同时修复了多项命令行交互与内存使用相关的缺陷,确保在复杂依赖关系下依然可靠运行。无论是新项目初始化还是现有系统维护,Composer 2.9.6 都能为开发者提供流畅、精准的依赖管理体验。
下载
为了忽略 post ID 带来的差异,我们使用了
方法,将 post ID 添加到可容忍的差异列表中。此外,我们还使用了
和
方法,指定了 post ID 的前缀和后缀,以便忽略更多由 post ID 引起的差异。
主要功能
时间敏感字段处理:
默认情况下,
会查找一些时间敏感的字段,例如
,并忽略它们带来的差异。你可以使用
方法自定义这些字段。
URL 替换:
会自动将快照 URL 替换为当前 WordPress 的 URL。你可以使用
方法自定义需要替换的属性。
可容忍差异:
使用
方法可以指定哪些值不应该触发快照测试失败。
可容忍差异前缀和后缀:
使用
和
方法可以指定可容忍差异的前缀和后缀。
属性排除:
使用
方法可以完全排除某些属性的比较。
优势
提高测试稳定性:
通过忽略时间敏感和环境依赖的差异,
可以提高 WordPress 代码的快照测试的稳定性。
简化测试代码:
提供了许多方便的方法,可以简化快照测试的代码。
易于集成:
可以轻松地集成到现有的 WordPress 项目中。
实际应用
非常适合以下场景:
测试 WordPress 主题和插件生成的 HTML 输出。
测试 WordPress REST API 的响应。
测试 WordPress 管理界面的渲染。
通过使用
,我们可以更加自信地进行 WordPress 代码的修改和重构,因为我们可以通过快照测试来确保代码的输出没有发生意外的变化。
lucatume/wp-snapshot-assertionslucatume/wp-snapshot-assertionsphpunit-snapshot-assertionsWPHtmlOutputDrivercomposer require lucatume/wp-snaphot-assertions --devWPHtmlOutputDriveruse Spatie\Snapshots\MatchesSnapshots;
use tad\WP\Snapshots\WPHtmlOutputDriver;
class MySnapshotTest extends \Codeception\TestCase\WPTestCase {
use MatchesSnapshots;
/**
* Test snapshot for render
*/
public function test_snapshot_render() {
// from some environment variable
$currentWpUrl = getenv('WP_URL');
$snapshotUrl = 'http://wp.localhost';
$driver = new WPHtmlOutputDriver($currentWpUrl, $snapshotUrl);
$sut = new MyPluginHTMLRenderingClass();
// create a random post and return its post ID
$postId= $this->factory->post->create();
$renderedHtml = $sut->renderHtmlFor($postId);
$driver->setTolerableDifferences([$postId]);
$driver->setTolerableDifferencesPrefixes(['post_', 'post-']);
$driver->setTolerableDifferencesPostfixes(['-single', '-another-postfix']);
$this->assertMatchesSnapshot($renderedHtml, $driver);
}
}WPHtmlOutputDriverMyPluginHTMLRenderingClasssetTolerableDifferencessetTolerableDifferencesPrefixessetTolerableDifferencesPostfixesWPHtmlOutputDriver_wpnoncesetTimeDependentKeysWPHtmlOutputDriversetUrlAttributessetTolerableDifferencessetTolerableDifferencesPrefixessetTolerableDifferencesPostfixessetTimeDependentAttributeslucatume/wp-snapshot-assertionsWPHtmlOutputDriverlucatume/wp-snapshot-assertionslucatume/wp-snapshot-assertionslucatume/wp-snapshot-assertions