Hyperf 项目如何使用 Pest

[huangdijia]

什么是 Pest？

Pest 是一个注重简单性的测试框架，经过精心设计，旨在带回 PHP 测试的乐趣。

• 官网：https://pestphp.com/
• 文档：https://pestphp.com/docs/
• GitHub：https://github.com/pestphp/pest

Pest 和 PHPUnit 是什么关系？

简单理解：套壳。类似 Laravel 与 Symfony 的关系。
集成和开发了一些功能：

• Mocking
• Architecture Testing
• Stress Testing
• Type Coverage
• Parallel Testing
• ……

Hyperf 项目如何引入 Pest ？

Hyperf 是基于 Swoole/Swow 的协程框架，最大的亮点也是 Coroutine（协程），但是 Swoole 的协程是需要协程环境的（Swow 不需要），也就意味着有些单元测试（TestCase）需要允许在协程环境下，否则会报错。

如：

<?php
use Hyperf\Coroutine\Coroutine;

class FooTest extends \PHPUnit\Framework\TestCase
{
    public function testCo()
    {
        Coroutine::create(function() {
            $this->assertTrue(true);
        });
    }
}

直接执行，会直接报错。需要套一层协程环境：

<?php
use Hyperf\Coroutine\Coroutine;

class FooTest extends \PHPUnit\Framework\TestCase
{
    public function testCo()
    {
        \Swoole\Coroutine\run(function () {
            Coroutine::create(function() {
                $this->assertTrue(true);
            });
        });
    }
}

这样就不会报错了。但是……每一个都这么“套”一层，挺累的吧。

改造 TestCase

前一步，我们发现每个 Case 都要套一个协程环境，开发体验确实不是特别好，那么我们通过自定义 TestCase 把协程环境自动前置套入到每一个 Case，代码如下：

<?php

abstract class TestCase extends \PHPUnit\Framework\TestCase
{
    final protected function runTestsInCoroutine(...$arguments) // final 装饰是防止重载
    {
        parent::setName($this->realTestName);

        $testResult = null;
        $exception = null;

        /* @phpstan-ignore-next-line */
        \Swoole\Coroutine\run(function () use (&$testResult, &$exception, $arguments) {
            try {
                $testResult = $this->{$this->realTestName}(...$arguments);
            } catch (Throwable $e) {
                $exception = $e;
            } finally {
                \Swoole\Timer::clearAll();
                \Hyperf\Coordinator\CoordinatorManager::until(\Hyperf\Coordinator\Constants::WORKER_EXIT)->resume();
            }
        });

        if ($exception) {
            throw $exception;
        }

        return $testResult;
    }

    final protected function runTest(): mixed // final 装饰是防止重载
    {
        if (extension_loaded('swoole') && \Swoole\Coroutine::getCid() === -1 && $this->enableCoroutine) { // 判断 Swoole 环境，Swow 不需要
            $this->realTestName = $this->name();
            parent::setName('runTestsInCoroutine');
        }

        return parent::runTest();
    }
}

项目中所有 TestCase 都继承这个类即可。

hyperf/testing 已经实现，可直接安装并使用 Hyperf\Testing\TestCase

安装&配置 Pest

前面又是协程环境，又是改造 TestCase，跟 pest 有什么关系？

当然有！除了前面提到的需要支持协程 Case，Pest 还有一个亮点功能：Parallel Testing（并行测试），需要依赖改造过的 TestCase::runTestsInCoroutine。

接下来先安装&配置 pest 吧。

1. 安装 pest

composer require pestphp/pest --dev --with-all-dependencies

2. 安装 hyperf/testing

composer require hyperf/testing

3. 配置 test/bootstrap.php

error_reporting(E_ALL);
date_default_timezone_set('Asia/Shanghai');

! defined('BASE_PATH') && define('BASE_PATH', dirname(__DIR__, 1));
! defined('SWOOLE_HOOK_FLAGS') && define('SWOOLE_HOOK_FLAGS', 0);

require BASE_PATH . '/vendor/autoload.php';

putenv('SCAN_CACHEABLE=true'); // 并行测试不会重复生成代理类

Hyperf\Di\ClassLoader::init();

4. 配置 phpunit.xml

<?xml version="1.0" encoding="UTF-8"?>
<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" backupGlobals="false" bootstrap="./test/bootstrap.php" colors="true" processIsolation="false" stopOnFailure="false" xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/10.1/phpunit.xsd" cacheDirectory=".phpunit.cache" backupStaticProperties="false">
  <coverage/>
  <testsuites>
    <testsuite name="TestCases">
      <directory suffix="Test.php">test</directory>
    </testsuite>
  </testsuites>
  <source>
    <include>
      <directory suffix=".php">app</directory>
    </include>
  </source>
</phpunit>

开始 Pest 之旅吧

• 初始化

./vendor/bin/pest --init

• 执行用例

vendor/bin/pest

• 并行执行用例

./vendor/bin/pest --parallel
# 制定进程数
./vendor/bin/pest --parallel --processes=10

[250121244]

composer require pestphp/pest --dev --with-all-dependencies 执行这个命令的时候出现包冲突。
Problem 1
- Root composer.json requires pestphp/pest * -> satisfiable by pestphp/pest[dev-allow-custom-arch-expectations, v0.1.0, ..., v0.3.19, v1.0.0, ..., 1.x-dev, v2.0.1, ..., 2.x-dev, v3.0.0, ..., 3.x-dev, 4.x-dev].
- pestphp/pest[v0.1.0, ..., v0.2.4] require php ^7.3 -> your php version (8.3.20) does not satisfy that requirement.
- pestphp/pest v0.3.0 requires phpunit/phpunit 9.3.7 -> found phpunit/phpunit[9.3.7] but it conflicts with your root composer.json require (^10.1).
- pestphp/pest v0.3.1 requires phpunit/phpunit 9.3.7 || 9.3.8 -> found phpunit/phpunit[9.3.7, 9.3.8] but it conflicts with your root composer.json require (^10.1).
- pestphp/pest[v0.3.10, ..., v0.3.11] require phpunit/phpunit >= 9.3.7 <= 9.4.2 -> found phpunit/phpunit[9.3.7, ..., 9.4.2] but it conflicts with your root composer.json require (^10.1).
- pestphp/pest[v0.3.12, ..., v0.3.14] require phpunit/phpunit >= 9.3.7 <= 9.4.3 -> found phpunit/phpunit[9.3.7, ..., 9.4.3] but it conflicts with your root composer.json require (^10.1).
- pestphp/pest[v0.3.15, ..., v0.3.19, v1.0.0] require phpunit/phpunit >= 9.3.7 <= 9.5.0 -> found phpunit/phpunit[9.3.7, ..., 9.5.0] but it conflicts with your root composer.json require (^10.1).
- pestphp/pest[v0.3.2, ..., v0.3.6] require phpunit/phpunit 9.3.7 || 9.3.8 || 9.3.9 || 9.3.10 -> found phpunit/phpunit[9.3.7, 9.3.8, 9.3.9, 9.3.10] but it conflicts with your root composer.json require (^10.1).
- pestphp/pest v0.3.7 requires phpunit/phpunit >= 9.3.7 <= 9.3.11 -> found phpunit/phpunit[9.3.7, ..., 9.3.11] but it conflicts with your root composer.json require (^10.1).
- pestphp/pest v0.3.8 requires phpunit/phpunit >= 9.3.7 <= 9.4.0 -> found phpunit/phpunit[9.3.7, ..., 9.4.0] but it conflicts with your root composer.json require (^10.1).
- pestphp/pest v0.3.9 requires phpunit/phpunit >= 9.3.7 <= 9.4.1 -> found phpunit/phpunit[9.3.7, ..., 9.4.1] but it conflicts with your root composer.json require (^10.1).
- pestphp/pest v1.0.1 requires phpunit/phpunit >= 9.3.7 <= 9.5.1 -> found phpunit/phpunit[9.3.7, ..., 9.5.1] but it conflicts with your root composer.json require (^10.1).
- pestphp/pest[v1.0.2, ..., v1.0.3] require phpunit/phpunit >= 9.3.7 <= 9.5.2 -> found phpunit/phpunit[9.3.7, ..., 9.5.2] but it conflicts with your root composer.json require (^10.1).
- pestphp/pest v1.0.4 requires phpunit/phpunit >= 9.3.7 <= 9.5.3 -> found phpunit/phpunit[9.3.7, ..., 9.5.3] but it conflicts with your root composer.json require (^10.1).
- pestphp/pest[v1.7.1, ..., v1.11.0] require phpunit/phpunit >= 9.3.7 <= 9.5.6 -> found phpunit/phpunit[9.3.7, ..., 9.5.6] but it conflicts with your root composer.json require (^10.1).
- pestphp/pest v1.12.0 requires phpunit/phpunit ^9.3.7 -> found phpunit/phpunit[9.3.7, ..., 9.6.x-dev] but it conflicts with your root composer.json require (^10.1).
- pestphp/pest[v1.13.0, ..., v1.22.1] require phpunit/phpunit ^9.5.5 -> found phpunit/phpunit[9.5.5, ..., 9.6.x-dev] but it conflicts with your root composer.json require (^10.1).
- pestphp/pest[v1.22.2, ..., v1.22.3] require phpunit/phpunit ^9.5.26 -> found phpunit/phpunit[9.5.26, ..., 9.6.x-dev] but it conflicts with your root composer.json require (^10.1).
- pestphp/pest v1.22.4 requires phpunit/phpunit ^9.6.0 -> found phpunit/phpunit[9.6.0, ..., 9.6.x-dev] but it conflicts with your root composer.json require (^10.1).
- pestphp/pest v1.22.5 requires phpunit/phpunit ^9.6.4 -> found phpunit/phpunit[9.6.4, ..., 9.6.x-dev] but it conflicts with your root composer.json require (^10.1).
- pestphp/pest v1.22.6 requires phpunit/phpunit ^9.6.5 -> found phpunit/phpunit[9.6.5, ..., 9.6.x-dev] but it conflicts with your root composer.json require (^10.1).
- pestphp/pest v1.23.0 requires phpunit/phpunit ^9.6.7 -> found phpunit/phpunit[9.6.7, ..., 9.6.x-dev] but it conflicts with your root composer.json require (^10.1).
- pestphp/pest[v1.23.1, ..., 1.x-dev] require phpunit/phpunit ^9.6.10 -> found phpunit/phpunit[9.6.10, ..., 9.6.x-dev] but it conflicts with your root composer.json require (^10.1).
- pestphp/pest[v1.0.5, ..., v1.3.0] require phpunit/phpunit >= 9.3.7 <= 9.5.4 -> found phpunit/phpunit[9.3.7, ..., 9.5.4] but it conflicts with your root composer.json require (^10.1).
- pestphp/pest[v1.3.1, ..., v1.7.0] require phpunit/phpunit >= 9.3.7 <= 9.5.5 -> found phpunit/phpunit[9.3.7, ..., 9.5.5] but it conflicts with your root composer.json require (^10.1).
- pestphp/pest v2.0.1 requires pestphp/pest-plugin-arch ^2.0.0 -> satisfiable by pestphp/pest-plugin-arch[v2.0.0, ..., 2.x-dev].
- pestphp/pest[v2.0.2, ..., v2.2.2] require pestphp/pest-plugin-arch ^2.0.1 -> satisfiable by pestphp/pest-plugin-arch[v2.0.1, ..., 2.x-dev].
- pestphp/pest[v2.9.5, ..., v2.15.0] require pestphp/pest-plugin-arch ^2.2.3 -> satisfiable by pestphp/pest-plugin-arch[v2.2.3, ..., 2.x-dev].
- pestphp/pest v2.16.0 requires pestphp/pest-plugin-arch ^2.3.1 -> satisfiable by pestphp/pest-plugin-arch[v2.3.1, ..., 2.x-dev].
- pestphp/pest[v2.16.1, ..., v2.23.0] require pestphp/pest-plugin-arch ^2.3.3 -> satisfiable by pestphp/pest-plugin-arch[v2.3.3, ..., 2.x-dev].
- pestphp/pest[v2.2.3, ..., v2.3.0] require pestphp/pest-plugin-arch ^2.0.2 -> satisfiable by pestphp/pest-plugin-arch[v2.0.2, ..., 2.x-dev].
- pestphp/pest[v2.23.1, ..., v2.23.2] require pestphp/pest-plugin-arch ^2.4.0 -> satisfiable by pestphp/pest-plugin-arch[v2.4.0, ..., 2.x-dev].
- pestphp/pest[v2.24.0, ..., v2.27.0] require pestphp/pest-plugin-arch ^2.4.1 -> satisfiable by pestphp/pest-plugin-arch[v2.4.1, ..., 2.x-dev].
- pestphp/pest[v2.28.0, ..., v2.30.0] require pestphp/pest-plugin-arch ^2.5.0 -> satisfiable by pestphp/pest-plugin-arch[v2.5.0, ..., 2.x-dev].
- pestphp/pest[v2.31.0, ..., v2.33.0] require pestphp/pest-plugin-arch ^2.6.1 -> satisfiable by pestphp/pest-plugin-arch[v2.6.1, v2.7.0, 2.x-dev].
- pestphp/pest[v2.33.1, ..., 2.x-dev] require pestphp/pest-plugin-arch ^2.7.0 -> satisfiable by pestphp/pest-plugin-arch[v2.7.0, 2.x-dev].
- pestphp/pest[v2.4.0, ..., v2.5.1] require pestphp/pest-plugin-arch ^2.1.1 -> satisfiable by pestphp/pest-plugin-arch[v2.1.1, ..., 2.x-dev].
- pestphp/pest[v2.5.2, ..., v2.6.2] require pestphp/pest-plugin-arch ^2.1.2 -> satisfiable by pestphp/pest-plugin-arch[v2.1.2, ..., 2.x-dev].
- pestphp/pest[v2.6.3, ..., v2.7.0] require pestphp/pest-plugin-arch ^2.2.0 -> satisfiable by pestphp/pest-plugin-arch[v2.2.0, ..., 2.x-dev].
- pestphp/pest[v2.8.0, ..., v2.8.2] require pestphp/pest-plugin-arch ^2.2.1 -> satisfiable by pestphp/pest-plugin-arch[v2.2.1, ..., 2.x-dev].
- pestphp/pest[v2.8.3, ..., v2.9.4] require pestphp/pest-plugin-arch ^2.2.2 -> satisfiable by pestphp/pest-plugin-arch[v2.2.2, ..., 2.x-dev].
- pestphp/pest[v3.0.0, ..., v3.0.6] require phpunit/phpunit ^11.3.4 -> found phpunit/phpunit[11.3.4, ..., 11.5.x-dev] but it conflicts with your root composer.json require (^10.1).
- pestphp/pest[v3.0.7, ..., v3.2.5] require phpunit/phpunit ^11.3.6 -> found phpunit/phpunit[11.3.6, ..., 11.5.x-dev] but it conflicts with your root composer.json require (^10.1).
- pestphp/pest v3.3.0 requires phpunit/phpunit ^11.4.0 -> found phpunit/phpunit[11.4.0, ..., 11.5.x-dev] but it conflicts with your root composer.json require (^10.1).
- pestphp/pest[v3.3.1, ..., v3.4.1] require phpunit/phpunit ^11.4.1 -> found phpunit/phpunit[11.4.1, ..., 11.5.x-dev] but it conflicts with your root composer.json require (^10.1).
- pestphp/pest[v3.4.2, ..., v3.5.0] require phpunit/phpunit ^11.4.2 -> found phpunit/phpunit[11.4.2, ..., 11.5.x-dev] but it conflicts with your root composer.json require (^10.1).
- pestphp/pest[dev-allow-custom-arch-expectations, v3.5.1] require phpunit/phpunit ^11.4.3 -> found phpunit/phpunit[11.4.3, ..., 11.5.x-dev] but it conflicts with your root composer.json require (^10.1).
- pestphp/pest[v3.5.2, ..., v3.6.0] require phpunit/phpunit ^11.4.4 -> found phpunit/phpunit[11.4.4, ..., 11.5.x-dev] but it conflicts with your root composer.json require (^10.1).
- pestphp/pest v3.7.0 requires phpunit/phpunit ^11.5.0 -> found phpunit/phpunit[11.5.0, ..., 11.5.x-dev] but it conflicts with your root composer.json require (^10.1).
- pestphp/pest v3.7.1 requires phpunit/phpunit ^11.5.1 -> found phpunit/phpunit[11.5.1, ..., 11.5.x-dev] but it conflicts with your root composer.json require (^10.1).
- pestphp/pest[v3.7.2, ..., v3.7.4] require phpunit/phpunit ^11.5.3 -> found phpunit/phpunit[11.5.3, ..., 11.5.x-dev] but it conflicts with your root composer.json require (^10.1).
- pestphp/pest[v3.7.5, ..., 3.x-dev] require phpunit/phpunit ^11.5.15 -> found phpunit/phpunit[11.5.15, 11.5.16, 11.5.17, 11.5.x-dev] but it conflicts with your root composer.json require (^10.1).
- pestphp/pest 4.x-dev requires pestphp/pest-plugin-arch ^4.0.0 -> satisfiable by pestphp/pest-plugin-arch[4.x-dev] from composer repo (https://repo.packagist.org) but pestphp/pest-plugin-arch[v2.0.0, ..., 2.x-dev, v3.0.0, 3.x-dev] from composer repo (https://mirrors.aliyun.com/composer) has higher repository priority. The packages from the higher priority repository do not match your constraint and are therefore not installable. That repository is canonical so the lower priority repo's packages are not installable. See https://getcomposer.org/repoprio for details and assistance.
- pestphp/pest-plugin-arch[v2.0.0, ..., v2.0.1] require ta-tikoma/phpunit-architecture-test ^0.7.1 -> satisfiable by ta-tikoma/phpunit-architecture-test[0.7.1, ..., 0.7.6].
- pestphp/pest-plugin-arch[v2.0.2, ..., v2.1.1] require ta-tikoma/phpunit-architecture-test ^0.7.2 -> satisfiable by ta-tikoma/phpunit-architecture-test[0.7.2, ..., 0.7.6].
- pestphp/pest-plugin-arch[v2.1.2, ..., v2.2.3] require ta-tikoma/phpunit-architecture-test ^0.7.3 -> satisfiable by ta-tikoma/phpunit-architecture-test[0.7.3, 0.7.4, 0.7.5, 0.7.6].
- pestphp/pest-plugin-arch[v2.3.0, ..., v2.4.0] require ta-tikoma/phpunit-architecture-test ^0.7.4 -> satisfiable by ta-tikoma/phpunit-architecture-test[0.7.4, 0.7.5, 0.7.6].
- pestphp/pest-plugin-arch[v2.4.1, ..., v2.5.0] require ta-tikoma/phpunit-architecture-test ^0.7.5 -> satisfiable by ta-tikoma/phpunit-architecture-test[0.7.5, 0.7.6].
- pestphp/pest-plugin-arch v2.6.0 requires ta-tikoma/phpunit-architecture-test ^0.8.0 -> satisfiable by ta-tikoma/phpunit-architecture-test[0.8.0, ..., 0.8.5].
- pestphp/pest-plugin-arch[v2.6.1, ..., 2.x-dev] require ta-tikoma/phpunit-architecture-test ^0.8.4 -> satisfiable by ta-tikoma/phpunit-architecture-test[0.8.4, 0.8.5].
- ta-tikoma/phpunit-architecture-test[0.7.1, ..., 0.7.4] require symfony/finder ^6.2.7 -> found symfony/finder[v6.2.7, ..., 6.4.x-dev] but these were not loaded, likely because it conflicts with another require.
- ta-tikoma/phpunit-architecture-test 0.7.5 requires symfony/finder ^6.2.7 || ^7.0.0 -> found symfony/finder[v6.2.7, ..., 6.4.x-dev, v7.0.0-BETA1, ..., 7.2.x-dev] but these were not loaded, likely because it conflicts with another require.
- ta-tikoma/phpunit-architecture-test[0.7.6, ..., 0.8.5] require symfony/finder ^6.4.0 || ^7.0.0 -> found symfony/finder[v6.4.0-BETA1, ..., 6.4.x-dev, v7.0.0-BETA1, ..., 7.2.x-dev] but these were not loaded, likely because it conflicts with another require.

You can also try re-running composer require with an explicit version constraint, e.g. "composer require pestphp/pest:*" to figure out if any version is installable, or "composer require pestphp/pest:^2.1" if you know which you need.

[huangdijia]

PHP什么版本？hyperf什么版本？phpunit什么版本？

[250121244]

PHP 8.3.20 (cli), hyperf3.1, phpunit 10.5。

[huangdijia]

先在composer.json加上pest再执行composer update试试