モッキング

• はじめに
• オブジェクトのモッキング
• ファサードのモッキング
  • ファサードスパイ
• 時間の操作

#はじめに

Laravelアプリケーションのテスト時に、特定の処理を実際に実行せずに「モック」したい場合があります。例えば、イベントをディスパッチするコントローラーをテストする際に、イベントリスナーをモックしてテスト中に実行されないようにすることができます。これにより、イベントリスナーの実行を気にせずにコントローラーのHTTPレスポンスだけをテストでき、イベントリスナーは別のテストケースで検証できます。

Laravelはイベント、ジョブ、その他のファサードをモックするための便利なメソッドを標準で提供しています。これらのヘルパーは主にMockeryの複雑なメソッド呼び出しを手動で行う必要がないように、利便性のレイヤーを提供します。

#オブジェクトのモッキング

Laravelのサービスコンテナ経由で注入されるオブジェクトをモックする場合、モックしたインスタンスをinstanceバインディングとしてコンテナにバインドする必要があります。これにより、コンテナはオブジェクトを自分で構築する代わりに、モックしたインスタンスを使用します：

use App\Service;
use Mockery;
use Mockery\MockInterface;

public function test_something_can_be_mocked(): void
{
    $this->instance(
        Service::class,
        Mockery::mock(Service::class, function (MockInterface $mock) {
            $mock->shouldReceive('process')->once();
        })
    );
}

より便利にするために、Laravelのベーステストケースクラスが提供するmockメソッドを使うこともできます。例えば、以下の例は上記の例と同等です：

use App\Service;
use Mockery\MockInterface;

$mock = $this->mock(Service::class, function (MockInterface $mock) {
    $mock->shouldReceive('process')->once();
});

オブジェクトの一部のメソッドだけをモックしたい場合は、partialMockメソッドを使えます。モックしなかったメソッドは通常通り実行されます：

use App\Service;
use Mockery\MockInterface;

$mock = $this->partialMock(Service::class, function (MockInterface $mock) {
    $mock->shouldReceive('process')->once();
});

同様に、オブジェクトをスパイしたい場合は、LaravelのベーステストケースクラスがMockery::spyの便利なラッパーとしてspyメソッドを提供しています。スパイはモックに似ていますが、スパイはテスト対象コードとのすべてのやり取りを記録し、コード実行後にアサーションできます：

use App\Service;

$spy = $this->spy(Service::class);

// ...

$spy->shouldHaveReceived('process');

#ファサードのモッキング

従来の静的メソッド呼び出しとは異なり、ファサード（リアルタイムファサードを含む）はモックできます。これにより、従来の静的メソッドよりも大きな利点があり、従来の依存性注入を使う場合と同じテストしやすさを得られます。テスト時には、コントローラー内で呼ばれるLaravelファサードの呼び出しをモックしたいことがよくあります。例えば、以下のコントローラーアクションを考えてみましょう：

<?php

namespace App\Http\Controllers;

use Illuminate\Support\Facades\Cache;

class UserController extends Controller
{
    /**
     * アプリケーションの全ユーザー一覧を取得します。
     */
    public function index(): array
    {
        $value = Cache::get('key');

        return [
            // ...
        ];
    }
}

Cacheファサードの呼び出しはshouldReceiveメソッドを使ってモックできます。これはMockeryのモックインスタンスを返します。ファサードは実際にはLaravelのサービスコンテナによって解決・管理されているため、通常の静的クラスよりもはるかにテストしやすいです。例えば、Cacheファサードのgetメソッドの呼び出しをモックしてみましょう：

<?php

namespace Tests\Feature;

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

class UserControllerTest extends TestCase
{
    public function test_get_index(): void
    {
        Cache::shouldReceive('get')
                    ->once()
                    ->with('key')
                    ->andReturn('value');

        $response = $this->get('/users');

        // ...
    }
}

#ファサードスパイ

ファサードをスパイしたい場合は、対応するファサードのspyメソッドを呼び出せます。スパイはモックに似ていますが、テスト対象コードとのすべてのやり取りを記録し、コード実行後にアサーションできます：

use Illuminate\Support\Facades\Cache;

public function test_values_are_be_stored_in_cache(): void
{
    Cache::spy();

    $response = $this->get('/');

    $response->assertStatus(200);

    Cache::shouldHaveReceived('put')->once()->with('name', 'Taylor', 10);
}

#時間の操作

テスト時に、nowやIlluminate\Support\Carbon::now()などのヘルパーが返す時間を変更したいことがあります。幸い、Laravelのベースの機能テストクラスには現在時刻を操作できるヘルパーが含まれています：

use Illuminate\Support\Carbon;

public function test_time_can_be_manipulated(): void
{
    // Travel into the future...
    $this->travel(5)->milliseconds();
    $this->travel(5)->seconds();
    $this->travel(5)->minutes();
    $this->travel(5)->hours();
    $this->travel(5)->days();
    $this->travel(5)->weeks();
    $this->travel(5)->years();

    // 過去に移動...
    $this->travel(-5)->hours();

    // 明示的な時間に移動...
    $this->travelTo(now()->subHours(6));

    // 現在時刻に戻る...
    $this->travelBack();
}

さまざまな時間移動メソッドにはクロージャを渡すこともできます。クロージャは指定した時間で時間が固定された状態で呼び出され、クロージャ実行後に時間は通常通り進みます：

$this->travel(5)->days(function () {
    // 5日後の未来で何かをテスト...
});

$this->travelTo(now()->subDays(10), function () {
    // 特定の時点で何かをテスト...
});

freezeTimeメソッドは現在時刻を固定できます。同様に、freezeSecondメソッドは現在の秒の開始時刻で時間を固定します：

use Illuminate\Support\Carbon;

// 時間を固定し、クロージャ実行後に通常の時間に戻す...
$this->freezeTime(function (Carbon $time) {
    // ...
});

// 現在の秒で時間を固定し、クロージャ実行後に通常の時間に戻す...
$this->freezeSecond(function (Carbon $time) {
    // ...
})

これらのメソッドは主に、ディスカッションフォーラムの非アクティブな投稿をロックするなど、時間に依存するアプリケーションの動作をテストする際に役立ちます：

use App\Models\Thread;

public function test_forum_threads_lock_after_one_week_of_inactivity()
{
    $thread = Thread::factory()->create();

    $this->travel(1)->week();

    $this->assertTrue($thread->isLockedByInactivity());
}