跳过到内容
Laravel

模拟

介绍

在测试 Laravel 应用程序时，您可能希望“模拟”应用程序的某些方面，以便它们在给定测试期间不会真正执行。例如，在测试一个分发事件的控制器时，您可能希望模拟事件监听器，这样它们在测试期间就不会真正执行。这使您能够仅测试控制器的 HTTP 响应，而无需担心事件监听器的执行，因为事件监听器可以在其自己的测试用例中进行测试。

Laravel 提供了方便的方法，可以开箱即用地模拟事件、作业和其他门面。这些助手主要为 Mockery 提供了一个方便的层，因此您不必手动进行复杂的 Mockery 方法调用。

模拟对象

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

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

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

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

模拟门面

与传统的静态方法调用不同，门面（包括 实时门面）可以被模拟。与传统的静态方法相比，这提供了很大的优势，并为您提供了与使用传统依赖注入时相同的可测试性。在测试时，您可能经常想要模拟控制器中发生的 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 [
            // ...
        ];
    }
}

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

<?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');
 
        // ...
    }
}
exclamation

您不应该模拟 Request 门面。相反，在运行测试时，将所需的输入传递到 HTTP 测试方法（如 get 和 post）。同样，不要模拟 Config 门面，而是在测试中调用 Config::set 方法。

门面间谍

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

<?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 的基本功能测试类包含允许您操作当前时间的助手。

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 () {
    // Test something five days into the future...
});
 
$this->travelTo(now()->subDays(10), function () {
    // Test something during a given moment...
});

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

use Illuminate\Support\Carbon;
 
// Freeze time and resume normal time after executing closure...
$this->freezeTime(function (Carbon $time) {
    // ...
});
 
// Freeze time at the current second and resume normal time after executing closure...
$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();
});
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());
}