模拟

简介

在测试 Laravel 应用时，你可能希望"模拟"应用的某些方面，使其在给定测试期间不会实际执行。例如，在测试一个分发事件的 controller 时，你可能希望模拟事件监听器，使其在测试期间不会实际执行。这允许你仅测试 controller 的 HTTP 响应，而无需担心事件监听器的执行，因为事件监听器可以在它们自己的测试用例中进行测试。

Laravel 提供了开箱即用的辅助方法来模拟事件、任务和其他 facade。这些辅助方法主要在 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->expects('process');
        })
    );
});

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

为了使这更方便，你可以使用 Laravel 基础测试用例类提供的 mock 方法。例如，以下示例等同于上面的示例：

php

use App\Service;
use Mockery\MockInterface;

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

当你只需要模拟对象的几个方法时，可以使用 partialMock 方法。未被模拟的方法在调用时将正常执行：

php

use App\Service;
use Mockery\MockInterface;

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

类似地，如果你想监视一个对象，Laravel 的基础测试用例类提供了一个 spy 方法作为 Mockery::spy 方法的便捷包装器。Spy 类似于 mock；但是，spy 会记录 spy 与被测试代码之间的任何交互，允许你在代码执行后进行断言：

php

use App\Service;

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

// ...

$spy->shouldHaveReceived('process');

模拟 Facade

与传统的静态方法调用不同，facade（包括实时 facade）可以被模拟。这相比传统的静态方法提供了巨大优势，赋予你与使用传统依赖注入时相同的可测试性。在测试时，你可能经常需要模拟 controller 中对 Laravel facade 的调用。例如，考虑以下 controller 操作：

php

<?php

namespace App\Http\Controllers;

use Illuminate\Support\Facades\Cache;

class UserController extends Controller
{
    /**
     * 获取应用的所有用户列表。
     */
    public function index(): array
    {
        $value = Cache::get('key');

        return [
            // ...
        ];
    }
}

我们可以使用 expects 方法来模拟对 Cache facade 的调用，该方法将返回一个 Mockery mock 实例。由于 facade 实际上是由 Laravel 服务容器解析和管理的，因此它们比典型的静态类具有更强的可测试性。例如，让我们模拟对 Cache facade 的 get 方法的调用：

PestPHPUnit

php

<?php

use Illuminate\Support\Facades\Cache;

test('get index', function () {
    Cache::expects('get')
        ->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::expects('get')
            ->with('key')
            ->andReturn('value');

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

        // ...
    }
}

WARNING

你不应该模拟 Request facade。相反，在运行测试时，将你想要的输入传递给 HTTP 测试方法，如 get 和 post。同样，不要模拟 Config facade，而是在测试中调用 Config::set 方法。

Facade Spy

如果你想监视一个 facade，你可以在相应的 facade 上调用 spy 方法。Spy 类似于 mock；但是，spy 会记录 spy 与被测试代码之间的任何交互，允许你在代码执行后进行断言：

PestPHPUnit

php

<?php

use Illuminate\Support\Facades\Cache;

test('values are stored in cache', function () {
    Cache::spy();

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

    $response->assertStatus(200);

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

php

use Illuminate\Support\Facades\Cache;

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

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

    $response->assertStatus(200);

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

与时间交互

在测试时，你可能偶尔需要修改由 now 或 Illuminate\Support\Carbon::now() 等辅助函数返回的时间。幸运的是，Laravel 的基础功能测试类包含了允许你操作当前时间的辅助方法：

PestPHPUnit

php

test('time can be manipulated', function () {
    // 穿越到未来...
    $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()->minus(hours: 6));

    // 返回到当前时间...
    $this->travelBack();
});

php

public function test_time_can_be_manipulated(): void
{
    // 穿越到未来...
    $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()->minus(hours: 6));

    // 返回到当前时间...
    $this->travelBack();
}

你还可以向各种时间穿越方法提供闭包。闭包将在时间冻结在指定时间的情况下被调用。闭包执行完毕后，时间将恢复正常：

php

$this->travel(5)->days(function () {
    // 测试五天后的某些内容...
});

$this->travelTo(now()->mins(days: 10), function () {
    // 测试给定时刻的某些内容...
});

freezeTime 方法可用于冻结当前时间。类似地，freezeSecond 方法将冻结当前时间，但冻结在当前秒的起始：

php

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

模拟 ​

简介 ​

模拟对象 ​

模拟 Facade ​

Facade Spy ​

与时间交互 ​

模拟

简介

模拟对象

模拟 Facade

Facade Spy

与时间交互