Requality: руководство пользователя


Работа с проектами


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

  1. Для создания проекта выберите в оконном меню пункт 'File' → 'New' → 'Project...'
  2. В появившемся диалоговом окне выберите 'Requality' → 'Requality Project' и нажмите кнопку 'Next'.

    Выбор типа нового проекта

  3. На следующей странице введите название проекта и нажмите кнопку 'Finish'.


Редактирование параметров проекта 'Requality'

Глобальные атрибуты, которые распространяются на все дерево проекта, могут быть заданы в окне 'Properties view'. Для этого нужно в 'Requality Explorer' кликнуть на названии проекта. После чего в 'Properties view' отобразятся параметры данного проекта.

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


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

  1. В 'Properties view' проекта кликните по кнопке 'Extract enum definitions from attributes'. Откроется диалоговое окно 'Enum definition extractor dialog'.
  2. В этом окне в поле выберите имя атрибута, тип которого вы хотите преобразовать в перечислимый. Справа в поле 'Values of selected attributes' отобразится список значений этого атрибута, этот список собран со всех атрибутов с таким же именем, которые есть в узлах проекта.
  3. Снизу в поле 'Select a name of ENUM definition' задайте имя для атрибута типа 'ENUM_DEFINITION', который будет создан на основании значений выбранного атрибута.
  4. Нажмите кнопку 'OK'.

Теперь атрибут типа 'ENUM_DEFINITION' создан, он отображается в таблице 'Attributes' с заданным именем и в качестве списка значений имеет список значений, собранный со всех атрибутов с выбранным именем. В 'Properties view' узлов, у которых были эти атрибуты, вы можете увидеть, что тип атрибутов изменился на новый созданный атрибут 'ENUM_DEFINITION'.


Работа с документами


Импортирование документа

Для того чтобы начать выделять требования, вам сначала нужно импортировать один или несколько документов, содержащих требования. Требования могут быть записаны в свободной форме. Requality предусматривает импортирование в проект документов со следующими расширениями: 'doc', 'pdf', 'htm', 'html'. При этом Requality копирует исходный документ, преобразовывает его формат в 'xhtml' и помещает полученный документ в проект. Исходный документ не испытывает никаких изменений. Дальнейшая работа осуществляется над полученным 'xhtml' -документом.

Requality позволяет импортировать документы по одному или группами, а также импортировать папки с документами.

  1. Для импорта документов выберите узел 'Documents' (или его дочерний узел) с пиктограммой папки. В контекстном меню выберите 'Import Document...'.

  2. Выбор директории. В открывшемся диалоговом окне 'Document Import Wizard' с помощью кнопки 'Browse...', расположенной справа от поля 'From directory:', укажите директорию, в которой находятся сами документы, содержащие требования, или папки с этими документами.

  3. Выбор документа или папки. Есть несколько способов выбора документов:

  4. Настройка фильтра расширений документов. Как было указано выше, Requality предусматривает импортирование в проект документов с расширениями 'doc', 'pdf', 'htm' и 'html'. И по умолчанию в инструменте настроен фильтр, который позволяет импортировать только их. Если вы хотите импортировать документ другого типа, то нужно перенастроить этот фильтр. Чтобы это сделать, используйте в окне 'Document Import Wizard' кнопку 'Select types', которая позволяет настраивать фильтр на типы доступных для импорта документов.

    Если вы уже выбрали нужные вам расширения, нажмите кнопку 'OK'. Теперь документы, расширения которых вы указали в фильтре, будут отображаться в окне импорта.

  5. Выбор целевой папки импортирования. Рассматриваем окно 'Document Import Wizard' дальше. Под полями выбора папок и документов находится поле 'Into folder:'. Укажите в нем папку проекта, в которую будут добавлены выбранные документы. По умолчанию в этом поле указана папка 'Documents' (корневая папка документов в проекте Requality) или ее подпапка, для которой вы выбрали меню 'Import Document...'. Но с помощью кнопки 'Browse...' возле этого поля вы можете выбрать или создать другую папку. (Подробнее о папках документов и других способах их создания вы можете прочитать дальше в документации – см. Создание папок документов.)

  6. Если имена документов, которые вы хотите импортировать, совпадают с именами уже находящихся в этой папке документов, вы можете использовать опцию переименования. Выберите в окне импорта флажок 'Rename existing documents'. Теперь импортируемые документы в случае совпадения имен будут переименовываться с добавлением индексов.

  7. Если вы импортируете не отдельные документы, а папку с документами целиком, и эта папка содержит вложенные папки с документами, то по умолчанию такая иерархия не будет сохранена в папке 'Documents' Requality-проекта. Все вложенные документы просто импортируются в корень целевой папки. Чтобы сохранить иерархию, выберите в окне импорта опциональный флажок 'Create folders'. Теперь при импорте все вложенные папки и документы будут импортированы с учетом иерархии.

  8. Если вы выбрали документы для импортирования и указали целевую папку, завершите процесс импортирования нажатием кнопки 'Finish' в окне 'Document Import Wizard'.

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

Удаление документа

  1. Для удаления документа выберите этот документ в окне 'Requality Explorer'.

    1. Правой кнопкой мыши вызовите контекстное меню, выберите в нем пункт 'Delete Document'.
    2. Для удаления документа вы также можете использовать горячую клавишу 'Delete'.
  2. После этого появится окно для подтверждения удаления документа. Нажмите в нем кнопку 'OK' для продолжения процесса удаления.

  3. Если в удаляемом документе уже были выделенные фрагменты требований, на данном этапе удаления возникнет еще одно окно для подтверждения удаления, содержащее предупреждение о наличии выделенных фрагментов. Нажмите в нем кнопку 'OK' для продолжения процесса удаления. Будьте внимательны, в этом случае будет удален как сам документ, так и все его фрагменты, которые были использованы в требованиях. Сами требования останутся на месте, но из них исчезнут ссылки на соответствующие фрагменты удаленного документа.


Обновление документа

'Requality' позволяет обновлять документацию путем переноса требований из старой версии документа в новую. Об этом подробнее написано в разделе "Перенос фрагментов требований в новую версию документа".


Создание папок документов

Для удобства работы с документами внутри узла 'Documents' можно создавать папки и размещать документы в них.

  1. Для создания папки документов выделите узел 'Documents' или любую другую вложенную папку, в контекстном меню выберите 'New → Folder'.
  2. В открывшемся окне в поле 'Enter folder name' введите желаемое имя папки.
  3. Имя не должно повторять имена папок, находящихся на том же уровне иерархии. В противном случае появится предупреждающее об этом сообщение, и продолжать процесс создания папки с таким именем будет невозможно.
  4. Если вы ввели корректное имя, нажмите кнопку 'OK'. Папка с указанным именем будет создана в 'Requality Explorer' на выбранном уровне иерархии.

Теперь вы можете импортировать документы в новую папку.


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

  1. Для удаления папки документов выберите эту папку в окне 'Requality Explorer'.

    1. Правой кнопкой мыши вызовите контекстное меню, выберите в нем пункт 'Delete Folder'.
    2. Для удаления папки вы также можете использовать горячую клавишу 'Delete'.
  2. После этого появится окно для подтверждения удаления папки. Обратите внимание, что удаление папки повлечет за собой удаление всех находящихся в ней документов и дочерних папок с их содержимым. Если вы уверены в правильности удаления выбранной папки, нажмите в окне подтверждения кнопку 'OK' для продолжения процесса удаления.

  3. Если в удаляемой папке или ее дочерних папках содержится документ, в котором есть выделенные фрагменты требований, на данном этапе удаления возникнет еще одно окно для подтверждения удаления. Обратите внимание, что при удалении папки все эти документы будут удалены, что повлечет удаление выделенных в них фрагментов требований. Если вы уверены в правильности удаления, нажмите в окне подтверждения кнопку 'OK' для продолжения процесса удаления.


Работа с требованиями

В проекте Requality все требования расположены в узле 'Requirements'.


Создание требования

Требование можно создать несколькими способами: из 'Requality Explorer', из 'UniEditor' и из 'ModuleEditor'. Требования можно создавать как с нуля, так и из шаблонов требований текущего проекта. Требования как потомки узлов можно создавать только для требований, у текстовых узлов не может быть требований-потомков.


Создание требования путем копирования

Требование также можно создать путем копирования уже существующего требования.


Создание уточняющего требования

Создать уточняющее требование можно одним из двух способов:

  1. Добавить к уже имеющемуся требованию атрибут типа 'REFERENCE' с указанием целевого требования; в таком случае имеющееся требование станет уточняющим для целевого требования;
  2. Cоздать новое требование как уточняющее к выделенному требованию.



Удаление требования

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

Требование можно удалить из 'Requality Explorer', для этого нужно выбрать его в этом окне, вызвать правой кнопкой контекстное меню и выбрать пункт 'Delete Requirement'. В редакторах 'UniEditor' и 'ModuleEditor' требование можно удалить из выпадающего меню узла либо из выпадающего меню в правом верхнем углу редактора с помощью пункта меню 'Delete Requirement'. Также можно воспользоваться горячей клавишей 'Delete'. После одного из указанных действий нужно подтвердить удаление требования в появившемся окне, нажав кнопку 'OK'.


Создание требования при выделении фрагмента текста


ВНИМАНИЕ! Если вы хотите скопировать фрагмент текста из редактора документа, воспользуйтесь для копирования горячими клавишами 'Ctrl+Shift+c'.


Создать требование вы можете из редактора документа ('Markup Editor'), сразу связав его с некоторым фрагментом текста.

  1. Откройте документ, часть текста которого вы хотите присвоить новому требованию.
  2. Выберите в 'Requality Explorer' узел-требование 'Requirements' или одно из вложенных требований. Назовем это выбранное требование целевым. Новое требование будет создаваться как подтребование целевого.
  3. В редакторе документа выделите часть текста. Внимание! Если требуемый фрагмент принадлежит какому-либо требованию и уже выделен в тексте документа, не требуется выделять его курсором мыши, пропустите этот шаг.
  4. Вызовите на выделенном тексте правой кнопкой мыши контекстное меню и выберите один из двух пунктов:
  5. В итоге к целевому требованию будет добавлено вложенное требование с указанными идентификатором и именем. Оно будет содержать ссылку на выделенный фрагмент документа. Данный фрагмент документа в тексте документа будет маркирован желтым цветом.

О простом способе создания требований вы можете почитать в разделе 'Создание требования'.


Контекстное меню выделенного фрагмента текста

Добавление фрагмента текста к требованию

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

  1. Откройте документ, часть текста которого вы хотите присвоить новому требованию.
  2. Выберите в 'Requality Explorer' требование, к которому вы хотите добавить фрагмент документа. Назовем это требование целевым.
  3. В редакторе документа выделите нужную часть текста. Внимание! Если требуемый фрагмент принадлежит какому-либо требованию и уже выделен в тексте документа, не требуется выделять его курсором мыши, пропустите этот шаг.
  4. Вызовите на выделенном тексте правой кнопкой мыши контекстное меню и выберите один из двух пунктов:
  5. Выделенный фрагмент требования теперь помечен в тексте желтым цветом и добавлен в целевое требование. То есть теперь целевое требование содержит ссылку на данный фрагмент текста.


Удаление фрагмента в редакторе документа

Чтобы удалить фрагмент документа из требования, нужно в редакторе документа снять с этого фрагмента выделение. После чего требование больше не будет содержать ссылки на данный фрагмент документа. Внимание! Если данный фрагмент принадлежит нескольким требованиям одновременно, он будет удален из всех этих требований. (Если вы хотите удалить фрагмент только из одного требования, см. Удаление фрагмента в окне Properties). Для этого:

  1. Дважды кликните на фрагменте в 'Properties view'. Документ откроется и будет прокручен на то место, где находится требуемый фрагмент.
  2. Найдите нужный фрагмент, вызовите на нем правой кнопкой мыши контекстное меню, выберите пункт меню 'Remove from Requirement'.
  3. В результате с данного фрагмента документа снимается выделение. И ссылка на него удаляется из требования (отследить это можно в окне 'Properties' требования на вкладке 'Description' в поле 'Locations:' или в окне 'Requality Explorer').


Удаление фрагмента в окне Properties

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

  1. Откройте в окне 'Properties' нужного требования вкладку 'Description' (см. Редактирование параметров требования).
  2. Выберите в списке 'Locations' требуемый фрагмент.
  3. Вызовите на нем контекстное меню и выберите пункт 'Delete'. Или воспользуйтесь горячей клавишей Delete.


Автоматическая разметка фрагментов требований в документе

'Requality' позволяет разметить документ автоматически. Для этого в 'Requality Explorer' выберите документ, вызовите контекстное меню и выберите HTML Headers Document Processor. Он позволяет выделить в качестве требований тот текст, который находится в HTML-документе внутри тегов-заголовков (<h1></h1>, <h2></h2> и т.д.). После этого соответствующие фрагменты текста в документе будут размечены как требования.


Редактирование параметров требования

Чтобы отредактировать параметры требования, щелкните по нужному требованию в 'Requality Explorer' или по одному из его фрагментов в окне 'Outline', в окне 'Properties' откроются свойства требования.

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

  1. Id

  2. Name

  3. Type

  4. Attributes

  5. Alternative Description

  6. Locations

  7. Predicate


Перенос фрагментов требований в новую версию документа

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

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


Для этого нужно сделать следующее:

  1. Убедитесь, что новый документ тоже импортирован в проект. Если нет, импортируйте его в текущий проект.
  2. Выберите в окне 'Requality Explorer' новый документ, вызовите контекстное меню и выберите в нем пункт 'Update Document'.
  3. В открывшемся окне выберите старый документ.
  4. После завершения обработки выдается окно с информацией о том, сколько фрагментов было найдено в старой версии документа, и сколько фрагментов было перенесено в новую версию.

  5. В любом случае, перенос всех требований должен быть проверен пользователем: для каждого требования пользователь или подтверждает корректный перенос требования, или модифицирует требование. Для этого после обработки документа процессором в перспективе 'Requality' открывается окно 'Update Processor Tasks', отображающее текущее состояние каждого требования из каталога и предоставляющее возможность ручной смены статусов перенесенных требований.


    Список задач для завершения переноса требований в новую версию документа

    В данном окне пользователь может анализировать и модифицировать требования. Для каждой задачи отображается требование, с которым она связана, и действие, которое предлагается выполнить. Действий всего 3 — по трем состояниям требований:

    1. 'Verify' – если все фрагменты требования были перенесены, требуется проверить корректность переноса.
    2. 'Add Locations' – если была перенесена часть фрагментов требований, предлагается найти в новом документе аналоги не найденных фрагментов требований, которые не были перенесены, или убедиться, что в новой версии их нет.
    3. 'Find Locations' – не было перенесено ни одного фрагмента требования. Предлагается найти их аналоги в новой версии или убедиться, что данного требования больше нет в новой версии спецификации.
  6. Пользователь может напрямую открыть желаемое требование как в старом документе, так и в новом. В старом документе фрагменты требования автоматически будут подсвечены в тексте. В новом документе будут подсвечены только перенесенные фрагменты требования, если ни один фрагмент не был перенесен, то документ будет открыт без выделенных фрагментов текста.

  7. Замечание. Gри включенной синхронизации между 'Requality Explorer'-ом и браузером (нажатой кнопке 'Link with Editor' в тулбаре 'Requality Explorer') из окна 'Update Processor Tasks' может некорректно открываться требование, для которого ни один фрагмент не был перенесен (с красной пиктограммой). Для корректного отображения таких требований рекомендуется отключать синхронизацию между браузером и 'Requality Explorer'-ом.

  8. Тут же пользователь может модифицировать требование - добавить к нему фрагменты или удалить, а также пометить требование как проверенное, чтобы не возвращаться к нему в дальнейшем. Проверенные требования переводятся в статус 'Completed', и можно настроить представление так, чтобы проверенные требования не отображались в таблице. Для этого нужно в тулбаре нажать на кнопку 'Hide Completed Items'. После того, как все требования проверены пользователем и при необходимости модифицированы, можно удалить список задач из данного представления. Задачи можно удалять с помощью кнопок из тулбара: кнопка 'Delete Selected Task' удаляет одну выделенную задачу, а кнопка 'Delete all Update Processor Tasks' удаляет все задачи из окна 'Update Processor Tasks' для текущего проекта. Удаление можно отменить, выполнив команду меню 'Edit → Undo …'. Также после переноса всех фрагментов требований рекомендуется удалить из проекта старую версию документа спецификации.

  9. Замечание. Предполагается последовательный перенос требований для разных документов. Сначала рекомендуется перенести и при необходимости откорректировать требования из одного документа, затем проводить процедуру для следущих документов.


Генерация теста для требования

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

Для генерации тестов можно воспользоваться 'Requality Explorer'. Для этого нужно:

Также возможно вызвать диалог добавления теста из 'Coverage' отчета путем нажатия на кнопку 'Add test' в окне просмотра отчета.

Диалог добавления теста также доступен в главном меню Eclipse: 'File' → 'New' → 'Other' → folder 'Requality' → 'Create Test'.


Работа со связанными требованиями

В проекте 'Requality' различные узлы каталога проекта могут быть связаны между собой. Связь задается только в одну сторону, снизу вверх. Для создания такой связи узлу, который будет ссылаться на другой узел, нужно на вкладке 'Main' окна 'Properties' добавить атрибут типа 'REFERENCE' и в качестве значения указать тот целевой узел. При этом у узла, на который ссылаются, не появится дополнительных атрибутов, но данную связь можно будет видеть в представлении 'Requality Links Explorer'. Открыть данное представление можно через 'Window' → 'Show View' → 'Other'. Затем развернуть пункт 'Requality' и выбрать 'Requality Links Explorer'.

В данном представлении отображаются узлы, связанные с выбранным узлом. Если выбранный узел имеет атрибут типа 'REFERENCE' со ссылкой на другой узел, то последний будет отображаться в представлении, и около него будет отображаться пиктограмма со стрелкой вниз. Также в представлении будут отображаться узлы, которые ссылаются на выбранный узел, они будут отображаться с пиктограммами со стрелкой вверх. Около пиктограмм отображаются не сами узлы, с которыми есть связь, а имена атрибутов типа 'REFERENCE', которые создают такую связь. При этом, если текущий узел ссылается на другой, то будет отображаться просто имя атрибута, а если это узел, который ссылается на текущий, то перед именем его атрибута будет добавлен префикс 'Backward_'. Для того, чтобы развернуть или свернуть информацию о самом узле, имеющем связь с выделенным узлом, нужно нажать на стрелочку около пиктограммы со стрелкой. Если нажать на название узла, то такой узел станет текущим выбранным, и в представлении 'Requality Links Explorer' уже будет отображаться информация для него.


Общий вид окна 'Requality Links Explorer'

Можно настроить представление так, чтобы отображались только узлы, на которые ссылается данный узел каталога проекта. Для этого нужно один или несколько раз нажать на кнопку 1 и перевести ее в положение 'стрелка вниз'. Чтобы отображались только узлы, которые ссылаются на данный узел, нужно кнопку 1 перевести в положение 'стрелка вверх'.

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


Фильтр отображаемых требований по имени атрибута


Работа с шаблонами узлов

Чтобы создать шаблон узла в проекте 'Requality' нужно сначала открыть окно редактора шаблонов:

Обратите внимание, в редакторе шаблонов в поле 'List of templates' отображается список шаблонов только для того типа узлов, который выбран в выпадающем списке 'Select Node Type'.

Для завершения работы с редактором шаблонов нажмите кнопку 'OK'.


Создание шаблона

Существует дла способа создания шаблона узла:


Удаление шаблона

Чтобы удалить шаблон:

  1. Откройте редактор шаблонов (как его открыть см. выше).
  2. Выберите тип узла, шаблон которого вы хотите удалить. При этом в поле 'List of templates' отобразятся все существующие в этом проекте шаблоны для узлов выбранного типа.
  3. Кликните в списке 'List of templates' по шаблону, который вы хотите удалить.
  4. Нажмите кнопку 'Remove' справа от списка.

После этого вы увидите, что этот шаблон исчез из списка шаблонов, то есть был удален.


Редактирование шаблона

Чтобы отредактировать шаблон:

  1. Откройте редактор шаблонов (как его открыть см. выше).
  2. Выберите тип узла, шаблон которого вы хотите отредактировать. При этом в поле 'List of templates' отобразятся все существующие в этом проекте шаблоны для узлов выбранного типа.
  3. Кликните в списке 'List of templates' по шаблону, который вы хотите отредактировать.
  4. Нажмите кнопку 'Edit' справа от списка.

В результате откроется окно для редактирования параметров шаблона. Редактирование параметров шаблона аналогично редактированию тех же параметров узла соответствующего типа в окне 'Properties'. Подробнее можно посмотреть здесь:

Установка активного шаблона

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

  1. Откройте редактор шаблонов (как его открыть см. выше).
  2. Выберите тип узла, шаблон которого вы хотите сделать активным. При этом в поле 'List of templates' отобразятся все существующие в этом проекте шаблоны для узлов выбранного типа.
  3. Кликните в списке 'List of templates' по шаблону, который вы хотите сделать активным.
  4. Нажмите кнопку 'Set as active справа от списка.

После этого вы увидите, что этот шаблон в списке 'List of templates' выделен жирным шрифтом. Это означает, что шаблон стал активным. Теперь все узлы такого же типа по умолчанию будут создаваться по этому шаблону.


Работа с текстовыми узлами

В проекте Requality все текстовые узлы расположены в узле 'Requirements'. Во многом работа с текстовыми узлами идентична работе с требованиями (см. 'Работа с требованиями').


Создание текстового узла

Создание текстового узла полностью идентично созданию требования (см. 'Создание требования').


Создание текстового узла путем копирования

Создание текстового узла путем копирования полностью идентично созданию требования путем копирования (см. 'Создание требования путем копирования').


Удаление текстового узла

Удаление текстового узла полностью идентично удалению требования (см. 'Удаление требования'). Нужно помнить, что при удалении текстового узла будет удалено все его поддерево узлов.


Редактирование параметров текстового узла

Редактирование параметров текстового узла почти полностью идентично редактированию параметров требования (см. 'Редактирование параметров требования'). Кроме нескольких исключений:


Работа с тестовыми ситуациями

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


Создание тестовой ситуации

Обратите внимание, тестовая ситуация может быть добавлена только листовому требованию, то есть такому требованию, у которого нет вложенных требований.

Тестовую ситуацию можно создать несколькими способами: из 'Requality Explorer' и из 'UniEditor'. Тестовые ситуации можно создавать как с нуля, так и из шаблонов тестовых ситуаций текущего проекта.


Создание тестовой ситуации путем копирования

Тестовую ситуацию также можно создать путем копирования уже существующей тестовой ситуации.


Редактирование параметров тестовых ситуаций

Чтобы отредактировать параметры тестовой ситуации, щелкните по нужной тестовой ситуации в 'Requality Explorer' в окне 'Properties' откроются свойства тестовой ситуации.

Далее рассмотрены только те параметры тестовой ситуации, которые можно изменить вручную.

  1. Id
  2. Name
  3. Status
  4. Author
  5. Attributes

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

  6. Description
  7. Expected Results
  8. Predicate


Удаление тестовой ситуации

Тестовую ситуацию можно удалить из 'Requality Explorer', для этого нужно выбрать ее в этом окне, вызвать правой кнопкой контекстное меню и выбрать пункт 'Delete Test Purpose'. В редакторе 'UniEditor' тестовую ситуацию можно удалить из выпадающего меню узла либо из выпадающего меню в правом верхнем углу редактора с помощью пункта меню 'Delete Test Purpose'. Также для удаления тестовой ситуации можно воспользоваться горячей клавишей 'Delete'. После одного из указанных действий нужно подтвердить удаление тестовой ситуации в появившемся окне, нажав кнопку 'OK'.


Генерация теста для тестовой ситуации

Для тестовой ситуации доступен механизм генерации связанного с ней теста, подробней процесс описан в разделе, описывающем процесс генерации теста для требования


Работа с отчетами


Создание настроек отчета

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

Для создания настроек отчета на узле 'Reports' (или любой папке отчетов) вызовите контекстное меню и выберите пункт 'New → Report Settings'. Узел настроек отчета будет создан.


Редактирование параметров настроек отчета

Чтобы отредактировать параметры настроек отчета, щелкните по нужному узлу настроек отчета в окне 'Requality Explorer', тогда в окне 'Properties' откроются его параметры.

Далее рассмотрены только те параметры настроек отчета, которые можно изменить вручную.

  1. Root requirement
  2. Template
  3. Attributes

    Атрибуты настроек отчетов аналогичны атрибутам требований. И работа с ними осуществляется точно так же. См. подробное описание работы с атрибутами в разделе о работе с требованиями.


Особенности работы с шаблоном отчета 'Coverage'


Шаблон отчета 'Coverage' предназначен для отображения информации о покрытии тестами элементов дерева требований, таких как тестовые ситуации и требования.


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

  1. В окне 'Properties' настроек отчета в качестве шаблона выбрать шаблон 'Coverage'.
  2. В окне 'Properties' настроек отчета нажать на появившуюся кнопку 'Update Coverage Source'.
  3. Отобразится список доступных источников. Требуется выбрать один из представленных:
  4. После выбора источника информации о покрытии на основании настроек отчета можно сгенерировать сам отчет стандартным способом.


Особенности работы с шаблоном отчета 'Document Model'

Шаблон отчета 'Document Model' предназначен для отображения информации о покрытии тестами фрагментов документа. Работа с шаблоном 'Document Model' аналогична работе с шаблоном'Coverage', однако в результате будет получен документ в размеченными фрагментами, где для каждого фрагмента цветом указано, покрыт он или нет.


Для построения отчета о покрытии требуется выбрать источник информации о покрытии. Для этого следует выполнить ряд действий:

  1. В окне 'Properties' настроек отчета в качестве шаблона выбрать шаблон 'Document Model'.
  2. В окне 'Properties' настроек отчета нажать на появившуюся кнопку 'Update Coverage Source'.
  3. Отобразится список доступных источников. Требуется выбрать один из представленных:
  4. После выбора источника информации о покрытии на основании настроек отчета можно сгенерировать сам отчет стандартным способом.


Особенности работы с шаблоном отчета 'Progress'

Шаблон отчета 'Progress' предназначен для отображения статистической информации о проекте, взятой из SVN

Внимание! Для генерации 'Progress' отчета необходимо наличие установленной версии плагина 'Requality Subclipse Connector' (доступен на 'update site'). В свою очередь, для установки этого плагина требуется добавить в 'available software sites' адрес "http://subclipse.tigris.org/update_1.8.x". Сделать это можно скопировав адрес в поле 'Work with' диалога 'Install'. После этого можно установить плагин 'Requality Subclipse Connector' обычным образом.


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

  1. В окне 'Properties' настроек отчета в качестве шаблона выбрать шаблон 'Progress'.


    Окно Properies для отчета Progress


  2. Опционально можно выбрать источник информации о покрытии. Например, добавить в отчет в том числе покрытие тестовыми ситуациями или данными из какого-либо другого проекта или внешнего файла. Для этого в окне 'Properties' настроек отчета нажать на кнопку 'Update Coverage Source' и выбрать источник, действия аналогичны действиям для построения отчета по шаблону ‘Coverage’.


    Окно Coverage Source Selection для отчета Progress


  3. Также можно указать дополнительные параметры. Для этого в окне 'Properties' настроек отчета нажать на кнопку 'Open Settings' и в открывшемся окне выбрать либо пункт 'Progress for selected dates', либо пункт 'Progress for all available dates'. В случае выбора 'Progress for selected dates' потребуется вручную указать даты начала и окончания интересующего периода и минимальный шаг по времени между ревизиями. Шаг записывается в формате, например, '1 week 2 day' или '5 month'. Также можно использовать не полные названия периодов, а короткие: 'd' вместо 'day, 'w' вместо 'week', 'm' вместо 'month', 'y' вместо 'year' (например, '1 w 2 d'). Для закрытия окна настроек нужно нажать кнопку 'OK'.


    Окно Progress report settings для отчета Progress


  4. Далее сгенерировать сам отчет стандартным способом.


Особенности работы с шаблоном отчета 'Traceability'


Шаблон отчета 'Traceability' предназначен для отображения информации о наличии связей-ссылок (определенного типа) между элементами в выбранном фрагменте каталога требований.

Отчет состоит из двух страниц:

'Traceability' отчет выглядит так:


Вид отчета 'Traceability'


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

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

Цифрами 4 и 6 обозначены результаты подстановки значений в primary и secondary шаблоны, описанные в пункте 3 ниже. При этом для 6 на второй странице есть информация о наличии обратной ссылки, потому имеется строка 'Backward_Уточняет' при нажатии на которую произойдет переход на вторую страницу.


Для построения отчета нужно выполнить следующие действия:

  1. В окне 'Properties' настроек отчета в качестве шаблона выбрать шаблон 'Traceability'.
  2. Далее необходимо задать вид связи, для которой требуется построить отчет. Для этого следует нажать на кнопку 'Open Settings'. После этого откроется окно настройки отчета в левой части которого (1,2 на рисунке) будет отображаться список доступных видов связей (имен свойств типа 'REFERENCE'). Значение в скобках справа от наименования отношения — количество элементов каталога требований, для которых подобное отношение указано. Среди них требуется выбрать одно и нажать на 'OK'.
    Задание дополнительных параметров отчета 'Traceability'
  3. Опционально — имеется возможность детальной настройки отчета. Сгенерированный отчет будет состоять из строк двух видов — информации о том, что ссылается, и на что ссылается. Цифрой 3 обозначен пример генерации, в котором можно видеть 2 строки — 'Requirements/01 [Backward...]' и 'Requirements/02 [Backward…]'. Первая строка содержит информацию об отношении, из которого исходит связь. Шаблон генерации строки обозначен цифрой 4 и имеет название 'Primary template'. Вторая строка — информация об элементе, на который указывает связь. Шаблон для генерации обозначен цифрой 5 и называется 'Secondary template'.
  4. Далее сгенерировать сам отчет стандартным способом.


Удаление настроек отчета

  1. Чтобы удалить настройки отчета, выберите этот узел в 'Requality Explorer', вызовите правой кнопкой контекстное меню и выберите пункт 'Delete Report Settings'.
  2. Вы также можете воспользоваться горячей клавишей 'Delete' для удаления настроек отчета.
  3. В появившемся окне подтвердите удаление настроек отчета, нажав кнопку 'OK'.


Генерация отчета

  1. Сгенерировать отчет можно двумя способами:
  2. Отчет создается рядом (на том же уровне иерархии) с узлом настроек отчета, на котором он был сгенерирован.
  3. В сгенерированном отчете в списке атрибутов автоматически создается атрибут 'date', содержащий информацию о дате и времени генерации отчета.


Открытие и редактирование отчета

  1. Выберите нужный отчет в 'Requality Explorer' и дважды кликните по нему.
  2. Обратите внимание, в окне 'Properties' откроются параметры, по которым был сгенерирован отчет. Однако изменить можно только идентификатор отчета.


Удаление отчета

  1. Чтобы удалить отчет, выберите его в 'Requality Explorer', вызовите правой кнопкой контекстное меню и выберите пункт 'Delete Report'.
  2. Вы также можете воспользоваться горячей клавишей 'Delete' для удаления отчета.
  3. В появившемся окне подтвердите удаление отчета, нажав кнопку 'OK'.


Создание папок отчетов

Для удобства работы с отчетами внутри узла 'Reports' можно создавать папки и размещать отчеты в них.

  1. Для создания папки отчетов выделите узел 'Reports' или любую другую вложенную папку, в контекстном меню выберите 'New → Folder'.
  2. В открывшемся окне в поле 'Enter folder name' введите желаемое имя папки.
  3. Имя не должно повторять имена папок, находящихся на том же уровне иерархии. В противном случае появится предупреждающее об этом сообщение, и продолжать процесс создания папки с таким именем будет невозможно.
  4. Если вы ввели корректное имя, нажмите кнопку 'OK'. Папка с указанным именем будет создана в 'Requality Explorer' на выбранном уровне иерархии.

Теперь вы можете создавать настройки отчетов и генерировать отчеты в новой папке.


Удаление папки отчетов

  1. Для удаления папки отчетов выберите эту папку в окне 'Requality Explorer'.

    1. Правой кнопкой мыши вызовите контекстное меню, выберите в нем пункт 'Delete Folder'.
    2. Для удаления папки вы также можете использовать горячую клавишу 'Delete'.
  2. После этого появится окно для подтверждения удаления папки. Обратите внимание, что удаление папки повлечет за собой удаление всех находящихся в ней настроек отчетов и отчетов. Если вы уверены в правильности удаления выбранной папки, нажмите в окне подтверждения кнопку 'OK' для продолжения процесса удаления.


Работа с комментариями


Создание комментария

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

Комментарий можно создать несколькими способами: из 'Requality Explorer', из 'UniEditor' и из 'Review'. Комментарии можно создавать как с нуля, так и из шаблонов комментариев текущего проекта.


Создание комментария путем копирования

Комментарий также можно создать путем копирования уже существующего комментария.


Редактирование параметров комментария

Чтобы отредактировать параметры комментария, щелкните по нужному комментарию в 'Requality Explorer', в окне 'Properties' откроются свойства комментария.

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

  1. Name

  2. Author

  3. Поле для текста комментария


Удаление комментария

Комментарий можно удалить из 'Requality Explorer', для этого нужно выбрать его в этом окне, вызвать правой кнопкой контекстное меню и выбрать пункт 'Delete Comment'. В редакторах 'UniEditor' и 'Review' комментарий можно удалить из выпадающего меню узла либо из выпадающего меню в правом верхнем углу редактора с помощью пункта меню 'Delete Comment'. Также для удаления комментария можно воспользоваться горячей клавишей 'Delete'. После одного из указанных действий нужно подтвердить удаление комментария в появившемся окне, нажав кнопку 'OK'.


Сортировка элементов в проекте Requality

Элементы дерева проекта могут быть отсортированы тремя способами: 'By Locations' (по фрагментам), 'By Names' (по именам) и 'By Index' (по индексам). По умолчанию способ сортировки - 'By Locations'.

Отдельно стоит отметить опцию 'Sort elements types separately'. В активированном состоянии данная возможность предполагает что элементы каталога требования будут отсортированы независимо друг от друга. При деактивации опции различные типы элементов будут отсортированы без разделениях их по типу. Опция по умолчанию активна, но при работе с способом сортировки "By Index" рекомендуется ее деактивировать.

Изменение настроек сортировки элементов в проекте Requality

Для изменения настроек сортировки нужно:

  1. В 'Requality Explorer' на проекте вызвать контекстное меню и выбрать пункт меню 'Properties'. Откроется окно настроек проекта.
  2. В левой части этого окна нужно выбрать 'Requality', тогда в правой части отобразятся свойства проекта 'Requality'.
  3. В выпадающем списке 'Sort method' нужно выбрать способ сортировки ('By Locations', 'By Names' или 'By Index') и нажать кнопку 'Apply'.
  4. Также можно установить или снять галочку 'Sort elements types separately'.


Настройки сортировка в проекте Requality


После этого для данного проекта установится выбранный способ сортировки.


Работа в UniEditor


Открытие UniEditor

В редакторе 'UniEditor' вы можете открыть дерево требований с тестовыми ситуациями и комментариями. В качестве корневого узла будет отображаться то требование, на котором вы вызвали открытие 'UniEditor', то есть в этом редакторе можно открыть как все дерево требований (вызвав его на корневом узле требований 'Requirements'), так и отдельное поддерево требований (вызвав открытие редактора на одном из подтребований).

Для открытия редактора нужно сделать следующее:


  1. В 'Requality Explorer' выберите целевое требование, откройте контекстное меню и выберите пункт 'Edit in UniEditor'.


Обратите внимание! В 'UniEditor' может быть удобно работать с помощью горячих клавиш. Подробнее см. 'Работа с помощью клавиатуры в UniEditor, Review и Module Editor: горячие клавиши'.


Добавление новых требований в UniEditor

Добавление требований описано в разделе 'Создание требования'.

Добавление требований путем копирования описано в разделе 'Создание требования путем копирования'.


Удаление требований в UniEditor

Удаление требований описано в разделе 'Удаление требования'.


Редактирование требований в UniEditor

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

  1. Чтобы отредактировать имя требования, дважды кликните в верхней части поля требования. Поле станет редактируемым, и вы сможете внести изменения. Чтобы закончить редактирование, кликните в любом другом месте экрана.
  2. Чтобы отредактировать текст требования, дважды кликните в нижней части поля требования. К вашим услугам будет целая панель для редактирования текста, включающая кнопки для форматирования текста, добавления символов, картинок, ссылок и т.д. Для сохранения изменений нажмите кнопку с пиктограммой в виде папки. Для отмены несохраненных изменений нажмите кнопку с пиктограммой в виде красного косого креста.
  3. Также для редактирования требования можно воспользователься редактором узла. Для этого нужно навести курсор мыши на пиктограмму треугольника в верхнем правом углу поля узла и в раскрывшемся меню выбрать пункт 'Open Editor'. Откроется редактор узла, где вы можете отредактировать параметры требования. Сделайте это и нажмите 'OK'.
  4. Чтобы изменить статус требования кликните на значок статуса слева от имени требования. При клике статус меняется с 'in process' на 'complete' и наоборот.


Добавление новых текстовых узлов в UniEditor

Добавление текстовых узлов описано в разделе 'Создание текстового узла'.

Добавление текстовых узлов путем копирования описано в разделе 'Создание текстового узла путем копирования'.


Удаление текстовых узлов в UniEditor

Удаление текстовых узлов описано в разделе 'Удаление текстового узла'.


Редактирование текстовых узлов в UniEditor

Поле текстового узла содержит текст описания этого узла. состоит из двух частей. Слева от текста расположена пиктограмма для смены типа узла с 'Text' на 'Header' или наоборот.

  1. Чтобы отредактировать текст текстового узла, дважды кликните в поле этого узла. К вашим услугам будет целая панель для редактирования текста, включающая кнопки для форматирования текста, добавления символов, картинок, ссылок и т.д. Для сохранения изменений нажмите кнопку с пиктограммой в виде папки. Для отмены несохраненных изменений нажмите кнопку с пиктограммой в виде красного косого креста.
  2. Чтобы изменить тип текстового узла кликните на значок типа слева от текста узла. При клике тип меняется с 'Text' на 'Header' и обратно.
  3. Также для редактирования текстового узла можно воспользователься редактором узла. Для этого нужно навести курсор мыши на пиктограмму треугольника в верхнем правом углу поля узла и в раскрывшемся меню выбрать пункт 'Open Editor'. Откроется редактор узла, где вы можете отредактировать параметры текстового узла. Сделайте это и нажмите 'OK'.


Добавление новых тестовых ситуаций в UniEditor

Добавление тестовых ситуаций описано в разделе 'Создание тестовой ситуации'.

Добавление тестовых ситуаций путем копирования описано в разделе 'Создание тестовой ситуации путем копирования'.


Удаление тестовых ситуаций в UniEditor

Удаление тестовых ситуаций описано в разделе 'Удаление тестовой ситуации'.


Редактирование тестовых ситуаций в UniEditor

Поле тестовой ситуации состоит из двух частей. Верхняя часть содержит имя тестовой ситуации, нижняя содержит текст тестовой ситуации.

  1. Чтобы отредактировать имя тестовой ситуации, дважды кликните в верхней части поля тестовой ситуации. Поле станет редактируемым, и вы сможете внести изменения. Чтобы закончить редактирование, кликните в любом другом месте экрана.
  2. Чтобы отредактировать текст тестовой ситуации, дважды кликните в нижней части поля тестовой ситуации. К вашим услугам будет целая панель для редактирования текста, включающая кнопки для форматирования текста, добавления символов, картинок, ссылок и т.д. Для сохранения изменений нажмите кнопку с пиктограммой в виде папки. Для отмены несохраненных изменений нажмите кнопку с пиктограммой в виде красного косого креста.
  3. Также для редактирования тестовой ситуации можно воспользователься редактором узла. Для этого нужно навести курсор мыши на пиктограмму треугольника в верхнем правом углу поля узла и в раскрывшемся меню выбрать пункт 'Open Editor'. Откроется редактор узла, где вы можете отредактировать параметры тестовой ситуации. Сделайте это и нажмите 'OK'.
  4. Чтобы изменить статус тестовой ситуации кликните на значок статуса слева от имени тестовой ситуации. При клике статус меняется с 'in process' на 'complete' и наоборот.


Добавление новых комментариев в UniEditor

Добавление комментариев описано в разделе 'Создание комментария'.

Добавление комментариев путем копирования описано в разделе 'Создание комментария путем копирования'.


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

Удаление комментариев описано в разделе 'Удаление комментария'.


Редактирование комментария в UniEditor

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


Работа в Review

Работа в 'Review' аналогична работе в 'UniEditor', но более ограничена по функциональности. Здесь вы не можете добавлять и удалять требования и тестовые ситуации, да и редактировать можно только их статусы.

Открытие Review

В редакторе 'Review' вы можете открыть дерево требований с тестовыми ситуациями и комментариями. В качестве корневого узла будет отображаться то требование, на котором вы вызвали открытие 'Review', то есть в этом редакторе можно открыть как все дерево требований (вызвав его на корневом узле требований 'Requirements'), так и отдельное поддерево требований (вызвав открытие редактора на одном из подтребований).

Для открытия редактора нужно сделать следующее:


  1. В 'Requality Explorer' выберите целевое требование, откройте контекстное меню и выберите пункт 'Review'.


Обратите внимание! В 'Review' может быть удобно работать с помощью горячих клавиш. Подробнее см. 'Работа с помощью клавиатуры в UniEditor, Review и Module Editor: горячие клавиши'.


Редактирование статусов требований и тестовых ситуаций в Review

Чтобы изменить статус требования/тестовой ситуации кликните на значок статуса слева от имени требования/тестовой ситуации. При клике статус меняется в следующем порядке'in process''complete''verified' → снова 'in process' и т.д.


Горячие клавиши в Review

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


Работа в Module Editor

Работа в 'Module Editor' аналогична работе в 'UniEditor', но более ограничена по функциональности. Здесь вы можете работать только с требованиями и текстовыми узлами.

Открытие Module Editor

В редакторе 'Module Editor' вы можете открыть дерево требований, включая текстовые узлы. В качестве корневого узла будет отображаться тот узел, на котором вы вызвали открытие 'Module Editor', то есть в этом редакторе можно открыть как все дерево требований (вызвав его на корневом узле требований 'Requirements'), так и отдельное поддерево требований (вызвав открытие редактора на одном из подтребований).

Для открытия редактора нужно сделать следующее:


  1. В 'Requality Explorer' выберите целевое требование или текстовый узел, откройте контекстное меню и выберите пункт 'Module Editor'.


Горячие клавиши в Module Editor

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


Работа с помощью клавиатуры в UniEditor, Review и Module Editor: горячие клавиши

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

ВНИМАНИЕ! В разных редакторах и для разных типов узлов доступен разный набор горячих клавиш.

Доступные сочетания горячих клавиш быывают двух форматов:

Меню редактора также можно открыть с помощью мыши. Для этого нужно навести курсор на кнопку в правом верхнем углу окна редактора, меню раскроется. Далее можно использовать сокращенные варианты горячих клавишь без дополнительного нажатия 'Ctrl+D' или просто кликать по пункам меню мышью, как обычно.


Общая кнопка раскрытия меню узла в окне редактора


Для навигации в редакторе и редакторах узлов также доступны работа с клавиатуры.

Все возможные сочетания клавиш для работы с помощью клавиатуры перечислены в таблице ниже:


Действие Комбинация клавиш Альтернативная комбинация клавиш (сначала нажать Ctrl+D, затем указанную клавишу)
Создать новое подтребование Ctrl+R R
Создать новое требование того же уровня Ctrl+S S
Создать новый дочерний текстовый узел Ctrl+J J
Создать новый текстовый узел того же уровня Ctrl+I I
Удалить узел Del Del
Редактировать текущее требование в отдельном окне Ctrl+E E
Изменить тип узла с требования Requirement на Text Node и наоборот Alt+M M
Создать новую тестовую ситуацию Ctrl+P P
Создать комментарий к текущему узлу Alt+C C
Открыть окно для редактирования и выбора шаблона Ctrl+T T
Переместить фокус на требование выше/ ниже Стрелки вверх/вниз --
Переместить фокус на требование выше/ ниже Стрелки вверх/вниз --
Раскрыть/свернуть поддерево с корнем в текущем узле Стрелки вправо/влево --
Редактировать имя требования F2 --
Редактировать описание требования (поле Description) Enter --
Переместить фокус на следующее представление (например, Outline). Примечание. При переводе фокуса также учитываются вкладки текущего представления и кнопки на панели управления текущего представления, например, минимизировать или раскрыть во все окно Tab --
Переместить фокус на предыдущее представление Shift+Tab --
Войти в представление (используется после навигации между разными представлениями с помощью Tab и Shift + Tab) F12 --
При открытом редакторе в UniEditor перемещаться на редактирование требований выше и ниже Ctrl+стрелки вверх/вниз --
Undo Ctrl+Z --
Redo Ctrl+Shift+Z --
Обновить редактор F5 --
Открыть диалог поиска Ctrl+F --
Закрыть редактор узла (выйти из режима редактирования узла) Esc --
Сохранить изменения в редакторе Ctrl+S --
Перейти на страницу вверх PageUp --
Перейти на страницу вниз PageDown --
Перенести фокус на первый узел Home --
Перенести фокус на последний узел End --
Добавить к узлу тест Alt+T --
Начать редактирование узла Enter --
Начать редактирование имени узла F2 --
Изменить статус Alt+S --
Раскрыть узел Num+ --
Свернуть узел Num- --
Скопировать узел Ctrl+C --
Вырезать узел Ctrl+X --
Вставить узел как соседа (без дочерних узлов) Ctrl+Shift+V --
Вставить узел как ребенка (без дочерних узлов) Ctrl+V --
Вставить узел со всеми его дочерними узлами как соседа Ctrl+Alt+Shift+V --
Вставить узел со всеми его дочерними узлами как ребенка Ctrl+Alt+V --


Работа с виртуальными узлами


Создание виртуального узла

  1. В 'Requality Explorer' выберите или создайте требование, для которого вы хотите создать виртуальный узел. Правой кнопкой вызовите на нем контекстное меню и выберите пункт 'New → Virtual Node'. Появится новый виртуальный узел.

Создание виртуального узла путем копирования

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

Копирование виртуального узла осуществляется в 'Requality Explorer' с помощью пункта меню 'Copy'. Вставка скопированного виртуального узла осуществляется с помощью пунктов меню 'Paste into' (для добавления скопированного виртуального узла как ребенка к целевому узлу) или 'Paste near' (для добавления скопированного виртуального узла как соседа к целевому узлу). Скопированный узел вставится в выбранное место дерева требований. Также для копирования узла можно использовать горячие клавиши 'Ctrl+c' и 'Ctrl+v', при этом копирование будет происходить по принципу 'Paste near'.


Удаление виртуального узла

  1. Чтобы удалить виртуальный узел, выберите его в 'Requality Explorer', вызовите правой кнопкой контекстное меню и выберите пункт 'Delete Virtual Node'.
  2. Вы также можете воспользоваться горячей клавишей 'Delete' для удаления виртуального узла.
  3. В появившемся окне подтвердите удаление виртуального узла, нажав кнопку 'OK'.


Редактирование параметров виртуального узла

Чтобы отредактировать параметры виртуального узла, щелкните по нужному виртуальному узлу в 'Requality Explorer', в окне 'Properties' откроются свойства требования.

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

  1. Id

  2. Name

  3. Attributes

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

  4. Target

  5. Iteration method

  6. It.vars

Скрытие виртуального узла

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

Отмена скрытия виртуального узла

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

Проверка корректности дерева проекта

Существует возможность проверить, корректно ли задано все дерево проекта Requality, найти возможные ошибки в описании узлов. Для этого нужно задействовать так называемый 'чекер'. На корневом узле проекта вызовите контекстное меню и выберите пункт 'Enable Checkers'. После этого все узлы, в которых 'чекер' найдет ошибки или проблемы, будут подсвечены.


Результат работы чекера


Контроль версий

Для управления версиями Requality предусматривает работу с CVS, Subversive, EGit или другим Eclipse Team Provider (исключая Subclipse). Открытое в 'Requality Explorer' контекстное меню содержит стандартный пункт 'Team', с помощью которого вы можете манипулировать версиями.

Работа с SVN

Чтобы работать с 'SVN', нужно, во-первых, установить в 'Eclipse' SVN-плагин (см. Установка плагина для взаимодействия с системой контроля версий) и, во-вторых, знать 'URL' репозитория, где уже размещен или будет размещен проект (а так же логин и пароль к репозиторию, в случае, если они требуются для доступа). Рекомендуется использовать плагин Subversive. Все дальнейшие инструкции написаны именно для этого плагина.

Экспорт проекта в SVN

  1. В 'Requality Explorer' на папке проекта вызовите контекстное меню и выберите 'Team → Share Projects...'.
  2. В появившемся окне 'Share Project Wizard' на вкладке 'General' укажите URL репозитория, где вы собираетесь разместить свой проект.


    Ввод URL репозитория


  3. Укажите логин и пароль в полях, соответственно, 'User:' и 'Password:'. Если репозиторий не защищен паролем, эту информацию указывать не требуется.
  4. Нажмите кнопку 'Finish'.


    Ввод комментария и выбор элементов для сохранения в репозиторий


  5. В окне 'Commit' укажите в поле 'Comment' свой комментарий. Убедитесь, что в поле выбора файлов для импортирования галочкой отмечены все файлы проекта. Нажмите 'OK'.
  6. Дождитесь завершения процесса передачи файлов в 'SVN'. При этом в 'Requality Explorer' все узлы проекта должны отображаться без галочки перед именем. Галочка означает наличие несохраненных в 'SVN' изменений в данном узле. Галочкой отмечаются также все родительские узлы, содержащие узел c несохраненными изменениями. Если какой-либо узел после завершения импорта в 'SVN' все еще отмечен галочкой, попробуйте обновить 'Requality Explorer' (кликните по узлу проекта, а потом нажмите 'F5' или в главном меню 'Eclipse' выберите 'File → Refresh'). Если галочка после обновления не исчезла, значит изменения в этом узле не были сохранены в 'SVN'.


    Несохраненные изменения


Загрузка изменений в SVN

Следующие инструкции объясняют, как изменения, сделанные вами в локальной версии проекта, сохранить в репозиторий (в том случае, если проект уже лежит в 'SVN').

Как понять, что проект уже привязан к 'SVN' (то есть вы работаете с локальной копией проекта, лежащего в репозитории): возле имени проекта в 'Requality Explorer' указаны номер версии и путь к репозиторию. Причем указанный номер версии - это номер той версии, которая последняя была синхронизирована с репозиторием.


Версия и адрес репозитория

  1. В 'Requality Explorer' выберите тот узел, изменения которого вы хотите загрузить в репозиторий. Если вы хотите загрузить в репозиторий все изменения, сделанные в проекте, выберите корневой узел проекта.
  2. Вызовите на этом узле контекстное меню и выберите 'Team → Commit'.
  3. В окне 'Commit' укажите в поле 'Comment' свой комментарий. Убедитесь, что в поле выбора файлов для импортирования галочкой отмечены все файлы проекта, которые вы хотите сохранить в репозитории. Нажмите 'OK'.


    Ввод комментария


  4. Если возникнет окно 'User Credentials' с запросом логина и пароля, укажите логин и пароль в полях, соответственно, 'User:' и 'Password:'. Чтобы система больше не спрашивала у вас эту информацию, поставьте галочку 'Save authentication'.


    Ввод логина и пароля


Импорт проекта из SVN

  1. В 'Requality Explorer' на свободном месте вызовите контекстное меню и выберите пункт 'Import...'.
  2. В окне 'Import' выберите 'SVN → Project from SVN' и нажмите 'Next >'.
  3. В окне 'Checkout from SVN' посмотрите список доступных адресов репозиториев.
    1. Если один из доступных репозиториев вам подходит, выберите пункт 'Use existing repository location:', кликните по нужному репозиторию в списке и нажмите 'Next >'.


      Выбор уже существующего в списке репозитория


    2. Если нужного репозитория нет в списке, выберите пункт 'Create a new repository location' и нажмите 'Next >'.


      Выбор нового репозитория


  4. На вкладке 'General' укажите URL репозитория, где вы собираетесь разместить свой проект. Также укажите логин и пароль в полях, соответственно, 'User:' и 'Password:'. (Чтобы система больше не спрашивала у вас эту информацию, поставьте галочку 'Save authentication'.) Если репозиторий не защищен паролем, эту информацию указывать не требуется.


    Ввод URL репозитория


  5. В поле 'URL:' введите путь к проекту в репозитории (включая папку проекта). Нажмите 'Finish'.


    Ввод пути к проекту


  6. В окне 'Check Out As' не меняйте ничего и нажмите 'Finish'.


    Выбор последней ревизии проекта


Обновление проекта из SVN

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

  1. Прежде всего следует закрыть все открытые в редакторе документы. Иначе вам придется переоткрыть их после завершения обновления, чтобы увидеть все внесенные изменения.
  2. В 'Requality Explorer' на нужном проекте вызовите контекстное меню и выберите 'Team → Update'.
  3. Если возникнет окно 'User Credentials' с запросом логина и пароля, укажите логин и пароль в полях, соответственно, 'User:' и 'Password:'. Чтобы система больше не спрашивала у вас эту информацию, поставьте галочку 'Save authentication'.


    Ввод логина и пароля


Импорт-экспорт каталога требований Requality в ReqIF

'Requality' позволяет импортировать каталог требований из формата ReqIF и экспортировать созданный в 'Requality'-проекте каталог требований в ReqIF-формат.

Экспорт каталога требований Requality в ReqIF

Для того, чтобы преобразовать каталог требований из проекта Requality в формат ReqIF, нужно:

  1. На проекте Requality вызвать контекстное меню и выбрать в нем пункт 'Export...'. В открывшемся диалоговом окне выбрать 'Requality' → 'Export to ReqIF' и нажать кнопку 'Next'.


    Выбор экспорта в ReqIF-формат


  2. В новом открывшемся окне нужно выбрать путь к целевой папке проекта, куда требуется поместить преобразованный в ReqIf-формат каталог требований, указать имя для этого ReqIF документа и нажать 'Finish'.
    Выбор файла для экспорта в ReqIF-формат

После этого произойдет экспорт каталога требований в формат ReqIF: каталог требований из 'Requality' проекта будет преобразован в каталог требований в формате ReqIF и размещен в указанном проекте в виде файла с расширением "reqif". Данный ReqIF-файл может быть использован любым инструментом для управления требованиями, который распознает ReqIF-формат.

Импорт каталога требований Requality в ReqIF

Для импорта документа формата ReqIF в проект 'Requality' нужно:

  1. В перспективе 'Requality' в окне 'Requality Explorer' открыть контекстное меню и выбрать пункт 'Import...'.
  2. В открывшемся диалоговом окне выбрать 'Requality' → 'Import from ReqIF' и нажать кнопку 'Next'.


    Выбор импорта из ReqIF-формата


  3. В новом открывшемся окне выбрать в файловой системе требуемый документ формата ReqIF и нажать кнопку 'Next'.


    Выбор файла для импорта из ReqIF-формата


  4. В следующих двух диалоговых окнах нужно указать соответствие элементов ReqIF-формата элементам формата Requality. Сначала откроется окно для сопоставления типов элементов ReqIF и 'Requality'. Для указания связи требуется выбрать в левой колонке тип элемента ReqIf, а в средней - соответствующий ему тип элемента 'Requality', потом нажать кнопку 'Add mapping'. Появившуюся связь можно увидеть в правой колонке, она будет отображена в виде 'тип_ReqIF → тип_Requality'. Существует возможность привязать сразу несколько типов элементов ReqIF к одному типу элемента 'Requality'. Для этого нужно выделить в левой колонке не один тип, а сразу несколько, и дальше действовать по описанной схеме.


    Задание связи между типами ReqIF и Requality форматов


  5. Для того, чтобы удалить некорректно заданную связь, нужно выделить ее в правом столбце и нажать кнопку 'Remove mapping', такая связь будет удалена.


    Удаление связи между типами ReqIF и Requality форматов


  6. Далее следует нажать кнопку 'Next', после чего откроется следующее окно для указания соответствия элементов, в котором требуется указать соответствие атрибутов ReqIF-документа атрибутам формата 'Requality'. Для указания связи требуется выбрать в левой колонке название атрибута ReqIF, а в средней - название соответствующего ему атрибута 'Requality', потом нажать кнопку 'Add mapping'. Появившуюся связь можно увидеть в правой колонке, она будет отображена в виде 'атрибут_ReqIF → атрибут_Requality'. Существует возможность привязать сразу несколько атрибутов ReqIF к одному атрибуту 'Requality'. Для этого нужно выделить в левой колонке не одно имя атрибута, а сразу несколько, и дальше действовать по описанной схеме.


    Задание связи между атрибутами ReqIF и Requality форматов


  7. Для того, чтобы удалить некорректно заданную связь, нужно выделить ее в правом столбце и нажать кнопку 'Remove mapping', такая связь будет удалена.


    Удаление связи между атрибутами ReqIF и Requality форматов


  8. Далее следует нажать кнопку 'Finish'.

После этого будет осуществлен процесс импорта выбранного документа ReqIF в формат проекта 'Requality', при этом будет создан новый проект 'Requality' с каталогом требований, созданным в соответствии с каталогом требований данного ReqIF-документа и выбранными взаимосвязями элементов между форматами ReqIF и 'Requality'.