Перейти к основному содержимому

CLI

Обзор​

HTML Reporter имеет следующие команды:

  • gui — чтобы запускать Testplane в GUI-режиме;
  • merge-reports — чтобы объединять несколько отчетов в один.
  • remove-unused-screens — чтобы удалять неиспользуемые в тестах эталонные скриншоты;

При использовании HTML Reporter с Testplane, вы также можете использовать команды через Testplane, например: npx testplane gui.

При использовании с другими инструментами, необходимо указывать название инструмента в аргументе tool, например: npx html-reporter gui --tool playwright.

gui​

Доступность команды

Команда доступна только при использовании HTML Reporter с Testplane и Playwright.

Используйте команду gui, чтобы запустить Testplane в GUI-режиме.

GUI-режим позволяет:

  • интерактивно запускать тесты;
  • переключать режимы работы с дампами прямо из отчета без перезапуска testplane;
  • обновлять скриншоты — визуально отсматривая их и принимая только нужные диффы;
  • переиспользовать отчеты из CI;
  • фильтровать результаты прогона по ошибкам, ключам из меты, и пр.

Использование​

npx html-reporter gui

merge-reports​

Доступность команды

Команда доступна только при использовании HTML Reporter с Testplane и Playwright.

Используйте команду merge-reports, чтобы объединить несколько отчетов в один.

Команда принимает пути к директориям с отчетами, файлам баз данных или к файлам databaseUrls.json.

Она создает новый html-отчет в папке назначения с данными из всех переданных отчетов.

  • При объединении локальных отчетов — все данные, включая SQLite базы данных и скриншоты, копируются в директорию назначения.
  • При объединении отчетов по ссылке (например, если на вход переданы файлы databaseUrls.json со ссылками на отчеты в S3) — в директории назначения будет создан отчет со ссылками на исходные отчеты в databaseUrls.json, без скачивания и копирования всех вложенных ресурсов. При работе с отчетом это никак не будет заметно, но нужно учитывать, что исходные отчеты должны оставаться доступными, так как объединенный отчет получает данные из них.

Использование​

Команда merge-reports поддерживает следующую обязательную опцию:

ОпцияОписание
-d, --destination <folder>Путь к папке, в которую нужно сохранить итоговый отчет.
-h, --header <header>HTTP-заголовок для файлов databaseUrls.json из исходных путей.

Пример использования:

npx html-reporter merge-reports report-dir/ path-to-database.db path-to-databaseUrls.json -d dest-report -h foo=bar

HTTP-заголовки также можно передавать через переменную окружения — html_reporter_headers (она имеет более высокий приоритет, чем опция CLI --header). Пример:

html_reporter_headers='{"foo":"bar"}' npx hermione merge-reports path-to-database.db path-to-databaseUrls.json -d dest-report -h baz=qux

В этом вызове path-to-databaseUrls.json будет запрошен с заголовками: {foo: 'bar', baz: 'qux'}.

remove-unused-screens​

Доступность команды

Команда доступна только при использовании HTML Reporter с Testplane.

Используйте команду remove-unused-screens, чтобы удалить неиспользуемые в тестах эталонные скриншоты.

Как это работает?​

Сначала команда ищет скриншоты, для которых на файловой системе нет тестов.

Далее команда ищет скриншоты, которые не были использованы в успешном тестировании (результат тестов берется из базы данных SQLite). Для этого html-отчет должен существовать на файловой системе и содержать результаты прогона тестов. Это означает, что вы должны до запуска команды remove-unused-screens запустить тесты локально или загрузить отчет из CI.

Использование​

Команда remove-unused-screens поддерживает несколько опций:

ОпцияОписание
-p, --pattern <pattern>Шаблон для поиска скриншотов на файловой системе.
--skip-questionsНе задавать вопросов во время выполнения (использовать значения по умолчанию).
-h, --helpВывести справочную информацию по команде в терминал.

Примеры использования​

Указываем папку, в которой надо искать неиспользуемые скриншоты:

npx testplane remove-unused-screens -p 'testplane-screens-folder'

Задаем маску, по которой будем искать скриншоты:

npx testplane remove-unused-screens -p 'screens/**/*.png'

Задаем несколько масок для поиска скриншотов:

npx testplane remove-unused-screens -p 'screens/**/chrome/*.png' -p 'screens/**/firefox/*.png'

Задаем папку для поиска скриншотов и просим не задавать вопросов:

npx testplane remove-unused-screens -p 'testplane-screens-folder' --skip-questions

Выводим справочную информацию о команде:

npx testplane remove-unused-screens --help
On this page