模擬

簡介
模擬物件
模擬 Facades
- Facade Spies
與時間互動

簡介

在測試 Laravel 應用程式時，您可能希望「模擬」應用程式的某些部分，使其在特定測試期間不會實際執行。例如，當測試一個分派事件的控制器時，您可能希望模擬事件監聽器，使其在測試期間不會實際執行。這讓您只需測試控制器的 HTTP 回應，而無需擔心事件監聽器的執行，因為事件監聽器可以在它們自己的測試案例中進行測試。

Laravel 提供了方便的方法來開箱即用地模擬事件、工作和其他 Facades。這些輔助方法主要提供一個在 Mockery 之上的便利層，讓您不必手動執行複雜的 Mockery 方法呼叫。

模擬物件

當模擬一個將透過 Laravel 的服務容器注入應用程式的物件時，您需要將模擬的實例以 instance 綁定方式綁定到容器中。這將指示容器使用您模擬的物件實例，而不是自行建構物件：

PestPHPUnit

php

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

php

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 方法的便利封裝。Spies 與 mocks 類似；然而，spies 會記錄 spy 與被測試程式碼之間的任何互動，讓您可以在程式碼執行後進行斷言：

use App\Service;

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

// ...

$spy->shouldHaveReceived('process');

模擬 Facades

與傳統的靜態方法呼叫不同，Facades (包括即時 Facades) 可以被模擬。這比傳統靜態方法提供了巨大的優勢，並賦予您使用傳統依賴注入時所擁有的相同可測試性。在測試時，您可能經常希望模擬控制器中對 Laravel Facade 的呼叫。例如，考慮以下控制器動作：

<?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 Facade 的呼叫，該方法將返回一個 Mockery 模擬實例。由於 Facades 實際上是由 Laravel 服務容器解析和管理的，因此它們比典型的靜態類別具有更高的可測試性。例如，讓我們模擬對 Cache Facade 的 get 方法的呼叫：

PestPHPUnit

php

<?php

use Illuminate\Support\Facades\Cache;

test('get index', function () {
    Cache::shouldReceive('get')
        ->once()
        ->with('key')
        ->andReturn('value');

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

    // ...
});

php

<?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 Facade。相反地，在執行測試時，將您想要的輸入傳遞給 HTTP 測試方法，例如 get 和 post。同樣地，與其模擬 Config Facade，不如在測試中呼叫 Config::set 方法。

Facade Spies

如果您想監聽 (spy) 一個 Facade，您可以在對應的 Facade 上呼叫 spy 方法。Spies 與 mocks 類似；然而，spies 會記錄 spy 與被測試程式碼之間的任何互動，讓您可以在程式碼執行後進行斷言：

PestPHPUnit

php

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

php

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 的基礎功能測試類別包含輔助函數，可讓您操作當前時間：

PestPHPUnit

php

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

php

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 () {
    // 測試未來五天後的某些功能...
});

$this->travelTo(now()->subDays(10), function () {
    // 測試某個特定時間點的功能...
});

freezeTime 方法可用於凍結當前時間。同樣地，freezeSecond 方法將凍結當前時間，但會從當前秒數的開始處凍結：

use Illuminate\Support\Carbon;

// 凍結時間並在閉包執行完畢後恢復正常時間...
$this->freezeTime(function (Carbon $time) {
    // ...
});

// 將時間凍結在當前秒數的開始處，並在閉包執行完畢後恢復正常時間...
$this->freezeSecond(function (Carbon $time) {
    // ...
})

正如您所預期的，上述所有方法主要用於測試時間敏感的應用程式行為，例如鎖定論壇中不活躍的貼文：

PestPHPUnit

php

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

php

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

模擬 ​

簡介 ​

模擬物件 ​

模擬 Facades ​

Facade Spies ​

與時間互動 ​

模擬

簡介

模擬物件

模擬 Facades

Facade Spies

與時間互動