Skip to content

Commit cd0fffd

Browse files
sealkingwaddaleax
sealkingw
authored and
addaleax
committed
test: convert table in test doc to markdown table
PR-URL: #14291 Reviewed-By: Rich Trott <[email protected]> Reviewed-By: Vse Mozhet Byt <[email protected]> Reviewed-By: Colin Ihrig <[email protected]> Reviewed-By: Tobias Nießen <[email protected]>
1 parent 5e95218 commit cd0fffd

File tree

1 file changed

+21
-151
lines changed

1 file changed

+21
-151
lines changed

‎test/README.md

+21-151
Original file line numberDiff line numberDiff line change
@@ -10,154 +10,24 @@ On how to run tests in this directory, see
1010

1111
## Test Directories
1212

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

0 commit comments

Comments
 (0)