Mocking

简介

在测试 Laravel 应用程序时，您可能希望 “模拟” 应用程序的某些部分，以便在给定的测试期间它们不会被实际执行。例如，在测试一个分发事件的控制器时，您可能希望模拟事件监听器，以便它们不会在测试中实际执行。这样，您就可以只测试控制器的 HTTP 响应，而不必担心事件监听器的执行，因为事件监听器可以在自己的测试用例中进行测试。

Laravel 提供了方便的方法来模拟事件、任务和其它 facade，这些助手主要提供了 Mockery 的便利层，避免了您需要手动进行复杂的 Mockery 方法调用。

模拟对象

当模拟一个将通过 Laravel 的【服务容器】注入到应用程序中的对象时，您需要将模拟实例绑定到容器中作为 instance 绑定。这将指示容器使用您模拟的对象实例，而不是自己构造对象：

Pest
PHPUnit

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

与传统的静态方法调用不同，【facades】（包括实时【facades】）是可以被模拟的。这相较于传统的静态方法调用提供了很大的优势，使您能够像使用传统的依赖注入一样进行测试。在测试时，您可能会经常希望模拟一个在控制器中调用的 Laravel facade。例如，考虑以下控制器操作：

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 方法的调用：

Pest
PHPUnit

<?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 facade。相反，当运行测试时，应通过 HTTP 测试方法如 get 和 post 将所需的输入传递给它。同样，代替模拟 Config facade，在测试中应调用 Config::set 方法。

Facade Spies

如果您想要对一个 facade 进行 spy，可以在对应的 facade 上调用 spy 方法。与模拟（mock）类似，监听会记录 spy 与正在测试的代码之间的所有交互，从而允许您在代码执行后进行断言：

Pest
PHPUnit

<?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 的基础功能测试类包含了帮助您操作当前时间的工具：

Pest
PHPUnit

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 () {
    // 测试五天后的行为...
});

$this->travelTo(now()->subDays(10), function () {
    // 测试在某个特定时刻的行为...
});

freezeTime 方法用于冻结当前时间。类似地，freezeSecond 方法会在当前秒的开始时冻结时间：

use Illuminate\Support\Carbon;

// 冻结时间，并在执行闭包后恢复正常时间...
$this->freezeTime(function (Carbon $time) {
    // ...
});

// 在当前秒冻结时间，并在执行闭包后恢复正常时间...
$this->freezeSecond(function (Carbon $time) {
    // ...
})

如您所料，上述所有方法主要用于测试与时间相关的应用行为，例如锁定论坛中长时间未活跃的帖子：

Pest
PHPUnit

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