nodejs/test

Table of Contents

• Test directories
• Common module API

Test Directories

abort

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

Runs on CI
No

addons

Tests for addon functionality along with some tests that require an addon to function properly.

Runs on CI
Yes

cctest

C++ test that is run as part of the build process.

Runs on CI
Yes

debugger

Tests for debugger 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

Tests for the V8 inspector integration.

Runs on CI
Yes

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 (setTimeout and setInterval).

Runs on CI
No

Common module API

The common.js module is used by tests for consistency across repeated tasks. It has a number of helpful functions and properties to help with writing tests.

allowGlobals(...whitelist)

• whitelist <Array> Array of Globals
• return <Array>

Takes whitelist and concats that with predefined knownGlobals.

arrayStream

A stream to push an array into a REPL

busyLoop(time)

• time <Number>

Blocks for time amount of time.

ddCommand(filename, kilobytes)

• return <Object>

Platform normalizes the dd command

enoughTestMem

• return <Boolean>

Check if there is more than 1gb of total memory.

expectWarning(name, expected)

• name <String>
• expected <String> | <Array>

Tests whether name and expected are part of a raised warning.

hasCrypto

• return <Boolean>

Checks for 'openssl'.

hasFipsCrypto

• return <Boolean>

Checks hasCrypto and crypto with fips.

hasIPv6

• return <Boolean>

Checks whether IPv6 is supported on this platform.

hasMultiLocalhost

• return <Boolean>

Checks if there are multiple localhosts available.

fail(msg)

• msg <String>
• return <Boolean>

Throws an AssertionError with msg

faketimeCli

• return <String>

Return the path to the fake.

fileExists(pathname)

• pathname <String>
• return <Boolean>

Checks if pathname exists

fixturesDir

• return <String>

Path to the 'fixtures' directory.

globalCheck

• return <Boolean>

Turn this off if the test should not check for global leaks.

inFreeBSDJail

• return <Boolean>

Checks whether free BSD Jail is true or false.

isAix

• return <Boolean>

Platform check for Advanced Interactive eXecutive (AIX).

isAlive(pid)

• pid <Number>
• return <Boolean>

Attempts to 'kill' pid

isFreeBSD

• return <Boolean>

Platform check for Free BSD.

isLinux

• return <Boolean>

Platform check for Linux.

isLinuxPPCBE

• return <Boolean>

Platform check for Linux on PowerPC.

isOSX

• return <Boolean>

Platform check for OS X.

isSunOS

• return <Boolean>

Platform check for SunOS.

isWindows

• return <Boolean>

Platform check for Windows.

isWOW64

• return <Boolean>

Platform check for Windows 32-bit on Windows 64-bit.

leakedGlobals

• return <Array>

Checks whether any globals are not on the knownGlobals list.

libDir

• return <String>

Path to the 'lib' directory.

localhostIPv4

• return <String>

Gets IP of localhost

localIPv6Hosts

• return <Array>

Array of IPV6 hosts.

mustCall(fn[, expected])

• fn <Function>
• expected <Number> default = 1

Number of times fn should be called.

nodeProcessAborted(exitCode, signal)

• exitCode <Number>
• signal <String>
• return <Boolean>

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>

Checks whether 'opensslCli' is supported.

platformTimeout(ms)

• ms <Number>
• return <Number>

Platform normalizes timeout.

PIPE

• return <String>

Path to the test sock.

PORT

• return <Number> default = 12346

Port tests are running on.

refreshTmpDir

• return <String>

Deletes the 'tmp' dir and recreates it

rootDir

• return <String>

Path to the 'root' directory. either / or c:\\ (windows)

skip(msg)

• msg <String>

Logs '1..0 # Skipped: ' + msg

spawnCat(options)

• options <Object>
• return <Object>

Platform normalizes the cat command.

spawnPwd(options)

• options <Object>
• return <Object>

Platform normalizes the pwd command.

spawnSyncCat(options)

• options <Object>
• return <Object>

Synchronous version of spawnCat.

spawnSyncPwd(options)

• options <Object>
• return <Object>

Synchronous version of spawnPwd.

testDir

• return <String>

Path to the 'test' directory.

tmpDir

• return <String>

Path to the 'tmp' directory.

tmpDirName

• return <String>

Name of the temp directory used by tests.