README.md
1# Node.js Core Tests
2
3This directory contains code and data used to test the Node.js implementation.
4
5For a detailed guide on how to write tests in this
6directory, see [the guide on writing tests](../doc/contributing/writing-tests.md).
7
8On how to run tests in this directory, see
9[the contributing guide](../doc/contributing/pull-requests.md#step-6-test).
10
11For the tests to run on Windows, be sure to clone Node.js source code with the
12`autocrlf` git config flag set to true.
13
14## Test Directories
15
16| Directory | Runs on CI | Purpose |
17| ---------------- | ---------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
18| `abort` | Yes | Tests that use `--abort-on-uncaught-exception` and other situations where we want to test something but avoid generating a core file. |
19| `addons` | Yes | Tests for [addon](https://nodejs.org/api/addons.html) functionality along with some tests that require an addon. |
20| `async-hooks` | Yes | Tests for [async\_hooks](https://nodejs.org/api/async_hooks.html) functionality. |
21| `benchmark` | Yes | Test minimal functionality of benchmarks. |
22| `cctest` | Yes | C++ tests that are run as part of the build process. |
23| `code-cache` | No | Tests for a Node.js binary compiled with V8 code cache. |
24| `common` | | Common modules shared among many tests. [Documentation](./common/README.md) |
25| `doctool` | Yes | Tests for the documentation generator. |
26| `es-module` | Yes | Test ESM module loading. |
27| `fixtures` | | Test fixtures used in various tests throughout the test suite. |
28| `internet` | No | Tests that make real outbound network connections. Tests for networking related modules may also be present in other directories, but those tests do not make outbound connections. |
29| `js-native-api` | Yes | Tests for Node.js-agnostic [Node-API](https://nodejs.org/api/n-api.html) functionality. |
30| `known_issues` | Yes | Tests reproducing known issues within the system. All tests inside of this directory are expected to fail. If a test doesn't fail on certain platforms, those should be skipped via `known_issues.status`. |
31| `message` | Yes | Tests for messages that are output for various conditions (`console.log`, error messages etc.) |
32| `node-api` | Yes | Tests for Node.js-specific [Node-API](https://nodejs.org/api/n-api.html) functionality. |
33| `parallel` | Yes | Various tests that are able to be run in parallel. |
34| `pseudo-tty` | Yes | Tests that require stdin/stdout/stderr to be a TTY. |
35| `pummel` | No | Various tests for various modules / system functionality operating under load. |
36| `sequential` | Yes | Various tests that must not run in parallel. |
37| `testpy` | | Test configuration utility used by various test suites. |
38| `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. |
39| `v8-updates` | No | Tests for V8 performance integration. |
40