Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc: document directories in test directory #5557

Closed
wants to merge 1 commit into from
Closed
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
117 changes: 117 additions & 0 deletions test/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,117 @@
# Tests

### abort

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

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

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe an explanation of why those tests are not run in CI could be useful?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I agree that would be useful.


### addons

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

| 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 |

### internet

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.

### timers

Tests for [timing utilities](https://nodejs.org/api/timers.html) (`setTimeout`
and `setInterval`).

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