Модульное тестирование в PyCharm

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

Написание и запуск модульных тестов в PyCharm очень удобны; IDE предоставляет полный рабочий процесс от создания тестов до выполнения и анализа результатов.

PyCharm имеет встроенную поддержку трёх основных фреймворков тестирования Python:unittest、pytestиnose。


Написание примеров тестов

Следующий полный пример демонстрирует, как писать модульные тесты в PyCharm.

Сначала мы создаём простойCarкласс, а затем пишем для него тестовые примеры.

Тестируемый код: car.py

Пример

# car.py - Простой класс Car для демонстрации написания модульных тестов
class Car:
    """Имитирует класс автомобиля, предоставляя функции ускорения и торможения."""

    def __init__(self, make="example", model="EXAMPLE-X1"):
        # Инициализировать марку и модель автомобиля
        self.make = make
        self.model = model
        # Начальная скорость равна 0
        self.speed = 0

    def accelerate(self, increment):
        """Метод ускорения.
Параметры:
increment: приращение скорости, должно быть положительным целым числом
Возвращает:
Текущая скорость после ускорения
Исключения:
ValueError: возникает, когда increment отрицателен или равен нулю
        """

        if increment <= 0:
            raise ValueError("Приращение ускорения должно быть положительным")
        self.speed += increment
        return self.speed

    def brake(self, decrement):
        """Метод торможения.
Параметры:
decrement: величина замедления, должна быть положительным целым числом
Возвращает:
Текущая скорость после торможения, минимум 0
Исключения:
ValueError: вызывается, когда decrement отрицателен или равен нулю
        """

        if decrement <= 0:
            raise ValueError("Величина замедления должна быть положительной")
        self.speed = max(0, self.speed - decrement)
        return self.speed

Тестовый код: test_car.py

Пример

# test_car.py - Модульные тесты для класса Car
# Напишите тестовые случаи с использованием фреймворка unittest
import unittest
from car import Car


class TestCar(unittest.TestCase):
    """Набор тестов для класса Car."""

    def setUp(self):
        """setUp вызывается перед каждым тестовым методом для создания нового экземпляра Car."""
        self.car = Car()

    def test_initial_speed(self):
        """Проверяет, равна ли начальная скорость 0."""
        self.assertEqual(self.car.speed, 0,
                         "Начальная скорость нового автомобиля должна быть 0")

    def test_accelerate_normal(self):
        """Тест обычного сценария ускорения."""
        # Ускорение на 50
        result = self.car.accelerate(50)
        # Проверка возвращаемого значения
        self.assertEqual(result, 50,
                         "Скорость после ускорения должна быть 50")
        # Проверка состояния объекта
        self.assertEqual(self.car.speed, 50,
                         "Атрибут car.speed должен быть обновлён до 50")

    def test_accelerate_multiple_times(self):
        """Проверяет совокупный эффект нескольких ускорений."""
        # Первое ускорение на 30
        self.car.accelerate(30)
        # Второе ускорение на 20
        result = self.car.accelerate(20)
        # Итоговая скорость должна быть 50
        self.assertEqual(result, 50,
                         "Скорость после двух ускорений должна быть 50")

    def test_accelerate_with_zero(self):
        """Проверяет, что возникает исключение, когда приращение ускорения равно 0."""
        with self.assertRaises(ValueError,
                               msg="Приращение ускорения, равное 0, должно вызывать ValueError"):
            self.car.accelerate(0)

    def test_accelerate_negative(self):
        """Проверяет, что возникает исключение, когда приращение ускорения отрицательно."""
        with self.assertRaises(ValueError,
                               msg="Отрицательное приращение ускорения должно вызывать ValueError"):
            self.car.accelerate(-10)

    def test_brake_normal(self):
        """Тест обычного сценария торможения."""
        # Сначала разгоняемся до 80
        self.car.accelerate(80)
        # Тормозим на 30
        result = self.car.brake(30)
        # Проверяем скорость
        self.assertEqual(result, 50,
                         "Скорость после торможения должна быть 50")

    def test_brake_below_zero(self):
        """Проверка того, что торможение не снижает скорость ниже 0."""
        # Сначала разгоняемся до 20
        self.car.accelerate(20)
        # Тормозим на 50, скорость должна быть ограничена до 0
        result = self.car.brake(50)
        self.assertEqual(result, 0,
                         "Скорость не должна быть ниже 0")

    def test_brake_with_zero(self):
        """Проверяет, что возникает исключение, когда величина замедления равна 0."""
        with self.assertRaises(ValueError,
                               msg="Величина замедления 0 должна вызывать ValueError"):
            self.car.brake(0)


# Выполнять тесты, когда скрипт запускается напрямую
if __name__ == "__main__":
    unittest.main()

PyCharm может автоматически распознавать тестовые классы и тестовые методы. Имена тестовых классов начинаются сTest, а имена тестовых методов начинаются сtest_Это соглашение об именовании тестов в Python.


Запуск тестов

После написания тестового кода есть несколько способов запустить тесты.

Способ 1: Нажмите на зелёный значок запуска

PyCharm отобразит в левой области Gutter рядом с тестовым классом и каждым тестовым методомзелёный значок запуска.。

Нажатие на зелёную иконку рядом с именем класса запускает все тесты в этом классе, а нажатие на иконку рядом с методом запускает только один этот тест.

Вы также можете щёлкнуть правой кнопкой мыши по тестовому файлу и выбрать в менюЗапустить 'test_car'。

Способ 2: Использование сочетаний клавиш

Установите курсор внутри тестового класса или тестового метода и нажмитеCtrl + Shift + F10чтобы запустить текущий тест.

Просмотр результатов тестов

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

Пройденные тесты отмечаются зелёной галочкой, непройденные — красным крестиком, вместе с подробными сообщениями об ошибках и трассировками стека.

Щелчок по элементу неудачного теста заставляет PyCharm перейти непосредственно к строке кода, где произошла ошибка, что позволяет легко и быстро найти проблему.


Переключение фреймворков тестирования

PyCharm по умолчанию используетunittestв качестве средства запуска тестов, но вы можете легко переключиться на другие фреймворки.

Шаги настройки

  1. ОткройтеНастройки(Сочетание клавиш: Ctrl + Alt + S или Command + , в macOS).
  2. Перейдите к Python。
  3. Вразделе Integrated Toolsнайдите раскрывающееся менюTesting.
  4. изUnittests、pytest、Nosetestsвыберите нужный фреймворк.
  5. НажмитеOK, чтобы сохранить настройки.

Если вы выбираете pytest в качестве средства запуска тестов, убедитесь, что у васpip install pytestустановлен пакет pytest.


Советы по разработке через тестирование

Модульное тестирование используется не только для проверки существующего кода; оно также являетсяTest-Driven Development (TDD)основной практикой.

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

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

Другие расширения