跳到內容
Laravel

模擬 (Mocking)

簡介

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

同樣地，如果您想在物件上 監聽 (spy)，Laravel 的基礎測試案例類別提供了一個 spy 方法，作為 Mockery::spy 方法的便利包裝。監聽器與模擬器類似；然而，監聽器會記錄監聽器和被測試程式碼之間的任何互動，讓您可以在程式碼執行後進行斷言。

use App\Service;
 
$spy = $this->spy(Service::class);
 
// ...
 
$spy->shouldHaveReceived('process');

模擬外觀模式 (Facades)

與傳統的靜態方法呼叫不同，外觀模式（包括即時外觀模式）可以被模擬。與傳統的靜態方法相比，這提供了很大的優勢，並賦予您與使用傳統依賴注入時相同的可測試性。在測試時，您可能經常想要模擬在您的控制器之一中發生的對 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 [
            // ...
        ];
    }
}

我們可以透過使用 shouldReceive 方法來模擬對 Cache 外觀模式的呼叫，該方法將返回一個 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');
 
        // ...
    }
}
exclamation

您不應該模擬 Request 外觀模式。相反，在執行測試時，將您想要的輸入傳遞到 HTTP 測試方法，例如 get 和 post。同樣，不要模擬 Config 外觀模式，而是在您的測試中呼叫 Config::set 方法。

外觀模式 (Facade) 間諜

如果您想在一個外觀模式上 監聽 (spy)，您可以在相應的外觀模式上呼叫 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());
}