Сегодня в рамках рубрики «QA советы новичкам» мы поговорим о том, как правильно описывать шаги воспроизведения дефекта (бага).

Шаги воспроизведения – это информация, требуемая для воспроизведения дефекта. Они должны быть минимальными для повторения ошибки.

Основные правила описания шагов воспроизведения дефекта (бага):

Шаги для воспроизведения (англ. Steps to Reproduce, или STR) тесно связаны с вытекающим из них результатом (актуальный результат).

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

Обобщенно структура описания шагов выглядит так:

Как правило, при описании шагов воспроизведения необходимо отвечать на вопрос: «Что необходимо сделать?», при этом не указывать личностные обороты.

Например:

Шаги нужно указывать так, чтобы любой человек мог воспроизвести указанные действия, поэтому начинать стоит с самого важного действия, например:

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

Например:

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

Например, адрес тестовой версии такого сайта может выглядеть как https://www.rc.site.com/ или https://www.dev.site.com/ и тогда ссылка на production версию сайта в первом шаге может только запутать:

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

Само же окружение нужно указывать в поле «Environment» (Jira) или «Additional information» (Mantis) в виде:

Зарегистрированный или незарегистрированный пользователь

Если в приложении/окружении/веб-сайте был найден дефект после регистрации и входа под зарегистрированным пользователем, то информацию об этом лучше указывать во втором шаге:

При этом не нужно уточнять параметры доступа к реальным аккаунтам по следующим причинам:

• у разработчика должен быть ряд тестовых аккаунтов на каждом окружении;
• в 95% случаев дефект воспроизводится под разными тестовыми аккаунтами (очень редко требуется доступ к одному конкретному аккаунту);
• в 50% случаев дефект воспроизводится для зарегистрированного пользователя, но отсутствует для незарегистрированного (noname) пользователя.

Другие условия, влияющие на описание шагов воспроизведения дефекта

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

В таком случае первые шаги могут быть вынесены в блок «Предусловия», например:

Количество шагов воспроизведения

Правилом хорошего тона является описание достаточного количества шагов для полного воспроизведения дефекта. Для каждой тестируемой системы или веб-сайта количество пунктов в блоке «Шаги воспроизведения» может отличаться.

В большинстве случаев необходимо придерживаться минимального/максимального предела: от 2 шагов до 7-8 шагов воспроизведения дефекта.  

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

Например:

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

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