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