7 октября 2019
Качество проекта – это один из важных пунктов и требований, который хочет видеть любой владелец сайта. Вопрос качества очень важный, так как от этого зависит как долго будет работать проект без технического обслуживания, как сложно будет внедрить новый функционал и сколько на это понадобится времени.
Некачественное решение грозится такими распространенными проблемами как: риски безопасности, низкая производительность, потеря возможности обновления, сложность развития проекта и добавления нового функционала.
Для разрешения этих проблем в Битриксе встроен инструмент Монитор качества. Этот инструмент позволяет исправить подобные проблемы на ранних этапах, закрыть уязвимости и правильно настроить систему перед сдачей проекта заказчику.
Зачем нужен монитор качества?
Монитор качества – это набор тестов и необязательный этап при сдаче проекта в эксплуатацию. Инициатива по его прохождению в первую очередь должна быть со стороны разработчика, так как перед вводом в эксплуатацию необходимо проверить всю целостность проекта перед сдачей.
Преимущества для заказчика:
- Гарантии результата, так как выполнение тестов проводится по рекомендациям экспертов Битрикса.
- Снижение рисков – на ранних стадиях выявляются проблемы, поэтому в дальнейшем это не станет «сюрпризом».
- Наличие отчета по всем проведенным тестам. Результат теста сохраняется на сайте, а при вводе нового разработчика этот отчет может помочь ознакомится с тонкостями проекта.
Преимущества для разработчика:
- Снижение рисков при сдаче проекта. Перед внедрением проекта в эксплуатацию разработчик проводит тесты с целью самопроверки.
- Автоматизированные тесты вместо рутинной проверки. Часть тестов покрыта автоматизированными проверками. Благодаря этому разработчику не нужно вручную проверять те или иные параметры в системе.
- Возможность расширения тестов. Разработчик может дополнить свой набор тестов для конкретного проекта. Это может быть проверка кода на стиль кодирования, поиск ошибок в коде, проверка на заполненность SEO и т.п.
Стоит отметить, что монитор качества – это не замена системам авто-тестирования, для этого разработчики используют другой функционал. Качество создает даже не сам монитор, а процесс проверки по этому списку – это некий чек-лист, который помогает разработчику правильно закончить проект, проставить галочки, удалить лишние файлы и т.п.
Для примера возьмем управление самолетом. Перед взлетом, посадки и других маневров пилоты выполняют все действия по чек-листу. Этот список можно было заучить, но ошибиться может каждый, поэтому регламент принуждает выполнять все маневры по чек-листу.
Чек-лист при пилотировании самолета
Монитор качества используется не только при внедрении проекта в эксплуатацию. Он может быть использован для проверки работы сайта после релиза сложных доработок, при получении проекта новым разработчиком, дабы удостовериться, что проект соответствует требованиям платформы и даже для в процессе отладки проекта.
Существуют также проблемы и недостатки использования монитора качества:
- Разработчик может сделать тесты «спустя рукава», не проделывая работу, указанную в рекомендациях. Тесты монитора качества – это всего лишь чек-лист, по которому разработчик проверяет себя. Так что все ложится на совесть разработчика.
- Монитор качества не затрагивает всех аспектов системы. В списке тестов отображаются только важные тесты по мнению экспертов Битрикс. Если необходимы дополнительные тесты – их может добавить разработчик.
В хороших руках монитор качества – это гарантия того, что проект пройдет все проверки и снизит риски появления проблем в процессе эксплуатации.
Содержимое монитора
Монитор включает в себя 14 тематических проверок и состоит из 65 тестов.
Тесты разделены на 5 основных блоков:
- Интеграция дизайна и разработка.
- Безопасность.
- Производительность.
- Размещение на хостинге.
- Сдача проекта.
Часть тестов выполняется в автоматическом режиме, остальная часть – заполняется вручную разработчиком. Ручное заполнение требует обязательного внесения комментария с обоснованием решением.
Важность заполнения комментария
Также тесты разделяются на обязательные и необязательные. Обязательные тесты (помечены черным) определяют качество проекта и критические места системы. Без них проект не может быть сдан. Необязательные тесты (помечены серым) – зависят от самого проекта и требований к нему. По желанию они могут быть пропущены, если проект небольшой и не нагруженный.
Обязательные и необязательные тесты
Каждый тест содержит рекомендации экспертов для выполнения качественной настройки проекта. Поэтому выполнение монитора качества перед сдачей проекта заказчику и внедрения его в эксплуатацию поможет привести проект в порядок и исправить основные проблемы.
Рекомендации от экспертов
Процесс прохождения тестов
Для прохождения монитора качества необходимо перейти на страницу Настройки / Инструменты / Монитор качества и нажать кнопку Начать тестирование.
После запуска система проходит автоматизированные тесты. Остальные тесты нужно пройти вручную. Необязательные тесты – могут быть пропущены в зависимости от сложности проекта.
Монитор качества
При клике по названию теста открывается детальная форма теста. Если тест заполняется вручную – то здесь нужно ввести комментарий и поставить статус Пройдено или Пропущен вручную.
Статус теста заполняется в зависимости от теста – если тематика теста не соответствует вашему проекту, то ему проставляется статус Пропустить и вносится комментарий. Например, «Эта настройка не предусмотрена ТЗ».
При выполнении монитора качества важна аргументированность в каждом из тестов. Это дополняет отчет подробностями о том, как работает проект и где имеются проблемы. Поэтому стоит серьезно относится к полю Комментарий.
Если тест выполняется автоматически, но при этом выдает ошибки при срабатывании – его можно перепройти заново или проставить Пройдено вручную с аргументацией своей позиции. Например, ложное срабатывание теста на часть кода компонента.
Детальная теста
У автоматических тестов есть кнопка Подробный отчет. По нажатию на нее вы увидите результат прохождения теста. Здесь описывается проблема из-за которой тест не может быть пройден.
Подробный отчет
По итогу тестирования выдаются результаты тестирования. Пока обязательные тесты не будут выполнены – монитор качества не будет пройден.
Результаты тестирования
Когда тест будет пройден – в списке проектов появится отчет, который при желании можно открыть с помощью ссылки Подробности. Отчеты не удаляются, но переходят в архив, чтобы их отобразить – установите галочку Показывать старые.
Завершенные тесты
Вот так выглядит пройденный монитор качества:
Пройденный монитор качества
Модификация тестов
При желании разработчик может самостоятельно добавлять новые разделы и тесты в Монитор качества. Для этого используется обработчик события главного модуля – onCheckListGet.
В коде обработчика onCheckListGet описывается новая категория и тесты, которые нужно включить, также указывается класс и метод, который будет возвращать текст и статус теста.
Пример добавления теста на проверку файла test.php в корне сайта
Качество – превыше всего
Монитор качества – чек-лист разработчика, используемый при внедрении проекта в эксплуатацию. Тесты не могут покрыть весь проект в целом, но затрагивают важные части системы, на которые нужно обращать особое внимание.
Хорошая практика для разработчиков – всегда использовать монитор качества при внедрении и дополнять набор тестов. Это может происходить в результате ретроспективы команды или анализа частых проблем внедрения.
Для владельца сайта важны результаты пройденного тестирования. Проходить тестирование за разработчиком – имеет мало смысла, так как разработчик знает о проекте больше, в процессе проверок он самостоятельно проверяет и вносит все тонкости работы в комментариях тестов.
