From 98a1bb6989150961b6838232396ed5ac5617c5b9 Mon Sep 17 00:00:00 2001 From: Michael Barrett Date: Thu, 3 Mar 2016 23:01:01 +0000 Subject: [PATCH] doc: document directories in test directory PR-URL: https://github.com/nodejs/node/pull/5557 Reviewed-By: James M Snell Reviewed-By: Evan Lucas Reviewed-By: Rich Trott --- test/README.md | 117 +++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 117 insertions(+) create mode 100644 test/README.md diff --git a/test/README.md b/test/README.md new file mode 100644 index 00000000000000..a40e800fef5921 --- /dev/null +++ b/test/README.md @@ -0,0 +1,117 @@ +# Tests + +### 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. + +| 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 |