Управление ошибками с&nb p;помощью FlySpray

Создание превосходного кода — это задача-максимум для любого программиста. Как жаль, что простые смертные так редко вникают в проблемы мастеров кода и предлагают свои версии и варианты поведения для наших программ. Конечно, даже гениальному разработчику не следует забывать про простых пользователей системы, ради которых собственно и создается программный продукт. Именно для более эффективной поддержки клиентов и оперативного решения задач вроде устранения мелких проблем в вашем коде, которые выявляются, как правило, по ходу тестирования, и предназначена предлагаемая система баг-контроля. FlySpray работает на основе популярного интерпретатора веб-скриптов PHP и хранит данные в столь же популярной базе данных MySQL.

Установка

Для того чтобы установить систему, вам понадобится уже настроенная связка MySQL + PHP. Для тестирования и установки FlySpray я использовал дистрибутив AltLinux Master 2.4 от одноименной российской компании. Сам дистрибутив программы свободно доступен для скачивания в разделе загрузки официального сайта системы FlySpraу.

Предшествующая самой установке подготовительная стадия в случае FlySpray мало чем отличается от аналогичных по построению систем. Вначале следует распаковать сам файл инсталляционного пакета. Поскольку программа предназначена для использования в профессиональных целях, то и формат архива установочного комплекта соответствующий, а именно — tar.gz. Для установки такого архива в веб-каталоге AltLinux достаточно выполнить из оболочки следующие команды:

tar xfzv./flyspray-0.9.8.tar.gz.tar
chmod -R 755 /var/www/html/
chown -R apache:apache /var/www/html/

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

Создание базы данных MySQL

Для создания базы данных MySQL следует, во-первых, убедиться, что сам сервер установлен. В AltLinux для этого достаточно выполнить команду:

apt-cache search mysql

Если SQL-сервер не найдет в вашей инсталляции AltLinux, его следует установить с помощью вызова:

apt-get install mysql

После этого рекомендуется подключиться к MySQL-серверу с помощью консольной утилиты mysql и выполнить следующие команды:

create database fly;
grant all privileges on fly.* to user@localhost identified by 'password';
flush privileges;

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

Веб-инсталляция

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

Установка ADODB на стартовой странице инсталлятора FlySpray

После настройки необходимых параметров в первом окне программы установки по нажатию кнопки Next вы попадете в раздел, предлагающий вам ознакомиться с лицензионным соглашением GNU/LGPL. Для пользователя FlySpray эта лицензия означает возможность свободного использования и распространения этой программы. После того как вы укажете внизу второго окна соответствующим флажком, что вы ознакомились с этой лицензией, можно переходить к третьему этапу установки этого программного обеспечения, а именно — к настройке базы данных. Собственно настройка подключения к выбранной базе данных (программа поддерживает кроме MySQL также Postgres) не имеет никаких особенностей. Вам необходимо указать реквизиты, которые вы использовали при создании базы данных (fly) и выделении соответствующих прав доступа к ней пользователю MySQL. Маленький нюанс состоит в необходимости указания пароля для выбранного пользователя. То есть вариант с пользователем root и пустым паролем, который проходит в большинстве случаев, в случае с FlySpray не подойдет. В случае же обновления версии FlySpray программе установки можно указать на необходимость провести резервное копирование базы данных.

Окончание установки

На следующем шаге программы установки вам будет предложено ввести имя пользователя, пароль (не менее 8 символов) и адрес администратора системы, а также URL и физическое расположение установленной программы. Последние два параметра, а также рекомендуемый пароль доступа система заполнит и сгенерирует для вас автоматически. Кроме того, если ваша версия операционной системы будет иметь командный интерпретатор PHP, инсталляционная программа предложить установить фоновую задачу, которая будет напоминать про необходимость выполнения запланированных действий. В большинстве систем такой интерпретатор доступен. После этого установка программы практически окончена, единственное, что остается сделать, — это стереть подкаталог setup из веб-папки, в которой установлена FlySpray. Это действие надо выполнить обязательно, поскольку наличие этого каталога позволяет провести инсталляцию повторно. На этом установку FlySpray можно считать оконченной, можно начать настройку этого приложения.

Настройка FlySpray

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

Управление проектами

Все сообщения, которые вы получите в дальнейшем от благодарных пользователей ваших программных продуктов, в контексте системы FlySpray будут относиться к одному из проектов. Непосредственно после установки программы автоматически создается новый (Default) проект. Поэтому для привязки возможностей системы к вашим потребностям достаточно просто отредактировать название и прочие параметры этого проекта по умолчанию. Для этого можно использовать возможности пункта меню Manage projects. Каждый из проектов кроме собственного названия имеет также ряд дополнительных параметров, которые полезно заполнить. В первую очередь это описание проекта, которое можно указать в поле Introductory message. С помощью соответствующего флага вы имеете возможность изменять статус проекта с активного на неактивный. Кроме того, можно указать, имеют ли анонимные пользователи доступ к просмотру проекта или созданию задач в его составе. При редактировании параметров проекта вы можете указать колонки, которые будут доступны в списке недочетов, кроме того, можно указать, какой стиль оформления использовать для того или иного проекта (FlySpray поддерживает шаблонный стиль оформления). Также для каждого проекта можно указать, на какой адрес электронной почты будут высылаться уведомления.

Окно параметров проекта

Создание проекта

В случае если вам недостаточно одного проекта, который создан системой по умолчанию, вы всегда можете (в качестве администратора системы) создать новый. Для этого всего лишь нужно использовать возможности административного интерфейса, который доступен из меню Admin Toolbox.

Управление версиями и категориями проектов

Для того чтобы иметь возможность различать стадии проектирования и уметь относить найденные ошибки к различным частям одного и того же проекта, система имеет встроенный механизм управления версиями. Данная возможность доступна в интерфейсе как администратора, так и менеджера проектов (пункт меню Manage Project) в подразделе Versions. Аналогичная возможность по управлению категориями задания (например: текущие, срочные) открывается в подменю Categories.

Создание задачи

Все выявленные ошибки или отчеты о необходимых возможностях в контексте системы FlySpray относятся к задачам, которые создаются в зависимости от статуса доступа или настройки проекта уполномоченными пользователями. Вы можете указать, что создать задачу может любой пользователь, при настройке параметров проекта на соответствующую возможность подачи заданий при отсутствии аутентификации. Такая возможность идеально подходит для разнообразных shareware- и freeware-проектов, в разработке или тестировании которых может участвовать любой желающий.

Типы задач

В зависимости от срочности и важности задачу можно отнести к одному из нескольких возможных типов. После инсталляции доступны только два типа задач — Bug report и Future request. Однако вы всегда можете как добавить новые типы задач, так и отредактировать текущие, например перевести их названия на русский язык. Разработчики наложили небольшое ограничение на длину поля названия типа задачи, поэтому вам необходимо будет выбрать лаконичный стиль перевода.

Управление типами задач

Добавление и управление задачами

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

Новая задача

Особенности системы

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

Ссылки по теме

• Сайт FlySpray