Skip to content

Commit

Permalink
Merge pull request #42 from gemini-testing/sp.fixParallelLimit
Browse files Browse the repository at this point in the history 
docs(config): fix wrong parallelLimit option default value
  • Loading branch information
@sipayRT
sipayRT authored Oct 1, 2024
2 parents 9394e08 + 96c4714 commit c83816c
Show file tree
Hide file tree
Showing 2 changed files with 144 additions and 24 deletions.
84 changes: 72 additions & 12 deletions docs/config/system.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -27,20 +27,80 @@ Example configuration of the `system` section:

<table>
<thead>
<tr><td>**Parameter**</td><td>**Type**</td><td>**Default**</td><td>**Description**</td></tr>
<tr>
<td>**Parameter**</td>
<td>**Type**</td>
<td>**Default**</td>
<td>**Description**</td>
</tr>
</thead>
<tbody>
<tr><td>[`debug`](#debug)</td><td>`boolean`</td><td>`false`</td><td>Enable/disable debug mode for WebDriver.</td></tr>
<tr><td>[`expectOpts`](#expect_opts)</td><td>`ExpectOpts`</td><td>_[see below](#expect_opts)_</td><td>expect-webdriverio options.</td></tr>
<tr><td>[`mochaOpts`](#mocha_opts)</td><td>`MochaOpts`</td><td>_[see below](#mocha_opts)_</td><td>Additional options for _mocha_.</td></tr>
<tr><td>[`ctx`](#ctx)</td><td>`Record<string, any>`</td><td>`{ }`</td><td>Context that will be available in all tests via the _testplane.ctx_ method.</td></tr>
<tr><td>[`patternsOnReject`](#patterns_on_reject)</td><td>`RegExp[]`</td><td>`[ ]`</td><td>List of error patterns. The session will be closed if a test fails with an error matching one of the specified patterns. A new session will then be created to avoid infrastructure issues.</td></tr>
<tr><td>[`workers`](#workers)</td><td>`number`</td><td>`1`</td><td>Number of subprocesses that will be launched to run tests.</td></tr>
<tr><td>[`testsPerWorker`](#tests_per_worker)</td><td>`number`</td><td>`Infinity`</td><td>Maximum number of tests that will be run in one subprocess before the subprocess is restarted.</td></tr>
<tr><td>[`diffColor`](#diff_color)</td><td>`string`</td><td>`"#ff00ff"`</td><td>Color to display the diff in screenshots.</td></tr>
<tr><td>[`parallelLimit`](#parallel_limit)</td><td>`number`</td><td>`1`</td><td>Maximum number of browsers that can be launched simultaneously.</td></tr>
<tr><td>[`fileExtensions`](#file_extensions)</td><td>`string[]`</td><td>`[".js", ".mjs", ".ts", ".mts", ".jsx", ".tsx"]`</td><td>File extensions in which Testplane will search for tests to run.</td></tr>
<tr><td>[testRunEnv](#testrunenv)</td><td>`nodejs` or `browser` or `Array`</td><td>`nodejs`</td><td>Ability to specify in which environment the tests should be run.</td></tr>
<tr>
<td>[`debug`](#debug)</td>
<td>`boolean`</td>
<td>`false`</td>
<td>Enable/disable debug mode for WebDriver.</td>
</tr>
<tr>
<td>[`expectOpts`](#expect_opts)</td>
<td>`ExpectOpts`</td>
<td>_[see below](#expect_opts)_</td>
<td>expect-webdriverio options.</td>
</tr>
<tr>
<td>[`mochaOpts`](#mocha_opts)</td>
<td>`MochaOpts`</td>
<td>_[see below](#mocha_opts)_</td>
<td>Additional options for _mocha_.</td>
</tr>
<tr>
<td>[`ctx`](#ctx)</td>
<td>`Record<string, any>`</td>
<td>`{ }`</td>
<td>Context that will be available in all tests via the _testplane.ctx_ method.</td>
</tr>
<tr>
<td>[`patternsOnReject`](#patterns_on_reject)</td>
<td>`RegExp[]`</td>
<td>`[ ]`</td>
<td>List of error patterns. The session will be closed if a test fails with an error matching one of the specified patterns. A new session will then be created to avoid infrastructure issues.</td>
</tr>
<tr>
<td>[`workers`](#workers)</td>
<td>`number`</td>
<td>`1`</td>
<td>Number of subprocesses that will be launched to run tests.</td>
</tr>
<tr>
<td>[`testsPerWorker`](#tests_per_worker)</td>
<td>`number`</td>
<td>`Infinity`</td>
<td>Maximum number of tests that will be run in one subprocess before the subprocess is restarted.</td>
</tr>
<tr>
<td>[`diffColor`](#diff_color)</td>
<td>`string`</td>
<td>`"#ff00ff"`</td>
<td>Color to display the diff in screenshots.</td>
</tr>
<tr>
<td>[`parallelLimit`](#parallel_limit)</td>
<td>`number`</td>
<td>`Infinity`</td>
<td>Maximum number of browsers that can be launched simultaneously.</td>
</tr>
<tr>
<td>[`fileExtensions`](#file_extensions)</td>
<td>`string[]`</td>
<td>`[".js", ".mjs", ".ts", ".mts", ".jsx", ".tsx"]`</td>
<td>File extensions in which Testplane will search for tests to run.</td>
</tr>
<tr>
<td>[testRunEnv](#testrunenv)</td>
<td>`nodejs` or `browser` or `Array`</td>
<td>`nodejs`</td>
<td>Ability to specify in which environment the tests should be run.</td>
</tr>
</tbody>
</table>

Expand Down
84 changes: 72 additions & 12 deletions i18n/ru/docusaurus-plugin-content-docs/current/config/system.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -27,20 +27,80 @@ import TestRunEnvExample from "@site/docs/config/_partials/examples/_system-test

<table>
<thead>
<tr><td>**Параметр**</td><td>**Тип**</td><td>**По&nbsp;умолчанию**</td><td>**Описание**</td></tr>
<tr>
<td>**Параметр**</td>
<td>**Тип**</td>
<td>**По&nbsp;умолчанию**</td>
<td>**Описание**</td>
</tr>
</thead>
<tbody>
<tr><td>[`debug`](#debug)</td><td>`boolean`</td><td>`false`</td><td>Включить / отключить режим отладки для WebDriver.</td></tr>
<tr><td>[`expectOpts`](#expect_opts)</td><td>`ExpectOpts`</td><td>_[см. ниже](#expect_opts)_</td><td>Опции expect-webdriverio.</td></tr>
<tr><td>[`mochaOpts`](#mocha_opts)</td><td>`MochaOpts`</td><td>_[см. ниже](#mocha_opts)_</td><td>Дополнительные опции для _mocha_.</td></tr>
<tr><td>[`ctx`](#ctx)</td><td>`Record<string, any>`</td><td>`{ }`</td><td>Контекст, который будет доступен во всех тестах через метод _testplane.ctx._</td></tr>
<tr><td>[`patternsOnReject`](#patterns_on_reject)</td><td>`RegExp[]`</td><td>`[ ]`</td><td>Список шаблонов ошибок. Сессия будет закрыта, если тест упадет с ошибкой, соответствующей одному из указанных шаблонов. После чего будет создана новая сессия, чтобы исключить инфраструктурные проблемы.</td></tr>
<tr><td>[`workers`](#workers)</td><td>`number`</td><td>`1`</td><td>Число подпроцессов, которые будут запущены для выполнения тестов.</td></tr>
<tr><td>[`testsPerWorker`](#tests_per_worker)</td><td>`number`</td><td>`Infinity`</td><td>Максимальное количество тестов, которые будут запущены в одном подпроцессе, прежде чем подпроцесс будет перезапущен.</td></tr>
<tr><td>[`diffColor`](#diff_color)</td><td>`string`</td><td>`"#ff00ff"`</td><td>Цвет, которым нужно отображать дифф на скриншотах.</td></tr>
<tr><td>[`parallelLimit`](#parallel_limit)</td><td>`number`</td><td>`1`</td><td>Максимальное количество браузеров, которые могут быть запущены одновременно.</td></tr>
<tr><td>[`fileExtensions`](#file_extensions)</td><td>`string[]`</td><td>`[".js", ".mjs", ".ts", ".mts", ".jsx", ".tsx"]`</td><td>Расширения файлов, в которых Testplane будет искать тесты для запуска.</td></tr>
<tr><td>[`testRunEnv`](#testrunenv)</td><td>`nodejs` или `browser` или `Array`</td><td>`nodejs`</td><td>Возможно указать в каком окружении должны выполняться тесты.</td></tr>
<tr>
<td>[`debug`](#debug)</td>
<td>`boolean`</td>
<td>`false`</td>
<td>Включить / отключить режим отладки для WebDriver.</td>
</tr>
<tr>
<td>[`expectOpts`](#expect_opts)</td>
<td>`ExpectOpts`</td>
<td>_[см. ниже](#expect_opts)_</td>
<td>Опции expect-webdriverio.</td>
</tr>
<tr>
<td>[`mochaOpts`](#mocha_opts)</td>
<td>`MochaOpts`</td>
<td>_[см. ниже](#mocha_opts)_</td>
<td>Дополнительные опции для _mocha_.</td>
</tr>
<tr>
<td>[`ctx`](#ctx)</td>
<td>`Record<string, any>`</td>
<td>`{ }`</td>
<td>Контекст, который будет доступен во всех тестах через метод _testplane.ctx._</td>
</tr>
<tr>
<td>[`patternsOnReject`](#patterns_on_reject)</td>
<td>`RegExp[]`</td>
<td>`[ ]`</td>
<td>Список шаблонов ошибок. Сессия будет закрыта, если тест упадет с ошибкой, соответствующей одному из указанных шаблонов. После чего будет создана новая сессия, чтобы исключить инфраструктурные проблемы.</td>
</tr>
<tr>
<td>[`workers`](#workers)</td>
<td>`number`</td>
<td>`1`</td>
<td>Число подпроцессов, которые будут запущены для выполнения тестов.</td>
</tr>
<tr>
<td>[`testsPerWorker`](#tests_per_worker)</td>
<td>`number`</td>
<td>`Infinity`</td>
<td>Максимальное количество тестов, которые будут запущены в одном подпроцессе, прежде чем подпроцесс будет перезапущен.</td>
</tr>
<tr>
<td>[`diffColor`](#diff_color)</td>
<td>`string`</td>
<td>`"#ff00ff"`</td>
<td>Цвет, которым нужно отображать дифф на скриншотах.</td>
</tr>
<tr>
<td>[`parallelLimit`](#parallel_limit)</td>
<td>`number`</td>
<td>`Infinity`</td>
<td>Максимальное количество браузеров, которые могут быть запущены одновременно.</td>
</tr>
<tr>
<td>[`fileExtensions`](#file_extensions)</td>
<td>`string[]`</td>
<td>`[".js", ".mjs", ".ts", ".mts", ".jsx", ".tsx"]`</td>
<td>Расширения файлов, в которых Testplane будет искать тесты для запуска.</td>
</tr>
<tr>
<td>[`testRunEnv`](#testrunenv)</td>
<td>`nodejs` или `browser` или `Array`</td>
<td>`nodejs`</td>
<td>Возможно указать в каком окружении должны выполняться тесты.</td>
</tr>
</tbody>
</table>

Expand Down

0 comments on commit c83816c

Please sign in to comment.