テスト - モッキング（Mocking） - 《Laravel 11.x ドキュメント》日本語

はじめに
オブジェクトのモック
ファサードのモック
- ファサードスパイ
時間との相互作用

はじめに

Laravel アプリケーションをテストする際、特定のアプリケーションの側面を「モック」して、特定のテスト中に実際に実行されないようにしたい場合があります。たとえば、イベントをディスパッチするコントローラーをテストする場合、テスト中に実際に実行されないようにイベントリスナーをモックしたいことがあります。これにより、イベントリスナーの実行を心配することなく、コントローラーの HTTP レスポンスのみをテストできます。イベントリスナーは独自のテストケースでテストできます。

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

オブジェクトのモック

Laravel のサービスコンテナを介してアプリケーションに注入されるオブジェクトをモックする場合、モックインスタンスを instance バインディングとしてコンテナにバインドする必要があります。これにより、コンテナはオブジェクト自体を構築するのではなく、オブジェクトのモックインスタンスを使用するよう指示されます:

use App\Service;
use Mockery;
use Mockery\MockInterface;
test('something can be mocked', function () {
   $this->instance(
   Service::class,
   Mockery::mock(Service::class, function (MockInterface $mock) {
   $mock->shouldReceive('process')->once();
   })
   );
});

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 の基本テストケースクラスは spy メソッドを提供しており、Mockery::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
{
   /**
     * Retrieve a list of all users of the application.
   */
   public function index(): array
   {
   $value = Cache::get('key');
   return [
   // ...
   ];
   }
}

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

<?php
use Illuminate\Support\Facades\Cache;
test('get index', function () {
   Cache::shouldReceive('get')
   ->once()
   ->with('key')
   ->andReturn('value');
   $response = $this->get('/users');
   // ...
});

<?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');
   // ...
   }
}

Request ファサードをモックしてはいけません。代わりに、テストを実行する際に get や post などの HTTP テストメソッドに必要な入力を渡してください。同様に、Config ファサードをモックするのではなく、テスト内で Config::set メソッドを呼び出してください。

ファサードスパイ

ファサードをスパイしたい場合は、対応するファサードで spy メソッドを呼び出すことができます。スパイはモックに似ていますが、スパイはスパイとテストされているコードとの間の相互作用を記録し、コードが実行された後にアサーションを行うことができます:

<?php
use Illuminate\Support\Facades\Cache;
test('values are be stored in cache', function () {
   Cache::spy();
   $response = $this->get('/');
   $response->assertStatus(200);
   Cache::shouldHaveReceived('put')->once()->with('name', 'Taylor', 10);
});

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 の基本機能テストクラスには、現在の時間を操作するためのヘルパーが含まれています:

test('time can be manipulated', function () {
   // 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();
   // Travel into the past...
   $this->travel(-5)->hours();
   // Travel to an explicit time...
   $this->travelTo(now()->subHours(6));
   // Return back to the present time...
   $this->travelBack();
});

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();
   // Travel into the past...
   $this->travel(-5)->hours();
   // Travel to an explicit time...
   $this->travelTo(now()->subHours(6));
   // Return back to the present time...
   $this->travelBack();
}

さまざまな時間旅行メソッドにクロージャを提供することもできます。クロージャは、指定された時間で凍結された時間で呼び出されます。クロージャが実行されると、時間は通常通りに戻ります:

$this->travel(5)->days(function () {
   // Test something five days into the future...
});
$this->travelTo(now()->subDays(10), function () {
   // Test something during a given moment...
});

freezeTime メソッドを使用して現在の時間を凍結できます。同様に、freezeSecond メソッドは現在の時間を凍結しますが、現在の秒の開始時点で凍結します:

use Illuminate\Support\Carbon;
// Freeze time and resume normal time after executing closure...
$this->freezeTime(function (Carbon $time) {
   // ...
});
// Freeze time at the current second and resume normal time after executing closure...
$this->freezeSecond(function (Carbon $time) {
   // ...
})

上記で説明したすべてのメソッドは、ディスカッションフォーラムで非アクティブな投稿をロックするなど、時間に敏感なアプリケーションの動作をテストするために主に役立ちます:

use App\Models\Thread;
test('forum threads lock after one week of inactivity', function () {
   $thread = Thread::factory()->create();
   $this->travel(1)->week();
   expect($thread->isLockedByInactivity())->toBeTrue();
});

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