Requality: глоссарий

M

Markup Editor

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


Окно 'Markup Editor'

Module Editor

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


Окно 'Module Editor'

O

Outline

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

P

Properties

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

R

REFERENCE-тип атрибута.

– cпециальный тип атрибутов требований, виртуальных узлов и тестовых ситуаций, позволяющий связывать узел, для которого он указан, с другим узлом из того же каталога проекта 'Requality'. Этот атрибут находится в окне 'Properties' на вкладке 'Main' в таблице 'Attributes'. Это обычный атрибут, у которого указан тип 'REFERENCE', а в качестве значения указан целевой узел, на который идет ссылка.


Атрибут типа 'REFERENCE' в окне 'Properties'

Связанность узлов можно посмотреть в представлении 'Requality Links Explorer'. Ссылки в этом представлении доступны в обе стороны, как у узла, в котором была создана такая ссылка:


Окно 'Requality Links Explorer', исходящая ссылка на связанный узел

так и для узла, к которому она была привязана (на который она ссылается):


Окно 'Requality Links Explorer', входящая ссылка на связанный узел

Requality Explorer

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

Окно Requality Explorer

Requality Links Explorer

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

Review

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


Окно Review

U

UniEditor

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

Окно UniEditor


Update Processor Tasks

– окно в перспективе 'Requality', используемое после автоматического переноса требований в новую версию документа для ручного уточнения корректности переноса требований и ручного переноса фрагментов требований в случае, если они не были перенесены автоматически. Отображает список всех требований и степень успешности их переноса:


Окно Update Processor Tasks


А

Активный шаблон узла (активный шаблон)

- шаблон узла, который выбран в качестве активного для данного типа узлов. Если шаблон выбран в качестве активного, то при создании новых узлов данного типа все узлы будут создаваться по этому шаблону по умолчанию. Изначально для всех узлов проекта выбран пустой шаблон, где все параметры заданы по умолчанию. (Cм. Редактор шаблонов.) Для одного типа узлов активный шаблон может быть только один. Активный шаблон выделяется жирным шрифтом в списке шаблонов в окне редактора шаблонов.


В

Виртуальный узел (Virtual Node)

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

Процесс повторного использования в общем случае осуществляется путем выбора подхода к повторному использованию с последующим указанием целевого элемента для которого будет проводиться переиспользование. На данный момент имеется два возможных подхода к повторному использованию:

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

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

Дерево проекта, содержащее виртуальный узел

Г

Генератор значений атрибута

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

У всех типов узлов проекта 'Requality' (кроме папок и документов) в окне 'Properties' во вкладке Main находится таблица атрибутов (см. 'Таблица атрибутов'). В этой таблице крайний справа столбец называется Generator. При клике в ячейку этого столбца открывается окно генератора значений атрибута - Attribute value generator.

Окно Attribute value generator содержит следующие параметры:


Д

Документ (Document)

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

К

Комментарий (Comment)

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

Н

Настройки отчета (Report settings)

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

О

Отчет (Report)

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

Отчет по шаблону Coverage

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

  1. Файл с информацией о покрытии, записанной в определенном формате
  2. Автоматический поиск файлов, содержащих идентификаторы покрытых ими требований или тестовых ситуаций.
    При использовании этого источника происходит поиск по выбранным пользователем проектам в workspace на предмет обнаружения файлов с заданным расширением. Расширение задается пользователем. Для указанных файлов производится построчная проверка содержимого файла на соответствие регулярному выражению, описанному пользователем. В результате такого поиска инструмент получает набор покрытых элементов и информацию о покрывающих файлах.

Отчет по шаблону Document Model

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

  1. Файл с информацией о покрытии, записанной в определенном формате
  2. Автоматический поиск файлов, содержащих идентификаторы покрытых ими требований или тестовых ситуаций
    При использовании этого источника происходит поиск по выбранным пользователем проектам в workspace на предмет обнаружения файлов с заданным расширением. Расширение задается пользователем. Для указанных файлов производится построчная проверка содержимого файла на соответствие регулярному выражению, описанному пользователем. В результате такого поиска инструмент получает набор покрытых элементов и информацию о покрывающих файлах.

Отчет по шаблону Progress

– отчет со статистикой по разным ревизиям, загруженным в SVN.>

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

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


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

Отчет по шаблону Traceability

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

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


П

Параметры виртуального узла

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

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

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

  2. Вкладка Iteration содержит следующие параметры виртуального узла:
  3. Вкладка Source содержит только json-код:
    Вкладка Source окна Properties для виртуального узла



Параметры Комментария

– свойства узла Комментарий, которые указываются в окне 'Properties'. (Также могут быть в сокращенном виде просмотрены и отредактированы в 'окне редактирования параметров'.)

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

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

  2. Вкладка Source содержит только json-код:
    Вкладка Source окна Properties для комментария


Параметры Настроек отчета

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

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

  1. Вкладка Report Settings:
    Окно Properties для Настроек отчета
  2. Вкладка Source содержит только json-код:


Параметры отчета

– параметры узла Свойства отчета, на основе которых отчет был сгенерирован. Указываются в окне 'Properties'.

Полностью идентичны параметрам узла Свойства отчета (за исключением атрибута 'date'), однако не могут быть отредактированы (за исключением параметра 'Id').


Окно Properties для отчета

Параметры проекта 'Requality' (свойства проекта)

– свойства проекта 'Requality', задаются как параметры корневого узла проекта. Устанавливаются в окне 'Properties'.

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

  1. 'Main'


    Вкладка Main окна Properties для проекта 'Requality'

  2. 'Templates' - содержимое этой вкладки полностью совпадает с содержимым окна 'Редактора шаблонов' и имеет ту же функциональность. См. 'Редактор шаблонов'.


    Вкладка Templates окна Properties для проекта 'Requality'



Параметры тестовой ситуации

– свойства тестовой ситуации, которые указываются в окне 'Properties'. (Также могут быть в сокращенном виде просмотрены и отредактированы в 'окне редактирования параметров'.)

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

  1. Вкладка Main:


    Вкладка Main окна Properties для тестовой ситуации


  2. Вкладка Description:


    Вкладка 'Description' окна 'Properties' для тестовой ситуации


  3. Вкладка Advanced содержит:


    Вкладка Advanced окна Properties для тестовой ситуации


  4. Вкладка Source:


    Вкладка Source окна Properties для тестовой ситуации



Параметры текстового узла

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

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

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

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


    Вкладка Description окна Properties для текстового узла

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

  4. Вкладка Source содержит только json-код:
    Вкладка Source окна Properties для текстового узла



Параметры требования

– свойства требования, которые устанавливаются в окне 'Properties'. (Также могут быть в сокращенном виде просмотрены и отредактированы в 'окне редактирования параметров'.)

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

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

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


    Вкладка Description окна Properties для требования

  3. Вкладка Advanced содержит:
    Вкладка Advanced окна Properties для требования

  4. Вкладка Source содержит только json-код:
    Вкладка Source окна Properties для требования



Параметры узла

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


Параметры шаблона узла

– свойства шаблона узла (см. 'Шаблон узла'). Параметры шаблона узла определенного типа полностью аналогичны параметрам узла этого типа. Устанавливаются в окне 'Properties'. (Также могут быть в сокращенном виде просмотрены и отредактированы в 'окне редактирования параметров'.

Перечисляемый тип атрибута (Enum)

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


Подтребование, дочернее требование (sub-requirement, child-node)

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

Проект Requality (Requality project)

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

Р

Редактор значений списка

– редактор значений атрибута типа 'LIST' (список). Если в 'Properties view' узла есть атрибут типа 'LIST', то для задания и редактирования его значений используется 'Редактор значений списка'. Редактор открывается в специальном окне, которое содержит два следующих элемента:

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

– редактор шаблонов узлов (см. 'Шаблон узла'). Позволяет создавать, удалять, редактировать шаблоны узлов и задавать активные шаблоны. Открывается из редакторов: 'Module Editor', 'UniEditor', 'Review'.

Содержит поля:

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

Т

Таблица атрибутов (атрибуты)

– это набор параметров - атрибутов - узла проекта 'Requality', которые характеризуют различные свойства этого узла.


Таблица атрибутов - общий вид


Атрибуты представлены в виде таблицы с полями 'Name' (имя атрибута), 'Type' (тип), 'Value' (значение), 'Scope' (область видимости) и 'Generator' (генератор значений атрибута).


Тестовая ситуация (Test purpose)

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

Текстовый узел (Text Node)

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


Требование (Requirement)

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


У

Уточняемое требование

– требование, на которое ссылается другое (уточняющее) требование.

Уточняющее требование

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

Ф

Файл с информацией о покрытии

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

Записывается следующим образом:

<?xml version="1.0" encoding="UTF-8"?>
<coverageInfo> 
  <reqcoverage qid="уникальный_идентификатор_требования_или_тестовой_ситуации">
    <covered_by uri="путь_к_покрывающему_элементу" [hits="1"]/>
  </reqcoverage>
  <reqcoverage qid="уникальный_идентификатор_требования_или_тестовой_ситуации">
    <covered_by uri="путь_к_покрывающему_элементу"/>
  </reqcoverage>
  <error [name="имя_ошибки"] testuri="uri_элемента_covered_by" [uri="ссылка_на_описание_ошибки"]>
      [<violates qid="уникальный_идентификатор_требования_или_тестовой_ситуации"/>]*
      [<description [format="вид_описания_ошибки"]>описание_ошибки</description>]
  </error>
</coverageInfo>

Здесь:

Квадратными скобками обозначены опциональные параметры.

  1. coverageInfo - может быть только один экземпляр в файле. Он содержит вложенные XML-элементы reqcoverage (один или несколько) и error (может не быть, может быть один или несколько).
  2. reqcoverage - элемент-ребенок для coverageInfo. Должен быть задан отдельно для каждого покрытого Requality-элемента. (Непокрытые узлы не описываются никак.) Содержит вложенные XML-элементы covered_by (один или несколько). Каждому вложенному covered_by должен соответствует одна тестовая процедура или тест. Имеет атрибут qid.
  3. qid - это user-visible-name(element) или qualifying-id(element) покрываемого элемента:
  4. covered_by - элемент-ребенок для reqcoverage. Внутри reqcoverage их может быть несколько в зависимости от того, сколько тестовых процедур или тестов покрывают соответствующий ему Requality-элемент. Каждый covered_by соответствует одному покрывающему Requality-элементу. covered_by меет атрибуты uri и hits.
  5. uri - атрибут XML-элемента covered_by, указывает путь к тесту, описанному в этом covered_by элементе:
  6. hits - атрибут XML-элемента covered_by, является опциональным. Указывает количество упоминаний этого требования reqcoverage в тесте covered_by.
  7. error - элемент для описания ошибки, полученной в результате выполнения теста. Может содержать один элемент description с описанием ошибки. Может включать один или несколько элементов violates в ситуации, когда можно определить какие именно требования нарушает ошибка. Имеет атрибут testuri и опциональные атрибуты name и uri.
  8. testuri - путь к одному из тестов, описанному в covered_by элементе.
  9. name - опциональный параметр, представляет собой отображаемое имя ошибки. В случае если не определен, используется имя "error"+порядковый_номер_ошибки.
  10. uri - опциональный параметр, путь к файлу с подробной информацией об ошибке.
  11. violates - опциональный элемент, соответствует требованию, которое нарушает ошибка. Каждый элемент violates соответствует одному нарушенному требованию. Имеет атрибут qid. Если элемент violates не указан, ошибка в отчете отображена не будет.
  12. qid – это user-visible-name(element) или qualifying-id(element) покрываемого элемента (подробнее см. выше, в описании элемента reqcoverage).
  13. description - опциональный элемент, текстовое описание ошибки. Имеет опциональный атрибут format.
  14. format - формат описания ошибки. Может быть "html" или "plain". В случае "plain" все html теги будут отображаться в виде текста.
  15. описание_ошибки представляет собой описание ошибки, при этом для формата "html" допускается использование html тегов для форматирования текста.


Фрагмент требования (выделенный фрагмент документа, фрагмент, Location)

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

Ш

Шаблон узла

– это некоторая сущность, соответствующая одному из типов узлов ('Comment', 'Report Settings', 'Requirement', 'Test Purpose', 'Text Node', 'Virtual Node') проекта 'Requality', которая служит шаблоном для создания новых узлов того же типа.