Lzh on GitHub

简介

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

Laravel 提供了开箱即用的有用方法来模拟事件、作业和其他 Facade。这些助手主要在 Mockery 之上提供一个便利层，因此您不必手动进行复杂的 Mockery 方法调用。

模拟对象

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

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

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

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

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

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

同样，如果您想 spy 一个对象，Laravel 的基础测试用例类提供了一个 spy 方法作为 Mockery::spy 方法的便捷包装器。Spies 类似于 mocks；但是，spies 记录 spy 和被测试代码之间的任何交互，允许您在代码执行后进行断言：

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

模拟 Facade

与传统的静态方法调用不同，Facade（包括 实时 Facade）可以被模拟。这比传统的静态方法提供了巨大的优势，并为您提供了与使用传统依赖注入相同的可测试性。在测试时，您通常会希望模拟在您的控制器之一中发生的对 Laravel Facade 的调用。例如，考虑以下控制器操作：

<?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 模拟实例。由于 Facade 实际上由 Laravel 服务容器 解析和管理，因此它们比典型的静态类具有更多的可测试性。例如，让我们模拟对 Cache Facade 的 get 方法的调用：

<?php

use Illuminate\Support\Facades\Cache;

test('get index', function () {
    Cache::expects('get')
        ->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 和被测试代码之间的任何交互，允许您在代码执行后进行断言：

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

与时间交互

在测试时，您可能偶尔需要修改由 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();
});

您还可以为各种时间旅行方法提供一个闭包。闭包将在指定时间冻结时被调用。一旦闭包执行完毕，时间将恢复正常：

$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) {
    // ...
})

正如您所料，上面讨论的所有方法主要用于测试时间敏感的应用程序行为，例如在论坛上锁定不活跃的帖子：

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