-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: add lastFailed config option (#21)
- Loading branch information
1 parent
655fda6
commit 757b4e4
Showing
4 changed files
with
113 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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} | ||
|
||
<table> | ||
<thead> | ||
<tr><td>**Параметр**</td><td>**Тип**</td><td>**По умолчанию**</td><td>**Описание**</td></tr> | ||
</thead> | ||
<tbody> | ||
<tr><td>[only](#only)</td><td>Boolean</td><td>false</td><td>Включить / отключить режим перезапуска упавших тестов.</td></tr> | ||
<tr><td>[input](#input)</td><td>String или Array</td><td>.testplane/failed.json</td><td>Путь или список путей для чтения списка упавших тестов</td></tr> | ||
<tr><td>[output](#output)</td><td>String</td><td>.testplane/failed.json</td><td>Путь для сохранения списка упавших тестов</td></tr> | ||
|
||
</tbody> | ||
</table> | ||
|
||
### only {#only} | ||
|
||
Включает режим перезапуска упавших тестов, в котором запускаются только тесты из списка, путь к которому указан в input, если установить значение в `true`. По умолчанию: `false`. | ||
|
||
### input {#input} | ||
|
||
Путь или список путей для чтения списка упавших тестов. Если указан список путей к файлам, то перезапускаются все тесты, которые встречаются хотя бы в одном из них. По умолчанию: `.testplane/failed.json` | ||
|
||
### output {#output} | ||
|
||
Путь для сохранения списка упавших тестов. Используется всегда, независимо от опции `only`. По умолчанию: `.testplane/failed.json` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
52 changes: 52 additions & 0 deletions
52
i18n/en/docusaurus-plugin-content-docs/current/config/last-failed.mdx
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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} | ||
|
||
<table> | ||
<thead> | ||
<tr><td>**Parameter**</td><td>**Type**</td><td>**Default value**</td><td>**Description**</td></tr> | ||
</thead> | ||
<tbody> | ||
<tr><td>[only](#only)</td><td>Boolean</td><td>false</td><td>Enable / disable the mode for rerunning failed tests.</td></tr> | ||
<tr><td>[input](#input)</td><td>String or Array</td><td>.testplane/failed.json</td><td>Path or list of paths for reading the list of failed tests.</td></tr> | ||
<tr><td>[output](#input)</td><td>String</td><td>.testplane/failed.json</td><td>Path for saving the list of failed tests.</td></tr> | ||
|
||
</tbody> | ||
</table> | ||
|
||
### 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` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters