もがき系プログラマの日常

もがき系エンジニアの勉強したこと、日常のこと、気になっている技術、備忘録などを紹介するブログです。

phpunitでstatic methodのmockはじめて使った

はじめに

こんばんは。

今日laravelでコードを書いていてstatic methodのmockをしたい場面があって初めて知ったのがあったので、忘れないように記録します。

本題

ロジックコード

<?php

use Illuminate\Support\Facades\Cookie;

class ExampleLogic
{
    public function __invoke(): int
    {
         Cookie::unqueue('test');
         return 1;
    }
}

テストコード

<?php 

use Tests\TestCase;
use Illuminate\Support\Facades\Cookie;

class ExampleLogicTest example TestCase

    public function test_example(): void
    {
        Cookie::shouldReceive('unqueue')
            ->with('test')
            ->once();

        $results = (new ExampleLogic())():
        self::assertSame(1, $results);
    }

このコードでテストを実行すると、テストファイル単体では成功するけど、他のコードでテストが落ち始めました。

テストが落ち始めた他のコードは Cookie::queue() を使用している箇所でした。

うーんと色々調べると runInSeparateProcess と preserveGlobalState の存在をはじめて知りました。

runInSeparateProcess

該当テストを個別のプロセスで実行してくれるようです。

preserveGlobalState disabled

runInSeparateProcess だけだと別プロセスで動くテストも本プロセスで読み込まれたスクリプトを読み込んでしまうようなのですが、 preserveGlobalState disabled をつけるとそれを無効にできるようです。

    /**
     * @runInSeparateProcess
     * @preserveGlobalState disabled
     */
    public function test_example(): void
    {
    }

みたいな感じで static methodを使うメソッドで指定してあげればよいようです。

これで単体でも全体でもテストが通るようになりました。

終わりに

いままで static methodのmockってやったことなかったので、意外にハマりました。

現場からは以上です。