lukechilds
/
node
mirror of https://github.com/lukechilds/node.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
Browse Source

test: convert table in test doc to markdown table 

PR-URL: https://github.com/nodejs/node/pull/14291
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Tobias Nießen <tniessen@tnie.de>
v6
vixony 8 years ago
committed by Rich Trott
parent
156549d8ff
commit
85939bd251
1 changed files with 21 additions and 151 deletions
Whitespace
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Unified View
Diff Options
Show Stats Download Patch File Download Diff File
  1. 172
      test/README.md

172
test/README.md
View File

@ -10,154 +10,24 @@ On how to run tests in this directory, see
## Test Directories ## Test Directories
<table> |Directory |Runs on CI |Purpose |
<thead> |-------------------|---------------|---------------|
<tr> |abort |No |Tests for when the ``` --abort-on-uncaught-exception ``` flag is used.|
<th>Directory</th> |addons |Yes |Tests for [addon](https://nodejs.org/api/addons.html) functionality along with some tests that require an addon to function properly.|
<th>Runs on CI</th> |cctest |Yes |C++ test that is run as part of the build process.|
<th>Purpose</th> |common | |Common modules shared among many tests. [Documentation](./common/README.md)|
</tr> |debugger |No |Tests for [debugger](https://nodejs.org/api/debugger.html)functionality along with some tests that require an addon to function properly.|
</thead> |disabled |No |Tests that have been disabled from running for various reasons.|
<tbody> |fixtures | |Test fixtures used in various tests throughout the test suite.|
<tr> |gc |No |Tests for garbage collection related functionality.|
<td>abort</td> |inspector |Yes |Tests for the V8 inspector integration.|
<td>No</td> |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.|
<td> |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`.|
Tests for when the <code>--abort-on-uncaught-exception</code> |message |Yes |Tests for messages that are output for various conditions (```console.log```, error messages etc.)|
flag is used. |parallel |Yes |Various tests that are able to be run in parallel.|
</td> |pseudo-tty |Yes |Tests that require stdin/stdout/stderr to be a TTY.|
</tr> |pummel |No |Various tests for various modules / system functionality operating under load.|
<tr> |sequential |Yes |Various tests that are run sequentially.|
<td>addons</td> |testpy | |Test configuration utility used by various test suites.|
<td>Yes</td> |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.|
<td> |timers |No |Tests for [timing utilities](https://nodejs.org/api/timers.html) (```setTimeout``` and ```setInterval```).|
Tests for <a href="https://nodejs.org/api/addons.html">addon</a>
functionality along with some tests that require an addon to function
properly.
</td>
</tr>
<tr>
<td>cctest</td>
<td>Yes</td>
<td>
C++ test that is run as part of the build process.
</td>
</tr>
<tr>
<td>common</td>
<td></td>
<td>
Common modules shared among many tests.
<a href="./common/README.md">[Documentation]</a>
</td>
</tr>
<tr>
<td>debugger</td>
<td>No</td>
<td>
Tests for <a href="https://nodejs.org/api/debugger.html">debugger</a>
functionality along with some tests that require an addon to function
properly.
</td>
</tr>
<tr>
<td>disabled</td>
<td>No</td>
<td>
Tests that have been disabled from running for various reasons.
</td>
</tr>
<tr>
<td>fixtures</td>
<td></td>
<td>Test fixtures used in various tests throughout the test suite.</td>
</tr>
<tr>
<td>gc</td>
<td>No</td>
<td>Tests for garbage collection related functionality.</td>
</tr>
<tr>
<td>inspector</td>
<td>Yes</td>
<td>Tests for the V8 inspector integration.</td>
</tr>
<tr>
<td>internet</td>
<td>No</td>
<td>
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.
</td>
</tr>
<tr>
<td>known_issues</td>
<td>Yes</td>
<td>
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`.
</td>
</tr>
<tr>
<td>message</td>
<td>Yes</td>
<td>
Tests for messages that are output for various conditions
(<code>console.log</code>, error messages etc.)</td>
</tr>
<tr>
<td>parallel</td>
<td>Yes</td>
<td>Various tests that are able to be run in parallel.</td>
</tr>
<tr>
<td>pseudo-tty</td>
<td>Yes</td>
<td>Tests that require stdin/stdout/stderr to be a TTY.</td>
</tr>
<tr>
<td>pummel</td>
<td>No</td>
<td>
Various tests for various modules / system functionality operating
under load.
</td>
</tr>
<tr>
<td>sequential</td>
<td>Yes</td>
<td>
Various tests that are run sequentially.
</td>
</tr>
<tr>
<td>testpy</td>
<td></td>
<td>
Test configuration utility used by various test suites.
</td>
</tr>
<tr>
<td>tick-processor</td>
<td>No</td>
<td>
Tests for the V8 tick processor integration. The tests are for the
logic in <code>lib/internal/v8_prof_processor.js</code> and
<code>lib/internal/v8_prof_polyfill.js</code>. The tests confirm that
the profile processor packages the correct set of scripts from V8 and
introduces the correct platform specific logic.
</td>
</tr>
<tr>
<td>timers</td>
<td>No</td>
<td>
Tests for
<a href="https://nodejs.org/api/timers.html">timing utilities</a>
(<code>setTimeout</code> and <code>setInterval</code>).
</td>
</tr>
</tbody>
</table>

Write Preview
Loading…
Cancel
Save