Project

General

Profile

Reqeditor-getting-started » History » Version 76

Yuriy Shekochihin, 09/03/2010 03:29 PM

1 75 Yuriy Shekochihin
h1. Getting started with Requality
2 1 Yuriy Shekochihin
3 75 Yuriy Shekochihin
Requality является инструментом для организации каталога требований. Этот инструмент выполнен в виде расширения для Eclipse. 
4 2 Yuriy Shekochihin
5 75 Yuriy Shekochihin
Найти подробную информацию о Requality можно по адресу: http://forge.ispras.ru/projects/show/reqdb
6 2 Yuriy Shekochihin
7 30 Илья Рудаков
h2. 1. Установка
8 1 Yuriy Shekochihin
9 16 Илья Рудаков
h3. 1.1 Системные требования
10 1 Yuriy Shekochihin
11 70 Yuriy Shekochihin
* Firefox 3.5 или выше ( http://www.mozilla.com/ );
12 76 Yuriy Shekochihin
* Eclipse Platform 3.6 или выше ( http://www.eclipse.org/downloads/ );
13 70 Yuriy Shekochihin
* XULRunner 1.9 или выше ( https://developer.mozilla.org/En/XULRunner );
14 2 Yuriy Shekochihin
15 16 Илья Рудаков
h3. 1.2 Установка Eclipse
16 1 Yuriy Shekochihin
17 73 Yuriy Shekochihin
Подробнее про установку Eclipse можно прочитать на странице http://wiki.eclipse.org/FAQ_Where_do_I_get_and_install_Eclipse%3F
18 1 Yuriy Shekochihin
19 72 Yuriy Shekochihin
h3. 1.3 Установка XULRunner (Windows)
20
21
Для установки XULRunner необходимо распаковать архив с дистрибутивом и выполнить регистрацию установки. Регистрация установки выполняется командой: 
22
<pre>xulrunner.exe --register-global</pre>
23
24 74 Yuriy Shekochihin
h3. 1.4 Установка Requality
25 2 Yuriy Shekochihin
26 74 Yuriy Shekochihin
Установить Requality можно с помощью update сайта. Для этого в оконном меню Eclipse''а нужно выбрать пункт "Help"->"Install New Software..."
27
В диалоговом окне добавить update-сайт requality, нажав на кнопку "Add..."
28 1 Yuriy Shekochihin
29 74 Yuriy Shekochihin
Name: Requality update site
30
31
Location: http://forge.ispras.ru/repo/requality/site
32 19 Илья Рудаков
33 21 Илья Рудаков
h2. 2. Разметка требований
34 20 Илья Рудаков
35 34 Илья Рудаков
Рассмотрим подробнее работу инструмента на примере требований к функции g_array_sized_new()
36 2 Yuriy Shekochihin
библиотеки glib.
37
38 20 Илья Рудаков
h3. 2.1 Подготовка к работе
39 1 Yuriy Shekochihin
40 76 Yuriy Shekochihin
Перед началом работы необходимо открыть перспективу Requality. Для этого нажмите на значок "Open Perspective", находящийся в верхнем правом углу, как показано на следующем рисунке.
41 1 Yuriy Shekochihin
42 60 Илья Рудаков
!choose_persp1.png!
43 23 Илья Рудаков
44 63 Илья Рудаков
Далее выберите "Other..."
45 11 Yuriy Shekochihin
46 61 Илья Рудаков
!choose_persp2.png!
47 11 Yuriy Shekochihin
48 76 Yuriy Shekochihin
Появится диалоговое окно, в котором нужно выбрать Requality и после нажать кнопку "OK", как показано на рисунке ниже.
49 24 Илья Рудаков
50 60 Илья Рудаков
!select-persp-dialog.png!
51 24 Илья Рудаков
52 76 Yuriy Shekochihin
В перспективе Requality по умолчанию открыты отображения "Documents" и "Requirements". В "Documents" будет отображаться дерево документов, в "Requirements" - дерево требований.
53 11 Yuriy Shekochihin
54 60 Илья Рудаков
!persp-view.png!
55 11 Yuriy Shekochihin
56 20 Илья Рудаков
h3. 2.2 Создание нового каталога
57 1 Yuriy Shekochihin
58 26 Илья Рудаков
Теперь нам нужно создать каталог требований. Под каталогом требований мы будем понимать контейнер, в котором хранятся документы и требования. Чтобы создать каталог требований, зайдите в File -> New -> Other, как показано ниже.
59 25 Илья Рудаков
60 1 Yuriy Shekochihin
!Catalog-call-wizards.png!
61 26 Илья Рудаков
62 27 Илья Рудаков
Вы увидите диалоговое окно. Выберите Unitesk Wizards -> Catalogue of Requirements  и нажмите Next.
63 10 Yuriy Shekochihin
64 1 Yuriy Shekochihin
!Catalog-select-wizard.png!
65 27 Илья Рудаков
66
В следующем диалоговом окне нужно указать имя каталога. В нашем примере мы назвали его "Glib-Catalogue". Жмем Finish.
67 9 Yuriy Shekochihin
68
!Catalog-_wizard_creates_new_cat.png!
69
70 12 Yuriy Shekochihin
В итоге должно получиться следующее:
71
72
!cat-after-creation.png!
73
74 20 Илья Рудаков
h3. 2.3 Импорт документа в каталог
75 1 Yuriy Shekochihin
76 66 Илья Рудаков
<pre>
77 76 Yuriy Shekochihin
В данный момент инструмент Requality позволяет работать с документами в кодировке UTF-8.
78 66 Илья Рудаков
</pre>
79
80 57 Илья Рудаков
Теперь нужно добавить документ в каталог. Для этого в Documents нажимаем правой кнопкой мыши на каталог требований "Glib-Catalogue". В появившемся меню выбираем "Import here".
81 53 Илья Рудаков
82 52 Илья Рудаков
!Doc-import-call.png!
83 53 Илья Рудаков
84 67 Илья Рудаков
В диалоговом окне в поле "Import file:" указываем путь к документу с помощью кнопки "Browse...". В нашем примере это "glib-Arrays.html":http://forge.ispras.ru/attachments/113/glib-Arrays-utf8.html.
85 53 Илья Рудаков
В поле "Save to:" при помощи кнопки "Browse..." указываем путь к папке Documents, которая находится в каталоге требований "Glib-Catalogue".
86
87 54 Илья Рудаков
!Doc-import-dialog.png!
88 53 Илья Рудаков
89
Чтобы открыть документ, добавленный в каталог требований, нужно двойным щелчком мыши нажать на название документа в отображении Documents, как показано ниже. Чтобы функционал разметки документа работал, важно открывать документы именно через отображение "Documents", а не через отображение "Project Explorer"!
90
91 52 Илья Рудаков
!Doc-open.png!
92 2 Yuriy Shekochihin
93 40 Илья Рудаков
h3. 2.4 Создание требований
94 1 Yuriy Shekochihin
95 42 Илья Рудаков
Теперь давайте создадим простую иерархию требований. Для этого перейдем в "Requirements", выделим каталог требований "Glib-Catalogue" и нажмем на правую кнопку мыши. Далее нажимаем на "Add requirement", как показано ниже.
96 40 Илья Рудаков
97 1 Yuriy Shekochihin
!Req-new-call.png!
98 42 Илья Рудаков
99
Появится диалоговое окно, в котором нужно указать имя требования. В нашем примере это "g_array_sized_new".
100
101 1 Yuriy Shekochihin
!Req-set-name.png!
102 42 Илья Рудаков
103
Следующий шаг - аналогичным образом добавим дочерние требования с именами: "01", "02", "03" и "04" к "g_array_sized_new". 
104
105 41 Илья Рудаков
!Req-new-call2.png!
106 40 Илья Рудаков
107
h3. 2.5 Добавление выделенного текста из документа в требование
108
109 35 Илья Рудаков
Выберите в Documents нужный вам документ и двойным щелчком мыши откройте его. Далее выделите текст в документе, как показано ниже.
110
111
!Req7.png!
112
113
После того как текст выделен нажмите правую кнопку мыши и выберете "Add to requirement...".
114
115
!Req9.png!
116
117 38 Илья Рудаков
Появится диалоговое окно, в котором вы можете выбрать к какому требованию добавить выделенный текст. В нашем примере мы добавляем текст к требованию g_array_sized_new.01.
118
119
!Req-select.png!
120
121 49 Илья Рудаков
После нажатия кнопки "OK", выбранный текст будет подсвечен желтым цветом в документе, как показано ниже.
122 36 Илья Рудаков
123 1 Yuriy Shekochihin
!Req.png!
124 49 Илья Рудаков
125 50 Илья Рудаков
Аналогичным образом размечаем еще три текстовых сегмента и добавляем их в требования g_array_sized_new.02, -03 и -04 соответственно. Сохраняем документ. После сохранения все размеченные текстовые фрагменты будут добавлены в базу требований.
126 49 Илья Рудаков
127
!Doc-save.png!
128 36 Илья Рудаков
129 43 Илья Рудаков
h3. 2.6 Удаление размеченного текста из требования
130 1 Yuriy Shekochihin
131 43 Илья Рудаков
Чтобы удалить размеченный текст из требования, достаточно один раз кликнуть мышью по тексту. Текст поменяет цвет с желтого на розовый. Это значит, что вы, таким образом, выбрали именно этот участок текста.
132 44 Илья Рудаков
После этого нажмите правую кнопку мыши и выберите "Remove from requirement".
133
134
!Req10.png!
135 43 Илья Рудаков
136 45 Илья Рудаков
h3. 2.7 Редактирование требований
137 1 Yuriy Shekochihin
138 47 Илья Рудаков
Чтобы открыть окно редактирования требования, нужно в Requirements выбрать нужное требование и двойным щелчком мыши его открыть.
139
В открывшемся окне вы увидите раздел "Main information". Здесь указана информация об id требования, об всех размеченных текстовых фрагментах из документа( поле "Description" ) и т.д.
140
141 1 Yuriy Shekochihin
!Req11.png!
142 47 Илья Рудаков
143
Вы можете добавить к требованию альтернативное описание в поле "Alternative description".
144
145 1 Yuriy Shekochihin
!Req-edit-desc.png!
146
147 48 Илья Рудаков
Так же, в графе "Additional information" вы можете добавить предикаты и атрибуты.
148 47 Илья Рудаков
149
!Req-erit-attr-pred.png!
150 9 Yuriy Shekochihin
151 28 Илья Рудаков
h2. 3. Генерация отчета
152
153 1 Yuriy Shekochihin
Итак, мы дошли до генерации отчета о покрытии. Наведите курсор на название каталога требований во вкладке Requirements и нажмите на правую кнопку мыши - появится всплывающие меню. Выберите Generate Report, как показано ниже.
154 9 Yuriy Shekochihin
155 29 Илья Рудаков
!RepGen-call.png!
156
157
Появится диалоговое окно. 
158
В нем четыре пункта для ввода:
159
# *Root* - определяет корневое требование в вашей иерархии требований;
160
# *Data* - путь к шаблону FreeMarker. Файл с расширением .ftl;
161
# *Template* - путь к файлу template.xml;
162 8 Yuriy Shekochihin
# *Save to* - путь к директории куда мы хотим сохранить получившийся отчет.
163 1 Yuriy Shekochihin
164
!RepGen-dialog.png!