TDD: разумно ли ставить ID тесту и помечать им тестируемый участок кода?

Оторвался от учебника по TDD и начал ходить на костылях. Как ни странно, но получается. Хотя, и очень медленно.

В связи с этим такая шальная мысль мелькнула в голове:
1. Берем генератор случайных чисел и генерируем строку, скажем, из 5 символов. Это будет ID.
2. К тесту в комментарии пишем этот ID.
3. И когда будем писать код непосредственно самого проекта, тоже помечаем участок этим ID.

Вообще-то говоря, так люди не пишут. Т.е. все проекты, которые я видел, написаны не так.
И в учебниках нам говорят - ты пиши код читабельным, и будет тебе хорошо.

Но, с другой стороны, я не видел ни одного проекта, сделанного по TDD.
Мне кажется, засмеют.

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

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

0

Сообщение от Kifsif Вообще, я подозреваю, что это идея не очень хорошая.

Согласен, идея бредовая.

Название теста должно отображать что он тестирует и как. Ещё желательно, чтобы иерархия исходных кодов тестов повторяла иерархию исходников тестируемого приложения. Тогда не возникнет вопросов, где искать тестируемый код. Да и без этого все современные IDE умеют выполнять поиск по названию класса/метода/переменной.

0

Не знаю, не знаю. Я не считаю эту идею бредовой. Уж чем-чем, а бредом ее назвать не могу. Почему же она бредовая?
Повышает читаемость кода? Да, повышает.
Быстро реализуема? Да, быстрее, чем развернутый комментарий к тесту.
Удобно? Возможно, никто просто не пробовал.

Вот возьмем, например, в веб-разработке подключение готового модуля. Ну, например, авторизации и регистрации пользователя.
Чтобы интегрировать этот модуль, надо эту интеграцию покрыть тестами.

Ну, самое простое - а вернет ли http-код 200 при запросе страницы регистрации.

Пишем тест с именем test_account_register_status_200.

Он, конечно, упадет в ошибку. А вот чтобы тест прошел, надо уже в нескольких местах подшурупить. Во-первых, модуль зарегистрировать, во-вторых, шаблон создать, в третьих указать путь до папки с шаблонами.

Вот три места.

Когда с нуля пишешь, можно по чуть-чуть идти. А когда тебе бульдозер подвез гору готового кода, тут, знаете ли, можно подумать уже и о прояснении того, что кроется за возвращаемым кодом 200.

В общем, бредом как-то я эту идею бы не назвал. А вот с реализацией, не знаю. Я пока не применяю.

0

Kifsif, таки это ерунда полная. Идентификатором теста покрывающего некоторый участок кода будет комбинация имени тестируемого класса с суффиксом "Test" и именем метода отражающим тестируемый метод и логику тестирования. И этого достаточно. И не нужны никакие пятизначные ID в комментариях.

Сообщение от Kifsif Когда с нуля пишешь, можно по чуть-чуть идти. А когда тебе бульдозер подвез гору готового кода, тут, знаете ли, можно подумать уже и о прояснении того, что кроется за возвращаемым кодом 200.

А это вообще о чём? Как тебе какие-то идентификаторы помогут разобраться в унаследованном коде?

Добавлено через 3 минуты

Сообщение от Kifsif Повышает читаемость кода? Да, повышает.

Т.е. строка вида //54395 разом прояснит что-то в коде? Предлагаешь по всему проекту поиск делать, чтобы разобрать что значит это число?

0

Ну, вот подключаю я модуль для регистрации юзера.

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

В тесте в регистрационной форме с помощью библиотеки Selenium заполнил все поля и нажал "Зарегистрировать".
И тест у меня должен проверить, оказался ли я редиректом на странице с сообщением о регистрации.

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

Начинаю тест выполнять. И получаю всякие сообщения.

Сначала орет: у тебя нет защиты от CSRF, иди, пропиши тег. Прописываю.
Потом он орет: у тебя не заданы установки, сколько дней действительна ссылка для активации. Иду, правлю.
Потом он орет: не могу отправить е-мейл. Иду, задаю установки для отправки е-мейла.
Потом орет: нет шаблона для заголовка е-мейла. Делаю шаблон.
Потом: нет шаблона для текста е-мейла. Делаю шаблон.
Потом: нет шаблона для самой страницы уведомления о том, что регистрацию мы сделали, теперь пора активировать.

Итого, в 6 местах, если не ошибаюсь я ради этого внес правки.

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

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

Так что тут речь не о том, что можно обойтись юнит-тестом для метода.

И вообще, есть стили разработки, принятые в компаниях. Может быть принято писать номер инцидента по багтрекеру. Т.е. когда правишь код, пишешь этот ID в каждом месте, где правил.

Так что от написания ID к куску кода никто в обморок не падает. Ну, а тут будет написан ID в шести местах, проблем особых нет - глобальный поиск по всему проекту найдет их все довольно быстро.

Чем плохо? Ну, менеджер проекта, если имеет квалификацию и сунет нос, увидит, конечно, что ты что-то писал без тестов. Может наругать. Но для проекта-то это все равно - по крайней мере - не ухудшает качество кода. А улучшить может.

0

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

Сообщение от Kifsif Т.е. когда правишь код, пишешь этот ID в каждом месте, где правил.

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

1

А где в первом посте про юнит-тесты?
Там просто про тесты. А по умной книжке первым тестом пишется функциональный тест. Потом, правда, написано, что надо помаленьку двигаться и юнит-тестами покрывать каждый шажок.

А тут-то юнит-тесты зачем? Модуль чужой. Надо просто проверить, хорошо ли он интегрировался с твоим проектом. Так что функционального достаточно. Мне так кажется. Я не претендую на истину.

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

Так что кого обременит идентификатор теста?

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

0

Сообщение от Kifsif А где в первом посте про юнит-тесты?

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

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

0

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

А если не секрет, ты плотно покрываешь код тестами? Просто чтобы понять уровень беседы. А то мало ли, вдруг ты вообще тесты не практикуешь.

0

Сообщение от Kifsif А если не секрет, ты плотно покрываешь код тестами?

Нет, я покрываю тестами только сложную логику ошибки в которой будет сложно увидеть при испытаниях софта. Весь код покрыть тестами - никакого времени не хватит, а, между тем, многое могут увидеть/отловить тестировщики. Так получается намного быстрее. Но это практика в моей фирме такая. Другие жители форума могут работать по другой схеме.

2

Спасибо за беседу.

0