跳到内容
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 方法的方便包装。Spies 与 mocks 类似；但是，spies 会记录 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 mock 的实例。由于外观模式实际上是由 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 方法。

外观模式的 Spies

如果您想监视外观模式，您可以在相应的外观模式上调用 spy 方法。Spies 与 mocks 类似；但是，spies 会记录 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());
}