Skip to content

Commit d8fcb89

Browse files
sipayRTsipayRT
committed
docs(test-repeater): fix plugin name
1 parent d22ae77 commit d8fcb89

File tree

6 files changed

+98
-40
lines changed

6 files changed

+98
-40
lines changed

‎docs/guides/how-to-check-test-stability.mdx‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,9 +12,9 @@ There are many reasons why tests can fail:
1212

1313
Often these failures do not reproduce on the first attempt. Therefore, to ensure a newly written test is stable, it needs to be run multiple times. But there is one problem: if you run your test in Testplane _as is,_ after the first successful run, Testplane will stop running your test. The test passed – everything is OK. But for stability verification, this is not enough. The test might have passed accidentally, and if you rerun it, it might fail. Ideally, you want to run it not just once or twice, but for example, 20 times and see how many times it passes out of 20. Or 30 times. Or... and so on.
1414

15-
## Solution: testplane-test-repeater {#solution}
15+
## Solution: @testplane/test-repeater {#solution}
1616

17-
To solve this problem, the [testplane-test-repeater][testplane-test-repeater] plugin was developed.
17+
To solve this problem, the [@testplane/test-repeater][testplane-test-repeater] plugin was developed.
1818

1919
The plugin allows you to run the same test (or group of tests) the required number of times.
2020

@@ -46,6 +46,6 @@ In the next screenshot, the first test is almost non-functional – out of 21 at
4646

4747
## Keywords {#keywords}
4848

49-
- testplane-test-repeater
49+
- @testplane/test-repeater
5050

5151
[testplane-test-repeater]: ../../plugins/testplane-test-repeater

‎docs/plugins/testplane-test-repeater.mdx‎

Lines changed: 45 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,15 @@
1-
# testplane-test-repeater
1+
# @testplane/test-repeater
22

33
## Overview {#overview}
44

5-
Use the [testplane-test-repeater][testplane-test-repeater] plugin to run the same test (or group of tests) the required number of times.
5+
Use the [@testplane/test-repeater][testplane-test-repeater] plugin to run the same test (or group of tests) the required number of times.
66

77
This plugin can be useful in cases when you need to make sure that the written tests are stable. The plugin guarantees that the tests will be run as many times as you set, regardless of the results of their run in each attempt. In addition, the plugin allows you to run tests every time in a new browser session. This eliminates the impact of browser degradation or any other side effects that could occur during repeated runs in the same browser session.
88

99
## Install {#install}
1010

1111
```bash
12-
npm install -D testplane-test-repeater
12+
npm install -D @testplane/test-repeater
1313
```
1414

1515
## Setup {#setup}
@@ -19,7 +19,7 @@ Add the plugin to the `plugins` section of the `testplane` config:
1919
```javascript
2020
module.exports = {
2121
plugins: {
22-
"testplane-test-repeater": {
22+
"@testplane/test-repeater": {
2323
enabled: true,
2424
repeat: 50,
2525
minRepeat: 10,
@@ -37,17 +37,46 @@ module.exports = {
3737
### Description of configuration parameters {#setup_description}
3838

3939
<table>
40-
<thead>
41-
<tr><td>**Parameter**</td><td>**Type**</td><td>**Default value**</td><td>**Description**</td></tr>
42-
</thead>
43-
<tbody>
44-
<tr><td>enabled</td><td>Boolean</td><td>true</td><td>Enable / disable the plugin.</td></tr>
45-
<tr><td>repeat</td><td>Number</td><td>0</td><td>How many times you need to run the test, regardless of the result of its run.</td></tr>
46-
<tr><td>minRepeat</td><td>Number</td><td>0</td><td>The minimum number of times the test can be run.</td></tr>
47-
<tr><td>maxRepeat</td><td>Number</td><td>Infinity</td><td>The maximum number of times the test can be run.</td></tr>
48-
<tr><td>uniqSession</td><td>Boolean</td><td>true</td><td>Run each test in a unique browser session.</td></tr>
49-
50-
</tbody>
40+
<thead>
41+
<tr>
42+
<td>**Parameter**</td>
43+
<td>**Type**</td>
44+
<td>**Default value**</td>
45+
<td>**Description**</td>
46+
</tr>
47+
</thead>
48+
<tbody>
49+
<tr>
50+
<td>enabled</td>
51+
<td>Boolean</td>
52+
<td>true</td>
53+
<td>Enable / disable the plugin.</td>
54+
</tr>
55+
<tr>
56+
<td>repeat</td>
57+
<td>Number</td>
58+
<td>0</td>
59+
<td>How many times you need to run the test, regardless of the result of its run.</td>
60+
</tr>
61+
<tr>
62+
<td>minRepeat</td>
63+
<td>Number</td>
64+
<td>0</td>
65+
<td>The minimum number of times the test can be run.</td>
66+
</tr>
67+
<tr>
68+
<td>maxRepeat</td>
69+
<td>Number</td>
70+
<td>Infinity</td>
71+
<td>The maximum number of times the test can be run.</td>
72+
</tr>
73+
<tr>
74+
<td>uniqSession</td>
75+
<td>Boolean</td>
76+
<td>true</td>
77+
<td>Run each test in a unique browser session.</td>
78+
</tr>
79+
</tbody>
5180
</table>
5281

5382
### Passing parameters via the CLI {#setup_by_cli}
@@ -74,7 +103,7 @@ npx testplane --repeat 5
74103

75104
## Useful links {#useful_links}
76105

77-
- [testplane-test-repeater plugin sources][testplane-test-repeater]
106+
- [@testplane/test-repeater plugin sources][testplane-test-repeater]
78107

79108
[testplane-test-repeater]: https://github.com/gemini-testing/testplane-test-repeater
80109
[cli]: https://en.wikipedia.org/wiki/Command-line_interface

‎docs/reference/testplane-events.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -347,7 +347,7 @@ An object of the [Commander][commander] type is passed to the event handler.
347347

348348
### Example of usage {#cli_usage}
349349

350-
Let's consider an example of the [implementation][testplane-test-repeater-index] of the [testplane-test-repeater][testplane-test-repeater] plugin.
350+
Let's consider an example of the [implementation][testplane-test-repeater-index] of the [@testplane/test-repeater][testplane-test-repeater] plugin.
351351

352352
Using the [CLI](#cli) event, the plugin adds a new `--repeat` option to testplane. With it, you can specify how many times to run tests, regardless of the result of each run.
353353

‎i18n/ru/docusaurus-plugin-content-docs/current/guides/how-to-check-test-stability.mdx‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,9 +12,9 @@
1212

1313
Часто такие падения не воспроизводятся с первого раза. Поэтому, чтобы убедиться, что свеженаписанный тест стабилен, нужно запустить его много раз. Но есть одна проблема: если вы запустите свой тест в testplane _as is,_ то после первого же успешного прогона testplane прекратит запускать ваш тест. Тест прошел — всё ОК. Но для проверки стабильности этого недостаточно. Может быть, тест прошел случайно, и если запустить его повторно, то он упадет. Хотелось бы запустить его не 1 раз, и не 2, а например, 20 раз и посмотреть сколько раз он успешно пройдет при 20 повторах. Или 30. Или... и т. д.
1414

15-
## Решение: testplane-test-repeater {#solution}
15+
## Решение: @testplane/test-repeater {#solution}
1616

17-
Для решения данной проблемы был разработан плагин [testplane-test-repeater][testplane-test-repeater].
17+
Для решения данной проблемы был разработан плагин [@testplane/test-repeater][testplane-test-repeater].
1818

1919
Плагин позволяет запустить один и тот же тест (или группу тестов) требуемое количество раз.
2020

@@ -46,6 +46,6 @@
4646

4747
## Ключевые слова {#keywords}
4848

49-
- testplane-test-repeater
49+
- @testplane/test-repeater
5050

5151
[testplane-test-repeater]: ../../plugins/testplane-test-repeater

‎i18n/ru/docusaurus-plugin-content-docs/current/plugins/testplane-test-repeater.mdx‎

Lines changed: 45 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,15 @@
1-
# testplane-test-repeater
1+
# @testplane/test-repeater
22

33
## Обзор {#overview}
44

5-
Используйте плагин [testplane-test-repeater][testplane-test-repeater], чтобы запустить один и тот же тест (или группу тестов) требуемое количество раз.
5+
Используйте плагин [@testplane/test-repeater][testplane-test-repeater], чтобы запустить один и тот же тест (или группу тестов) требуемое количество раз.
66

77
Данный плагин может пригодиться в тех случаях, когда нужно убедиться в стабильности написанных тестов. Плагин гарантирует, что тесты будут запущены столько раз, сколько вы задали, независимо от результатов их прогона в каждой попытке. Кроме того, плагин позволяет запускать тесты каждый раз в новой сессии браузера. Это исключает влияние деградации браузера или еще какие-либо побочные эффекты, которые могли бы возникнуть при повторных прогонах в одной и той же сессии браузера.
88

99
## Установка {#install}
1010

1111
```bash
12-
npm install -D testplane-test-repeater
12+
npm install -D @testplane/test-repeater
1313
```
1414

1515
## Настройка {#setup}
@@ -19,7 +19,7 @@ npm install -D testplane-test-repeater
1919
```javascript
2020
module.exports = {
2121
plugins: {
22-
"testplane-test-repeater": {
22+
"@testplane/test-repeater": {
2323
enabled: true,
2424
repeat: 50,
2525
minRepeat: 10,
@@ -37,17 +37,46 @@ module.exports = {
3737
### Расшифровка параметров конфигурации {#setup_description}
3838

3939
<table>
40-
<thead>
41-
<tr><td>**Параметр**</td><td>**Тип**</td><td>**По&nbsp;умолчанию**</td><td>**Описание**</td></tr>
42-
</thead>
43-
<tbody>
44-
<tr><td>enabled</td><td>Boolean</td><td>true</td><td>Включить / отключить плагин.</td></tr>
45-
<tr><td>repeat</td><td>Number</td><td>0</td><td>Сколько раз нужно запустить тест, независимо от результата от его прогона.</td></tr>
46-
<tr><td>minRepeat</td><td>Number</td><td>0</td><td>Минимальное количество раз, которые можно запустить тест.</td></tr>
47-
<tr><td>maxRepeat</td><td>Number</td><td>Infinity</td><td>Максимальное количество раз, которые можно запустить тест.</td></tr>
48-
<tr><td>uniqSession</td><td>Boolean</td><td>true</td><td>Запускать каждый тест в уникальной сессии браузера.</td></tr>
49-
50-
</tbody>
40+
<thead>
41+
<tr>
42+
<td>**Параметр**</td>
43+
<td>**Тип**</td>
44+
<td>**По&nbsp;умолчанию**</td>
45+
<td>**Описание**</td>
46+
</tr>
47+
</thead>
48+
<tbody>
49+
<tr>
50+
<td>enabled</td>
51+
<td>Boolean</td>
52+
<td>true</td>
53+
<td>Включить / отключить плагин.</td>
54+
</tr>
55+
<tr>
56+
<td>repeat</td>
57+
<td>Number</td>
58+
<td>0</td>
59+
<td>Сколько раз нужно запустить тест, независимо от результата от его прогона.</td>
60+
</tr>
61+
<tr>
62+
<td>minRepeat</td>
63+
<td>Number</td>
64+
<td>0</td>
65+
<td>Минимальное количество раз, которые можно запустить тест.</td>
66+
</tr>
67+
<tr>
68+
<td>maxRepeat</td>
69+
<td>Number</td>
70+
<td>Infinity</td>
71+
<td>Максимальное количество раз, которые можно запустить тест.</td>
72+
</tr>
73+
<tr>
74+
<td>uniqSession</td>
75+
<td>Boolean</td>
76+
<td>true</td>
77+
<td>Запускать каждый тест в уникальной сессии браузера.</td>
78+
</tr>
79+
</tbody>
5180
</table>
5281

5382
### Передача параметров через CLI {#setup_by_cli}
@@ -76,7 +105,7 @@ npx testplane --repeat 5
76105

77106
## Полезные ссылки {#useful_links}
78107

79-
- [Исходники плагина testplane-test-repeater][testplane-test-repeater]
108+
- [Исходники плагина @testplane/test-repeater][testplane-test-repeater]
80109

81110
[testplane-test-repeater]: https://github.com/gemini-testing/testplane-test-repeater
82111
[cli]: https://ru.wikipedia.org/wiki/Интерфейс_командной_строки

‎i18n/ru/docusaurus-plugin-content-docs/current/reference/testplane-events.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -348,7 +348,7 @@ testplane.on(testplane.events.CLI, cli => {
348348

349349
### Пример использования {#cli_usage}
350350

351-
Рассмотрим в качестве примера [реализацию][testplane-test-repeater-index] плагина [testplane-test-repeater][testplane-test-repeater].
351+
Рассмотрим в качестве примера [реализацию][testplane-test-repeater-index] плагина [@testplane/test-repeater][testplane-test-repeater].
352352

353353
Используя событие [CLI](#cli), плагин добавляет к testplane новую опцию `--repeat`. С помощью неё можно указать, сколько раз нужно прогнать тесты, независимо от результата каждого прогона.
354354

0 commit comments

Comments
 (0)