模拟

介绍
模拟对象
模拟 Facades
- Facade 间谍
与时间交互

介绍

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

Laravel 提供了用于模拟事件、作业和其他 facades 的有用方法。这些助手主要提供了一个便利层，覆盖了 Mockery，因此您不必手动进行复杂的 Mockery 方法调用。

模拟对象

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

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 方法。例如，以下示例等同于上面的示例：

php

use App\Service;
use Mockery\MockInterface;

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

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

php

use App\Service;
use Mockery\MockInterface;

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

同样，如果您想监视一个对象，Laravel 的基础测试用例类提供了一个 spy 方法，作为 Mockery::spy 方法的便捷包装。间谍类似于模拟；然而，间谍记录间谍与被测试代码之间的任何交互，允许您在代码执行后进行断言：

php

use App\Service;

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

// ...

$spy->shouldHaveReceived('process');

模拟 Facades

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

php

<?php

namespace App\Http\Controllers;

use Illuminate\Support\Facades\Cache;

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

        return [
            // ...
        ];
    }
}

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

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 间谍

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

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 的基础功能测试类包含允许您操控当前时间的助手：

php

use Illuminate\Support\Carbon;

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()->subHours(6));

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

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

php

$this->travel(5)->days(function () {
    // 测试未来五天的某些事情...
});

$this->travelTo(now()->subDays(10), function () {
    // 在给定时刻测试某些事情...
});

freezeTime 方法可用于冻结当前时间。同样，freezeSecond 方法将在当前秒开始时冻结当前时间：

php

use Illuminate\Support\Carbon;

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

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

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

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 间谍 ​

与时间交互 ​

模拟

介绍

模拟对象

模拟 Facades

Facade 间谍

与时间交互