mirror of
https://github.com/nodejs/node.git
synced 2024-12-01 16:10:02 +01:00
0c743b5f77
Notes: 1) Removed a number of root properties that did not seem relevant: source, desc, and introduced_in. There no longer is a source, and the other two are from the first include and do not reflect the entire API. 2) As with https://github.com/nodejs/node/issues/20100, the current "desc" properties sometimes contained in-page links, other times referenced another page, and often did not match the links in the original HTML or JSON file. I chose to standardize on external links as "desc" values are isolated snippets as opposed to all.html which can be viewed as a standalone and self contained document. 3) Eliminated preprocessing for @include entirely, including the test case for this function. 4) _toc.md was renamed to index.md. 5) index comments no longer appear in embedded TOCs (left hand side column in the generated documentation. PR-URL: https://github.com/nodejs/node/pull/21637 Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com> Reviewed-By: Rich Trott <rtrott@gmail.com> |
||
---|---|---|
.. | ||
abort | ||
addons | ||
addons-napi | ||
async-hooks | ||
cctest | ||
code-cache | ||
common | ||
doctool | ||
es-module | ||
fixtures | ||
gc | ||
internet | ||
known_issues | ||
message | ||
parallel | ||
pseudo-tty | ||
pummel | ||
sequential | ||
testpy | ||
tick-processor | ||
v8-updates | ||
.eslintrc.yaml | ||
README.md |
Node.js Core Tests
This directory contains code and data used to test the Node.js implementation.
For a detailed guide on how to write tests in this directory, see the guide on writing tests.
On how to run tests in this directory, see the contributing guide.
For the tests to successfully run on Windows, Node.js has to be checked out from
GitHub with the autocrlf
git config flag set to true.
Test Directories
Directory | Runs on CI | Purpose |
---|---|---|
abort | Yes | Tests for when the --abort-on-uncaught-exception flag is used. |
addons | Yes | Tests for addon functionality along with some tests that require an addon to function properly. |
cctest | Yes | C++ test that is run as part of the build process. |
common | Common modules shared among many tests. Documentation | |
es-module | Yes | Test ESM module loading. |
fixtures | Test fixtures used in various tests throughout the test suite. | |
gc | No | Tests for garbage collection related functionality. |
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. |
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 . |
message | Yes | Tests for messages that are output for various conditions (console.log , error messages etc.) |
parallel | Yes | Various tests that are able to be run in parallel. |
pseudo-tty | Yes | Tests that require stdin/stdout/stderr to be a TTY. |
pummel | No | Various tests for various modules / system functionality operating under load. |
sequential | Yes | Various tests that are run sequentially. |
testpy | Test configuration utility used by various test suites. | |
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. |
timers | No | Tests for timing utilities (setTimeout and setInterval ). |
When a new test directory is added, make sure to update the CI_JS_SUITES
variable in the Makefile
and the js_test_suites
variable in
vcbuild.bat
.