Commit a744e42
doc: document wildcard supported by tools/test.py
This seems to be a underdocumented but useful trick that only very few
people know about. Also add a pointer to the test running guide in
the test writing guide.
PR-URL: #60265
Reviewed-By: Richard Lau <richard.lau@ibm.com>
Reviewed-By: Marco Ippolito <marcoippolito54@gmail.com>
Reviewed-By: Chengzhong Wu <legendecas@gmail.com>
Reviewed-By: Yagiz Nizipli <yagiz@nizipli.com>
Reviewed-By: Rafael Gonzaga <rafael.nunu@hotmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Chemi Atlow <chemi@atlow.co.il>1 parent 91ea9b0 commit a744e42
2 files changed
Lines changed: 26 additions & 0 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -352,6 +352,27 @@ You can also execute the tests in a test suite directory | |||
| 352 | 352 | tools/test.py test/message | |
| 353 | 353 | ``` | |
| 354 | 354 | ||
| 355 | + You can execute tests that match a specific naming pattern using the wildcard | ||
| 356 | + `*`. For example, to run all tests under `test/parallel` with a name that starts | ||
| 357 | + with `test-stream-`: | ||
| 358 | + | ||
| 359 | + ```bash | ||
| 360 | + tools/test.py test/parallel/test-stream-* | ||
| 361 | + tools/test.py parallel/test-stream-* # The test/ prefix can be omitted | ||
| 362 | + # In some shell environments, you may need to quote the pattern | ||
| 363 | + tools/test.py "test/parallel/test-stream-*" | ||
| 364 | + ``` | ||
| 365 | + | ||
| 366 | + The whildcard `*` can be used in any part of the path. For example, to run all tests | ||
| 367 | + with a name that starts with `test-inspector-`, regardless of the directory they are in: | ||
| 368 | + | ||
| 369 | + ```bash | ||
| 370 | + # Matches test/sequential/test-inspector-*, test/parallel/test-inspector-*, | ||
| 371 | + # test/known_issues/test-inspector-*, etc. | ||
| 372 | + tools/test.py "test/*/test-inspector-*" | ||
| 373 | + tools/test.py "*/test-inspector-*" # The test/ prefix can be omitted | ||
| 374 | + ``` | ||
| 375 | + | ||
| 355 | 376 | If you want to check the other options, please refer to the help by using | |
| 356 | 377 | the `--help` option: | |
| 357 | 378 | ||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -485,6 +485,11 @@ To generate a test coverage report, see the | |||
| 485 | 485 | Nightly coverage reports for the Node.js `main` branch are available at | |
| 486 | 486 | <https://coverage.nodejs.org/>. | |
| 487 | 487 | ||
| 488 | + ## Running tests | ||
| 489 | + | ||
| 490 | + See the [Building guide](../../BUILDING.md#running-tests) for details on how to | ||
| 491 | + run tests. | ||
| 492 | + | ||
| 488 | 493 | [ASCII]: https://man7.org/linux/man-pages/man7/ascii.7.html | |
| 489 | 494 | [Google Test]: https://github.com/google/googletest | |
| 490 | 495 | [Test Coverage section of the Building guide]: https://github.com/nodejs/node/blob/HEAD/BUILDING.md#running-coverage | |
0 commit comments