Pytest в Python: структура теста

• 07.09.2023
• 278
• Библиотеки Python
• Pytest

Когда мы говорим о структуре теста, особенно в контексте pytest, мы часто думаем о модели Arrange-Act-Assert (AAA). Эта модель представляет собой систематический подход к написанию тестов и включает в себя три основных этапа:

1. Arrange (Подготовка)
На этом этапе вы подготавливаете все необходимые данные и состояние системы для выполнения теста. Это может включать:

• Инициализация объектов.
• Установка значений.
• Создание моков (mocks) и стабов (stubs) для эмуляции поведения внешних систем или компонентов.

2. Act (Действие)

Здесь вы выполняете действие, которое хотите протестировать. Это может быть вызов функции, метода или любой другой операции.

3. Assert (Подтверждение)
После выполнения действия вы проверяете, что результат соответствует вашим ожиданиям.

4. Очистка (Teardown)
Хотя это и не является частью модели AAA, очистка также является важным этапом в процессе тестирования:

• Освобождение ресурсов.
• Удаление созданных данных.
• Возвращение системы к исходному состоянию.

В pytest этап очистки часто реализуется с помощью фикстур (fixtures) с использованием yield или параметра teardown.

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

В реальных проектах часто применяют следующую структуру:

1. Код приложения находится в одном месте (например, в папке src/ или app/).
2. Тесты находятся в отдельной папке, часто называемой tests/.

Допустим, у нас есть простое приложение с функцией сложения.

Структура файлов может выглядеть следующим образом:

my_project/
|-- src/
|   |-- my_module.py
|-- tests/
|   |-- test_my_module.py
|-- README.md

Файл my_module.py:

# src/my_module.py

def add(a, b):
    return a + b

Файл test_my_module.py:

# tests/test_my_module.py

from src.my_module import add

def test_add():
    # Arrange
    x = 3
    y = 4

    # Act
    result = add(x, y)

    # Assert
    assert result == 7

Чтобы запустить тесты, вы обычно переходите в корневую папку проекта (в нашем случае my_project/) и запускаете pytest. Программа pytest автоматически найдет файлы, которые начинаются или заканчиваются на test в папке tests/, и выполнит их.

Это базовая структура, и она может изменяться или усложняться в зависимости от требований и размера проекта. Например, в больших проектах могут использоваться подпапки внутри tests/ для группировки тестов по модулям или функционалу.

Заключение

Структура теста играет ключевую роль в обеспечении качества, читаемости и поддерживаемости кода. Модель Arrange-Act-Assert (AAA) предоставляет простой и последовательный способ написания тестов, обеспечивая ясное разделение между подготовкой данных, выполнением действий и проверкой результатов.

Когда тесты организованы и структурированы правильно, они становятся гораздо более понятными и информативными. Это не только упрощает процесс разработки, но и обеспечивает уверенность в том, что код работает должным образом.

Кроме того, правильно структурированные тесты облегчают процесс интеграции и развертывания, так как разработчики и команды могут быть уверены в том, что любые изменения, внесенные в код, не вызовут непредвиденных проблем.

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