From 757b4e42a53029a2f737fa59cd51965f70ea6b41 Mon Sep 17 00:00:00 2001 From: Kabir-Ivan <110986400+Kabir-Ivan@users.noreply.github.com> Date: Thu, 8 Aug 2024 08:27:41 -0700 Subject: [PATCH] docs: add lastFailed config option (#21) --- docs/config/last-failed.mdx | 51 ++++++++++++++++++ docs/config/main.mdx | 5 ++ .../current/config/last-failed.mdx | 52 +++++++++++++++++++ .../current/config/main.mdx | 5 ++ 4 files changed, 113 insertions(+) create mode 100644 docs/config/last-failed.mdx create mode 100644 i18n/en/docusaurus-plugin-content-docs/current/config/last-failed.mdx diff --git a/docs/config/last-failed.mdx b/docs/config/last-failed.mdx new file mode 100644 index 0000000..d5f9185 --- /dev/null +++ b/docs/config/last-failed.mdx @@ -0,0 +1,51 @@ +import Admonition from "@theme/Admonition"; + +# lastFailed + +## Обзор {#overview} + +Раздел `lastFailed` в настройках Testplane не является обязательным. + +Используйте его, чтобы настроить перезапуск упавших тестов. + +## Настройка {#setup} + +Раздел `lastFailed` имеет следующий формат: + +```javascript +module.exports = { + lastFailed: { + only: false, + input: [".testplane/failed.json"], + output: ".testplane/failed.json", + }, + + // другие настройки Testplane... +}; +``` + +### Расшифровка параметров конфигурации {#setup_description} + + + + + + + + + + + +
**Параметр****Тип****По умолчанию****Описание**
[only](#only)BooleanfalseВключить / отключить режим перезапуска упавших тестов.
[input](#input)String или Array.testplane/failed.jsonПуть или список путей для чтения списка упавших тестов
[output](#output)String.testplane/failed.jsonПуть для сохранения списка упавших тестов
+ +### only {#only} + +Включает режим перезапуска упавших тестов, в котором запускаются только тесты из списка, путь к которому указан в input, если установить значение в `true`. По умолчанию: `false`. + +### input {#input} + +Путь или список путей для чтения списка упавших тестов. Если указан список путей к файлам, то перезапускаются все тесты, которые встречаются хотя бы в одном из них. По умолчанию: `.testplane/failed.json` + +### output {#output} + +Путь для сохранения списка упавших тестов. Используется всегда, независимо от опции `only`. По умолчанию: `.testplane/failed.json` diff --git a/docs/config/main.mdx b/docs/config/main.mdx index 9a93d47..a31bbf5 100644 --- a/docs/config/main.mdx +++ b/docs/config/main.mdx @@ -54,6 +54,9 @@ module.exports = { plugins: { // подключение внешних плагинов Testplane... }, + lastFailed: { + // настройки перезапуска упавших тестов... + }, prepareBrowser: function(browser) { // здесь можно добавить новые команды к объекту browser, // где browser - это сессия WebdriverIO @@ -84,6 +87,7 @@ module.exports = { [sets][sets]Раздел, позволяющий привязать набор тестов к определенным браузерам и запускать их сразу одной командой. Может пригодиться, например, для отдельного запуска десктопных и мобильных тестов. [system][system]Раздел системных настроек Testplane. Позволяет задать число подпроцессов, в которых будут запускаться тесты, включить режим дебага для WebDriver, и многое другое. [plugins][plugins]Раздел, с помощью которого можно подключить к testplane внешние плагины. +[lastFailed][last-failed]Раздел, с помощью которого можно настроить перезапуск упавших тестов. [prepareBrowser][prepare-browser]Функция, в которой можно подготовить браузер до того, как в нем будут запущены тесты. Например, в этой функции можно добавить новые команды для объекта _browser_. [prepareEnvironment][prepare-environment]Функция, в которой можно задать переменные окружения или, например, дополнить какие-то параметры конфига. @@ -102,5 +106,6 @@ module.exports = { [sets]: ../sets [system]: ../system [plugins]: ../plugins +[last-failed]: ../last-failed [prepare-browser]: ../prepare-browser [prepare-environment]: ../prepare-environment diff --git a/i18n/en/docusaurus-plugin-content-docs/current/config/last-failed.mdx b/i18n/en/docusaurus-plugin-content-docs/current/config/last-failed.mdx new file mode 100644 index 0000000..367d530 --- /dev/null +++ b/i18n/en/docusaurus-plugin-content-docs/current/config/last-failed.mdx @@ -0,0 +1,52 @@ +javascript +import Admonition from "@theme/Admonition"; + +# lastFailed + +## Overview {#overview} + +The `lastFailed` section in Testplane settings is optional. + +Use it to configure the rerun of failed tests. + +## Setup {#setup} + +The `lastFailed` section has the following format: + +```javascript +module.exports = { + lastFailed: { + only: false, + input: [".testplane/failed.json"], + output: ".testplane/failed.json", + }, + + // other Testplane settings... +}; +``` + +### Description of Configuration Parameters {#setup_description} + + + + + + + + + + + +
**Parameter****Type****Default value****Description**
[only](#only)BooleanfalseEnable / disable the mode for rerunning failed tests.
[input](#input)String or Array.testplane/failed.jsonPath or list of paths for reading the list of failed tests.
[output](#input)String.testplane/failed.jsonPath for saving the list of failed tests.
+ +### only {#only} + +Enables the mode for rerunning failed tests, in which only the tests from the list specified in input are run if set to true. Default: `false`. + +### input {#input} + +Path or list of paths for reading the list of failed tests. If a list of file paths is specified, all tests that are found in at least one of them are rerun. Default: `.testplane/failed.json` + +### output {#output} + +Path for saving the list of failed tests. Always used regardless of the only option. Default: `.testplane/failed.json` diff --git a/i18n/en/docusaurus-plugin-content-docs/current/config/main.mdx b/i18n/en/docusaurus-plugin-content-docs/current/config/main.mdx index d543a25..d0fe0dc 100644 --- a/i18n/en/docusaurus-plugin-content-docs/current/config/main.mdx +++ b/i18n/en/docusaurus-plugin-content-docs/current/config/main.mdx @@ -54,6 +54,9 @@ module.exports = { plugins: { // external Testplane plugins settings... }, + lastFailed: { + // failed tests rerun settings... + }, prepareBrowser: function(browser) { // here you can add new commands to the browser object, // where browser is a WebdriverIO session @@ -84,6 +87,7 @@ In order not to repeat common [settings of each browser][browsers] over and over [sets][sets]A section that allows you to bind a set of tests to certain browsers and run them at once with one command. For example, you can launch desktop and mobiles tests separately by using this option. [system][system]Testplane system settings section. Allows you to set the number of subprocesses to run the tests in, enable the debug mode for WebDriver, and much more. [plugins][plugins]A section with which you can mount external plugins to Testplane. +[lastFailed][last-failed]A section with which you can configure the rerun of failed tests. [prepareBrowser][prepare-browser]A function in which you can prepare the browser before to run the tests in it. For example, in this function you can add new commands for the _browser_ object. [prepareEnvironment][prepare-environment]A function in which you can set environment variables or, for example, add some config parameters. @@ -102,5 +106,6 @@ You can set your configuration file using the `--config` CLI option, specifying [sets]: ../sets [system]: ../system [plugins]: ../plugins +[last-failed]: ../last-failed [prepare-browser]: ../prepare-browser [prepare-environment]: ../prepare-environment