Commit a1403a8
doc: clarify concurrency model of test runner
Refs: #47365
PR-URL: #47642
Reviewed-By: Moshe Atlow <moshe@atlow.co.il>
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>1 parent a793cf4 commit a1403a8
1 file changed
Lines changed: 9 additions & 3 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -379,6 +379,11 @@ Otherwise, the test is considered to be a failure. Test files must be | |||
| 379 | 379 | executable by Node.js, but are not required to use the `node:test` module | |
| 380 | 380 | internally. | |
| 381 | 381 | ||
| 382 | + Each test file is executed as if it was a regular script. That is, if the test | ||
| 383 | + file itself uses `node:test` to define tests, all of those tests will be | ||
| 384 | + executed within a single application thread, regardless of the value of the | ||
| 385 | + `concurrency` option of [`test()`][]. | ||
| 386 | + | ||
| 382 | 387 | ## Collecting code coverage | |
| 383 | 388 | ||
| 384 | 389 | > Stability: 1 - Experimental | |
@@ -735,7 +740,8 @@ changes: | |||
| 735 | 740 | * `options` {Object} Configuration options for running tests. The following | |
| 736 | 741 | properties are supported: | |
| 737 | 742 | * `concurrency` {number|boolean} If a number is provided, | |
| 738 | - then that many files would run in parallel. | ||
| 743 | + then that many test processes would run in parallel, where each process | ||
| 744 | + corresponds to one test file. | ||
| 739 | 745 | If `true`, it would run `os.availableParallelism() - 1` test files in | |
| 740 | 746 | parallel. | |
| 741 | 747 | If `false`, it would only run one test file at a time. | |
@@ -805,7 +811,7 @@ changes: | |||
| 805 | 811 | * `options` {Object} Configuration options for the test. The following | |
| 806 | 812 | properties are supported: | |
| 807 | 813 | * `concurrency` {number|boolean} If a number is provided, | |
| 808 | - then that many tests would run in parallel. | ||
| 814 | + then that many tests would run in parallel within the application thread. | ||
| 809 | 815 | If `true`, it would run `os.availableParallelism() - 1` tests in parallel. | |
| 810 | 816 | For subtests, it will be `Infinity` tests in parallel. | |
| 811 | 817 | If `false`, it would only run one test at a time. | |
@@ -1774,7 +1780,7 @@ changes: | |||
| 1774 | 1780 | * `options` {Object} Configuration options for the subtest. The following | |
| 1775 | 1781 | properties are supported: | |
| 1776 | 1782 | * `concurrency` {number|boolean|null} If a number is provided, | |
| 1777 | - then that many tests would run in parallel. | ||
| 1783 | + then that many tests would run in parallel within the application thread. | ||
| 1778 | 1784 | If `true`, it would run all subtests in parallel. | |
| 1779 | 1785 | If `false`, it would only run one test at a time. | |
| 1780 | 1786 | If unspecified, subtests inherit this value from their parent. | |
0 commit comments