Co-PHPUnit

Co-PHPUnit 讓 PHPUnit 測試在 Swoole 協程中運行，適用於測試依賴協程上下文的 Hyperf 組件。

安裝

將組件安裝為開發依賴：

composer require friendsofhyperf/co-phpunit --dev

組件依賴 hyperf/coordinator ~3.2.0，並支持 PHPUnit 10、11 和 12。它沒有將 Swoole 擴展聲明為 Composer 依賴；未加載該擴展時，測試會回退到 PHPUnit 的普通執行方式。

使用

在協程中運行測試

在測試類或共享的測試基類中使用 RunTestsInCoroutine：

<?php

namespace App\Tests;

use FriendsOfHyperf\CoPHPUnit\Concerns\RunTestsInCoroutine;
use PHPUnit\Framework\TestCase;
use Swoole\Coroutine;

class ServiceTest extends TestCase
{
    use RunTestsInCoroutine;

    public function testRunsInCoroutine(): void
    {
        self::assertNotSame(-1, Coroutine::getCid());
    }
}

安裝組件後，不需要額外配置 PHPUnit 或 Composer 自動加載。

退出協程執行

將 NonCoroutine 應用於單個測試方法，可以讓該方法在不創建協程的情況下運行：

<?php

namespace App\Tests;

use FriendsOfHyperf\CoPHPUnit\Attributes\NonCoroutine;
use FriendsOfHyperf\CoPHPUnit\Concerns\RunTestsInCoroutine;
use PHPUnit\Framework\TestCase;
use Swoole\Coroutine;

class ServiceTest extends TestCase
{
    use RunTestsInCoroutine;

    #[NonCoroutine]
    public function testRunsWithoutCoroutine(): void
    {
        self::assertSame(-1, Coroutine::getCid());
    }
}

也可以將 #[NonCoroutine] 應用於測試類，讓該類中的所有測試方法退出協程執行。該屬性可用於 類和方法，且沒有構造參數。

組件的公開 API 包括：

• FriendsOfHyperf\CoPHPUnit\Concerns\RunTestsInCoroutine；
• FriendsOfHyperf\CoPHPUnit\Attributes\NonCoroutine。

執行行為

RunTestsInCoroutine 會重寫 PHPUnit 的 runBare() 方法。

每個測試開始前，遇到以下任一情況時，它不會創建協程，而是以普通方式運行測試：

• 未加載 Swoole 擴展；
• 當前已經位於 Swoole 協程中；
• 測試類帶有 #[NonCoroutine]；或
• 當前測試方法帶有 #[NonCoroutine]。

否則，它會調用 Swoole\Coroutine\run()，並在協程內執行 PHPUnit 父類的 runBare()。 異常會先被捕獲，並在協程退出後重新拋出。在 finally 塊中，該 trait 會清除所有 Swoole 定時器，並恢復 Hyperf 的 WORKER_EXIT 協調器。僅當該 trait 創建協程時，才會執行這些 清理操作。

#[NonCoroutine] 只會阻止該 trait 創建協程。如果測試已經在協程內運行，該屬性不會讓測試 退出現有協程。

PHPUnit 補丁

組件通過 Composer 的 autoload.files 註冊 phpunit-patch.php。加載 Composer 自動加載 文件時，該補丁會找到 PHPUnit 的 TestCase 源文件；如果 TestCase::runBare() 帶有 final 關鍵字，則將其移除，以便 trait 重寫該方法。

該補丁會直接寫入已安裝的 PHPUnit 源文件。需要應用補丁時，請確保 Composer 的 vendor 目錄可寫。