Как создать unittest в Python: пошаговое руководство

Юнит-тестирование — это важная часть разработки ПО, обеспечивающая контроль качества и надежность кода. Оно помогает находить ошибки на ранних стадиях и избегать регрессий. В Python для этой цели существует несколько библиотек, среди которых unittest, pytest и nose2.

В этой статье мы сосредоточимся на unittest и рассмотрим основные аспекты его использования — от установки и настройки до написания и запуска тестов.

Основные цели этой статьи:

• Объяснить важность юнит-тестирования.
• Показать, как использовать библиотеку unittest.
• Поделиться примерами кода для лучшего понимания.

Установка и настройка

Прежде чем начать писать тесты, убедитесь, что у вас установлен Python:

python --version

Если Python не установлен, скачать его можно здесь.

Теперь установим библиотеку unittest, она поставляется в стандартной библиотеке Python, поэтому дополнительной установки не требуется. Однако, если вы хотите использовать дополнительные возможности тестирования, такие как покрытие кода, установите coverage:

pip install coverage

Обзор системы тестирования unittest

Библиотека unittest предоставляет стандартный интерфейс для написания и запуска тестов. Она основана на концепции тестовых случаев и пригодна для тестирования как маленьких функций, так и больших модулей. Основное преимущество unittest — это его тесная интеграция с экосистемой Python и простота использования.

Пример установки и настройки окружения

Создайте структуру проекта следующим образом:

project/
    ├── src/
    │   └── my_module.py
    ├── tests/
    │   └── test_my_module.py
    ├── requirements.txt
    └── .gitignore

Основы unittest

Объяснение структуры файла тестирования

В unittest тесты организуются в классы, которые наследуются от unittest.TestCase. Каждый тест представляет собой метод внутри этого класса. Структура файла тестов обычно включает следующее:

• Импорт необходимых модулей.
• Определение тестовых классов.
• Использование методов assert для проверки условий.

Пример создания простого теста

import unittest

def add(a: int, b: int) -> int:
    return a + b

class TestMathFunctions(unittest.TestCase):
    def test_add(self):
        """Method to test add function"""
        self.assertEqual(add(2, 3), 5)

if __name__ == '__main__':
    unittest.main()

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

Написание тестов для функций

Как писать тесты для различных типов функций

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

Параметризация тестов с помощью subTest

Иногда вам нужно протестировать функцию на разные входные данные. Для этого удобно использовать subTest:

class TestMathFunctions(unittest.TestCase):
    def test_additional_cases(self):
        """Method to test add function with multiple cases"""
        cases = [(1, 2, 3), (2, 3, 5), (5, 5, 10)]
        for a, b, expected in cases:
            with self.subTest(a=a, b=b):
                self.assertEqual(add(a, b), expected)

Использование моков и заглушек

Объяснение, что такое моки и заглушки

Моки и заглушки используются для изоляции тестов от внешних зависимостей. Они позволяют симулировать поведение объектов и контролировать их взаимодействия. В unittest для этого используется модуль unittest.mock.

Пример использования unittest.mock для изоляции тестов

from unittest.mock import MagicMock
import unittest

class TestAPICalls(unittest.TestCase):
    def test_api_call(self):
        """Test to check API call function using Mock"""
        mock_response = MagicMock(return_value='response data')
        self.assertEqual(mock_response(), 'response data')

Запуск и анализ результатов тестов

Способы запуска тестов

Тесты можно запускать из консоли или интегрированной среды разработки (IDE). Для запуска всех тестов в проекте удобно использовать следующую команду:

python -m unittest discover

Подводя итоги: как интерпретировать результаты и значение покрываемости кода

Для получения отчета по покрытию кода выполните команды:

coverage run -m unittest discover
coverage report

Это поможет вам понять, какая часть кода была протестирована и где могут находиться необнаруженные ошибки.

Интеграция с CI/CD

Краткий обзор систем непрерывной интеграции и доставки

CI/CD системы, такие как Travis CI, GitHub Actions и GitLab CI, позволяют автоматически запускать тесты при каждом изменении кода, обеспечивая таким образом постоянно высокий уровень качества.

Примеры интеграции тестов в процесс CI/CD

Пример конфигурации для Travis CI

Создайте файл .travis.yml в корневой директории проекта:

language: python
python:
  - "3.8"

script:
  - python -m unittest discover

Заключение

Обзор ключевых моментов статьи

В этой статье мы разобрали:

• Зачем нужно юнит-тестирование.
• Как настроить и использовать библиотеку unittest.
• Как писать и запускать тесты.
• Как пользоваться моками и заглушками.
• Как интегрировать тесты с CI/CD.

Подходы к улучшению качества тестов

• Постоянно обновляйте тесты по мере изменения кода.
• Убедитесь, что ваши тесты покрывают как можно больше сценариев.
• Интегрируйте тестирование в процесс CI/CD для автоматизации и повышения надежности.