mirror of
https://github.com/bia-technologies/yaxunit.git
synced 2025-04-20 11:38:01 +02:00
87 lines
7.9 KiB
Markdown
87 lines
7.9 KiB
Markdown
# Конфигурация запуска
|
|
|
|
Конфигурация настраивается в файле json и может иметь следующие параметры.
|
|
|
|
## Основные параметры
|
|
|
|
| Имя параметра | Тип | Значение по умолчанию | Описание |
|
|
|-------------------|-----------|---------------------------------------------------------|--------------------------------------------------------------------------------------------------------------|
|
|
| `filter` | `Object` | [Object, смотрите ниже](#параметры-фильтрации) | Параметры фильтрации, поиска тестов |
|
|
| `reportFormat` | `String` | `"jUnit"` | Формат отчета о тестировании, возможные значения: `"jUnit"`, `"JSON"` , `"allure"` |
|
|
| `reportPath` | `String` | `""` | Путь к формируемому отчету, можно указать или каталог (в которому будет создан файл отчета) или путь к файлу |
|
|
| `closeAfterTests` | `Boolean` | `True` | Признак закрытия 1С:Предприятие по завершению тестирования |
|
|
| `showReport` | `Boolean` | `True` | Открыть форму отчета завершению тестирования |
|
|
| `logging` | `Object` | [Object, смотрите ниже](#параметры-логирования) | Параметры логирования, подробнее ниже |
|
|
| `exitCode` | `String` | `""` | Путь к файлу, в который будет записан признак успешного выполнения (0 - успешно, 1 - есть ошибки) |
|
|
| `projectPath` | `String` | `""` | Путь к каталогу проекта, содержащему файлы для тестов |
|
|
| `rpc` | `Object` | [Object, смотрите ниже](#параметры-внешнего-управления) | Параметры подключения к серверу внешнего управления, подробнее ниже |
|
|
|
|
## Параметры фильтрации
|
|
|
|
| Имя параметра | Тип | Значение по умолчанию | Описание |
|
|
|---------------|---------|-----------------------|-------------------------------------------------------------------------------------|
|
|
| `extensions` | `Array` | `["tests"]` | Список имен расширений, из которых грузятся тесты |
|
|
| `modules` | `Array` | `Null` | Список имен модулей, из которых грузятся тесты |
|
|
| `tests` | `Array` | `Null` | Список полных путей к исполняемым тестам (`[имя модуля.имя теста{.Имя контекста}]`) |
|
|
| `suites` | `Array` | `Null` | Список имен тестовых наборов, которые будут запускаться |
|
|
| `tags` | `Array` | `Null` | Список тегов, которые будут запускаться |
|
|
| `contexts` | `Array` | `Null` | Список имен контекстов исполнения, в которых будут запускаться тесты |
|
|
|
|
## Параметры логирования
|
|
|
|
| Имя параметра | Тип | Значение по умолчанию | Описание |
|
|
|---------------|-----------|-----------------------|--------------------------------------------------------------------------------------------------------------------------------|
|
|
| `file` | `String` | `""` | Путь к файлу лога |
|
|
| `enable` | `Boolean` | `Null` | Использование логирвания.<br/>Если не указан, зависит от параметра `file` и `console`, если установлены - вкл, если нет - выкл |
|
|
| `console` | `Boolean` | `false` | Вывод лога в stdout (консоль) |
|
|
| `level` | `String` | `"debug"` | Уровень детализации лога. Возможные значения: `"debug"`, `"info"`, `"warning"`, `"error"` |
|
|
|
|
## Параметры внешнего управления
|
|
|
|
Служебные параметры, для настройки взаимодействия YAxUnit и 1С:EDT.
|
|
|
|
| Имя параметра | Тип | Значение по умолчанию | Описание |
|
|
|---------------|-----------|-----------------------|------------------------------------|
|
|
| `enable` | `Boolean` | `false` | Использование внешнего управления |
|
|
| `transport` | `String` | `"ws"` | Используемый транспортный протокол |
|
|
| `port` | `Boolean` | `0` | Порт сервера |
|
|
| `key` | `String` | `""` | Ключ клиента, для рукопожатия |
|
|
|
|
## Примеры
|
|
|
|
1. Запустить тесты расположенные в модулях `МодульТестов1`, `МодульТестов2`, закрыть предприятие по завершении и сохранить отчет в формате `junit`
|
|
|
|
```json
|
|
{
|
|
"filter": {
|
|
"modules": ["МодульТестов1", "МодульТестов2"]
|
|
},
|
|
"reportPath": "C:\\temp\\jUnit\\report.xml",
|
|
"reportFormat": "jUnit",
|
|
"closeAfterTests": true
|
|
}
|
|
```
|
|
|
|
2. Запустить все тесты из расширения `YAXUNIT` и сохранить отчет файл `C:\temp\jUnit\report.xml`, остальные параметры будут установлены по умолчанию
|
|
|
|
```json
|
|
{
|
|
"filter": {
|
|
"extensions": ["YAXUNIT"]
|
|
},
|
|
"reportPath": "C:\\temp\\jUnit\\report.xml"
|
|
}
|
|
```
|
|
|
|
3. Запустить все тесты с выводом подробного лога в файл, сохранить отчет файл `C:\temp\jUnit\report.xml`
|
|
|
|
```json
|
|
{
|
|
"reportPath": "C:\\temp\\jUnit\\report.xml",
|
|
"logging": {
|
|
"file": "C:\\temp\\jUnit\\tests.log",
|
|
"level": "debug"
|
|
}
|
|
}
|
|
```
|