本文介绍了如何使用 PHPUnit 测试 HTML 结构输出，因为 PHPUnit 自带的 assertTag 方法已经过时。文章将指导你如何使用 phpunit-dom-assertions 扩展包来验证 HTML 结构，并提供示例代码和注意事项，帮助你编写可靠的 HTML 结构测试。
在 PHPUnit 中，曾经用于测试 HTML 结构的 assertTag 方法已被弃用。这意味着我们需要寻找新的方法来验证 HTML 输出的正确性。一个推荐的解决方案是使用 phpunit-dom-assertions 扩展包。
安装 phpunit-dom-assertions
首先，你需要使用 Composer 安装 phpunit-dom-assertions 扩展包。在你的项目根目录下，运行以下命令：
composer require phpunit/phpunit-dom-assertions
安装完成后，PHPUnit 将自动加载该扩展，你就可以在测试中使用它提供的断言方法了。
立即学习“PHP免费学习笔记（深入）”；
使用 assertStringContainsString 测试 HTML 结构
虽然 phpunit-dom-assertions 提供了一系列专门用于 DOM 结构的断言方法，但最简单的方法，也适用于很多场景，是使用 PHPUnit 自带的 assertStringContainsString 方法。 这种方式可以验证 HTML 字符串中是否包含特定的字符串，从而间接验证 HTML 结构。
示例：
假设你有一个函数 render()，它生成以下 HTML 结构：
Hello, World!
This is a test.
你可以使用以下 PHPUnit 测试来验证 render() 函数的输出：
render(); // 假设 $this->render() 返回 HTML 字符串
$this->assertStringContainsString('', $output);
$this->assertStringContainsString('Hello, World!
', $output);
$this->assertStringContainsString('This is a test.
', $output);
$this->assertStringContainsString('', $output);
}
private function render(): string
{
// 模拟渲染 HTML 结构
return 'Hello, World!
This is a test.
';
}
}在这个例子中，我们使用 assertStringContainsString 来确保输出字符串包含我们期望的 HTML 标签和内容。
使用 phpunit-dom-assertions 进行更精确的测试
phpunit-dom-assertions 提供了更强大的 DOM 断言功能，允许你更精确地验证 HTML 结构。 该扩展提供了一系列专门用于 DOM 结构的断言方法，例如 assertSelectCount，assertSelectEquals，assertSelectContains等。
示例：
render(); // 假设 $this->render() 返回 HTML 字符串
$dom = new DOMDocument();
$dom->loadHTML($output);
$xpath = new DOMXPath($dom);
$this->assertGreaterThan(0, $xpath->evaluate('count(//div[@class="container"])'));
$this->assertGreaterThan(0, $xpath->evaluate('count(//h1[text()="Hello, World!"])'));
$this->assertGreaterThan(0, $xpath->evaluate('count(//p[text()="This is a test."])'));
}
private function render(): string
{
// 模拟渲染 HTML 结构
return 'Hello, World!
This is a test.
';
}
}在这个例子中，我们首先将 HTML 字符串加载到 DOMDocument 对象中，然后使用 DOMXPath 来查询特定的元素和属性。 evaluate 方法允许我们使用 XPath 表达式来选择元素并进行断言。
注意事项
- 确保你的 HTML 结构是有效的，可以使用 HTML 验证器来检查。
- 根据你的测试需求选择合适的断言方法。对于简单的测试，assertStringContainsString 可能就足够了。对于更复杂的测试，phpunit-dom-assertions 提供了更强大的功能。
- 编写清晰、简洁的测试代码，使其易于理解和维护。
- 考虑使用数据提供器来测试不同的 HTML 结构。
总结
虽然 PHPUnit 的 assertTag 方法已被弃用，但我们仍然可以使用 assertStringContainsString 或 phpunit-dom-assertions 扩展包来有效地测试 HTML 结构。通过选择合适的断言方法并编写清晰的测试代码，我们可以确保我们的 HTML 输出是正确的，并提高代码的质量。phpunit-dom-assertions 提供了更强大的功能，允许我们更精确地验证 HTML 结构。
