模拟

简介
模拟对象
模拟外观
- 外观 Spies
与时间互动

简介

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

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

模拟对象

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

 1use App\Service;
 2use Mockery;
 3use Mockery\MockInterface;
 4 
 5test('something can be mocked', function () {
 6    $this->instance(
 7        Service::class,
 8        Mockery::mock(Service::class, function (MockInterface $mock) {
 9            $mock->shouldReceive('process')->once();
10        })
11    );
12});

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

 1use App\Service;
 2use Mockery;
 3use Mockery\MockInterface;
 4 
 5public function test_something_can_be_mocked(): void
 6{
 7    $this->instance(
 8        Service::class,
 9        Mockery::mock(Service::class, function (MockInterface $mock) {
10            $mock->shouldReceive('process')->once();
11        })
12    );
13}

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

1use App\Service;
2use Mockery\MockInterface;
3 
4$mock = $this->mock(Service::class, function (MockInterface $mock) {
5    $mock->shouldReceive('process')->once();
6});

use App\Service;
use Mockery\MockInterface;

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

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

1use App\Service;
2use Mockery\MockInterface;
3 
4$mock = $this->partialMock(Service::class, function (MockInterface $mock) {
5    $mock->shouldReceive('process')->once();
6});

use App\Service;
use Mockery\MockInterface;

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

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

1use App\Service;
2 
3$spy = $this->spy(Service::class);
4 
5// ...
6 
7$spy->shouldHaveReceived('process');

use App\Service;

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

// ...

$spy->shouldHaveReceived('process');

模拟外观

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

 1<?php
 2 
 3namespace App\Http\Controllers;
 4 
 5use Illuminate\Support\Facades\Cache;
 6 
 7class UserController extends Controller
 8{
 9    /**
10     * Retrieve a list of all users of the application.
11     */
12    public function index(): array
13    {
14        $value = Cache::get('key');
15 
16        return [
17            // ...
18        ];
19    }
20}

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

 1<?php
 2 
 3use Illuminate\Support\Facades\Cache;
 4 
 5test('get index', function () {
 6    Cache::shouldReceive('get')
 7        ->once()
 8        ->with('key')
 9        ->andReturn('value');
10 
11    $response = $this->get('/users');
12 
13    // ...
14});

<?php

use Illuminate\Support\Facades\Cache;

test('get index', function () {
    Cache::shouldReceive('get')
        ->once()
        ->with('key')
        ->andReturn('value');

    $response = $this->get('/users');

    // ...
});

 1<?php
 2 
 3namespace Tests\Feature;
 4 
 5use Illuminate\Support\Facades\Cache;
 6use Tests\TestCase;
 7 
 8class UserControllerTest extends TestCase
 9{
10    public function test_get_index(): void
11    {
12        Cache::shouldReceive('get')
13            ->once()
14            ->with('key')
15            ->andReturn('value');
16 
17        $response = $this->get('/users');
18 
19        // ...
20    }
21}

<?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 外观。相反，在运行测试时，将您想要的输入传递到 HTTP 测试方法（例如 get 和 post）。同样，与其模拟 Config 外观，不如在测试中调用 Config::set 方法。

外观 Spies

如果您想spy一个外观，您可以调用相应外观上的 spy 方法。Spies 类似于 mocks；但是，spies 记录 spy 和被测试代码之间的任何交互，允许您在代码执行后进行断言

 1<?php
 2 
 3use Illuminate\Support\Facades\Cache;
 4 
 5test('values are be stored in cache', function () {
 6    Cache::spy();
 7 
 8    $response = $this->get('/');
 9 
10    $response->assertStatus(200);
11 
12    Cache::shouldHaveReceived('put')->once()->with('name', 'Taylor', 10);
13});

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

 1use Illuminate\Support\Facades\Cache;
 2 
 3public function test_values_are_be_stored_in_cache(): void
 4{
 5    Cache::spy();
 6 
 7    $response = $this->get('/');
 8 
 9    $response->assertStatus(200);
10 
11    Cache::shouldHaveReceived('put')->once()->with('name', 'Taylor', 10);
12}

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

 1test('time can be manipulated', function () {
 2    // Travel into the future...
 3    $this->travel(5)->milliseconds();
 4    $this->travel(5)->seconds();
 5    $this->travel(5)->minutes();
 6    $this->travel(5)->hours();
 7    $this->travel(5)->days();
 8    $this->travel(5)->weeks();
 9    $this->travel(5)->years();
10 
11    // Travel into the past...
12    $this->travel(-5)->hours();
13 
14    // Travel to an explicit time...
15    $this->travelTo(now()->subHours(6));
16 
17    // Return back to the present time...
18    $this->travelBack();
19});

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

 1public function test_time_can_be_manipulated(): void
 2{
 3    // Travel into the future...
 4    $this->travel(5)->milliseconds();
 5    $this->travel(5)->seconds();
 6    $this->travel(5)->minutes();
 7    $this->travel(5)->hours();
 8    $this->travel(5)->days();
 9    $this->travel(5)->weeks();
10    $this->travel(5)->years();
11 
12    // Travel into the past...
13    $this->travel(-5)->hours();
14 
15    // Travel to an explicit time...
16    $this->travelTo(now()->subHours(6));
17 
18    // Return back to the present time...
19    $this->travelBack();
20}

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

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

1$this->travel(5)->days(function () {
2    // Test something five days into the future...
3});
4 
5$this->travelTo(now()->subDays(10), function () {
6    // Test something during a given moment...
7});

$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 方法将冻结当前时间，但冻结在当前秒的开始

 1use Illuminate\Support\Carbon;
 2 
 3// Freeze time and resume normal time after executing closure...
 4$this->freezeTime(function (Carbon $time) {
 5    // ...
 6});
 7 
 8// Freeze time at the current second and resume normal time after executing closure...
 9$this->freezeSecond(function (Carbon $time) {
10    // ...
11})

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

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

1use App\Models\Thread;
2 
3test('forum threads lock after one week of inactivity', function () {
4    $thread = Thread::factory()->create();
5 
6    $this->travel(1)->week();
7 
8    expect($thread->isLockedByInactivity())->toBeTrue();
9});

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

 1use App\Models\Thread;
 2 
 3public function test_forum_threads_lock_after_one_week_of_inactivity()
 4{
 5    $thread = Thread::factory()->create();
 6 
 7    $this->travel(1)->week();
 8 
 9    $this->assertTrue($thread->isLockedByInactivity());
10}

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

序言

快速入门

架构概念

基础知识

深入探讨

安全

数据库

Eloquent ORM

测试

扩展包

模拟

简介

模拟对象

模拟外观

外观 Spies

与时间互动

产品

扩展包

资源