Featured image of post 用 Mockery::capture 測試含亂數的方法，寫出確定的 assertion
Testing PHP

用 Mockery::capture 測試含亂數的方法，寫出確定的 assertion

方法內部有 random_int 導致回傳值不固定時，用 Mockery::capture 搭配 passthru 抓出中間值，就能算出確定的 expected 值來完成 assertion。

當方法內部會產生亂數，導致回傳值不固定時，要怎麼寫 assertion？

亂數讓測試無法預期結果

假設我們有一個 RandomHash class，它會先產生 1 到 10 的亂數再做 hash：

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24

class Hash
{
    public function make($data): string
    {
        return hash_hmac('sha256', $data, false);
    }
}

class RandomHash
{
    public function __construct(public Hash $hash)
    {
    }

    /**
     * @throws \Exception
     */
    public function hash(): string
    {
        $random = md5(random_int(1, 10));

        return $this->hash->make($random);
    }
}

因為 random_int 每次回傳的值都不同，hash() 的結果也跟著變，測試寫不出確定的 expected value：

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11

class RandomHashTest extends TestCase
{
    public function test_mockery_capturing_arguments(): void
    {
        $hash = new Hash();
        $randomHash = new RandomHash($hash);

        // 很難驗證是否正確
        $actual = $randomHash->hash();
    }
}

用 Mockery::capture 把中間值抓出來

Mockery 的 Capturing Arguments 可以在方法被呼叫時，把傳入的參數存到變數裡。搭配 passthru() 讓原本的方法照常執行，我們就能同時拿到中間值和最終結果：

1

composer require --dev mockery/mockery

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18

class RandomHashTest extends TestCase
{
    /**
     * @throws \Exception
     */
    public function test_mockery_capturing_arguments(): void
    {
        $hash = Mockery::spy(new Hash());
        // 用 Mockery::capture 把 random 抓出來，passthru 讓 make 真的執行
        $hash->allows('make')->with(Mockery::capture($random))->passthru();
        $randomHash = new RandomHash($hash);

        $actual = $randomHash->hash();

        // 拿到 $random 後就能算出確定的 expected
        self::assertEquals((new Hash)->make($random), $actual);
    }
}

這樣即使內部有亂數，測試依然能寫出明確的 assertion。