Laravel (5.7) HTTP-тесты

Вступление

Laravel предоставляет нам очень удобный API для отправки запросов к нашему приложению и проверки результатов. Например, рассмотрим тест, определенный ниже:

<?php
namespace Tests\Feature;
use Tests\TestCase;
use Illuminate\Foundation\Testing\RefreshDatabase;
use Illuminate\Foundation\Testing\WithoutMiddleware;
class ExampleTest extends TestCase
{
    /**
     * A basic test example.
     *
     * @return void
     */
    public function testBasicTest()
    {
        $response = $this->get('/');
        $response->assertStatus(200);
    }
}

Метод get отправит запрос GET в приложение, а метод assertStatus подтвердит, что возвращенный ответ должен иметь заданный код состояния HTTP. Laravel не ограничивается этим простым утверждением, он также содержит различные утверждения для проверки заголовков ответа, содержимого, структуры JSON и многого другого.

Настройка заголовков запросов

Вы можете использовать метод withHeaders, чтобы настроить заголовки запроса перед отправкой его в приложение. Это позволит вам добавить любые произвольные заголовки, которые вы хотели бы добавить в запрос:

<?php
class ExampleTest extends TestCase
{
    /**
     * A basic functional test example.
     *
     * @return void
     */
    public function testBasicExample()
    {
        $response = $this->withHeaders([
            'X-Header' => 'Value',
        ])->json('POST', '/user', ['name' => 'Sally']);
        $response
            ->assertStatus(201)
            ->assertJson([
                'created' => true,
            ]);
    }

Сессия / Аутентификация

Laravel предоставляет нам несколько помощников для работы с сеансом во время HTTP-тестирования. Во-первых, вы можете установить данные сеанса для данного массива, используя метод withSession. Это очень полезно для загрузки сеанса с данными перед отправкой запроса в ваше приложение:

<?php
class ExampleTest extends TestCase
{
    public function testApplication()
    {
        $response = $this->withSession(['foo' => 'bar'])
                         ->get('/');
    }
}

Обычное использование сеанса заключается в поддержании состояния для аутентифицированного пользователя. Вспомогательный метод actAs обеспечит простой способ аутентификации данного пользователя в качестве текущего пользователя. Например, вы можете использовать фабрику моделей для генерации и аутентификации пользователя:

<?php
use App\User;
class ExampleTest extends TestCase
{
    public function testApplication()
    {
        $user = factory(User::class)->create();
        $response = $this->actingAs($user)
                         ->withSession(['foo' => 'bar'])
                         ->get('/');
    }
}

Вы также можете указать, какой сторож следует использовать для аутентификации данного пользователя, передавая имя сторожа в качестве второго аргумента в действующий метод:

$this->actingAs($user, 'api')

Тестирование API JSON

Laravel также предоставляет вам несколько помощников для тестирования API-интерфейсов JSON и их ответов. Например, методы json, get, post, put, patch и delete могут использоваться для выдачи запросов с различными HTTP-глаголами. Вы также можете легко передавать данные и заголовки в эти методы. Для начала давайте напишем тест, чтобы сделать запрос POST для / user и утверждать, что ожидаемые данные были возвращены:

<?php
class ExampleTest extends TestCase
{
    /**
     * A basic functional test example.
     *
     * @return void
     */
    public function testBasicExample()
    {
        $response = $this->json('POST', '/user', ['name' => 'Sally']);
        $response
            ->assertStatus(201)
            ->assertJson([
                'created' => true,
            ]);
    }
}

Проверка точного соответствия JSON

Если вы хотите убедиться, что данный массив является точным соответствием для JSON, возвращенного приложением, используйте метод assertExactJson:

<?php
class ExampleTest extends TestCase
{
    /**
     * A basic functional test example.
     *
     * @return void
     */
    public function testBasicExample()
    {
        $response = $this->json('POST', '/user', ['name' => 'Sally']);
        $response
            ->assertStatus(201)
            ->assertExactJson([
                'created' => true,
            ]);
    }
}

Тестирование загрузки файлов

Класс IlluminateHttpUploadedFile предоставляет поддельный метод, который можно использовать для создания фиктивных файлов или изображений для тестирования. Когда это комбинируется с поддельным методом Storage фасад, это значительно упрощает тестирование загрузки файлов. Например, вы можете легко объединить эти две функции для проверки формы загрузки аватара:

<?php
namespace Tests\Feature;
use Tests\TestCase;
use Illuminate\Http\UploadedFile;
use Illuminate\Support\Facades\Storage;
use Illuminate\Foundation\Testing\RefreshDatabase;
use Illuminate\Foundation\Testing\WithoutMiddleware;
class ExampleTest extends TestCase
{
    public function testAvatarUpload()
    {
        Storage::fake('avatars');
        $file = UploadedFile::fake()->image('avatar.jpg');
        $response = $this->json('POST', '/avatar', [
            'avatar' => $file,
        ]);
        // Assert the file was stored...
        Storage::disk('avatars')->assertExists($file->hashName());
        // Assert a file does not exist...
        Storage::disk('avatars')->assertMissing('missing.jpg');
    }
}

Поддельные настройки файла

Всякий раз, когда вы создаете файлы с использованием поддельного метода, вы можете указать ширину, высоту и размер изображения, чтобы лучше проверить правила проверки:

UploadedFile::fake()->image('avatar.jpg', $width, $height)->size(100);

Помимо создания изображений, вы также можете создавать файлы любого другого типа, используя метод create:

UploadedFile::fake()->create('document.pdf', $sizeInKilobytes);

Доступные утверждения

Ответные утверждения

Laravel предоставляет вам множество пользовательских методов подтверждения для ваших тестов PHPUnit. К этим утверждениям можно получить доступ в ответе, который возвращается из методов тестирования json, get, post, put и delete:

Утверждения аутентификации

Laravel предоставляет различные проверки подлинности для наших тестов PHPUnit