Skip to content

Commit

Permalink
doc: improve test/README.md
Browse files Browse the repository at this point in the history 
* 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 <jasnell@gmail.com>
Reviewed-By: Andreas Madsen <amwebdk@gmail.com>
  • Loading branch information
@joyeecheung @addaleax
joyeecheung authored and addaleax committed Feb 22, 2017
1 parent 5d12fd9 commit 66f9506
Showing 1 changed file with 144 additions and 137 deletions.
281 changes: 144 additions & 137 deletions test/README.md
View file
Original file line number Diff line number Diff line change
@@ -1,147 +1,154 @@
# Table of Contents
* [Test directories](#test-directories)
* [Common module API](#common-module-api)

## Test Directories

### abort

Tests for when the `--abort-on-uncaught-exception` flag is used.

| Runs on CI |
|:----------:|
| No |

### addons

Tests for [addon](https://nodejs.org/api/addons.html) functionality along with
some tests that require an addon to function properly.


| Runs on CI |
|:----------:|
| Yes |

### cctest

C++ test that is run as part of the build process.

| Runs on CI |
|:----------:|
| Yes |

### debugger

Tests for [debugger](https://nodejs.org/api/debugger.html) functionality.

| Runs on CI |
|:----------:|
| No |

### disabled

Tests that have been disabled from running for various reasons.

| Runs on CI |
|:----------:|
| No |

### fixtures

Test fixtures used in various tests throughout the test suite.

### gc

Tests for garbage collection related functionality.

| Runs on CI |
|:----------:|
| No |

# Node.js Core Tests

### inspector
This folder contains code and data used to test the Node.js implementation.

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

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

### internet
## Table of Contents

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.

| Runs on CI |
|:----------:|
| No |

### known_issues

Tests reproducing known issues within the system.

| Runs on CI |
|:----------:|
| No |

### message

Tests for messages that are output for various conditions (`console.log`,
error messages etc.)

| Runs on CI |
|:----------:|
| Yes |

### parallel

Various tests that are able to be run in parallel.

| Runs on CI |
|:----------:|
| Yes |

### pummel

Various tests for various modules / system functionality operating under load.

| Runs on CI |
|:----------:|
| No |

### sequential

Various tests that are run sequentially.

| Runs on CI |
|:----------:|
| Yes |

### testpy

Test configuration utility used by various test suites.

### tick-processor

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.

| Runs on CI |
|:----------:|
| No |

### timers

Tests for [timing utilities](https://nodejs.org/api/timers.html) (`setTimeout`
and `setInterval`).
* [Test directories](#test-directories)
* [Common module API](#common-module-api)

| Runs on CI |
|:----------:|
| No |
## Test Directories

<table>
<thead>
<tr>
<th>Directory</th>
<th>Runs on CI</th>
<th>Purpose</th>
</tr>
</thead>
<tbody>
<tr>
<td>abort</td>
<td>No</td>
<td>
Tests for when the <code>--abort-on-uncaught-exception</code>
flag is used.
</td>
</tr>
<tr>
<td>addons</td>
<td>Yes</td>
<td>
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>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>No</td>
<td>Tests reproducing known issues within the system.</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>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>

## Common module API

Expand Down

0 comments on commit 66f9506

Please sign in to comment.