Skip to content

doc: enrich test commands with executable #44347

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
nodejs-github-bot merged 10 commits into from
Feb 6, 2023
Merged

doc: enrich test commands with executable #44347

Changes from 1 commit
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
9c9bf64
doc: enrich test command with executable
tony-go Aug 22, 2022
ac5ddd9
doc: use python3 as command
tony-go Aug 23, 2022
fe37e8a
doc: apply linter
tony-go Aug 23, 2022
e79e768
doc: fix code snippet
tony-go Aug 24, 2022
1fb9db3
doc: add note
tony-go Aug 24, 2022
76846de
doc: lint
tony-go Aug 24, 2022
f946aa2
doc: delete python note
tony-go Aug 24, 2022
d6ee7d8
doc: switch from python3 to python
tony-go Feb 4, 2023
889b81f
doc: revert "switch from python3 to python"
tony-go Feb 5, 2023
99fa16b
doc: delete python exec from command and add a note for windows
tony-go Feb 5, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 13 additions & 5 deletions BUILDING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -318,36 +318,44 @@ If you are updating tests and want to run tests in a single test file
(e.g. `test/parallel/test-stream2-transform.js`):

```text
$ tools/test.py test/parallel/test-stream2-transform.js
$ <python-exec> tools/test.py test/parallel/test-stream2-transform.js
```

Comment thread
tony-go marked this conversation as resolved.
Outdated
For example on Mac it will be:

```text
$ python3 tools/test.py child-process
Comment thread
tony-go marked this conversation as resolved.
Outdated
```

You can execute the entire suite of tests for a given subsystem
by providing the name of a subsystem:

```text
$ tools/test.py child-process
$ <python-exec> tools/test.py child-process
```

You can also execute the tests in a test suite directory
(such as `test/message`):

```text
$ tools/test.py test/message
$ <python-exec> tools/test.py test/message
```

If you want to check the other options, please refer to the help by using
the `--help` option:

```text
$ tools/test.py --help
$ <python-exec> tools/test.py --help
```

You can usually run tests directly with node:

```text
$ ./node ./test/parallel/test-stream2-transform.js
$ ./node test/parallel/test-stream2-transform.js
Comment thread
tony-go marked this conversation as resolved.
```

> Info: `./node` points to your local Node.js build.

Remember to recompile with `make -j4` in between test runs if you change code in
the `lib` or `src` directories.

Expand Down