README.md

Node.js Core Tests

This folder 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 direcotry, see the contributing guide.

Table of Contents

• Test directories
• Common module API

Test Directories

Directory	Runs on CI	Purpose
abort	No	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.
debugger	No	Tests for debugger functionality along with some tests that require an addon to function properly.
disabled	No	Tests that have been disabled from running for various reasons.
fixtures		Test fixtures used in various tests throughout the test suite.
gc	No	Tests for garbage collection related functionality.
inspector	Yes	Tests for the V8 inspector integration.
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	No	Tests reproducing known issues within the system.
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).

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.

canCreateSymLink

API to indicate whether the current running process can create symlinks. On Windows, this returns false if the process running doesn't have privileges to create symlinks (specifically SeCreateSymbolicLinkPrivilege). On non-Windows platforms, this currently returns true.

ddCommand(filename, kilobytes)

• return <Object>

Platform normalizes the dd command

enoughTestMem

• return <Boolean>

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

expectsError(settings)

• settings <Object> with the following optional properties:

  • code <String> expected error must have this value for its code property
  • type <Function> expected error must be an instance of type
  • message <String> or <RegExp> if a string is provided for message, expected error must have it for its message property; if a regular expression is provided for message, the regular expression must match the message property of the expected error

• return function suitable for use as a validation function passed as the second argument to assert.throws()

The expected error should be subclassed by the internal/errors module.

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

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 macOS.

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.

localhostIPv4

• return <String>

Gets IP of localhost

localIPv6Hosts

• return <Array>

Array of IPV6 hosts.

mustCall([fn][, expected])

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

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.

If fn is not provided, common.noop will be used.

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.

noop

A non-op Function that can be used for a variety of scenarios.

For instance,

const common = require('../common');

someAsyncAPI('foo', common.mustCall(common.noop));

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

spawnPwd(options)

• options <Object>
• return <Object>

Platform normalizes the pwd command.

spawnSyncPwd(options)

• options <Object>
• return <Object>

Synchronous version of spawnPwd.

tmpDir

• return <String>

The realpath of the 'tmp' directory.

tmpDirName

• return <String>

Name of the temp directory used by tests.

WPT

A port of parts of W3C testharness.js for testing the Node.js WHATWG URL API implementation with tests from W3C Web Platform Tests.