Write Deterministic PHPUnit Assertions with Mockery::capture

#phpunit #mockery #php #testing

Originally published at recca0120.github.io

How do you write assertions when a method internally generates a random value, making the return value unpredictable?

Random Values Make Tests Unpredictable

Suppose we have a RandomHash class that generates a random number between 1 and 10, then hashes it:

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);
    }
}

Since random_int returns a different value each time, the result of hash() changes too, making it impossible to write a definitive expected value:

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

        // no way to write a definitive assertion here
        $actual = $randomHash->hash();
    }
}

Use Mockery::capture to Extract the Intermediate Value

Mockery's Capturing Arguments can store the arguments passed to a method call. Combined with passthru() to let the original method execute normally, we can capture both the intermediate value and the final result:

composer require --dev mockery/mockery

class RandomHashTest extends TestCase
{
    /**
     * @throws \Exception
     */
    public function test_mockery_capturing_arguments(): void
    {
        $hash = Mockery::spy(new Hash());
        // capture the intermediate value; passthru lets make() execute normally
        $hash->allows('make')->with(Mockery::capture($random))->passthru();
        $randomHash = new RandomHash($hash);

        $actual = $randomHash->hash();

        // now $random is known, so we can compute the expected value
        self::assertEquals((new Hash)->make($random), $actual);
    }
}