lukechilds
/
node
mirror of https://github.com/lukechilds/node.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
15814 Commits
131 Branches
446 Tags
325 MiB
Tree: 7e7062cdca
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from '7e7062cdca'
${ noResults }
node/test/README.md

375 lines
11 KiB
Raw Normal View History

doc: add documentation for test common module Alphabetized list of methods and properties for the common.js module. Add table of contents to the top of the readme. PR-URL: https://github.com/nodejs/node/pull/8840 Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: Santiago Gimeno <santiago.gimeno@gmail.com> Reviewed-By: Franziska Hinkelmann <franziska.hinkelmann@gmail.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
8 years ago
# Table of Contents
* [Test directories](#test-directories)
* [Common module API](#common-module-api)
## Test Directories
doc: document directories in test directory PR-URL: https://github.com/nodejs/node/pull/5557 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Evan Lucas <evanlucas@me.com> Reviewed-By: Rich Trott <rtrott@gmail.com>
9 years ago
### abort
Tests for when the `--abort-on-uncaught-exception` flag is used.
| Runs on CI |
|:----------:|
| No |
### addons
test: fix another flaky stringbytes test Avoid depending on precise timing of when an object will be collected by GC. This test was missed by #6039 as it happened to be in a different directory than the rest. Ref: https://github.com/nodejs/node/pull/6039 PR-URL: https://github.com/nodejs/node/pull/6073 Reviewed-By: Trott - Rich Trott <rtrott@gmail.com>
9 years ago
Tests for [addon](https://nodejs.org/api/addons.html) functionality along with
some tests that require an addon to function properly.
doc: document directories in test directory PR-URL: https://github.com/nodejs/node/pull/5557 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Evan Lucas <evanlucas@me.com> Reviewed-By: Rich Trott <rtrott@gmail.com>
9 years ago
| 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 |
inspector: introduce a smoke test This test executes a simple debug session over the inspector protocol. PR-URL: https://github.com/nodejs/node/pull/8429 Reviewed-By: ofrobots - Ali Ijaz Sheikh <ofrobots@google.com>
8 years ago
### inspector
Tests for the V8 inspector integration.
| Runs on CI |
|:----------:|
| Yes |
doc: document directories in test directory PR-URL: https://github.com/nodejs/node/pull/5557 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Evan Lucas <evanlucas@me.com> Reviewed-By: Rich Trott <rtrott@gmail.com>
9 years ago
### 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.
test: move tick-processor tests to own directory The tick-processor tests are inherently non-deterministic. They therefore have false negatives from time to time. They also sometimes leave extra processes running. Move them to their own directory until these issues are sorted. Note that this means that the tests will not be run in CI. Like the inspector tests and other tests, they will have to be run manually when they are wanted. PR-URL: https://github.com/nodejs/node/pull/9506 Reviewed-By: Daniel Bevenius <daniel.bevenius@gmail.com> Reviewed-By: Matthew Loring <mattloring@google.com> Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com>
8 years ago
### 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 |
doc: document directories in test directory PR-URL: https://github.com/nodejs/node/pull/5557 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Evan Lucas <evanlucas@me.com> Reviewed-By: Rich Trott <rtrott@gmail.com>
9 years ago
### timers
Tests for [timing utilities](https://nodejs.org/api/timers.html) (`setTimeout`
and `setInterval`).
| Runs on CI |
|:----------:|
| No |
doc: add documentation for test common module Alphabetized list of methods and properties for the common.js module. Add table of contents to the top of the readme. PR-URL: https://github.com/nodejs/node/pull/8840 Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: Santiago Gimeno <santiago.gimeno@gmail.com> Reviewed-By: Franziska Hinkelmann <franziska.hinkelmann@gmail.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
8 years ago
## Common module API
The common.js module is used by tests for consistency across repeated
tools: disallow trailing whitespace for markdown markdown had a dispensation because 2 or more trailing spaces triggers a new paragraph. There are no examples of that usage in Node, all trailing whitespace found were mistakes, and the dispensation is now removed. See: https://github.com/nodejs/node/pull/9620 PR-URL: https://github.com/nodejs/node/pull/9676 Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Roman Reiss <me@silverwind.io> Reviewed-By: Michaël Zasso <targos@protonmail.com> Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com>
8 years ago
tasks. It has a number of helpful functions and properties to help with
doc: add documentation for test common module Alphabetized list of methods and properties for the common.js module. Add table of contents to the top of the readme. PR-URL: https://github.com/nodejs/node/pull/8840 Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: Santiago Gimeno <santiago.gimeno@gmail.com> Reviewed-By: Franziska Hinkelmann <franziska.hinkelmann@gmail.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
8 years ago
writing tests.
### allowGlobals(...whitelist)
* `whitelist` [<Array>](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array) Array of Globals
* return [<Array>](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array)
Takes `whitelist` and concats that with predefined `knownGlobals`.
### arrayStream
A stream to push an array into a REPL
### busyLoop(time)
* `time` [<Number>](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type)
Blocks for `time` amount of time.
### ddCommand(filename, kilobytes)
* return [<Object>](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)
Platform normalizes the `dd` command
### enoughTestMem
* return [<Boolean>](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type)
Check if there is more than 1gb of total memory.
### expectWarning(name, expected)
* `name` [<String>](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type)
* `expected` [<String>](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type) | [<Array>](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array)
tools: disallow trailing whitespace for markdown markdown had a dispensation because 2 or more trailing spaces triggers a new paragraph. There are no examples of that usage in Node, all trailing whitespace found were mistakes, and the dispensation is now removed. See: https://github.com/nodejs/node/pull/9620 PR-URL: https://github.com/nodejs/node/pull/9676 Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Roman Reiss <me@silverwind.io> Reviewed-By: Michaël Zasso <targos@protonmail.com> Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com>
8 years ago
Tests whether `name` and `expected` are part of a raised warning.
doc: add documentation for test common module Alphabetized list of methods and properties for the common.js module. Add table of contents to the top of the readme. PR-URL: https://github.com/nodejs/node/pull/8840 Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: Santiago Gimeno <santiago.gimeno@gmail.com> Reviewed-By: Franziska Hinkelmann <franziska.hinkelmann@gmail.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
8 years ago
### hasCrypto
* return [<Boolean>](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type)
Checks for 'openssl'.
### hasFipsCrypto
* return [<Boolean>](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type)
Checks `hasCrypto` and `crypto` with fips.
### hasIPv6
* return [<Boolean>](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type)
Checks whether `IPv6` is supported on this platform.
### hasMultiLocalhost
* return [<Boolean>](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type)
Checks if there are multiple localhosts available.
### fail(msg)
* `msg` [<String>](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type)
* return [<Boolean>](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type)
Throws an `AssertionError` with `msg`
### fileExists(pathname)
* pathname [<String>](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type)
* return [<Boolean>](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type)
Checks if `pathname` exists
### fixturesDir
* return [<String>](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type)
Path to the 'fixtures' directory.
### globalCheck
* return [<Boolean>](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type)
Turn this off if the test should not check for global leaks.
### inFreeBSDJail
* return [<Boolean>](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type)
Checks whether free BSD Jail is true or false.
### isAix
* return [<Boolean>](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type)
Platform check for Advanced Interactive eXecutive (AIX).
### isAlive(pid)
* `pid` [<Number>](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type)
* return [<Boolean>](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type)
Attempts to 'kill' `pid`
### isFreeBSD
* return [<Boolean>](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type)
Platform check for Free BSD.
### isLinux
* return [<Boolean>](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type)
Platform check for Linux.
### isLinuxPPCBE
* return [<Boolean>](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type)
Platform check for Linux on PowerPC.
### isOSX
* return [<Boolean>](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type)
Platform check for OS X.
### isSunOS
* return [<Boolean>](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type)
Platform check for SunOS.
### isWindows
* return [<Boolean>](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type)
Platform check for Windows.
### isWOW64
* return [<Boolean>](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type)
Platform check for Windows 32-bit on Windows 64-bit.
### leakedGlobals
* return [<Array>](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array)
Checks whether any globals are not on the `knownGlobals` list.
### localhostIPv4
* return [<String>](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type)
Gets IP of localhost
### localIPv6Hosts
* return [<Array>](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array)
Array of IPV6 hosts.
### mustCall(fn[, expected])
* fn [<Function>](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Function)
* expected [<Number>](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type) default = 1
doc: improve common.mustCall() explanation PR-URL: https://github.com/nodejs/node/pull/10390 Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Julian Duque <julianduquej@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Italo A. Casas <me@italoacasas.com> Reviewed-By: James M Snell <jasnell@gmail.com>
8 years ago
* return [<Function>](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Function)
doc: add documentation for test common module Alphabetized list of methods and properties for the common.js module. Add table of contents to the top of the readme. PR-URL: https://github.com/nodejs/node/pull/8840 Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: Santiago Gimeno <santiago.gimeno@gmail.com> Reviewed-By: Franziska Hinkelmann <franziska.hinkelmann@gmail.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
8 years ago
doc: improve common.mustCall() explanation PR-URL: https://github.com/nodejs/node/pull/10390 Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Julian Duque <julianduquej@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Italo A. Casas <me@italoacasas.com> Reviewed-By: James M Snell <jasnell@gmail.com>
8 years ago
Returns a function that calls `fn`. If the returned function has not been called
exactly `expected` number of times when the test is complete, then the test will
fail.
doc: add documentation for test common module Alphabetized list of methods and properties for the common.js module. Add table of contents to the top of the readme. PR-URL: https://github.com/nodejs/node/pull/8840 Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: Santiago Gimeno <santiago.gimeno@gmail.com> Reviewed-By: Franziska Hinkelmann <franziska.hinkelmann@gmail.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
8 years ago
### nodeProcessAborted(exitCode, signal)
* `exitCode` [<Number>](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type)
* `signal` [<String>](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type)
* return [<Boolean>](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type)
Returns `true` if the exit code `exitCode` and/or signal name `signal` represent the exit code and/or signal name of a node process that aborted, `false` otherwise.
### opensslCli
* return [<Boolean>](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type)
Checks whether 'opensslCli' is supported.
### platformTimeout(ms)
* `ms` [<Number>](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type)
* return [<Number>](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type)
Platform normalizes timeout.
### PIPE
* return [<String>](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type)
Path to the test sock.
### PORT
* return [<Number>](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type) default = `12346`
Port tests are running on.
### refreshTmpDir
* return [<String>](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type)
Deletes the 'tmp' dir and recreates it
### rootDir
* return [<String>](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type)
Path to the 'root' directory. either `/` or `c:\\` (windows)
### skip(msg)
* `msg` [<String>](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type)
Logs '1..0 # Skipped: ' + `msg`
### spawnCat(options)
* `options` [<Object>](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)
* return [<Object>](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)
Platform normalizes the `cat` command.
### spawnPwd(options)
* `options` [<Object>](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)
* return [<Object>](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)
Platform normalizes the `pwd` command.
### spawnSyncCat(options)
* `options` [<Object>](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)
* return [<Object>](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)
Synchronous version of `spawnCat`.
### spawnSyncPwd(options)
* `options` [<Object>](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)
* return [<Object>](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)
Synchronous version of `spawnPwd`.
### tmpDir
* return [<String>](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type)
Path to the 'tmp' directory.
### tmpDirName
* return [<String>](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type)
Name of the temp directory used by tests.