Моки · Laravel

Вступ

Під час тестування застосунків на Laravel вам може знадобитися «замокати» певні частини застосунку, щоб вони не виконувалися насправді в межах конкретного тесту. Наприклад, тестуючи контролер, який відправляє подію, ви можете замокати слухачів події, щоб вони не виконувалися під час тесту. Так ви тестуєте лише HTTP-відповідь контролера й не турбуєтеся про виконання слухачів, бо слухачів можна перевірити в окремому тестовому кейсі.

Laravel одразу дає зручні методи для моків подій, завдань (jobs) та інших фасадів. Ці хелпери здебільшого є шаром зручності над 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->expects('process');
        })
    );
});

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

Щоб зробити це зручніше, можна скористатися методом mock, який надає базовий клас тестів Laravel. Наприклад, наступний приклад еквівалентний попередньому:

use App\Service;
use Mockery\MockInterface;

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

Метод partialMock стане в пригоді, коли потрібно замокати лише кілька методів обʼєкта. Незамокані методи під час виклику виконуватимуться як зазвичай:

use App\Service;
use Mockery\MockInterface;

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

Так само, якщо ви хочете шпигувати за обʼєктом, базовий клас тестів 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 [
            // ...
        ];
    }
}

Замокати виклик фасада Cache можна методом expects, який поверне екземпляр мока Mockery. Оскільки фасади насправді резолвляться й керуються контейнером сервісів Laravel, вони набагато тестованіші за типовий статичний клас. Наприклад, замокаємо наш виклик методу get фасада Cache:

<?php

use Illuminate\Support\Facades\Cache;

test('get index', function () {
    Cache::expects('get')
        ->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::expects('get')
            ->with('key')
            ->andReturn('value');

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

        // ...
    }
}

Увага Не варто мокати фасад Request. Замість цього передавайте потрібні дані в методи HTTP-тестування, як-от get і post, під час запуску тесту. Так само, замість мока фасада Config викликайте в тестах метод Config::set.

Шпигуни фасадів

Якщо ви хочете шпигувати за фасадом, викличте метод spy на відповідному фасаді. Шпигуни схожі на моки, але вони записують будь-яку взаємодію між шпигуном і кодом, що тестується, тож ви можете робити перевірки вже після виконання коду:

<?php

use Illuminate\Support\Facades\Cache;

test('values are stored in cache', function () {
    Cache::spy();

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

    $response->assertStatus(200);

    Cache::shouldHaveReceived('put')->with('name', 'Taylor', 10);
});

use Illuminate\Support\Facades\Cache;

public function test_values_are_stored_in_cache(): void
{
    Cache::spy();

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

    $response->assertStatus(200);

    Cache::shouldHaveReceived('put')->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()->minus(hours: 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()->minus(hours: 6));

    // Повернення до теперішнього часу...
    $this->travelBack();
}

Різним методам подорожі в часі можна також передати замикання. Замикання буде викликане із замороженим часом на вказаному моменті. Щойно замикання відпрацює, час піде далі як зазвичай:

$this->travel(5)->days(function () {
    // Test something five days into the future...
});

$this->travelTo(now()->mins(days: 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());
}