Подготовка отчета об ошибках

Отчеты об ошибках (на англ. «Bug
Report»)– это основной
материальный продукт тестирования,
надежная техническая документация,
которая описывает вид ошибки в тестируемой
системе.

Для упрощения организации взаимодействия
групп и общего централизованного
хранения отчетов об ошибках следует
использовать системы отслеживания
ошибок (на англ. «bug tracking»).
Это позволяет иметь единое хранилище
ошибок, отслеживать их повторное
появление, контролировать скорость и
эффективность исправления ошибок,
видеть наиболее нестабильные компоненты
системы, а также поддерживать связь
между группой разработчиков и группой
тестирования (уведомления об изменениях
по почте и т.п.). Чем больше проект, тем
сильнее потребность в централизованном
хранилище дефектов.

Пример одной из свободных систем
отслеживания ошибок с веб-интерфейсом.
является Bugzilla (разработка
компании Mozilla). Данная
система очень проста и популярна в
использовании [10].

Подобная
система обеспечивает следующие функции:

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

• система
  уведомления о появлении новых ошибок,
  об изменении статуса известных в системе
  ошибок (как правило, это уведомления
  по электронной почте);

• отчеты
  об актуальных ошибках по компонентам
  системы, по интервалам времени, по
  группам разработчиков и разработчикам;

• информация
  об истории ошибки (в том числе отслеживание
  похожих ошибок, отслеживание повторного
  возникновения ошибки);

• правила
  доступа к ошибкам тех или иных категорий;

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

Существуют основные виды продвижения
ошибки (на англ. «bug») по
системе (на англ. «Defect
flow»)(см. рисунок 6).

Рисунок 6 — Defect
flow

При поступление ошибки в систему, из
любого источника (заказчик, разработчик,
тестировщик), баг принимает статус new
(пер. с англ. «новый»). Затем рассматривается
программистом его описание и: или ошибка
решается (на англ. «resolve»)
или ей ставится статус duplicated
(пер. с англ. «дубль»), что означает, что
данная ошибка уже была и на данном этапе
решается, или же ей ставится статус
invalid (пер. с англ.
«необоснованный»)- неверное описание,
такой ошибки не существует. После всего
этого командой тестировщиков данная
ошибка перепроверяется и закрывается
(на англ. «verify») в случае,
если она больше не повторяется, или
переоткрывается (на англ. «reopen»), если
изменения все равно приводят к ошибке.

В отчете об ошибки необходимо соблюдать
некоторые правила:

1. В отчете должна быть с самого начала
понятна суть ошибки.

2.Должны быть четко понятны шаги
воспроизведения.

3.Должен быть известен альтернативный
правильный вариант поведения.

4. Указана версия и приоритет данной
ошибки.

Соседние файлы в предмете [НЕСОРТИРОВАННОЕ]

• #
• #
• #
• #
• #
• #
• #
• #
• #
• #
• #

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

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

Почему важно сообщать об ошибках и кто это делает

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

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

Тестировщиком реально стать даже без опыта в IT. Для этого пройдите курс Skypro «Инженер по тестированию». Научитесь писать тестовую документацию и составлять отчеты, тестировать веб- и мобильные приложения и API, освоите нужные инструменты. Внутри — мастер-классы с реальными рабочими задачами, домашки и разборы от наставника. Создадите четыре проекта для портфолио и получите диплом гособразца.

Основные принципы

Правильные отчеты помогают программистам быстрее исправлять ошибки. Детали зависят от типа багов. Но есть несколько основных принципов — что и как включать в баг-репорт, чтобы заранее снять вопросы разработчиков.

Указывайте:

1️⃣ Только одну ошибку на отчет. Это золотое правило, потому что так гораздо проще исправлять баги. Легче отслеживать статус отдельных отчетов и выставлять приоритеты задач, распределять работу между несколькими разработчиками. Да и меньшее количество информации проще запомнить и проанализировать.

2️⃣ Место интерфейса программного обеспечения, в котором возникла ошибка. Опишите экран, на котором находитесь, состояние интерфейса. Включите URL-адрес страницы, если это веб-приложение.

3️⃣ Действия в программе. Пошагово опишите действия, которые выполняли перед тем, как столкнулись с ошибкой. Это важно: может оказаться, что некорректное поведение программы началось до того, как вы его заметили.

4️⃣ Ожидания. Поведение программы может быть некорректным с точки зрения общей логики или вашего личного опыта — указывайте не только очевидные отказы выполнения и неверные результаты вычислений. Программы создают, чтобы облегчить пользователям жизнь, а не заставлять их подстраиваться под готовый результат.

5️⃣ Скриншот или запись экрана с ошибкой. Есть риск ошибиться, когда пишешь отчет об ошибке. Это значительно усложнит работу команды разработки. Визуальные материалы — более точный способ указать на проблему, чем просто описать ее.

6️⃣ Техническую информацию. То есть вашу операционную систему, браузер, тип устройства — персональный компьютер, мобильный телефон или планшет. А еще тип устройства ввода — клавиатуру, мышь, сенсорный экран и прочее. Будут полезны и параметры монитора, чтобы исправить ошибки в отображении пользовательского интерфейса.

7️⃣ Все сообщения об ошибках и коды. Они помогут определить, что это за ошибка и как ее устранить. Показывайте и те сообщения, которые кажутся нерелевантными. Даже они могут помочь разобраться в проблеме.

8️⃣ Можете ли вы воспроизвести проблему. То есть происходит ли одно и то же каждый раз, когда вы пытаетесь выполнить задачу. Эта информация поможет разработчику найти причину ошибки.

9️⃣ Пробовали ли исправить проблему. Есть причина, по которой айтишник всегда спрашивает: «Вы пробовали выключить и снова включить?» или «Пытались ли обновить веб-страницу?». Перезагрузка может быть простым способом исправить проблему. Если она не исчезает — это дает много информации. Укажите, и это сэкономит время на последующее обсуждение проблемы.

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

Основные элементы

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

Обычно программисты и тестировщики договариваются, что и как указывать. Еще на это влияет система, в которой готовят отчет. Но есть общие компоненты баг-репорта:

👉 Резюме — краткое обозначение проблемы, причина и тип ошибки.

👉 Описание — подробности и любые сведения, которые помогут локализовать и исправить ошибку.

👉 Вложения — любые визуальные или другие материалы.

👉 Срок выполнения — если важно, чтобы ошибку исправили к определенной дате.

👉 Критичность — комментарий, насколько баг мешает нормальной работе приложения.

Часто выделяют следующие уровни критичности ошибок:

☝ Блокирующий (Blocker) — полностью блокирует нормальную работу программы, нужно исправить как можно быстрее.

☝ Критический (Critical) — сильно искажает логику приложения и значительно осложняет работу с ним.

☝ Значительный (Major) — затрагивает только отдельные элементы программы, существенно мешает работать.

☝ Незначительный (Minor) — либо не сильно влияет на работу программы, либо проявляется редко.

☝ Тривиальный (Trivial) — относится к визуальным недочетам в интерфейсе: опечатки, неудобные цвета и прочее.

Жизненный цикл

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

💡 Новый — только создан, ждет проверки разработчиком.

💡 Принят — отчет проверили, проблему подтвердили.

💡 Отклонен — отчет проверили, но команда разработки отказалась работать по нему. Например, потому что ошибку не удалось повторить. Или то, что показалось ошибкой, — нормальное поведение программы. Или проблему уже устранили, когда работали над другим отчетом.

💡 Назначен — ошибку передали исполнителю.

💡 В работе — разработчик исправляет ошибку.

💡 Проверяется — исполнитель закончил работу, результат проверяет старший специалист.

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

Системы для отчетов об ошибках

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

Такие программы называют баг-трекерами. Чаще всего они — часть более сложных систем: управления проектами или исходным кодом приложения.

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

К наиболее распространенным системам управления проектами относят:

• Jira.
• YouTrack.
• Redmine.

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

К основным системам управления исходным кодом относят:

• GitHub.
• GitLab.
• Bitbucket.

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

✔️ форма создания отчета об ошибке с полями для ввода основных элементов;

✔️ управление состоянием и параметрами;

✔️ форма обсуждения, в которой команда задает вопросы и оставляет комментарии, указывает дополнительные детали;

✔️ уведомление об изменениях через имейл или другую систему обмена сообщениями.

У части баг-трекеров есть публичное голосование. Пользователи голосуют за или против бага: так повышают или понижают его приоритет.

Главное

• Баг-репорт — специальный вид отчета о неисправности в программном обеспечении или веб-сайте. Баг-репорт готовят тестировщики или специалисты из команды по контролю качества.
• Оформление баг-репорта сильно влияет на скорость, с которой исправят ошибки, на итоговый результат. Указывайте причину и тип ошибки, подробности, срок выполнения, критичность. Прикладывайте скриншоты или запись экрана.
• Прописывайте, пробовали ли исправить проблему, насколько она влияет на работу. Указывайте операционную систему, браузер, тип устройства, параметры монитора.
• Есть системы, с которыми проще создавать баг-репорты и управлять ими. Основные: Jira, YouTrack, Redmine, GitHub, GitLab, Bitbucket.

Служба Windows Error Reporting

Область применения

Это тема уровня 300 (умеренно продвинутая).
Полный список тем в этой статье см. в разделе Устранение ошибок при обновлении до Windows 10.

Если установка Windows не выполняется, коды результата и расширения регистрируются в качестве информационного события в журнале приложений отчетов об ошибках Windows как событие 1001. Имя события: WinSetupDiag02. Для просмотра этого события можно использовать средство просмотра событий либо Windows PowerShell.

Чтобы использовать Windows PowerShell, введите следующие команды в командной строке Windows PowerShell с повышенными привилегиями:

Следующий источник будет доступен только в том случае, если вы обновили предыдущую версию Windows 10 новой версии. Если установлена текущая версия и не обновлена, источник с именем WinSetupDiag02 будет недоступен.

Использование просмотра событий:

Примечание. В старых операционных системах имя события было WinSetupDiag01.

В событии указаны десять параметров.

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

Источник

Журнал отчета об ошибках виндовс 10

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

Статья будет построена на примере windows 10, но данная функция доступна и в более ранних версиях windows.

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

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

Подготовка к просмотру журнала ошибок

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

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

Если журнал ошибок отключен то дважды кликнете по нему и запустите его, в графе тип запуска выберите автоматически. Затем применить и ОК.

Перед просмотром журнала ошибок

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

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

Смотрим журнал ошибок и подробности ошибки

Открываем панель управления, в панели управления выбираем мелкие значки, затем пункт Администрирование и далее Просмотр событий.

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

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

Главное не торопиться, все проанализировать и используя наш могучий «инструмент» Интернет, принять правильное решение.

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

Источник

Журнал событий в Windows: как его открыть и найти информацию об ошибке

Доброго дня!

Разумеется, в некоторых случаях эти записи могут быть очень полезными. Например, при поиске причин возникновения ошибок, синих экранов, внезапных перезагрузок и т.д. Отмечу, что если у вас установлена не официальная версия Windows — может так стать, что журналы у вас отключены. 😢

В общем, в этой заметке покажу азы работы с журналами событий в Windows (например, как найти ошибку и ее код, что несомненно поможет в диагностике).

Работа с журналом событий (для начинающих)

Как его открыть

Этот вариант универсальный и работает во всех современных версиях ОС Windows.

eventvwr — команда для вызова журнала событий

Система и безопасность

Просмотр событий — Администрирование

Актуально для пользователей Windows 10/11.

1) Нажать по значку с «лупой» на панели задач, в поисковую строку написать «событий» и в результатах поиска ОС Windows предоставит вам ссылку на журнал (см. скрин ниже). 👇

Windows 10 — события

2) Еще один способ: нажать сочетание Win+X — появится меню со ссылками на основные инструменты, среди которых будет и журнал событий.

Журналы Windows

Наибольшую пользу (по крайней мере, для начинающих пользователей) представляет раздел «Журналы Windows» (выделен на скрине выше). Довольно часто при различных неполадках приходится изучать как раз его.

В нем есть 5 вкладок, из которых 3 основных: «Приложение», «Безопасность», «Система». Именно о них пару слов подробнее:

Как найти и просмотреть ошибки (в т.ч. критические)

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

Система — фильтр текущего журнала / Кликабельно

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

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

Например, на своем подопытном компьютере я нашел ошибку из-за которой он перезагрузился (благодаря коду ошибки и ее подробному описанию — можно найти решение на сайте Microsoft).

Представлены все ошибки по дате и времени их возникновения / Кликабельно

Т.е. как видите из примера — использование журнала событий очень даже помогает в решении самых разных проблем с ПК.

Можно ли отключить журналы событий

Можно! Только нужно ли? (хотя не могу не отметить, что многие считают, что на этом можно сэкономить толику дискового пространства, плюс система более отзывчива и меньше нагрузка на жесткий диск)

Для отключения журналов событий нужно:

Службы — журналы событий

Источник

Журнал ошибок Windows 10 — как посмотреть отчет

При работе с ОС Windows 10 у пользователей могут возникать аппаратные и программные сбои. Чтобы владельцы персонального компьютера смогли узнать, из-за чего произошли неполадки, разработчиками был создан специальный журнал ошибок Windows 10. В нем фиксируется история ошибок и сбоев, а также источник их возникновения. Зайти в журнал можно с помощью штатных инструментов ОС: командной строки или панели управления. Таким образом, многие пользователи спрашивают, как посмотреть логи в Windows 10?

Журнал событий Windows 10 — что это такое и для чего нужен

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

Журнал событий Виндовс

Благодаря анализу сборщика событий можно узнать причины неправильной работы ОС. Для качественной диагностики персонального компьютера предусмотрено несколько логов: «Приложения», «Установка», «Безопасность» и «Параметры ОС». В каждом из них регистрируются код сбоя, дата и время, а также поврежденные файлы, которые вызывают ошибку.

Какие отчеты можно посмотреть в сборщике системных событий:

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

В журнале событий содержится информация обо всех сбоях

Как открыть журнал, посмотреть ошибки и где он находится

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

Чтобы владелец персонального компьютера смог проверить отчеты, необходимо воспользоваться специальной штатной утилитой «eventvwr». Только с помощью данной утилиты можно осуществить просмотр отчетов и узнавать из-за чего произошли неполадки.

К сведению! Открыть файлы с расширением «EVTX» с помощью встроенного текстового редактора невозможно.

При помощи консоли

Открыть журнал сборщика событий можно с помощью консоли системной отладки – PowerShell:

Открытие сборщика производится с помощью PowerShell

Через панель управления

Посмотреть логи в Windows 10 можно через классическую панель управления и сделать это можно следующим образом:

Функция поиска через меню «Пуск»

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

Где и что находится в просмотре событий

Многие спрашивают, как посмотреть ошибки в Windows 10 и что находится в журнале. Вот ответ на последний вопрос:

Полный отчет о произошедшем сбое, который поможет установить причину неправильной работы ОС

Анализ журнала ошибок

Как анализировать журнал ошибок в ОС Виндовс 10:

Использование фильтров и настраиваемых представлений

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

Фильтры представлений помогут получать только важные отчеты

Как почистить журнал событий

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

Очистка журнала производится через консоль PowerShell

Журнал событий Windows 10 позволяет пользователям персональных компьютеров получить информацию обо всех критически важных системных событиях. С его помощью можно устранить неполадки в работе программного обеспечения и системных компонентов. Открыть журнал можно с помощью консоли отладки или стартового меню. Чтобы получать только важные уведомления, следует настраивать фильтры представлений.

Источник

Где и как посмотреть журнал ошибок Windows 10

Часто бывает, что компьютер без видимых причин перезагружается, зависает, перестает работать. Если на нем установлена современная операционная система, такая как Windows 10, можно легко выяснить причину неполадок. Для этого необходимо знать, как посмотреть ошибки Windows 10 и что они означают.

Что такое Журнал событий и для чего он нужен

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

Как открыть журнал и посмотреть ошибки

Существует несколько способов, как открыть журнал событий.

Панель управления

Консоль Выполнить

Одновременно нажать клавиши «Win» и «R» и во всплывающем окне строки «Открыть» ввести eventvwr.msc и нажать Ввод.

Меню Пуск

Нажать правой кнопкой мыши на «Пуск» и выбрать во всплывающем списке «Выполнить», ввести eventvwr.msc и нажать ввод.

Поиск Виндовс 10

Ввести в меню поиска Windows 10 фразу «Просмотр событий» или «Журнал» и нажать Ввод.

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

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

Можно также воспользоваться журналами событий Windows 10, меню которых находится в левой колонке программы «Просмотр событий». Здесь доступны журналы приложений, безопасности и системы. Последний как раз и содержит сведения о наиболее важных сбоях, происходящих в системе, например о проблемах в работе драйверов, системных программ и другие важные сведения.

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

Заключение

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

Источник

Отображение ошибок

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

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

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

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

Сообщение об ошибке

Сообщение об ошибке содержит иконку, соответствующую категории ошибки, текст, а также может содержать ссылку для формирования отчета об ошибке.

Декларативная настройка текста сообщения об ошибке

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

Отчет об ошибке

Сообщение об ошибке может содержать ссылку для автоматического формирования отчета об ошибке. Доступно как интерактивное, так и программное формирование отчета. Программно можно добавлять в отчет свои вложения и объекты. Отчет об ошибке можно сохранить на диск или отправить в сервис регистрации ошибок.

Сервис регистрации ошибок

Сервис регистрации ошибок — внешний по отношению к платформе компонент, представляющий собой набор НТТР-сервисов с определенными интерфейсами. Он может быть реализован с помощью любой подходящей технологии. Например, это может быть информационная база «1С:Предприятия» с набором HTTP-сервисов.

Чтобы упростить работу тестировщикам и программистам, был разработан и стандартизирован отчет о дефектах. С одной стороны его задача — быть простым и понятным, а с другой стороны — быть эффективным.

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

Шаблон отчета о дефекте, который отвечает запросам тестировщика и программиста, выглядит следующим образом:
1. Заголовок ошибки
2. Описание ошибки
3. Начальные условия
4. Шаги воспроизведения
5. Ожидаемый результат
6. Фактический результат
7. Вложения

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

Теперь рассмотрим структуру шаблона подробно на конкретном примере. Допустим, мы тестируем сайт. На сайт есть раздел Контакты. В этом разделе находится Форма обратной связи.

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

Данный баг мы и будем описывать по шаблону.

Заголовок ошибки (Title)

По сути это краткое описание найденной ошибки. Его задача — в понятной и простой форме передать смысл найденной ошибки.

Наиболее эффективным описанием считается описание, которое отвечает на три вопроса:
— Что произошло?
— Где появилась ошибка?
— Когда или при каких условиях найден дефект?

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

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

Пример плохого заголовка: Ошибка, когда нажимаю «Отправить сообщение».
Пример хорошего заголовка: При нажатии на кнопку «Отправить сообщение» в форме обратной связи сообщение не отправляется.

Описание ошибки (Summary)

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

Правильное и качественное описание также позволяет сразу понять проблему и приступить к ее исправлению.

Пример плохого описания: Жму «Отправить сообщение», а в ответ тишина.
Пример хорошего описания: При нажатии на кнопку «Отправить сообщение» в заполненной форме обратной связи ничего не происходит. Аналогичное поведение, если форма не заполнена.

Начальные условия (Precondition)

В случае, если есть специфичные действия или шаги воспроизведения достаточно объемные, то указываются начальные условия. Например:
1. Быть авторизованным в системе.
2. Находиться на главной странице.

Пример плохих начальных условий: Находиться на сайте.
Пример хороших начальных условий:
1. Страница «Контакты»,
2. Платформа и устройство не имеют значения.

Шаги воспроизведения (Steps To Reproduce)

Шаги, при которых повторяется найденная ошибка. Например:
1. Нажать на кнопку “Войти”
2. Ввести “Имя пользователя” и “Пароль”
3. Нажать на кнопку “Ок”

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

Пример плохих шагов: 1. Зайти на сайт, 2. Зайти на страницу обратной связи, 3. Поставить курсор в поле Имя, 4. Ввести имя, 5. Поставить курсор в поле e-mail, 6. Ввести действующий e-mail, 7. Навести курсор на Отправить сообщение, 8. Щелкнуть по Отправить сообщение.
Пример хороших шагов:
1. Заполнить поля формы обратной связи,
2. Нажать на копку «Отправить сообщение»

Ожидаемый результат (Expected Result)

Результат, который должен быть при выполнении шагов. В идеале, его можно найти в ТЗ (техническом задании). На практике, ТЗ бывает не всегда и ожидаемый результат определяется либо здравым смыслом, либо по аналогии.

Пример плохого ожидаемого результата: Что-то должно произойти.
Пример хорошего ожидаемого результата: Сообщение отправляется либо система сообщает о невозможности его отправки.

Фактический результат (Actual Result)

Указывается результат, который получил тестировщик при выполнении описанных шагов. Также может отвечать на три вопроса “Что? Где? Когда?”.

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

Вложения (Attachments)

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

Оригинал:

«Ubuntu Hacks: Chapter 1 — Getting Started»

Авторы: Кайл Ранкин, Джонатан Оксер, Билл Чайлдерс (Kyle Rankin, Jonathan Oxer, Bill Childers)

Дата публикации: June 2006

Перевод: Н.Ромоданов

Дата перевода: июль 2010 г.

Совет # 12: Подготовка отчета об ошибках

Во всех программах есть ошибки и Ubuntu не является исключением. Ниже описывается, как вы можете помочь улучшить Ubuntu, отсылая свои отчеты об ошибках

Это печальное правило компьютерного мира: все программы содержат ошибки. Разработчики Ubuntu и сотрудники фирмы Canonical сделали все возможное, чтобы в последней версии Ubuntu свести к минимуму количество ошибок и их последствий, но они не всесильны. Впрочем, одно из основных преимуществ открытого ПО в том, что у вас есть возможность, сообщив об ошибке, помочь улучшить программное обеспечение. Процесс подачи сообщения об ошибке удивительно прост, и, несмотря на название, может оказаться довольно интересным интерактивным процессом

Подготавливаем отчет об ошибках

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

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

Создаем учетную запись для Malone

Подача отчета об ошибке в Ubuntu осуществляется через приложение с веб интерфейсом, которое называется Malone (см.рис. 1-11). Malone является частью сервиса Launchpad
(https://launchpad.net/malone/), а по сравнению с другими другими системами багтреккинга (bugtrackers) уникальная особенность Malone состоит в том, что с его помощью отслеживаются не только ошибки в Ubuntu, но и ошибки в других дистрибутивах. Это позволит воспользоваться еще одним преимуществом, которое дает программное обеспечение с открытым кодом: чем больше глаз, тем проще ошибка. Если кратко, то это означает, что если в одном из дистрибутивов локализована и исправлена ошибка, во всех остальные дистрибутивы, для которых используется сервис Malone, также видно, где нужно внести исправление — преимущество получают все.

Рис.1-11. Ваш первый визит на сайт Malone

При первом вашем посещении сайта Malone вам следует создать свою собственную учетную запись для того, чтобы вы могли вносить в базу данных записи. Просто щелкните по ссылке Log In/Register («Войти/ Регистрация»), которая находится в верхнем правом углу, и следуйте инструкциям по регистрации учетной записи.

Подсказка

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

Поиск вашей ошибки

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

К тому же, если вы видите сообщение об ошибке, которая похожа на вашу ошибку, вы можете добавить свои комментарии и информацию, относящуюся к этой ошибке. Это позволит подтвердить сообщение об ошибке и пусть разработчики знают, что эта проблема возникла у нескольких пользователей. Для разработчиков нет ничего ужаснее, чем получать повторные сообщения об ошибках (да, это так, но не только; малоинформативные сообщения об ошибках — это еще хуже!)

На рисунке 1-12, мы ищем запись об ошибке, относящуюся к пакету gnome-power-manager и с которой нам пришлось столкнуться. Так случилось, что была обнаружена ранее уже известная ошибка и разработчик ждет информации. Мы смогли добавить наши собственные комментарии к ошибке и предоставить разработчику немного информации, которую он искал. Вот так действует открытый код!

Рис.1-12. Поиск ошибки

Заполняем ваш отчет об ошибке

Если вашей ошибки до сих пор нет в базе данных, то самое время сообщить о ней. Войдите в Malone, если вы этого еще не сделали, и перейдите к странице «Report a bug about a package» — «Сообщение об ошибке в пакете» (https://launchpad.net/malone/bugs/+package). Выберите в выпадающем меню Ubuntu и введите имя пакета в соответствующем поле. Далее введите краткое описание ошибки. Вы должны быть маскимально информативными. Не пишите, «gnome-power-manager is broken» — «Пакет gnome-power-manage не работает» или, хуже того, «battery icon doesn’t work» — «не работает иконка батареи». Любой из этих двух вариантов резюме послужит причиной отклонения вашего отчета об ошибке. Более уместная запись должна быть следующей: «gnome-power-manager icon does not show AC power status» – «иконка gnome-power-manager не отображает статус питания от сети переменного тока».

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

После того как вы это сделаете, вы можете отправить сообщение об ошибке, нажав для этого на кнопку Add («Добавить»). На сайте есть возможность возвести флажок, указывающий, что информация конфиденциальная, таким образом, вы можете поставить отметку о конфиденциальности в случае, если есть потенциальный риск, что описание этой ошибки несет угрозу безопасности. Впрочем, в 99,9 % случаев ошибка не повлечет за собой угрозу безопасности, и вы можете спокойно оставить этот флажок сброшенным.

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