Skip to content

Commit 51b10ea

Browse files
committed
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.
1 parent db0121b commit 51b10ea

File tree

2 files changed

+24
-0
lines changed

2 files changed

+24
-0
lines changed

BUILDING.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -352,6 +352,25 @@ You can also execute the tests in a test suite directory
352352
tools/test.py test/message
353353
```
354354

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+
# In some shell environments, you may need to quote the pattern
362+
tools/test.py "test/parallel/test-stream-*"
363+
```
364+
365+
The whildcard `*` can be used in any part of the path. For example, to run all tests
366+
with a name that starts with `test-inspector-`, regardless of the directory they are in:
367+
368+
```bash
369+
# Matches test/sequential/test-inspector-*, test/parallel/test-inspector-*,
370+
# test/known_issues/test-inspector-*, etc.
371+
tools/test.py test/*/test-inspector-*
372+
```
373+
355374
If you want to check the other options, please refer to the help by using
356375
the `--help` option:
357376

doc/contributing/writing-tests.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -485,6 +485,11 @@ To generate a test coverage report, see the
485485
Nightly coverage reports for the Node.js `main` branch are available at
486486
<https://coverage.nodejs.org/>.
487487

488+
## Running tests
489+
490+
See the [Building guide](../../BUILDING.md#running-tests) for details on how to
491+
run tests.
492+
488493
[ASCII]: https://man7.org/linux/man-pages/man7/ascii.7.html
489494
[Google Test]: https://github.com/google/googletest
490495
[Test Coverage section of the Building guide]: https://github.com/nodejs/node/blob/HEAD/BUILDING.md#running-coverage

0 commit comments

Comments
 (0)