Skip to content

Commit 88bdbf1

Browse files
Trottdanielleadams
Trott
authored and
danielleadams
committed
doc: format markdown files in test directory
Use `make format-md` to format markdown files in `test` directory. PR-URL: #40290 Reviewed-By: Michaël Zasso <[email protected]> Reviewed-By: Zijian Liu <[email protected]> Reviewed-By: Daijiro Wachi <[email protected]> Reviewed-By: Tobias Nießen <[email protected]> Reviewed-By: James M Snell <[email protected]>
1 parent 9af2592 commit 88bdbf1

File tree

3 files changed

+163
-160
lines changed

3 files changed

+163
-160
lines changed

‎test/README.md

+24-24
Original file line numberDiff line numberDiff line change
@@ -13,27 +13,27 @@ For the tests to run on Windows, be sure to clone Node.js source code with the
1313

1414
## Test Directories
1515

16-
| Directory | Runs on CI | Purpose |
17-
| ---------------- | ---------- | --------------- |
18-
| `abort` | Yes | Tests that use `--abort-on-uncaught-exception` and other situations where we want to test something but avoid generating a core file. |
19-
| `addons` | Yes | Tests for [addon](https://nodejs.org/api/addons.html) functionality along with some tests that require an addon. |
20-
| `async-hooks` | Yes | Tests for [async\_hooks](https://nodejs.org/api/async\_hooks.html) functionality. |
21-
| `benchmark` | Yes | Test minimal functionality of benchmarks. |
22-
| `cctest` | Yes | C++ tests that are run as part of the build process. |
23-
| `code-cache` | No | Tests for a Node.js binary compiled with V8 code cache. |
24-
| `common` | | Common modules shared among many tests. [Documentation](./common/README.md) |
25-
| `doctool` | Yes | Tests for the documentation generator. |
26-
| `es-module` | Yes | Test ESM module loading. |
27-
| `fixtures` | | Test fixtures used in various tests throughout the test suite. |
28-
| `internet` | No | Tests that make real outbound network connections. Tests for networking related modules may also be present in other directories, but those tests do not make outbound connections. |
29-
| `js-native-api` | Yes | Tests for Node.js-agnostic [n-api](https://nodejs.org/api/n-api.html) functionality. |
30-
| `known_issues` | Yes | Tests reproducing known issues within the system. All tests inside of this directory are expected to fail. If a test doesn't fail on certain platforms, those should be skipped via `known_issues.status`. |
31-
| `message` | Yes | Tests for messages that are output for various conditions (`console.log`, error messages etc.) |
32-
| `node-api` | Yes | Tests for Node.js-specific [n-api](https://nodejs.org/api/n-api.html) functionality. |
33-
| `parallel` | Yes | Various tests that are able to be run in parallel. |
34-
| `pseudo-tty` | Yes | Tests that require stdin/stdout/stderr to be a TTY. |
35-
| `pummel` | No | Various tests for various modules / system functionality operating under load. |
36-
| `sequential` | Yes | Various tests that must not run in parallel. |
37-
| `testpy` | | Test configuration utility used by various test suites. |
38-
| `tick-processor` | No | Tests for the V8 tick processor integration. The tests are for the logic in `lib/internal/v8_prof_processor.js` and `lib/internal/v8_prof_polyfill.js`. The tests confirm that the profile processor packages the correct set of scripts from V8 and introduces the correct platform specific logic. |
39-
| `v8-updates` | No | Tests for V8 performance integration. |
16+
| Directory | Runs on CI | Purpose |
17+
| ---------------- | ---------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
18+
| `abort` | Yes | Tests that use `--abort-on-uncaught-exception` and other situations where we want to test something but avoid generating a core file. |
19+
| `addons` | Yes | Tests for [addon](https://nodejs.org/api/addons.html) functionality along with some tests that require an addon. |
20+
| `async-hooks` | Yes | Tests for [async\_hooks](https://nodejs.org/api/async\_hooks.html) functionality. |
21+
| `benchmark` | Yes | Test minimal functionality of benchmarks. |
22+
| `cctest` | Yes | C++ tests that are run as part of the build process. |
23+
| `code-cache` | No | Tests for a Node.js binary compiled with V8 code cache. |
24+
| `common` | | Common modules shared among many tests. [Documentation](./common/README.md) |
25+
| `doctool` | Yes | Tests for the documentation generator. |
26+
| `es-module` | Yes | Test ESM module loading. |
27+
| `fixtures` | | Test fixtures used in various tests throughout the test suite. |
28+
| `internet` | No | Tests that make real outbound network connections. Tests for networking related modules may also be present in other directories, but those tests do not make outbound connections. |
29+
| `js-native-api` | Yes | Tests for Node.js-agnostic [n-api](https://nodejs.org/api/n-api.html) functionality. |
30+
| `known_issues` | Yes | Tests reproducing known issues within the system. All tests inside of this directory are expected to fail. If a test doesn't fail on certain platforms, those should be skipped via `known_issues.status`. |
31+
| `message` | Yes | Tests for messages that are output for various conditions (`console.log`, error messages etc.) |
32+
| `node-api` | Yes | Tests for Node.js-specific [n-api](https://nodejs.org/api/n-api.html) functionality. |
33+
| `parallel` | Yes | Various tests that are able to be run in parallel. |
34+
| `pseudo-tty` | Yes | Tests that require stdin/stdout/stderr to be a TTY. |
35+
| `pummel` | No | Various tests for various modules / system functionality operating under load. |
36+
| `sequential` | Yes | Various tests that must not run in parallel. |
37+
| `testpy` | | Test configuration utility used by various test suites. |
38+
| `tick-processor` | No | Tests for the V8 tick processor integration. The tests are for the logic in `lib/internal/v8_prof_processor.js` and `lib/internal/v8_prof_polyfill.js`. The tests confirm that the profile processor packages the correct set of scripts from V8 and introduces the correct platform specific logic. |
39+
| `v8-updates` | No | Tests for V8 performance integration. |

‎test/async-hooks/coverage.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
Showing which kind of async resource is covered by which test:
44

55
| Resource Type | Test |
6-
|---------------------|-----------------------------------------|
6+
| ------------------- | --------------------------------------- |
77
| CONNECTION | test-connection.ssl.js |
88
| FSEVENTWRAP | test-fseventwrap.js |
99
| FSREQCALLBACK | test-fsreqcallback-{access,readFile}.js |

0 commit comments

Comments
 (0)