Skip to content

Commit 736814e

Browse files
joyeecheungjoyeecheung
committed
doc: improve test/README.md
* Add description about the test directory * Add link to the test writing guide and the contributing guide * Use table to describe the directory layout and CI info PR-URL: #11237 Fixes: #11190 Reviewed-By: James M Snell <[email protected]> Reviewed-By: Andreas Madsen <[email protected]>
1 parent 8926f11 commit 736814e

File tree

1 file changed

+144
-137
lines changed

1 file changed

+144
-137
lines changed

‎test/README.md‎

Lines changed: 144 additions & 137 deletions
Original file line numberDiff line numberDiff line change
@@ -1,147 +1,154 @@
1-
# Table of Contents
2-
* [Test directories](#test-directories)
3-
* [Common module API](#common-module-api)
4-
5-
## Test Directories
6-
7-
### abort
8-
9-
Tests for when the `--abort-on-uncaught-exception` flag is used.
10-
11-
| Runs on CI |
12-
|:----------:|
13-
| No |
14-
15-
### addons
16-
17-
Tests for [addon](https://nodejs.org/api/addons.html) functionality along with
18-
some tests that require an addon to function properly.
19-
20-
21-
| Runs on CI |
22-
|:----------:|
23-
| Yes |
24-
25-
### cctest
26-
27-
C++ test that is run as part of the build process.
28-
29-
| Runs on CI |
30-
|:----------:|
31-
| Yes |
32-
33-
### debugger
34-
35-
Tests for [debugger](https://nodejs.org/api/debugger.html) functionality.
36-
37-
| Runs on CI |
38-
|:----------:|
39-
| No |
40-
41-
### disabled
42-
43-
Tests that have been disabled from running for various reasons.
44-
45-
| Runs on CI |
46-
|:----------:|
47-
| No |
48-
49-
### fixtures
50-
51-
Test fixtures used in various tests throughout the test suite.
52-
53-
### gc
54-
55-
Tests for garbage collection related functionality.
56-
57-
| Runs on CI |
58-
|:----------:|
59-
| No |
60-
1+
# Node.js Core Tests
612

62-
### inspector
3+
This folder contains code and data used to test the Node.js implementation.
634

64-
Tests for the V8 inspector integration.
5+
For a detailed guide on how to write tests in this
6+
directory, see [the guide on writing tests](../doc/guides/writing-tests.md).
657

66-
| Runs on CI |
67-
|:----------:|
68-
| Yes |
8+
On how to run tests in this direcotry, see
9+
[the contributing guide](../CONTRIBUTING.md#step-5-test).
6910

70-
### internet
11+
## Table of Contents
7112

72-
Tests that make real outbound connections (mainly networking related modules).
73-
Tests for networking related modules may also be present in other directories,
74-
but those tests do not make outbound connections.
75-
76-
| Runs on CI |
77-
|:----------:|
78-
| No |
79-
80-
### known_issues
81-
82-
Tests reproducing known issues within the system.
83-
84-
| Runs on CI |
85-
|:----------:|
86-
| No |
87-
88-
### message
89-
90-
Tests for messages that are output for various conditions (`console.log`,
91-
error messages etc.)
92-
93-
| Runs on CI |
94-
|:----------:|
95-
| Yes |
96-
97-
### parallel
98-
99-
Various tests that are able to be run in parallel.
100-
101-
| Runs on CI |
102-
|:----------:|
103-
| Yes |
104-
105-
### pummel
106-
107-
Various tests for various modules / system functionality operating under load.
108-
109-
| Runs on CI |
110-
|:----------:|
111-
| No |
112-
113-
### sequential
114-
115-
Various tests that are run sequentially.
116-
117-
| Runs on CI |
118-
|:----------:|
119-
| Yes |
120-
121-
### testpy
122-
123-
Test configuration utility used by various test suites.
124-
125-
### tick-processor
126-
127-
Tests for the V8 tick processor integration. The tests are for the logic in
128-
`lib/internal/v8_prof_processor.js` and `lib/internal/v8_prof_polyfill.js`. The
129-
tests confirm that the profile processor packages the correct set of scripts
130-
from V8 and introduces the correct platform specific logic.
131-
132-
| Runs on CI |
133-
|:----------:|
134-
| No |
135-
136-
### timers
137-
138-
Tests for [timing utilities](https://nodejs.org/api/timers.html) (`setTimeout`
139-
and `setInterval`).
13+
* [Test directories](#test-directories)
14+
* [Common module API](#common-module-api)
14015

141-
| Runs on CI |
142-
|:----------:|
143-
| No |
16+
## Test Directories
14417

18+
<table>
19+
<thead>
20+
<tr>
21+
<th>Directory</th>
22+
<th>Runs on CI</th>
23+
<th>Purpose</th>
24+
</tr>
25+
</thead>
26+
<tbody>
27+
<tr>
28+
<td>abort</td>
29+
<td>No</td>
30+
<td>
31+
Tests for when the <code>--abort-on-uncaught-exception</code>
32+
flag is used.
33+
</td>
34+
</tr>
35+
<tr>
36+
<td>addons</td>
37+
<td>Yes</td>
38+
<td>
39+
Tests for <a href="https://nodejs.org/api/addons.html">addon</a>
40+
functionality along with some tests that require an addon to function
41+
properly.
42+
</td>
43+
</tr>
44+
<tr>
45+
<td>cctest</td>
46+
<td>Yes</td>
47+
<td>
48+
C++ test that is run as part of the build process.
49+
</td>
50+
</tr>
51+
<tr>
52+
<td>debugger</td>
53+
<td>No</td>
54+
<td>
55+
Tests for <a href="https://nodejs.org/api/debugger.html">debugger</a>
56+
functionality along with some tests that require an addon to function
57+
properly.
58+
</td>
59+
</tr>
60+
<tr>
61+
<td>disabled</td>
62+
<td>No</td>
63+
<td>
64+
Tests that have been disabled from running for various reasons.
65+
</td>
66+
</tr>
67+
<tr>
68+
<td>fixtures</td>
69+
<td></td>
70+
<td>Test fixtures used in various tests throughout the test suite.</td>
71+
</tr>
72+
<tr>
73+
<td>gc</td>
74+
<td>No</td>
75+
<td>Tests for garbage collection related functionality.</td>
76+
</tr>
77+
<tr>
78+
<td>inspector</td>
79+
<td>Yes</td>
80+
<td>Tests for the V8 inspector integration.</td>
81+
</tr>
82+
<tr>
83+
<td>internet</td>
84+
<td>No</td>
85+
<td>
86+
Tests that make real outbound connections (mainly networking related
87+
modules). Tests for networking related modules may also be present in
88+
other directories, but those tests do not make outbound connections.
89+
</td>
90+
</tr>
91+
<tr>
92+
<td>known_issues</td>
93+
<td>No</td>
94+
<td>Tests reproducing known issues within the system.</td>
95+
</tr>
96+
<tr>
97+
<td>message</td>
98+
<td>Yes</td>
99+
<td>
100+
Tests for messages that are output for various conditions
101+
(<code>console.log</code>, error messages etc.)</td>
102+
</tr>
103+
<tr>
104+
<td>parallel</td>
105+
<td>Yes</td>
106+
<td>Various tests that are able to be run in parallel.</td>
107+
</tr>
108+
<tr>
109+
<td>pummel</td>
110+
<td>No</td>
111+
<td>
112+
Various tests for various modules / system functionality operating
113+
under load.
114+
</td>
115+
</tr>
116+
<tr>
117+
<td>sequential</td>
118+
<td>Yes</td>
119+
<td>
120+
Various tests that are run sequentially.
121+
</td>
122+
</tr>
123+
<tr>
124+
<td>testpy</td>
125+
<td></td>
126+
<td>
127+
Test configuration utility used by various test suites.
128+
</td>
129+
</tr>
130+
<tr>
131+
<td>tick-processor</td>
132+
<td>No</td>
133+
<td>
134+
Tests for the V8 tick processor integration. The tests are for the
135+
logic in <code>lib/internal/v8_prof_processor.js</code> and
136+
<code>lib/internal/v8_prof_polyfill.js</code>. The tests confirm that
137+
the profile processor packages the correct set of scripts from V8 and
138+
introduces the correct platform specific logic.
139+
</td>
140+
</tr>
141+
<tr>
142+
<td>timers</td>
143+
<td>No</td>
144+
<td>
145+
Tests for
146+
<a href="https://nodejs.org/api/timers.html">timing utilities</a>
147+
(<code>setTimeout</code> and <code>setInterval</code>).
148+
</td>
149+
</tr>
150+
</tbody>
151+
</table>
145152

146153
## Common module API
147154

0 commit comments

Comments
 (0)