Настройка тестовой среды для проекта

Давайте честно, писали ли вы когда-нибудь код, который работал у вас на локальной машине, но внезапно "всё сломалось" на продакшене? Если да, то у нас плохие новости: разработчики об этом узнают сразу. Вот почему тестовая среда является жизненно необходимой: она помогает нам создавать и запускать тесты вне влияния основного приложения. Мы настраиваем тестовую базу данных, отдельные конфигурации и организуем тесты так, чтобы "болото багов" вас не затянуло.

Подготовка тестовой базы данных

Тестирование без отдельной базы данных — как запускать гонку на разбитом велосипеде. Django умеет автоматически создавать (и очищать) базу данных специально для тестов. Тестовая база изолирована и не затрагивает ваши "боевые данные". Давайте посмотрим, как это работает.

Автоматическое создание тестовой базы данных

Когда вы запускаете тесты в Django (например, командой pytest), система автоматически создает тестовую базу данных. Это обычно выглядит так:

• Django берет настройки базы данных из settings.py.
• Создает временную базу данных, имя которой начинается с test_....
• Все миграции автоматически накатываются на новую базу.

Пример из settings.py:

DATABASES = {
    'default': {
        'ENGINE': 'django.db.backends.sqlite3',
        'NAME': BASE_DIR / "db.sqlite3",
    }
}

Если у вас используется PostgreSQL или MySQL, Django создаст соответствующую тестовую базу для каждого тестового запуска. Вам ничего не нужно настраивать дополнительно, кроме прав на создание базы данных для пользователя базы.

Как убедиться, что всё работает? Попробуйте выполнить любую команду тестирования, например:

pytest

При запуске Django автоматически выведет что-то вроде:

Creating test database for alias 'default'...

Если вы видите это сообщение, то тестовая база успешно создана!

Организация тестов в проекте

Представьте себе библиотеку, где книги валяются где угодно. Теперь замените "книги" на "ваши тесты". Чтобы не оказаться в хаосе, тесты нужно правильно организовать.

Где размещать тесты?

Django рекомендует несколько подходов:

1. Тесты в отдельных файлах для каждого приложения
   Например, если у вас есть приложение blog, тесты можно разместить в таком файле:

      blog/
          tests.py
   

2. Тесты в отдельных папках
   Для больших проектов более удобна структура с каталогом для тестов. Например:

   blog/
       tests/
           test_models.py
           test_views.py
           test_urls.py
   

Для начала выберите второй подход: создание папки tests в каждом приложении. Это позволит удобно группировать тесты по типу.

Советы по организации

• Названия файлов всегда начинайте с префикса test_. Это нужно, чтобы pytest их нашёл. Например: test_api.py, test_forms.py.
• Старайтесь называть файлы и тесты так, чтобы сразу было понятно, что они проверяют.

Настройка тестовой конфигурации

Чтобы ваши тесты "жили своей жизнью", можно настроить отдельный файл конфигурации, например test_settings.py.

Пример test_settings.py

from my_project.settings import *  # Импортируем базовые настройки

# Используем SQLite для тестов (быстро и без лишних зависимостей)
DATABASES = {
    'default': {
        'ENGINE': 'django.db.backends.sqlite3',
        'NAME': ':memory:',  # Используем базу в памяти
    }
}

# Выключаем ненужные middleware для ускорения тестов
MIDDLEWARE = [mw for mw in MIDDLEWARE if mw not in [
    'your_project.middleware.SomeHeavyMiddleware',
]]

# Вывод отладки в тестах
DEBUG = False

# Настройки e-mail
EMAIL_BACKEND = 'django.core.mail.backends.locmem.EmailBackend'

# Любые дополнительные настройки для тестирования

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

DJANGO_SETTINGS_MODULE=test_settings pytest

Или настройте это прямо в pytest.ini:

[pytest]
DJANGO_SETTINGS_MODULE = test_settings

Пример базовой структуры тестов

Теперь, когда у нас всё настроено, давайте создадим простейшую структуру тестов в каталоге вашего приложения.

Шаг 1: создайте папку tests

В каталоге вашего приложения создайте папку tests/, а внутри файл __init__.py (чтобы Python знал, что это модуль).

Структура будет выглядеть так:

blog/
    tests/
        __init__.py
        test_models.py
        test_views.py

Шаг 2: пример простого теста

В test_views.py напишем простейший тест:

from django.test import TestCase
from django.urls import reverse

class BlogViewTests(TestCase):
    def test_homepage_status_code(self):
        response = self.client.get(reverse('home'))  # Проверяем главную страницу
        self.assertEqual(response.status_code, 200)

Этот тест проверяет, что главная страница вашего блога возвращает статус 200 (OK).

Распространённые проблемы и их решение

Когда вы запускаете тесты впервые, могут появиться следующие проблемы:

1. Bugs в миграциях или модели базы данных: Если миграции не проходят или модель некорректна, тесты невозможно запустить. Убедитесь, что ваша миграция проходит локально:

   python manage.py makemigrations
   python manage.py migrate
   

2. Переменные окружения для тестовой базы данных: Если используете PostgreSQL или MySQL, убедитесь, что права на создание тестовой базы есть у текущего пользователя.

3. Ошибки зависимости приложений: Проверьте, что все приложения в INSTALLED_APPS добавлены корректно.

Теперь, когда у вас есть рабочая тестовая среда, готовьтесь к следующему этапу: написанию собственных тестов. Настройка у вас уже в руках — осталось, чтобы магия заработала!