Requality - это инструмент для работы с требованиями, в первую очередь к программным системам. Он позволяет:
Возможна совместная работа над документами и требованиями при их хранении с использованием любой системы управления версиями, например, Subversion или git.
Инструмент реализован как плагин на платформе Eclipse и может быть использован как в средах разработки на основе этой платформы, так и независимо.
UniTESK Lab, Институт системного программировния РАН
xulrunner.exe --register-global
При уже установленном браузере Mozilla Firefox можно не устанавливать отдельную копию XULRunner. Можно скопировать в папку с Firefox только файл xulrunner.exe и выполнить вышеуказанную команду.
Также можно просто добавить в реестр следующую информацию (контролируйте правильность путей и номеров версий!):
Windows Registry Editor Version 5.00 [HKEY_LOCAL_MACHINE\SOFTWARE\mozilla.org] [HKEY_LOCAL_MACHINE\SOFTWARE\mozilla.org\GRE] [HKEY_LOCAL_MACHINE\SOFTWARE\mozilla.org\GRE\1.9.2.8] "Version"="1.9.2.8" "GreHome"="C:\\Program Files\\Mozilla Firefox" "xulrunner"="true" "abi"="x86-msvc" "javaxpcom"="1" [HKEY_LOCAL_MACHINE\SOFTWARE\mozilla.org\Mozilla] "CurrentVersion"="1.9.2.8"
Возможны два варианта установки
инструмента - в каталог eclipse/dropins
или
через Eclipse Update Manager. Первый способ позволяет
использовать инструмент как из Eclipse, так и в
консольном режиме. Второй способ упрощает
процесс обновления версии инструмента, но
ограничивает использование только средой
Eclipse.
Для установки Requality архив следует
распаковать в каталог eclipse/dropins
.
Если Requality устновлен в каталог
eclipse/dropins
, то для удаления
требуется:
eclipse/dropins
.Удалить предыдущую версию Requality, а затем установить новую верproсию как описано в пунктах 'Удаление' и 'Установка' соответственно.
Для установки Requality с помошью Eclipse Update Manager, необходимо в оконном меню выбрать пункт "Install New Software..."
В открывшемся окне нужно ввести информацию о сайте обновления Requality.
Name: Requality
Location: http://forge.ispras.ru/repo/requality/site/
Далее нужно выбрать плагин Requality в списке доступных плагинов и продолжить установку, согласно указанием мастера установки плагинов.
В процессе установки появиться предупреждение о не подписанном содержании. Нужно нажать «OK»
После окончания установки нужно перезагрузить Eclipse.
TO BE DONE
TO BE DONE
Для начала работы над требованиями к системе необходимо создать в Eclipse проект: меню File - New - Project - Requality - Requality Project.
После создания проекта автоматически будет открыта перспектива Requality, которая содержит пользовательский интерфейс работы с требованиями.
Requality поддерживает процесс анализа существующих документов, описывающих систему, и выделение из них требований. В документ при этом добавляется информация о выделенных требованиях, поэтому для анализа необходимо создать копию документа в проекте.
В настоящее время Requality поддерживает обработку HTML документов. При импорте в проект они преобразуются в XHTML (представление HTML в виде корректного XML документа). Если в документ вставлены изображения, их придется скопировать вручную (будет доработано в будущем). Если в документе используются скрипты, модифицирующие его после открытия, может потребоваться их предварительное удаление или изменение.
Для импорта документа нужно выделить узел с пиктограммой папки. В контекстном меню выбрать "Import Document...":
В диалоговом окне нужно с помощью кнопки "Browse..." указать HTML документ, содержащий требования:
При успешном выполнении операции, откроется окно редактора разметки.
Требования в Requality представлены в виде иерархии узлов. С узлами могут быть ассоциированы части документации. Корнем дерева требований является специальный узел с
именем "Requirements" и идентификатором "/Requirements". Для начала работы нужно создать простую иерархию требований. Для этого к корневому узлу требований добавим первый дочерний узел.
В Requality Explorer выберете корневой узел требований, и в контекстном меню нажмите "Add Requirement..."
Будет создано требование с идентификатором 01 и откроется редактор требований. Тут можно указать другой идентификатор узла и поменять другие атрибуты требования.
Под разметкой требований понимается выделение требований из текста документа. С одним требованием может быть связанно несколько частей документа. Работа с документами производится в редакторе разметки. Для разметки документа нужно выполнить следующие действия:
В результате в документе должна появиться отметка, о том выделенный текст принадлежит требованию.
Чтобы удалить размеченный текст из требования, достаточно один раз правой кнопкой мыши и выбрать "Remove from requirement".
Чтобы открыть окно редактирования
требования, нужно в Requirements выбрать нужное
требование и двойным щелчком мыши его
открыть.
В открывшемся окне вы увидите информацию
об id требования, о всех размеченных
текстовых фрагментах из документа ( поле
"Description" ) и т.д.
Вы можете добавить к требованию альтернативное описание в поле "Alternative description".
Так же вы можете добавить предикаты и атрибуты.
В некоторых случаях выделение части требований из документа может быть автоматизированно. Например, если требования предполагается группировать в соответствии со структурой заголовков документа, то создание требований, соответствующих заголовкам, можно автоматизировать.
Посмотреть список доступных обработчиков и запустить автоматическую обработку документа можно из контекстного меню документа в Requality Explorer.
В будущем предполагается дать возможность пользователям создавать свои скрипты для автоматизации анализа документов и создания требований.
Совместная работа над документами и требованиями может быть организована с помощью системы управления версиями, например, Subversion или git. Требования хранятся в текстовых файлах, что даёт возможность отслеживать изменения построчно, параллельно изменять одни и те же файлы, а потом объединять эти изменения. В зависимости от используемой схемы работы с требованиями параллельные изменения файлов могут быть запрещены. Ниже преведены базовые сведения о работе с системой управления версиями. Для получения полной информации обратитесь к руководству по используемой системе контроля версий.
Для интеграции с SVN необходимо:
1. Установить Subversive через меню Help->Install new Software (подробнее)
2. Установить перспективу Requality и через меню Window->Customize Perspective, закладка Command Groups Availability, установить галочку у группы SVN.
Появятся меню и тулбар SVN. Команды применяются к ресурсу, выбранному в Project Explorer View. В контекстном меню ресурса есть группа Team, в которой команды работы с SVN.
Если проект еще не использует систему управления версиями, начать её использование можно через пункт контекстного меню проекта Team - Share Project.
Получить локальную копию файлов проекта из репозитория системы управления версиями можно через основное меню File - Import, далее в зависимости от используемой системы управления версиями, например SVN - Project from SVN.
Для получения изменений, выполненных другими пользователями, из репозитория системы управления версиями используется команда контекстного меню проекта Team - Update.
Для передачи выполненных локально изменений в репозиторий системы управления версиями используется команда контекстного меню проекта Team - Commit.
Если со времени последнего обновления локальной копии файла в репозитории появились изменения, выполненные другими пользователями, передать изменения в репозиторий не получится. Предварительно требуется получить обновления из репозитория.
Если изменения в репозитории и локально произведены в одном и том же месте файла, автоматическое слияние изменений невозможно. При обновлении Eclipse сообщит о возникновении конфликтов и предложит для разрешения конфликтов открыть окно Team - Synchronize with Repository. В этом окне можно просмотреть оба варианта изменений, выбрать правильный и оставить его для дальнейшей передачи в репозиторий системы управления версиями.
Итак, мы дошли до генерации отчета о покрытии. Наведите курсор на название каталога требований во вкладке Requirements и нажмите на правую кнопку мыши - появится всплывающие меню. Выберите Generate Report, как показано ниже.
Появится диалоговое окно. В нем три пункта для ввода:
Чтобы перенести разметку требований из старого документа в новый, нужно: