Working with reqdb console interface¶

Описание¶

Дистрибутив ReqDB выглядит следующим образом:

/..
/bin
/libs
/src
/templates
 reqdb-someversion.jar

В папке /bin находится три файла для работы с reqdb в консольном режиме: reqdb, reqdb.64 и reqdb.exe. Первые два позволяют вам работать в Linux системе, последний - в Windows. Так же в этой папке лежит logger.properties. В этом файле описаны простые настройки logging системы.
Если вы работаете в Linux, reqdb и reqdb.64 нужно сделать executable. Достаточно набрать следующую команду в консоли:

$ chmod +x reqdb

или

$ chmod +x reqdb.64

reqdb.64 используется, если у вас Linux x64.

Настройка логов¶

Настройки для логов хранятся в файле bin/logger.properties. По умолчанию он выглядит следующим образом:

appender.type=console
log.path=/tmp/reqdb-logs/reqdb.log

appender.type - тип вывода информации логов. Всего поддерживается два типа: console и file. По умолчанию стоит значение console. Все логи в этом режиме будут выводиться на консоль монитора.
Если же вы хотите, чтобы логи писались в файл, установите appender.type=file. При этом не забудьте указать путь к файлу log.path, в который будут сохраняться логи. Совсем не обязательно, чтобы файл существовал. Если такового не существует, он будет создан автоматически. При этом, конечный файл будет выглядеть следующим образом: /tmp/reqdb-logs/reqdb_DD-MM-YYYY.log. При изменении даты в календаре будет создаваться новый log-файл в соответствии с этим шаблоном.

Замечание! Если вы работаете на Windows платформе, log.path нужно указывать с использованием двойных slash символов "\\", 
как показано в этом примере: log.path=C:\\reqdb-logs\\reqdb.log

Работа с консольным интерфейсом¶

Если вы запустите один из вышеописанных файлов без каких-либо параметров, то на консоль будет выведена следующая информация:

Usage: reqdb <help|import|convert|init|report> [params]

Вы видите, что в интерфейсе используется 5 параметров.

help параметр выводит вспомогательную информацию о других параметрах. Например, вызов

$reqdb help import

выведет на экран следующую информацию

Usage: reqdb import <input file> <path to catalogue> <root id>
OR
reqdb import <input file> <path to catalogue> <root id> <branch path>

import позволяет импортировать существующий документ с разметкой требований в каталог требований. Для данного параметра предусмотрено следующие использование:

Usage: reqdb import <input file> <path to catalogue> <root id>
OR
reqdb import <input file> <path to catalogue> <root id> <branch path>

<input file> - путь к документу, который должен быть импортирован в каталог требований; <path to catalogue> - путь к каталогу требований; <root id> - идентификатор корневого требования; <branch path> - путь branch''а импортируемых требовании.

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

Usage: reqdb convert <input file> <output file> <opt_encoding>
OR
reqdb convert <input dir> <output dir> <opt_encoding>

<input file> - путь к html файлу со старой разметкой требований; <output file> - путь к результирующему файлу; <input dir> - путь к директории с документами; <output dir> - путь к директории куда будут сохранены файлы; <opt_encoding> - кодировка (если параметр не указан, то используется стандартная кодировка UTF-8).

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

Usage: reqdb init <path to new catalogue>

<path to new catalogue> - путь, где должен быть создан новый каталог требований.

report позволяет генерировать отчет. Для данного параметра предусмотрено следующие использование:

Usage: reqdb report <path to template> <path to catalogue> <root id> <save location>

<path to template> - путь к template.xml (в нем описывается связка - имя файла с freemarker шаблоном -> имя результирующего файла); <path to catalogue> - путь к каталогу требований; <root id> - идентификатор корневого требования; <save location> - путь к папке, куда должен быть сохранен файл с отчетом.

complex-import позволяет одновременно импортировать html документ со старой разметкой требований и требования из него в базу данных. Для данного параметра предусмотрено следующие использование:

Usage: reqdb complex-import <input dir> <catalogue path> <root id> <opt_branch>

<input dir> - путь к директории, где хранятся html документы; <catalogue path> - путь к каталогу требований; <root id> - идентификатор корневого требования; <opt_branch> - путь branch''а импортируемых требовании.