Laravelのイベント・リスナーのテスト完全入門｜初心者でもわかる書き方と考え方

1. Laravelのイベントとリスナーとは？

1. Laravelのイベントとリスナーとは？

Laravelのイベントとリスナーは、ある出来事をきっかけに処理を実行する仕組みです。たとえば「会員登録が完了した」という出来事がイベントで、「登録完了メールを送る」という処理がリスナーです。

学校のチャイムを思い浮かべてください。チャイムが鳴ることがイベントで、生徒が席に着く行動がリスナーです。Laravelでは、この流れをコードで書けるようになっています。

2. なぜイベント・リスナーのテストが必要なの？

2. なぜイベント・リスナーのテストが必要なの？

アプリは見た目が正しくても、中で処理が動いていないことがあります。イベントやリスナーは画面に表示されないため、動作確認がとても大切です。

テストとは「本当にイベントが発生して、リスナーが呼ばれたか」を自動で確認する仕組みです。人の目で毎回確認しなくても、ボタン一つで安心を得られるのが特徴です。

3. テストで使うEventファサードの基本

3. テストで使うEventファサードの基本

LaravelのテストではEventファサードを使います。ファサードとは、難しい処理を簡単な書き方で使える窓口のようなものです。

まずはイベントが発生したかを確認する基本的な書き方を見てみましょう。

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

class SampleEventTest extends TestCase
{
    public function test_event_is_dispatched()
    {
        Event::fake();

        event(new UserRegistered());

        Event::assertDispatched(UserRegistered::class);
    }
}

4. イベントが発生したかをテストする方法

4. イベントが発生したかをテストする方法

Event::fake()は、本当に処理を動かさず、記録だけを取る仕組みです。これにより、メール送信などを防ぎながら安全にテストできます。

assertDispatchedは「イベントが発生したか」を確認する命令です。まるで防犯カメラで出来事を確認するような役割を持っています。

5. リスナーが呼ばれたかをテストする方法

5. リスナーが呼ばれたかをテストする方法

次はリスナーが正しく反応したかを確認します。イベントが鳴っても、誰も動かなければ意味がありません。

Event::fake();

event(new UserRegistered());

Event::assertListening(
    UserRegistered::class,
    SendWelcomeMail::class
);

このテストでは「UserRegisteredイベントに対してSendWelcomeMailリスナーが設定されているか」を確認しています。

6. リスナーの処理内容をテストする考え方

6. リスナーの処理内容をテストする考え方

リスナーの中身まで確認したい場合は、リスナー単体のテストを書きます。これは機械の部品を一つずつ確認するイメージです。

use App\Listeners\SendWelcomeMail;
use App\Events\UserRegistered;

public function test_listener_handle_method()
{
    $listener = new SendWelcomeMail();
    $event = new UserRegistered($user);

    $listener->handle($event);

    $this->assertTrue(true);
}

7. テストを書くときの初心者向け注意点

7. テストを書くときの初心者向け注意点

最初は「イベントが発生したか」「リスナーが登録されているか」だけで十分です。細かい処理は後から確認できます。

テストは失敗しても問題ありません。間違いを教えてくれる案内板のような存在なので、安心して書いていきましょう。

8. イベント・リスナーのテストがもたらす安心感

8. イベント・リスナーのテストがもたらす安心感

イベントとリスナーのテストを書くことで、アプリの裏側の動きを自信を持って把握できます。修正や追加をしても壊れていないことがすぐに分かるため、開発がとても楽になります。

Laravelのテストは初心者にも優しく作られているので、少しずつ慣れていくことが大切です。