Requality

h1. Requality: глоссарий

* *Проект Requality* - проект Eclipse, созданный с помощью плагина Requality. Cодержит документы, требования отчеты, комментарии.

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

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

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

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

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

* *Комментарий* - некоторая сущность, содержащая текстовый комментарий, относящийся к требованию или тестовой ситуации. У одного требования/одной тестовой ситуации может быть несколько комментариев.

* *Requality Explorer* - окно в перспективе Requality, отображающее все содержимое проекта (документы, требования, отчеты, комментарии).

* *Markup Editor* - окно в перспективе Requality, редактор документов, используется для разметки фрагментов требований в документах.

* *UniEditor* - окно в перспективе Requality, визуальный редактор для требований, тестовых ситуаций и комментариев. Позволяет добавлять, редактировать и изменять требования, тестовые ситуации и комментарии, а так же изменять статусы требований и тестовых ситуаций. В отличие от редактора Review не дает возможности устанавливать статусы требований и тестовых ситуаций в значение "verified".

!UniEditorView.png!

* *Review* - окно в перспективе Requality, визуальный редактор для требований, тестовых ситуаций и комментариев. Предназначен скорее для просмотра, нежели для редактирования, поэтому обладает ограниченной функциональностью. Позволяет только добавлять, редактировать и удалять комментарии, а так же изменять статусы требований и тестовых ситуаций. В отличие от UniEditor позволяет устанавливать статусы требований и тестовых ситуаций в значение "verified".

!ReviewView.png!

* *Properties* - окно в перспективе Requality, отображает свойства выбранного объекта (требования, документа, тестовой ситуации, отчета, комментария).

* *Параметры требования* - свойства требования, которые устанавливаются в окне ''Properties''.

Для требований окно ''Properties'' содержит 4 вкладки:

1. Вкладка *Main* содержит следующие параметры требования:

1.1. *Id* – идентификатор требования. Идентификатор уникален среди детей одного родителя. Может быть отредактирован вручную.

1.2. *Name* – имя требования. Может не быть уникальным. Совпадает с идентификатором, если не задано отдельно. Может быть отредактировано вручную.

1.3. *Attributes* – атрибуты требования. По умолчанию наследуются от родительских требований, но могут быть переопределены. Применяются в предикатах. Заполняются вручную.

!ReqPropertiesMain.png!

2. Вкладка *Description* содержит следующие параметры требования:

2.1. *Alternative Description* – альтернативный текст требования, уточняет и дополняет текст выделенных фрагментов. Заполняется вручную.

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

!ReqPropertiesDescription.png!

3. Вкладка *Advanced* содержит следующие параметры требования:

3.1. *Predicate* – предикат, условие отбора требований для отчетов. По умолчанию наследуется от родительских требований. Заполняется вручную.

3.2. *Base requirements* – базовые требования. Требования, которые наследует и расширяет данное требование. Указываются вручную.

!ReqPropertiesAdvanced.png!

4. Вкладка *Source* содержит только json-код:

4.1. *json* – низкоуровневое представление требования как сущности. Не редактируется.

!ReqPropertiesSource.png!

* *Параметры тестовой ситуации* - свойства тестовой ситуации, которые указываются в окне ''Properties''. Щелкните по нужной тестовой ситуации в ''Requality Explorer'', в ''Properties'' откроются ее свойства.

Для тестовых ситуаций окно ''Properties'' содержит 4 вкладки:

1. Вкладка *Main*:

1.1. *Id* – идентификатор тестовой ситуации. Идентификатор уникален среди тестовых ситуаций одного требования. Может быть отредактирован вручную.

1.2. *Status* - статус требования, может иметь одно из трех значений: _''in process'', ''complete'' или ''verified''_. Редактируется вручную.

1.3. *Author* - автор требования, редактируется вру

1.4. *Attributes* – атрибуты требования. По умолчанию наследуются от родительских требований, но могут быть переопределены. Применяются в предикатах. Заполняются вручную.

!PurposePropertiesMain.png!

2. Вкладка *Description* содержит следующие параметры тестовой ситуации:

2.1. *Test purpose description* - описание теста, редактируется вручную.

2.2. *Expected results* - ожидаемый после выполнения теста результат.

!PurposePropertiesDescription.png!

3. Вкладка *Advanced* содержит следующие параметры тестовой ситуации:

3.1. *Predicate* – предикат, условие отбора тестовых ситуаций для отчетов. По умолчанию наследуется от родительских требований. Заполняется вручную.

4. Вкладка *Source* содержит только json-код:

4.1. *json* – низкоуровневое представление тестовой ситуации как сущности. Не редактируется.

!PurposePropertiesSource.png!

* *Параметры отчета* - свойства отчета, которые указываются в окне ''Properties''.

Для отчетов окно ''Properties'' содержит 2 вкладки:

1. Вкладка *Report Data*:

1.1. *Root requirement* – требование, для которого создается отчет. В отчет войдет это требование-узел и все его дочерние узлы (требования и комментарии). В случае подключения дополнительных плагинов к Requality в отчет могут войти и узлы других типов. Редактируется вручную.

1.2. *Template* – шаблон, в соответствии с которым модифицируется вид и содержимое отчета. Например, данные можно представить в виде списка или таблицы. Можно включить в отчет все узлы дерева Requirements или только узлы некоторого конкретного типа. В случае использования плагинов к Requality список доступных шаблонов может пополняться. Вы также можете самостоятельно создавать нужные шаблоны. Шаблон редактируется вручную: выбирается из списка доступных шаблонов. По умолчанию доступны 3 шаблона: _''XML-export'', ''Requirements Coverage'' и ''Test Purposes Coverage''_.

*''XML-export''* - отчет в формате XML, предназначем для использования отчета другими интсрументами.

*''Requirements Coverage''* - содержит список всех требований. 

*''Test Purposes Coverage''* - содержит статистику о статусах требований и тестовых ситуаций, а также таблицу всех требований и тестовых ситуаций.

1.3. *Attributes* – атрибуты отчета, аналогичны атрибутам требования. По умолчанию включает один дополнительный атрибут – _''date''_ – дата и время генерации последнего отчета. Атрибут пересоздается каждый раз при генерации отчета. Таблица атрибутов редактируется вручную.

!ReportProperties.png!

2. Вкладка *Source* содержит только json-код:

2.1. *json* – низкоуровневое представление отчета как сущности. Не редактируется.

* *Outline* - окно в перспективе Requality, отображающее список фрагментов документа. 

* *Подтребование*, *дочернее требование* - это требование, являющееся дочерним узлом другого требования в иерархии проекта.