laravel
9. 测试
模拟

简介

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

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

模拟对象

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

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

同样，如果您想要监视 (opens in a new tab)一个对象，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
{
    /**
     * 检索应用程序的所有用户列表。
     */
    public function index(): array
    {
        $value = Cache::get('key');

        return [
            //...
        ];
    }
}

我们可以通过使用 shouldReceive 方法来模拟对 Cache 外观的调用，该方法将返回一个 Mockery (opens in a new tab) 模拟的实例。由于外观实际上是由 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');
 
        //...
    }
}

[!WARNING]
您不应该模拟 Request 外观。相反，在运行测试时，将您想要的输入传递到 HTTP 测试方法 中，例如 get 和 post。同样，不要模拟 Config 外观，而是在测试中调用 Config::set 方法。

外观间谍

如果您想要对外观进行监视 (opens in a new tab)，您可以在相应的外观上调用 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 () {
    // 前往未来...
    $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();
});
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();
}

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

$this->travel(5)->days(function () {
    // 在未来五天测试某些内容...
});

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

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

use Illuminate\Support\Carbon;

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

// 在当前秒冻结时间，并在执行闭包后恢复正常时间...
$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());
}
数据库测试Laravel Cashier（Stripe）