From d8fcb8922aedb4628207938fc3abb9b0de34018d Mon Sep 17 00:00:00 2001 From: sipayrt Date: Fri, 30 Aug 2024 18:04:00 +0300 Subject: [PATCH] docs(test-repeater): fix plugin name --- docs/guides/how-to-check-test-stability.mdx | 6 +- docs/plugins/testplane-test-repeater.mdx | 61 ++++++++++++++----- docs/reference/testplane-events.mdx | 2 +- .../guides/how-to-check-test-stability.mdx | 6 +- .../plugins/testplane-test-repeater.mdx | 61 ++++++++++++++----- .../current/reference/testplane-events.mdx | 2 +- 6 files changed, 98 insertions(+), 40 deletions(-) diff --git a/docs/guides/how-to-check-test-stability.mdx b/docs/guides/how-to-check-test-stability.mdx index 52cd8ba..3883c9f 100644 --- a/docs/guides/how-to-check-test-stability.mdx +++ b/docs/guides/how-to-check-test-stability.mdx @@ -12,9 +12,9 @@ There are many reasons why tests can fail: 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. -## Solution: testplane-test-repeater {#solution} +## Solution: @testplane/test-repeater {#solution} -To solve this problem, the [testplane-test-repeater][testplane-test-repeater] plugin was developed. +To solve this problem, the [@testplane/test-repeater][testplane-test-repeater] plugin was developed. The plugin allows you to run the same test (or group of tests) the required number of times. @@ -46,6 +46,6 @@ In the next screenshot, the first test is almost non-functional – out of 21 at ## Keywords {#keywords} -- testplane-test-repeater +- @testplane/test-repeater [testplane-test-repeater]: ../../plugins/testplane-test-repeater diff --git a/docs/plugins/testplane-test-repeater.mdx b/docs/plugins/testplane-test-repeater.mdx index 249eec9..8123f2b 100644 --- a/docs/plugins/testplane-test-repeater.mdx +++ b/docs/plugins/testplane-test-repeater.mdx @@ -1,15 +1,15 @@ -# testplane-test-repeater +# @testplane/test-repeater ## Overview {#overview} -Use the [testplane-test-repeater][testplane-test-repeater] plugin to run the same test (or group of tests) the required number of times. +Use the [@testplane/test-repeater][testplane-test-repeater] plugin to run the same test (or group of tests) the required number of times. 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. ## Install {#install} ```bash -npm install -D testplane-test-repeater +npm install -D @testplane/test-repeater ``` ## Setup {#setup} @@ -19,7 +19,7 @@ Add the plugin to the `plugins` section of the `testplane` config: ```javascript module.exports = { plugins: { - "testplane-test-repeater": { + "@testplane/test-repeater": { enabled: true, repeat: 50, minRepeat: 10, @@ -37,17 +37,46 @@ module.exports = { ### Description of configuration parameters {#setup_description} - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
**Parameter****Type****Default value****Description**
enabledBooleantrueEnable / disable the plugin.
repeatNumber0How many times you need to run the test, regardless of the result of its run.
minRepeatNumber0The minimum number of times the test can be run.
maxRepeatNumberInfinityThe maximum number of times the test can be run.
uniqSessionBooleantrueRun each test in a unique browser session.
**Parameter****Type****Default value****Description**
enabledBooleantrueEnable / disable the plugin.
repeatNumber0How many times you need to run the test, regardless of the result of its run.
minRepeatNumber0The minimum number of times the test can be run.
maxRepeatNumberInfinityThe maximum number of times the test can be run.
uniqSessionBooleantrueRun each test in a unique browser session.
### Passing parameters via the CLI {#setup_by_cli} @@ -74,7 +103,7 @@ npx testplane --repeat 5 ## Useful links {#useful_links} -- [testplane-test-repeater plugin sources][testplane-test-repeater] +- [@testplane/test-repeater plugin sources][testplane-test-repeater] [testplane-test-repeater]: https://github.com/gemini-testing/testplane-test-repeater [cli]: https://en.wikipedia.org/wiki/Command-line_interface diff --git a/docs/reference/testplane-events.mdx b/docs/reference/testplane-events.mdx index 6d479a2..3265750 100644 --- a/docs/reference/testplane-events.mdx +++ b/docs/reference/testplane-events.mdx @@ -347,7 +347,7 @@ An object of the [Commander][commander] type is passed to the event handler. ### Example of usage {#cli_usage} -Let's consider an example of the [implementation][testplane-test-repeater-index] of the [testplane-test-repeater][testplane-test-repeater] plugin. +Let's consider an example of the [implementation][testplane-test-repeater-index] of the [@testplane/test-repeater][testplane-test-repeater] plugin. 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. diff --git a/i18n/ru/docusaurus-plugin-content-docs/current/guides/how-to-check-test-stability.mdx b/i18n/ru/docusaurus-plugin-content-docs/current/guides/how-to-check-test-stability.mdx index 7de2917..6dffab1 100644 --- a/i18n/ru/docusaurus-plugin-content-docs/current/guides/how-to-check-test-stability.mdx +++ b/i18n/ru/docusaurus-plugin-content-docs/current/guides/how-to-check-test-stability.mdx @@ -12,9 +12,9 @@ Часто такие падения не воспроизводятся с первого раза. Поэтому, чтобы убедиться, что свеженаписанный тест стабилен, нужно запустить его много раз. Но есть одна проблема: если вы запустите свой тест в testplane _as is,_ то после первого же успешного прогона testplane прекратит запускать ваш тест. Тест прошел — всё ОК. Но для проверки стабильности этого недостаточно. Может быть, тест прошел случайно, и если запустить его повторно, то он упадет. Хотелось бы запустить его не 1 раз, и не 2, а например, 20 раз и посмотреть сколько раз он успешно пройдет при 20 повторах. Или 30. Или... и т. д. -## Решение: testplane-test-repeater {#solution} +## Решение: @testplane/test-repeater {#solution} -Для решения данной проблемы был разработан плагин [testplane-test-repeater][testplane-test-repeater]. +Для решения данной проблемы был разработан плагин [@testplane/test-repeater][testplane-test-repeater]. Плагин позволяет запустить один и тот же тест (или группу тестов) требуемое количество раз. @@ -46,6 +46,6 @@ ## Ключевые слова {#keywords} -- testplane-test-repeater +- @testplane/test-repeater [testplane-test-repeater]: ../../plugins/testplane-test-repeater diff --git a/i18n/ru/docusaurus-plugin-content-docs/current/plugins/testplane-test-repeater.mdx b/i18n/ru/docusaurus-plugin-content-docs/current/plugins/testplane-test-repeater.mdx index d76de34..cabbe18 100644 --- a/i18n/ru/docusaurus-plugin-content-docs/current/plugins/testplane-test-repeater.mdx +++ b/i18n/ru/docusaurus-plugin-content-docs/current/plugins/testplane-test-repeater.mdx @@ -1,15 +1,15 @@ -# testplane-test-repeater +# @testplane/test-repeater ## Обзор {#overview} -Используйте плагин [testplane-test-repeater][testplane-test-repeater], чтобы запустить один и тот же тест (или группу тестов) требуемое количество раз. +Используйте плагин [@testplane/test-repeater][testplane-test-repeater], чтобы запустить один и тот же тест (или группу тестов) требуемое количество раз. Данный плагин может пригодиться в тех случаях, когда нужно убедиться в стабильности написанных тестов. Плагин гарантирует, что тесты будут запущены столько раз, сколько вы задали, независимо от результатов их прогона в каждой попытке. Кроме того, плагин позволяет запускать тесты каждый раз в новой сессии браузера. Это исключает влияние деградации браузера или еще какие-либо побочные эффекты, которые могли бы возникнуть при повторных прогонах в одной и той же сессии браузера. ## Установка {#install} ```bash -npm install -D testplane-test-repeater +npm install -D @testplane/test-repeater ``` ## Настройка {#setup} @@ -19,7 +19,7 @@ npm install -D testplane-test-repeater ```javascript module.exports = { plugins: { - "testplane-test-repeater": { + "@testplane/test-repeater": { enabled: true, repeat: 50, minRepeat: 10, @@ -37,17 +37,46 @@ module.exports = { ### Расшифровка параметров конфигурации {#setup_description} - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
**Параметр****Тип****По умолчанию****Описание**
enabledBooleantrueВключить / отключить плагин.
repeatNumber0Сколько раз нужно запустить тест, независимо от результата от его прогона.
minRepeatNumber0Минимальное количество раз, которые можно запустить тест.
maxRepeatNumberInfinityМаксимальное количество раз, которые можно запустить тест.
uniqSessionBooleantrueЗапускать каждый тест в уникальной сессии браузера.
**Параметр****Тип****По умолчанию****Описание**
enabledBooleantrueВключить / отключить плагин.
repeatNumber0Сколько раз нужно запустить тест, независимо от результата от его прогона.
minRepeatNumber0Минимальное количество раз, которые можно запустить тест.
maxRepeatNumberInfinityМаксимальное количество раз, которые можно запустить тест.
uniqSessionBooleantrueЗапускать каждый тест в уникальной сессии браузера.
### Передача параметров через CLI {#setup_by_cli} @@ -76,7 +105,7 @@ npx testplane --repeat 5 ## Полезные ссылки {#useful_links} -- [Исходники плагина testplane-test-repeater][testplane-test-repeater] +- [Исходники плагина @testplane/test-repeater][testplane-test-repeater] [testplane-test-repeater]: https://github.com/gemini-testing/testplane-test-repeater [cli]: https://ru.wikipedia.org/wiki/Интерфейс_командной_строки diff --git a/i18n/ru/docusaurus-plugin-content-docs/current/reference/testplane-events.mdx b/i18n/ru/docusaurus-plugin-content-docs/current/reference/testplane-events.mdx index 4f38ae6..0e82a07 100644 --- a/i18n/ru/docusaurus-plugin-content-docs/current/reference/testplane-events.mdx +++ b/i18n/ru/docusaurus-plugin-content-docs/current/reference/testplane-events.mdx @@ -348,7 +348,7 @@ testplane.on(testplane.events.CLI, cli => { ### Пример использования {#cli_usage} -Рассмотрим в качестве примера [реализацию][testplane-test-repeater-index] плагина [testplane-test-repeater][testplane-test-repeater]. +Рассмотрим в качестве примера [реализацию][testplane-test-repeater-index] плагина [@testplane/test-repeater][testplane-test-repeater]. Используя событие [CLI](#cli), плагин добавляет к testplane новую опцию `--repeat`. С помощью неё можно указать, сколько раз нужно прогнать тесты, независимо от результата каждого прогона.