Unit Testing в Laravel

В этом блоге мы рассмотрим Unit тестирование в Laravel — что это такое, почему это важно и как начать писать тесты. К концу вы поймете, как создавать и выполнять тесты в Laravel с реальными примерами.

Что такое Unit тестирование?

Unit Testing (Модульное тестирование) — это тип тестирования, при котором вы пишете код для проверки отдельных модулей вашего приложения, таких как функции, методы или классы. Эти тесты небольшие, быстрые и направлены на то, чтобы гарантировать, что определенный фрагмент кода работает так, как ожидается.

В Laravel Unit тесты обычно пишутся с использованием PHPUnit , который предустановлен вместе с Laravel.

Почему Unit тестирование важно

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

• Раннее обнаружение ошибок : тесты помогают выявлять ошибки до того, как ваше приложение будет запущено в эксплуатацию, что избавляет вас от дорогостоящих исправлений в дальнейшем.
• Проводите рефакторинг с уверенностью : знание того, что ваши тесты выявят любые проблемы, делает рефакторинг более безопасным и эффективным.
• Повышение качества кода : написание тестов заставляет вас продумывать логику кода и пограничные случаи, что приводит к созданию более чистого и надежного кода.
• Обеспечение согласованности : тесты гарантируют, что обновления или новые функции не нарушат существующую функциональность.

Настройка Unit тестирования в Laravel

Laravel предварительно настроен для Unit тестирования, поэтому вам не нужно устанавливать никаких дополнительных инструментов. Вот как начать:

Шаг 1: Проверьте установку PHPUnit

Laravel включает PHPUnit из коробки. Вы можете проверить версию, выполнив:

vendor/bin/phpunit --version

Шаг 2: Создание тестового класса

Laravel предоставляет удобную команду Artisan для генерации нового тестового класса:

php artisan make:test ExampleTest --unit

Это создаст тестовый файл в tests/Unit каталоге:

tests/
├── Unit/
│   └── ExampleTest.php

Шаг 3: Настройте среду тестирования

Laravel использует .env.testing файл для тестирования. Скопируйте .env файл и переименуйте его в .env.testing. Обновите конфигурацию базы данных, чтобы использовать отдельную тестовую базу данных, гарантируя, что ваши тесты не повлияют на вашу базу данных разработки.

DB_CONNECTION=sqlite
DB_DATABASE=:memory:

Написание первого Unit теста

Давайте напишем простой тест, чтобы проверить, возвращает ли метод в классе ожидаемое значение.

Пример: Тестирование вспомогательной математической функции

Создайте вспомогательный класс в app/Helpers/MathHelper.php:

namespace App\Helpers;

class MathHelper
{
    public static function add($a, $b)
    {
        return $a + $b;
    }
}

Напишите тест для этой функции в tests/Unit/MathHelperTest.php:

namespace Tests\Unit;

use PHPUnit\Framework\TestCase;
use App\Helpers\MathHelper;

class MathHelperTest extends TestCase
{
    public function testAddition()
    {
        $result = MathHelper::add(2, 3);
        $this->assertEquals(5, $result);
    }
}

Запустите тест:

vendor/bin/phpunit

Если все правильно, PHPUnit выведет:

OK (1 test, 1 assertion)

Тестирование моделей, контроллеров и сервисов

Тестирование моделей

Модели являются центральными для любого приложения Laravel. Давайте протестируем простой метод модели.

Добавьте User модель с пользовательским методом в app/Models/User.php:

namespace App\Models;

use Illuminate\Database\Eloquent\Factories\HasFactory;
use Illuminate\Database\Eloquent\Model;

class User extends Model
{
    use HasFactory;

    public function isAdmin()
    {
        return $this->role === 'admin';
    }
}

Напишите тест на tests/Unit/UserTest.php:

namespace Tests\Unit;

use PHPUnit\Framework\TestCase;
use App\Models\User;

class UserTest extends TestCase
{
    public function testIsAdmin()
    {
        $user = new User();
        $user->role = 'admin';

        $this->assertTrue($user->isAdmin());
    }
}

Тестирование контроллеров

Для контроллеров обычно используются feature tests, но вы все равно можете тестировать отдельные методы.

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

Создать сервис в app/Services/ExampleService.php:

namespace App\Services;

class ExampleService
{
    public function greet($name)
    {
        return "Hello, $name!";
    }
}

Напишите тест для этого:

namespace Tests\Unit;

use PHPUnit\Framework\TestCase;
use App\Services\ExampleService;

class ExampleServiceTest extends TestCase
{
    public function testGreeting()
    {
        $service = new ExampleService();
        $this->assertEquals('Hello, John!', $service->greet('John'));
    }
}

Проведение и интерпретация тестов

Чтобы запустить все тесты в вашем проекте:

vendor/bin/phpunit

Чтобы запустить определенный тестовый файл:

vendor/bin/phpunit tests/Unit/ExampleTest.php

Вывод покажет:

• Тесты, которые прошли успешно.
• Тесты, которые не прошли (с подробностями о том, что пошло не так).

Лучшие практики для Unit тестирования Laravel

1. Тестируйте небольшие блоки : сосредоточьтесь на небольших изолированных блоках кода, например на отдельном методе или функции.
2. Используйте утверждения с умом : Laravel предоставляет множество методов утверждений, таких как assertEquals, assertTrue, и assertCount. Используйте их для проверки ожидаемых результатов.
3. Имитация внешних зависимостей : используйте возможности имитации Laravel для имитации запросов к базе данных или вызовов API, гарантируя независимость тестов от внешних факторов.
4. Регулярно проводите тесты : интегрируйте тестирование в процесс разработки, чтобы выявлять проблемы на ранних стадиях.

Заключительные мысли

Unit тестирование в Laravel не должно пугать. Благодаря встроенным инструментам и бесшовной интеграции с PHPUnit, Laravel упрощает написание и управление тестами. Приняв мышление, ориентированное на тестирование, вы обеспечите надежность, прочность и готовность своего приложения к производству.

Начните с малого — напишите тест для одной функции или класса. Когда вы освоитесь, вы увидите, как модульное тестирование может преобразовать ваш процесс разработки. Счастливого кодирования!