Test driven development - как писать чистый код, который работает

Старт:28.10.2024

Срок обучения:62 ч.

«Практические навыки когнитивно-поведенческой терапии (ступень 3). Коррекция нарушений пищевого поведения в КПТ-подходе»

Дистанционное обучение по программе Практические навыки когнитивно-поведенческой терапии (ступень 3). Коррекция нарушений пищевого поведения в КПТ-подходе (62 часа) в ЦАППКК. ✍ Мы подберем вам подходящий курс, пишите!

29 900 ₽

Подробнее

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

Затем, напишите минимальный код, который пройдёт тест. Если тест не проходит - значит, код не соответствует ожиданию!

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

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

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

Test Driven Development: как писать чистый код, который работает

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

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

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

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

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

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

Как подготовить проект к TDD

Создайте структуру проекта, соответствующую принципам TDD. Ключевой момент – четкое разделение кода на модули, которые можно тестировать независимо.

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

Пишем первый тест: от идеи к коду

Начните с простейшей функциональности. Представьте, что вы хотите проверить, умеет ли ваш код складывать два числа.

Шаг 1: Определите действие. Вы хотите, чтобы функция складывала два числа. Запишите это как описание ожидаемого поведения, например: "Функция `sum` должна возвращать сумму двух переданных аргументов."

Шаг 2: Обозначьте входные параметры. Какие данные функция принимает? Два числа (например, целые или вещественные).

Шаг 3: Определите ожидаемый результат. При каких входных данных будет какое значение? Пусть первый аргумент – 5, второй – 3. Ожидаемое значение – 8.

Шаг 4: Создайте тест. Используйте фреймворк для тестирования (например, pytest). В тесте опишите входные параметры и ожидаемый результат.

Пример (на Python с pytest):

import pytest
def sum(a, b):
return a + b
def test_sum():
assert sum(5, 3) == 8

В данном примере функция `test_sum` проверяет, что `sum(5, 3)` действительно возвращает 8. Тест должен быть кратким и прямолинейным.

Шаг 5: Запустите тест. Ошибка укажет, что ваш код не соответствует ожидаемому поведению.

Шаг 6 (если тест не пройден): Исправьте код, чтобы он соответствовал описанному ожидаемому результату. Напишите функцию `sum`, которая складывает два числа.

Ключ – в простоте каждого шага! Первый тест – это ясное описание действия, которое вы ожидали от вашего кода, и проверка его.

Создаем код, проходящий тест

Начните с формулирования ожидаемого поведения функции. Например, для функции сложения двух чисел: add(1, 2) == 3. Запишите это как тест (например, в виде утверждения).

Теперь напишите функцию add, которая удовлетворяет этому тесту. Если тест не проходит, функция не должна компилироваться. При этом, тестирующая среда покажет, что ожидаемое поведение не достигнуто.

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

Постепенно добавляйте новые тесты, отражающие различные сценарии использования: add(0, 0) == 0, add(-1, 2) == 1 и так далее. Это позволит удостовериться, что функция ведет себя корректно во всех случаях.

Важно: При добавлении нового функционала, сразу же создавайте тесты для проверки этого функционала. Тесты должны предшествовать написанию кода.

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

Разбираемся с ошибками тестов: отладка и исправление

1. Прочитайте сообщение об ошибке. Аккуратно изучите сообщение об ошибке. Оно содержит ключи к проблеме: ожидаемое значение, полученное значение, место в коде.

• Пример: "Ожидается 10, получено 5. Строка 25, метод calculateSum(2,8)."
• Действие: Откройте файл с методом calculateSum, сместите фокус на строку 25. Проверьте логику. Начните с простого воспроизведения ошибки в более простой конфигурации.

2. Изолируйте проблему. Сконцентрируйтесь не на всех тестах, а лишь на том, что не работает. Не придумывайте сложных теорий – сфокусируйтесь на коде. Это может быть выделение части кода в отдельный метод для тестирования.

1. Пример 1: Тест вычисления суммы не проходит. Выделите обработку входных значений в separateSum(x,y) для тестирования.
2. Пример 2: Многое работает, но результат обработки массива неверный. Изолируйте код для обработки массива в собственный метод.

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

• Пример: Если ожидается 20, а результат 15, есть вероятность проблемы в коде. Обдумайте корректность введённых данных.
• Действие: Проверьте данные, которые передаются в обработку, на правильность и соответствие формату.

4. Запустите отдельные тесты. Если проблема связана с несколькими связанными функциями, начните с тестирования отдельной функции, которая вызывает ошибку.

5. Рефакторинг. Исправьте ошибку, но не делайте нелогичного рефакторинга. Внесите минимальные изменения и протестируйте все ключевые сценарии.

6. Добавьте тестовый случай. Добавление тестов на граничные/краевые условия помогает определить потенциальные новые ошибки. Продумайте тесты, которые могут вызывать проблему или её усугублять.

Работа с различными типами тестов в TDD

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

• Тесты юзкейсов (User Stories):
• Конкретно моделируют использование Вашей функции/класса конечным пользователем.
• Примеры: регистрация пользователя, добавление товара в корзину. Целенаправленное воспроизведение реальных сценариев.
• Тесты граничных значений (Boundary Value Analysis)
• Проверяют поведение функции на критичных значениях, на границах допустимого диапазона входных данных. Например, минимальное, максимальное, нулевое значение.
• Обязательно включайте тесты на крайние ситуации:
1. Пустые или с нулевым значением входные данные
2. Входящие данные, близкие к границе диапазона
• Тесты на исключения (Error Handling):
• Проверяйте, что код корректно обрабатывает ошибки и не вызывает неожиданных исключений.
• Важный момент: проверяйте не только правильную реакцию на ошибку, но и корректную обработку исключительных ситуаций (возвращаемые значения, логгирование).
• Производительность (Performance):
• Установите метрики и тесты, измеряющие производительность кода.
• Например, время выполнения операций.
• Тесты на корректность ввода:
• Ваши тесты должны проверять, как метод обрабатывает неверный ввод (например, нецифровые данные).
• Предусмотрите как минимум один тест на корректный ввод, один на некорректный.

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

Поддерживаем качество кода в проекте: практические советы

Используйте линтеры. Например, для Python - Flake8, для JavaScript - ESLint. Отправляйте код на проверку с помощью линтеров в CI/CD. Это выявит стилистические и синтаксические ошибки сразу, предотвращая их накопление.

Регулярно выполняйте тесты. Не ждите, пока всё сломается. Запускайте тесты при коммитах. Используйте различные типы тестов: юнит-тесты, интеграционные, с нужным уровнем детализации. Чем раньше найдены баги, тем меньше проблем потом.

Следуйте соглашениям кодирования. Создайте style guide и придерживайтесь его. Это поможет проекту в дальнейшем, особенно при работе в команде. Использование стандартизированного стиля позволит легко понять код другим разработчикам, а также облегчить поддержку.

Делите код на модули или классы. Большие функции следует декомпозировать на меньшие, более простые. Каждый модуль/функция должна иметь чёткую ответственность.

Комментируйте код. Добавляйте комментарии к сложным участкам. Они объясняют ваш замысел, почему был выбран тот или иной подход. Комментарии должны быть понятными и актуальными.

Регулярно пересматривайте, рефакторьте и упрощайте код. Не позволяйте ему «заплесневеть». Периодическая ревизия кода поможет выявить потенциальные проблемы и улучшить логику. Если код не поддаётся изменениям, это может свидетельствовать о необходимости перестройки.

Вопрос-ответ:

Как TDD помогает избежать ошибок в коде на ранних стадиях разработки?

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

Нужно ли писать тесты для каждой строки кода? Или есть какие-то разумные исключения?

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

Как TDD помогает в написании более поддерживаемого кода?

TDD подталкивает писать код, который легко тестируется. Это улучшает его читаемость и структурированность. Коротко описываемый код проще понять и модифицировать в дальнейшем. В результате каждый модуль кода имеет своё независимое поведение, о котором свидетельствует написанный для него тест. Это существенно упрощает процесс модификаций: каждая часть кода рассматривается изолированно, что делает процесс поддержки простым и эффективным. Проработка каждого небольшого фрагмента гарантирует корректный и ожидаемый результат при дальнейшем введении изменений в программу.

Какие инструменты можно использовать для реализации TDD? И как выбрать подходящий?

Для реализации TDD есть множество инструментов, например, такие фреймворки тестирования, как JUnit для Java, pytest для Python или Mocha для JavaScript. Выбор инструмента зависит от того, какой язык программирования вы используете. Важно, чтобы инструмент поддерживал задачу: была возможность написать тест для кодовой логики и запустить его для проверки. Также, инструмент должен помогать в отслеживании результатов тестов, показывая корректность поведения кодовой базы по ходу разработки. Проверьте возможности инструмента по отношению к тестуемому языку и используемому стилю разработки.

Как начать использовать TDD, если у меня уже есть большая система кода?

Если у вас уже большая база кода, не нужно сразу тестировать все. Начните с небольших, критически важных фрагментов. Например, выберите функцию, которая часто вызывает ошибки или которую нужно изменить. Сначала напишите тест для этой функции, а затем реализуйте код, который проходит этот тест. Постепенно добавляйте тесты для других функций, особенно тех, которые взаимодействуют с новой частью кода. Помните — основной принцип TDD – проверить корректность малых фрагментов, постепенно расширяя проверку на большую часть системы. Постепенное внедрение TDD поможет сохранить стабильность программного обеспечения и сделает процесс модификаций более управляемым.