Notification Fakeを使って通知が送られたかどうかのテストを実装する

環境

Laravel9
PHP8

やりたいこと

PHP UnitテストでメールやSMSなどの通知が送られているかをテストしたいことがあると思います。
今回はユーザー登録したユーザーにメールが送られているかをテストしてみます。

やり方

Notification Fakeというやつを使います。
Notificationファサードのfakeメソッドを使用すると、通知が送られるのを防ぐことができます。

SendMialTest.php

public function 会員通録したユーザーにメール通知が送られることを検証する()
{
    // fakeメソッド準備
    Notification::fake();
    // この段階では通知で送られていないことをアサートする
    Notification::assertNothingSent();
    
    // ユーザー登録用のサービスで登録処理を行う
    $request = ['name' => '田中たろう', 'email' => '[e-mail]'];
    $user = (new CreateUserService())($requests);
    
    // 対象に通知が送られたことをアサート
    Notification::assertSentTo(
        $user,
        SendMail::class//　Notificationを実行するクラス
    );
    // 通知が一度だけ送られてたことをアサート
    Notification::assertTimesSent(
        1,
        SendMail::class
    );
}

以上です。