Filip/playwright
1
0
Fork 0
Code Issues Pull requests Actions Packages Projects Releases Wiki Activity

chore: add a parallel mode note (#11943)

Browse source
This commit is contained in:
Pavel Feldman 2022-02-08 14:36:14 -08:00 committed by GitHub
parent 9ce8572c78
commit 4bcca2c87e
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 8 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
docs/src/test-api/class-test.md
View file

@ -334,7 +334,9 @@ A callback that is run immediately when calling [`method: Test.describe.only`].
Declares a group of tests that could be run in parallel. By default, tests in a single test file run one after another, but using [`method: Test.describe.parallel`] allows them to run in parallel. Declares a group of tests that could be run in parallel. By default, tests in a single test file run one after another, but using [`method: Test.describe.parallel`] allows them to run in parallel.
:::note
See [`method: Test.describe.configure`] for the preferred way of configuring the execution mode. See [`method: Test.describe.configure`] for the preferred way of configuring the execution mode.
:::
```js js-flavor=js ```js js-flavor=js
test.describe.parallel('group', () => { test.describe.parallel('group', () => {
@ -384,7 +386,9 @@ A callback that is run immediately when calling [`method: Test.describe.parallel
Declares a group of tests that should always be run serially. If one of the tests fails, all subsequent tests are skipped. All tests in a group are retried together. Declares a group of tests that should always be run serially. If one of the tests fails, all subsequent tests are skipped. All tests in a group are retried together.
:::note
See [`method: Test.describe.configure`] for the preferred way of configuring the execution mode. See [`method: Test.describe.configure`] for the preferred way of configuring the execution mode.
:::
:::note :::note
Using serial is not recommended. It is usually better to make your tests isolated, so they can be run independently. Using serial is not recommended. It is usually better to make your tests isolated, so they can be run independently.

9
packages/playwright-test/types/test.d.ts vendored
View file

@ -1640,9 +1640,8 @@ export interface TestType<TestArgs extends KeyValue, WorkerArgs extends KeyValue
* Declares a group of tests that should always be run serially. If one of the tests fails, all subsequent tests are * Declares a group of tests that should always be run serially. If one of the tests fails, all subsequent tests are
* skipped. All tests in a group are retried together. * skipped. All tests in a group are retried together.
* *
* See [test.describe.configure([options])](https://playwright.dev/docs/api/class-test#test-describe-configure) for the * > NOTE: See [test.describe.configure([options])](https://playwright.dev/docs/api/class-test#test-describe-configure) for
* preferred way of configuring the execution mode. * the preferred way of configuring the execution mode.
*
* > NOTE: Using serial is not recommended. It is usually better to make your tests isolated, so they can be run * > NOTE: Using serial is not recommended. It is usually better to make your tests isolated, so they can be run
* independently. * independently.
* *
@ -1686,8 +1685,8 @@ export interface TestType<TestArgs extends KeyValue, WorkerArgs extends KeyValue
* but using [test.describe.parallel(title, callback)](https://playwright.dev/docs/api/class-test#test-describe-parallel) * but using [test.describe.parallel(title, callback)](https://playwright.dev/docs/api/class-test#test-describe-parallel)
* allows them to run in parallel. * allows them to run in parallel.
* *
* See [test.describe.configure([options])](https://playwright.dev/docs/api/class-test#test-describe-configure) for the * > NOTE: See [test.describe.configure([options])](https://playwright.dev/docs/api/class-test#test-describe-configure) for
* preferred way of configuring the execution mode. * the preferred way of configuring the execution mode.
* *
* ```ts * ```ts
* test.describe.parallel('group', () => { * test.describe.parallel('group', () => {