Skip to content

Commit

Permalink
docs: add info about "passive" option and "testplane.also.in" helper
Browse files Browse the repository at this point in the history
  • Loading branch information
DudaGod committed Jul 10, 2024
1 parent 36e7001 commit 3a31e3a
Show file tree
Hide file tree
Showing 4 changed files with 27 additions and 3 deletions.
15 changes: 14 additions & 1 deletion docs/config/browsers.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -249,6 +249,7 @@ windowSize: {
<tr><td>[retry](#retry)</td><td>Number</td><td>0</td><td>Сколько раз нужно перезапускать падающий тест.</td></tr>
<tr><td>[shouldRetry](#should_retry)</td><td>Function</td><td>_см. описание_</td><td>Функция, которая определяет нужен ли ретрай. По умолчанию задается функция, которая возвращает _true_, если _retry > 0,_ и _false_, если _retry == 0_.</td></tr>
<tr><td>[strictTestsOrder](#strict_test_order)</td><td>Boolean</td><td>false</td><td>Гарантировать строгий порядок тестов. Если _true_, то функция API _testplane.readTests_ будет всегда возвращать один и тот же результат.</td></tr>
<tr><td>[passive](#passive)</td><td>Boolean</td><td>false</td><td>Позволяет сделать браузер пассивным, в котором тесты не запускаются по умолчанию. _Доступна с [email protected]_.</td></tr>

</tbody>
</table>
Expand Down Expand Up @@ -279,7 +280,7 @@ windowSize: {

<table>
<thead>
<tr><td>ctx</td><td>Object</td><td>Данные об упавшем тесте: _\{ id(): string; browserId: string; sessionId: string; }_.</td></tr>
<tr><td>ctx</td><td>Object</td><td>Данные об упавшем тесте: _\{ id(): string; browserId: string; sessionId: string; }_.</td></tr>
</thead>
<tbody>
<tr><td>retriesLeft</td><td>Number</td><td>Число оставшихся ретраев</td></tr>
Expand All @@ -291,6 +292,17 @@ windowSize: {

Данная опция включает гарантию строгого порядка чтения тестов. По умолчанию: `false`.

### passive {#passive}

<Admonition type="warning">
Доступна с [email protected]. Не работает вместе с устаревшим плагином
[hermione-passive-browsers](https://github.com/gemini-testing/testplane-passive-browsers).
</Admonition>

Позволяет сделать браузер пассивным, в котором тесты не запускаются по умолчанию. С помощью хелпера [testplane.also.in][testplane-also-in-helper] можно включить тест или сьют, перед которым он указан.

По умолчанию: `false`.

## Информация о тесте и падении {#info_when_test_fails}

<table>
Expand Down Expand Up @@ -652,3 +664,4 @@ RequestOptions => RequestOptions;
[system-mocha-opts]: ../system#mocha_opts
[element-wait-until]: ../../commands/element/waitUntil
[how-to-use-cdp]: ../../guides/how-to-use-cdp
[testplane-also-in-helper]: ../../guides/how-to-skip-test-in-browsers#solution_4
11 changes: 11 additions & 0 deletions docs/guides/how-to-skip-test-in-browsers.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -62,9 +62,20 @@ testplane.only.in("chrome"); // запустить тест только в chro
testplane.only.notIn("ie8"); // запустить тест во всех браузерах, кроме ie8
```

## Решение 4: директива .also.in и браузерная опция passive {#solution_4}

В случае если вы внедряете новый браузер и необходимо его запускать только в нескольких тестах, а у вас их тысячи, то использовать хелпер `.skip.in` неудобно. Для решения этой проблемы можно воспользоваться браузерной опцией [passive][passive-option] и хелпером `.also.in`:

```javascript
testplane.also.in("chrome"); // запустить тест в пассивном браузере chrome
```

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

- testplane.skip.in
- testplane.skip.notIn
- testplane.only.in
- testplane.only.notIn
- testplane.also.in

[passive-option]: ../../config/browsers#passive
2 changes: 1 addition & 1 deletion docs/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@
- [по совпадению с маской][testplane-option-grep];
- [из конкретного файла][how-to-run-test-in-file];
- [заданное количество раз для проверки стабильности][how-to-check-test-stability];
- [хелперы only.in, only.notIn, skip.in, skip.notIn][how-to-skip-tests].
- [хелперы only.in, only.notIn, skip.in, skip.notIn, also.in][how-to-skip-tests].

### Умное поведение при ошибках {#smart}

Expand Down
2 changes: 1 addition & 1 deletion i18n/en/docusaurus-plugin-content-docs/current/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ And that’s not all.
- [by matching patterns][testplane-option-grep];
- [from a specific file][how-to-run-test-in-file];
- [a set number of times to check stability][how-to-check-test-stability];
- [helpers only.in, only.notIn, skip.in, skip.notIn][how-to-skip-tests].
- [helpers only.in, only.notIn, skip.in, skip.notIn, also.in][how-to-skip-tests].

### Smart Error Handling {#smart}

Expand Down

0 comments on commit 3a31e3a

Please sign in to comment.