Mocking

• Introduction
• 模拟对象
• 模拟立面
  • 门面间谍
• 与时间互动

#Introduction

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

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

#模拟对象

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

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

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

use App\Service;
use Mockery\MockInterface;

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

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

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 （包括实时立面) 可能会被嘲笑。与传统的静态方法相比，这提供了一个很大的优势，并为您提供了与使用传统依赖注入时相同的可测试性。在测试时，您可能经常想模拟在您的一个控制器中发生的对 Laravel 门面的调用。例如，考虑以下控制器操作：

<?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 [
            // ...
        ];
    }
}

我们可以模拟调用Cache 外观通过使用shouldReceive 方法，它将返回一个实例Mockery 嘲笑。由于门面实际上是由 Laravel 解决和管理的服务容器，它们比典型的静态类具有更多的可测试性。例如，让我们模拟我们对Cache 门面的get 方法：

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

        // ...
    }
}

Warning
你不应该嘲笑Request 正面。相反，将您想要的输入传递给HTTP测试方法 例如get 和post 运行测试时。同样，与其嘲笑Config 立面，调用Config::set 测试中的方法。

#门面间谍

如果你愿意spy 在立面上，你可以调用spy 相应外观上的方法。间谍类似于模拟；但是，间谍会记录间谍与被测试代码之间的任何交互，允许您在代码执行后进行断言：

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

#与时间互动

在测试的时候，你可能偶尔需要修改 helpers 返回的时间，比如now 或者Illuminate\Support\Carbon::now().值得庆幸的是，Laravel 的基本功能测试类包含允许您操作当前时间的助手：

use Illuminate\Support\Carbon;

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

    // Freeze time and resume normal time after executing closure...
    $this->freezeTime(function (Carbon $time) {
        // ...
    });

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