Конфигурация
Примеры настройки
- Testplane
- Playwright
- Jest
export = {
// ...
plugins: {
'html-reporter/testplane': {
enabled: true,
path: 'html-report',
},
},
};
// playwright.config.ts
export default defineConfig({
// ...
reporter: [
['html-reporter/playwright', {
enabled: true,
defaultView: 'failed',
path: 'html-report',
}],
],
});
const config = {
// ...
reporters: [
'html-reporter/jest', // Подключаем наш репортер
'default' // Встроенный репортер Jest или любые другие необходимые (опционально)
],
};
Если нужно передать параметры конфигурации, можно сделать так:
const config = {
// ...
reporters: [
['html-reporter/jest', {
path: 'html-report',
}]
],
};
html-reporter/build/jest
.Справочник по параметрам конфигурации
Параметр | Тип | По умолчанию | Описание |
enabled | boolean | true | Включить / отключить плагин. |
path | string | "testplane-report" | Путь к папке для сохранения файлов html-отчета. |
saveErrorDetails | boolean | false | Сохранять / не сохранять подробности ошибок в json-файлах. |
uiMode | string | null | Режим интерфейса по умолчанию: "old" для классического интерфейса, "new" для современного интерфейса. |
defaultView | string | "all" | Режим фильтрации тестов при отображении, который будет установлен по умолчанию. |
diffMode | string | "3-up" | Режим просмотра диффов, который будет установлен по умолчанию. |
baseHost | string | N/A | Заменяет оригинальный адрес хоста для просмотра в браузере. |
errorPatterns | ErrorPattern[] | string[] | [] | Паттерны ошибок с подсказками для улучшения UX отчета. |
metaInfoBaseUrls | Record<string, string> | {} | Базовые URL-адреса для формирования ссылок в разделе Meta на основе мета-информации о прогоне теста. |
saveFormat | string | "sqlite" | ПАРАМЕТР УСТАРЕЛ. Позволяет задать формат, в котором будут сохранены результаты прогона тестов. |
customGui | CustomGUI | { } | ПАРАМЕТР УСТАРЕЛ. Используйте вместо него plugins. Описание собственных элементов управления для GUI-режима. |
pluginsEnabled | boolean | false | Включить плагины для отчета. |
plugins | Plugin[] | [] | Список плагинов с их настройками. |
customScripts | AnyFunction[] | [] | Список функций, реализующих кастомные скрипты. Например, скрипты Яндекс.Метрики или Жучка. |
yandexMetrika | YandexMetrika | см. ниже | Яндекс.Метрика. |
enabled
Включает или отключает плагин.
path
Путь к папке для сохранения файлов html-отчета. По умолчанию файлы будут сохранены в папку testplane-report
в текущей рабочей папке.
saveErrorDetails
Сохранять или не сохранять подробности ошибок в json-файлах (в папку error-details
).
По умолчанию «не сохранять»: false
.
Любой плагин testplane может добавить какие-либо подробности в объект ошибки при её возникновении. Эти подробности могут помочь пользователю в отладке проблем, которые возникли в тесте. Html-reporter сохраняет эти детали в папке error-details
в файле с именем: <хэш от полного названия теста>-<браузер>_<номер ретрая>_<временная метка>.json
.
Под стектрейсом html-reporter добавляет раздел Error details
со ссылкой <title>
, указывающей на json-файл. Пользователь может открыть этот файл либо в браузере, либо в любой IDE.
Пример как добавить подробности в объект ошибки из плагина:
const err = new Error("some error");
err.details = {
title: "description, will be used as url title",
data: {}, // или [], или String
};
throw err;
uiMode
Режим интерфейса по умолчанию: "old" для классического интерфейса, "new" для современного интерфейса. Влияет на редиректы между старым и новым интерфейсом.
По умолчанию редиректы не выполняются.
Доступны следующие значения: "old"
, "new"
.
Например, если установлено значение "new"
, то пользователи будут перенаправляться на новый интерфейс при попытке доступа к старому интерфейсу. Однако, если пользователь вручную нажмет кнопку "вернуться к старому интерфейсу", эта настройка будет сохранена, и он всегда будет использовать старый интерфейс, пока не переключится обратно.
defaultView
Режим фильтрации тестов при отображении, который будет установлен по умолчанию. Доступны следующие значения:
Режим | Описание |
all | все тесты |
passed | только успешные тесты |
failed | только упавшие тесты |
retried | только те тесты, в которых были ретраи (повторные запуски) |
skipped | только отключенные (заскипанные) тесты |
По умолчанию: all
, то есть если параметр не задан, то будут показываться все тесты.
diffMode
Режим просмотра диффов, который будет установлен по умолчанию. Доступны следующие значения:
Режим | Описание |
3-up | все изображения (expected, actual, diff) в одном столбце, друг под другом |
3‑up‑scaled | все изображения (expected, actual, diff) в один ряд так, чтобы они помещались на экране |
only-diff | только дифф (diff) |
switch | эталонное изображение с возможностью переключаться на актуальное изображение по клику мыши |
swipe | актуальное изображение поверх эталонного, с разделителем открывающим эталонное изображение |
onion-skin | актуальное изображение поверх эталонного с возможностью менять прозрачность актуального изображения |
По умолчанию: 3-up
.
baseHost
Заменяет оригинальный адрес хоста для просмотра в браузере. По умолчанию оригинальный адрес хоста не изменяется.
errorPatterns
Паттерны ошибок используются:
- чтобы показать более понятную информацию об ошибках, если они соответствуют паттернам, для которых есть подробное описание;
- в режиме отображения
Group by
с выбранным ключомerror
.
Паттерны ошибок можно задавать как в виде объектов, так и в виде строк.
Чтобы задать паттерн ошибки в виде объекта, используйте следующий формат:
{
name: '<название ошибки>',
pattern: '<паттерн ошибки>',
hint: '<подсказка пользователю>'
}
где:
Параметр | Тип | Описание |
name | string | Название ошибки. |
pattern | string | RegExp | Регулярное выражение или обычная строка, которой должна соответствовать ошибка. |
hint | string | Необязательный параметр. Подсказка, что можно сделать с данной ошибкой: почему она возникла, как её исправить и т. п. |
Если паттерн ошибки задан в виде строки, например: <ошибка>
, то эта строка автоматически рассматривается как объект вида:
{
name: '<ошибка>',
pattern: '<ошибка>'
}
Такой способ задания паттерна удобен для тех ошибок, у которых name
и pattern
полностью совпадают.
Когда один из шаблонов ошибок совпадает с сообщением об ошибке, то:
name
шаблона ошибки будет отображаться как заголовок сообщения об ошибке, а исходное сообщение об ошибке будет скрыто под катом;hint
для ошибки будет отображаться после поля ошибкиstack
. Подсказка может быть задана в виде html-строки. Например,<div>some-useful-hint</div>
.
В режиме Group by
(группировать по) с выбранным ключом error
тест будет связан с группой, если ошибка теста совпадает с шаблоном ошибок группы. Если тест не может быть связан с существующими группами, то будет создана новая группа.
metaInfoBaseUrls
Базовые URL-адреса для формирования ссылок в разделе Meta
на основе мета-информации о прогоне теста.
Параметр задается в виде объекта:
{
'<опция-1>': 'значение опции 1',
'<опция-2>': 'значение опции 2',
// и т. д.
}
Например:
{
'file': 'base/path'
}
Когда значение любого ключа установлено на auto
, базовый URL будет установлен на базовый хост, указанный в интерфейсе отчета, или останется неизменным, если базовый хост не указан.
Например, если у вас есть следующее значение metaInfoBaseUrls
:
{
custom_url: "auto";
}
И вы установите поле meta.custom_url
в https://example.com/some/path
в ваших тестах, вы увидите в мете:
- Ссылку на
https://example.com/some/path
, если базовый хост не установлен в интерфейсе пользователя - Ссылку на
https://another-host.com/some/path
, если базовый хост в интерфейсе пользователя установлен вhttps://another-host.com
saveFormat
Параметр устарел
Позволяет задать формат, в котором будут сохранены результаты прогона тестов.
Доступным осталось только одно значение, которое используется по умолчанию:
sqlite
— сохранить результаты прогона тестов в базе данных формата SQLite.
customGui
Параметр устарел
Вместо customGui рекомендуется использовать плагины для отчета.
Описание собственных элементов управления для GUI-режима.
Смотрите подробнее в разделе «Кастомизация GUI».
pluginsEnabled
Включить плагины для html-reporter
.