Runner

Runner

new Runner(suite, optsopt)

Source:

Initialize a Runner at the Root Suite, which represents a hierarchy of Suites and Tests.

Parameters:
Name Type Attributes Description
suite Suite

Root suite
opts Object | boolean <optional>

Options. If boolean, whether or not to delay execution of root suite until ready (for backwards compatibility).

Properties
Name Type Attributes Description
delay boolean <optional>

Whether to delay execution of root suite until ready.
cleanReferencesAfterRun boolean <optional>

Whether to clean references to test fns and hooks when a suite is done.

Extends

Members

(static, readonly) constants :string

Source:
Properties:
Name Type Description
EVENT_HOOK_BEGIN string

Emitted when Hook execution begins
EVENT_HOOK_END string

Emitted when Hook execution ends
EVENT_RUN_BEGIN string

Emitted when Root Suite execution begins (all files have been parsed and hooks/tests are ready for execution)
EVENT_DELAY_BEGIN string

Emitted when Root Suite execution has been delayed via delay option
EVENT_DELAY_END string

Emitted when delayed Root Suite execution is triggered by user via global.run()
EVENT_RUN_END string

Emitted when Root Suite execution ends
EVENT_SUITE_BEGIN string

Emitted when Suite execution begins
EVENT_SUITE_END string

Emitted when Suite execution ends
EVENT_TEST_BEGIN string

Emitted when Test execution begins
EVENT_TEST_END string

Emitted when Test execution ends
EVENT_TEST_FAIL string

Emitted when Test execution fails
EVENT_TEST_PASS string

Emitted when Test execution succeeds
EVENT_TEST_PENDING string

Emitted when Test becomes pending
EVENT_TEST_RETRY string

Emitted when Test execution has failed, but will retry
STATE_IDLE string

Initial state of Runner
STATE_RUNNING string

State set to this value when the Runner has started running
STATE_STOPPED string

State set to this value when the Runner has stopped

Runner-related constants.

Type:
  • string

_eventListeners :Map:.<EventEmitter:, Map:.<string:, Set:.<EventListener:>>>

Source:
Type:
  • Map:.<EventEmitter:, Map:.<string:, Set:.<EventListener:>>>

Methods

abort() → {Runner}

Source:

Cleanly abort execution.

Returns:

Runner instance.

Type
Runner

dispose()

Source:

Removes all event handlers set during a run on this instance.
Remark: this does not clean/dispose the tests or suites themselves.

globals(arr) → {Runner}

Source:

Allow the given arr of globals.

Parameters:
Name Type Description
arr Array
Returns:

Runner instance.

Type
Runner

grep(re, invert) → {Runner}

Source:

Run tests with full titles matching re. Updates runner.total
with number of tests matched.

Parameters:
Name Type Description
re RegExp
invert boolean
Returns:

Runner instance.

Type
Runner

grepTotal(suite) → {number}

Source:

Returns the number of tests matching the grep search for the
given suite.

Parameters:
Name Type Description
suite Suite
Returns:
Type
number

run(fn, optsopt) → {Runner}

Source:

Run the root suite and invoke fn(failures)
on completion.

Parameters:
Name Type Attributes Description
fn function

Callback when finished
opts Object <optional>

For subclasses
Returns:

Runner instance.

Type
Runner

runAsync(optsopt) → {Promise:.<number:>}

Source:

Like Runner#run, but does not accept a callback and returns a Promise instead of a Runner.
This function cannot reject; an unhandledRejection event will bubble up to the process object instead.

Parameters:
Name Type Attributes Description
opts Object <optional>

Options for Runner#run
Returns:

Failure count

Type
Promise:.<number:>