模拟

简介
模拟对象
模拟 Facades
- Facade 监听器
与时间交互

简介

在测试 Laravel 应用程序时,你可能希望"模拟"应用程序的某些方面,以便它们在特定测试中不会实际执行。例如,在测试触发事件的控制器时,你可能希望模拟事件监听器,以便它们在测试期间不会实际执行。这允许你只测试控制器的 HTTP 响应,而不必担心事件监听器的执行,因为事件监听器可以在它们自己的测试用例中进行测试。

Laravel 提供了开箱即用的方法来模拟事件、任务和其他 facades。这些辅助方法主要提供了一个便利层,用于封装 Mockery,因此你不必手动进行复杂的 Mockery 方法调用。

模拟对象

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

php

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

php

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

php

    use App\Service;
    use Mockery\MockInterface;

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

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

php

    use App\Service;
    use Mockery\MockInterface;

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

同样，如果你想监视一个对象，Laravel 的基本测试用例类提供了一个 spy 方法作为 Mockery：：spy 方法的便捷包装器。间谍类似于模拟;但是，间谍会记录间谍与被测试代码之间的任何交互，从而允许您在执行代码后进行断言：

php

    use App\Service;

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

    // ...

    $spy->shouldHaveReceived('process');

模拟 Facades

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

php

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

php

<?php

use Illuminate\Support\Facades\Cache;

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

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

    // ...
});

php

<?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 Facade。相反，在运行测试时，请将所需的输入传递到 HTTP 测试方法中，例如 get 和 post。同样，不要模拟 Config Facade，而是在测试中调用 Config：：set 方法。

Facade 监听器

如果你想监视 Facade，你可以在相应的 Facade 上调用 spy 方法。间谍类似于模拟;但是，间谍会记录间谍与被测试代码之间的任何交互，从而允许您在执行代码后进行断言：

php

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

php

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

与时间交互

在测试时，您可能偶尔需要修改 helper 返回的时间，例如 now 或 Illuminate\Support\Carbon::now() 。值得庆幸的是，Laravel 的基本功能测试类包含允许您操作当前时间的帮助程序：

php

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

php

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

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

php

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

php

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

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

php

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

php

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

模拟 ​

简介 ​

模拟对象 ​

模拟 Facades ​

Facade 监听器 ​

与时间交互 ​

模拟

简介

模拟对象

模拟 Facades

Facade 监听器

与时间交互