PHPUnit Polyfills 使用指南

PHPUnit Polyfills 使用指南

PHPUnit-PolyfillsSet of polyfills for changed PHPUnit functionality to allow for creating PHPUnit cross-version compatible tests项目地址:https://gitcode.com/gh_mirrors/ph/PHPUnit-Polyfills

---

项目介绍

Yoast 的 PHPUnit Polyfills 是一个旨在支持跨版本 PHPUnit 测试套件兼容性的库。它提供了一系列补丁（polyfills），以适应那些在不同 PHPUnit 版本间引入、拆分或重命名的功能。这使得开发者可以面向最新版 PHPUnit 编写测试，同时能在较旧的 PHPUnit 版本上运行这些测试，确保了测试的向前兼容性。通过这种方式，升级到新版本的 PHPUnit 语法的压力被转移到决定使用新版本进行测试的时候。

项目快速启动

安装依赖

首先，你需要将 Yoast/PHPUnit-Polyfills 添加到你的项目的开发依赖中。可以通过 Composer 来完成这一操作：

composer require --dev yoast/phpunit-polyfills:^1.1.0

确保运行此命令后，通过以下步骤设置你的测试环境：

1. 运行 composer dump-autoload --dev 更新自动加载配置。
2. 在你的测试引导文件中，确保包含了项目本地 vendor/autoload.php 文件来载入所需依赖。

示例配置

在你的 phpunit.xml 配置文件中，无需特殊配置即可使用 PHPUnit Polyfills，因为 Composer 的自动加载机制会处理它。但如果你需要显式地控制加载顺序或者在特定情况下，可以这样在测试引导文件中手动包括它：

// testbootstrap.php
require_once 'vendor/autoload.php'; // 确保这个在之前已经执行
if (!class_exists(\PHPUnit\Framework\TestCase::class)) {
    require_once 'vendor/yoast/phpunit-polyfills/phpunitpolyfills-autoload.php';
}

应用案例和最佳实践

当你需要在遗留项目中采用新的 PHPUnit 断言方法时，PHPUnit Polyfills 显得尤为重要。例如，假设你想利用 PHPUnit 10 的新断言功能，但在项目中只能运行 PHPUnit 7。你可以直接在测试代码中使用新断言：

use PHPUnit\Framework\TestCase;

final class ExampleTest extends TestCase
{
    public function testUsingNewAssertion(): void
    {
        $this->assertStringContainsString('example', 'This is an example string.');
    }
}

即使在较老版本的 PHPUnit 上运行，这些断言也会通过 polyfills 正常工作，不需要修改测试代码即可实现向上的平滑迁移。

典型生态项目

虽然该库主要为任何使用 PHPUnit 的PHP项目服务，并不特定于某几个生态项目，但它尤其对大型项目或有着复杂测试环境的项目非常有用。这些项目可能涉及到多种版本的 PHPUnit 升级路径或者需要长期维护多个分支，其中每个分支可能依赖不同的PHPUnit版本。Yoast/PHPUnit-Polyfills成为了这类情景下的桥梁，保证了测试的一致性和可维护性。

---

通过遵循以上指南，你可以有效地在你的项目中集成并利用 PHPUnit Polyfills，确保测试代码的跨版本兼容性，简化项目升级和维护过程。

PHPUnit-PolyfillsSet of polyfills for changed PHPUnit functionality to allow for creating PHPUnit cross-version compatible tests项目地址:https://gitcode.com/gh_mirrors/ph/PHPUnit-Polyfills