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.
 
 
 
 
 
 

15 KiB

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

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

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)

Takes whitelist and concats that with predefined knownGlobals.

arrayStream

A stream to push an array into a REPL

busyLoop(time)

Blocks for time amount of time.

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)

Platform normalizes the dd command

enoughTestMem

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)

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

getArrayBufferViews(buf)

Returns an instance of all possible ArrayBufferViews of the provided Buffer.

hasCrypto

Checks for 'openssl'.

hasFipsCrypto

Checks hasCrypto and crypto with fips.

hasIPv6

Checks whether IPv6 is supported on this platform.

hasMultiLocalhost

Checks if there are multiple localhosts available.

fileExists(pathname)

Checks if pathname exists

fixturesDir

Path to the 'fixtures' directory.

globalCheck

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

inFreeBSDJail

Checks whether free BSD Jail is true or false.

isAix

Platform check for Advanced Interactive eXecutive (AIX).

isAlive(pid)

Attempts to 'kill' pid

isFreeBSD

Platform check for Free BSD.

isLinux

Platform check for Linux.

isLinuxPPCBE

Platform check for Linux on PowerPC.

isOSX

Platform check for macOS.

isSunOS

Platform check for SunOS.

isWindows

Platform check for Windows.

isWOW64

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

leakedGlobals

Checks whether any globals are not on the knownGlobals list.

localhostIPv4

Gets IP of localhost

localIPv6Hosts

Array of IPV6 hosts.

mustCall([fn][, expected])

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)

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

Checks whether 'opensslCli' is supported.

platformTimeout(ms)

Platform normalizes timeout.

PIPE

Path to the test sock.

PORT

Port tests are running on.

refreshTmpDir

Deletes the 'tmp' dir and recreates it

rootDir

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

skip(msg)

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

spawnPwd(options)

Platform normalizes the pwd command.

spawnSyncPwd(options)

Synchronous version of spawnPwd.

tmpDir

The realpath of the 'tmp' directory.

tmpDirName

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.