Генерация динамических unit-тестов в Python: пошаговый гид

Быстрый ответ

Для создания параметризованных модульных тестов в Python вы можете использовать комбинацию цикла и функции setattr, которая подходит для дополнения класса unittest.TestCase новыми тестовыми методами. Каждый тест должен проверять ожидаемый результат и иметь свое уникальное имя, сгенерированное на лету.

import unittest

class ParametrizedTestCase(unittest.TestCase):
    pass

def generate_test(value):
    def test(self):
        self.assertEqual(value, value)
    return test

parameters = ["test_value1", "test_value2", "test_value3"]
for index, param in enumerate(parameters):
    test_name = f"test_{param}"
    test_method = generate_test(param)
    setattr(ParametrizedTestCase, test_name, test_method)

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

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

Быстрый старт с Pytest

Библиотека pytest значительно облегчает процесс генерации тестов благодаря декоратору @pytest.mark.parametrize, который позволяет передавать различные наборы данных в тестируемую функцию:

import pytest

@pytest.mark.parametrize("input, expected", [
    ("input1", "expected1"),  # тест, где output совпадает с expected
    ("input2", "expected2"),  # второй тест, где output также ожидаемый expected 
    ("input3", "expected3")   # и еще один пример теста с его expected
])
def test_evaluation(input, expected):
    assert some_function(input) == expected

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

Работа со подтестами в Unittest

Начиная с Python 3.4, в Unittest включен контекстный менеджер subTest, который упрощает проход по списку тестовых случаев в рамках одного метода:

import unittest

class TestMathOperations(unittest.TestCase):
    def test_multiplication(self):
        for x in range(5):
            with self.subTest(i=x):
                self.assertEqual(x * x, x ** 2)

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

Преимущества использования пакета Parameterized

С использованием пакета parameterized процесс создания динамических тестов еще больше облегчается, в то же время снижается дублирование кода:

from parameterized import parameterized
import unittest

class TestStringMethods(unittest.TestCase):
    @parameterized.expand([
        ("hello world", 0, 'h'),
        ("hello world", -1, 'd'),
    ])
    def test_indexing(self, string, index, expected):
        self.assertEqual(string[index], expected)

Каждый элемент списка представляет отдельный тест с назначенными параметрами.

Визуализация

Можно рассматривать процесс создания модульных тестов как приготовление блюда: вы подготавливаете ингредиенты согласно рецепту:

Рецепт (📋): Инструкция с пространством для **изменяемых ингредиентов**.

Процесс создания динамических тестов:

1. Выбирается база теста (шаблон теста) 📋
2. Подготавливается набор переменных как ингредиенты [🥦, 🍅, 🧀]
3. Объединяется база с переменными для создания различных тестов

Обработка каждого нового сочетания ведет к формированию уникального теста:

for ingredient in [🥦, 🍅, 🧀]:
    test = create_test_recipe(📋, ingredient)  # Создаётся тест с уникальными параметрами

Завершение: Так же как и в кулинарии, создание идеальных модульных тестов требует внимательной работы с параметрами.

Углубление в продвинутые сценарии

Создание пользовательского набора тестов (TestSuite)

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

def load_tests(loader, tests, pattern):
    suite = unittest.TestSuite()
    test_data = [("apple", "fruit"), ("broccoli", "vegetable")]
    for param1, param2 in test_data:
        suite.addTest(MyTestCase('test_relation', param1, param2))
    return suite

Работа со сложными параметрами

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

@pytest.mark.parametrize("data", [
    ({'key1': 'value1'},),
    ({'key2': 'value2'},),
])
def test_complex_data(data):
    assert data_processor(data) == expected_output(data)

Используйте docstring и именованные параметры для объяснения логики каждого тестового случая.

Избегание дублирования кода

Чтобы избежать дублирования кода в тестах, активно применяйте методы подготовки (setup) и вспомогательные функции. Принцип DRY (Don't Repeat Yourself) здесь так же важен, как и в написании основного кода.

Уникальность имён тестов

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

Полезные материалы

1. tdd – Python library 'unittest': Generate multiple tests programmatically – Stack Overflow — статья, посвященная различным методам динамической генерации тестов в Python с использованием 'unittest'.
2. Writing tests — nose 1.3.7 documentation — руководство по параметризации тестов в Python с помощью Nose.
3. How to parametrize fixtures and test functions — pytest documentation — методы параметризации фикстур при помощи pytest.
4. unittest — Unit testing framework — Python 3.12.2 documentation — детальное руководство по использованию фреймворка unittest.
5. Parametrizing tests — pytest documentation — подробный обзор функционала параметризации тестов в pytest.
6. Parametrizing tests — pytest documentation (Another Version) — осмотр разных аспектов использования декоратора pytest parametrize.
7. Advanced uses of Python decorators in testing — обзор продвинутых применений декораторов в тестировании.