new Runner(suite, optsopt)
Parameters:
Name | Type | Attributes | Description | ||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
suite |
Suite | Root suite |
|||||||||||||||||||||
opts |
Object |
<optional> |
Settings object Properties
|
Extends
Members
(static, readonly) constants :string
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 |
EVENT_DELAY_END |
string | Emitted when delayed Root Suite execution is triggered by user via |
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:>>>
Type:
- Map:.<EventEmitter:, Map:.<string:, Set:.<EventListener:>>>
Methods
abort() → {Runner}
Cleanly abort execution.
Returns:
Runner instance.
- Type
- Runner
dispose()
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}
Allow the given arr
of globals.
Parameters:
Name | Type | Description |
---|---|---|
arr |
Array |
Returns:
Runner instance.
- Type
- Runner
grep(re, invert) → {Runner}
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}
Returns the number of tests matching the grep search for the
given suite.
Parameters:
Name | Type | Description |
---|---|---|
suite |
Suite |
Returns:
- Type
- number
isParallelMode() → {false}
Returns true
if Mocha is running in parallel mode. For reporters.
Subclasses should return an appropriate value.
Returns:
- Type
- false
(abstract) linkPartialObjects(valueopt) → {Runner}
Toggle partial object linking behavior; used for building object references from
unique ID's. Does nothing in serial mode, because the object references already exist.
Subclasses can implement this (e.g., ParallelBufferedRunner
)
Example
// this reporter needs proper object references when run in parallel mode
class MyReporter() {
constructor(runner) {
this.runner.linkPartialObjects(true)
.on(EVENT_SUITE_BEGIN, suite => {
// this Suite may be the same object...
})
.on(EVENT_TEST_BEGIN, test => {
// ...as the `test.parent` property
});
}
}
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
value |
boolean |
<optional> |
If |
Returns:
- Type
- Runner
run(fn, optsopt) → {Runner}
Run the root suite and invoke fn(failures)
on completion.
Parameters:
Returns:
Runner instance.
- Type
- Runner
(abstract) workerReporter(path) → {Runner}
Configures an alternate reporter for worker processes to use. Subclasses
using worker processes should implement this.
Parameters:
Name | Type | Description |
---|---|---|
path |
string | Absolute path to alternate reporter for worker processes to use |
Throws:
When in serial mode
Returns:
- Type
- Runner