API Docs for: 3.18.1

Test.Runner Class

Defined in: test/js/TestRunner.js:119
Module: test

Runs test suites and test cases, providing events to allowing for the interpretation of test results.

Item Index

Methods

Properties

Events

Methods

add

(
  • testObject
)
static

Defined in test/js/TestRunner.js:843

Adds a test suite or test case to the list of test objects to run.

Parameters:

  • testObject Object

    Either a TestCase or a TestSuite that should be run.

clear

() static

Defined in test/js/TestRunner.js:854

Removes all test objects from the runner.

getCoverage

(
  • format
)
Object | String

Defined in test/js/TestRunner.js:904

Returns the coverage report for the files that have been executed. This returns only coverage information for files that have been instrumented using YUI Test Coverage and only those that were run in the same pass.

Parameters:

  • format Function

    (Optional) A coverage format to return results in.

Returns:

Object | String:

Either the coverage object or, if a coverage format is specified, a string representing the results in that format.

getName

() String

Defined in test/js/TestRunner.js:820

Retrieves the name of the current result set.

Returns:

String:

The name of the result set.

getResults

(
  • format
)
Object | String

Defined in test/js/TestRunner.js:883

Returns the last complete results set from the TestRunner. Null is returned if the TestRunner is running or no tests have been run.

Parameters:

  • format Function

    (Optional) A test format to return the results in.

Returns:

Object | String:

Either the results object or, if a test format is passed as the argument, a string representing the results in a specific format.

isRunning

() Boolean

Defined in test/js/TestRunner.js:873

Indicates that the TestRunner is busy running tests and therefore can't be stopped and results cannot be gathered.

Returns:

Boolean:

True if the TestRunner is running, false if not.

isWaiting

() Boolean static

Defined in test/js/TestRunner.js:863

Indicates if the TestRunner is waiting for a test to resume

Returns:

Boolean:

True if the TestRunner is waiting, false if not.

resume

(
  • segment
)
static

Defined in test/js/TestRunner.js:957

Resumes the TestRunner after wait() was called.

Parameters:

  • segment Function

    The function to run as the rest of the haulted test.

run

(
  • options
)
static

Defined in test/js/TestRunner.js:972

Runs the test suite.

Parameters:

  • options Object | Boolean

    (Optional) Options for the runner: oldMode indicates the TestRunner should work in the YUI <= 2.8 way of internally managing test suites. groups is an array of test groups indicating which tests to run.

setName

(
  • name
)

Defined in test/js/TestRunner.js:829

The name assigned to the master suite of the TestRunner. This is the name that is output as the root's name when results are retrieved.

Parameters:

  • name String

    The name of the result set.

Properties

Events

begin

static

Defined in test/js/TestRunner.js:303

Fires when the run() method is called.

complete

static

Defined in test/js/TestRunner.js:296

Fires when all test suites and test cases have been completed.

error

static

Defined in test/js/TestRunner.js:282

Fires when a non-test method has an error.

fail

static

Defined in test/js/TestRunner.js:275

Fires when a test has failed.

ignore

static

Defined in test/js/TestRunner.js:289

Fires when a test has been ignored.

pass

static

Defined in test/js/TestRunner.js:268

Fires when a test has passed.

testcasebegin

static

Defined in test/js/TestRunner.js:237

Fires when a test case is opened but before the first test is executed.

testcasecomplete

static

Defined in test/js/TestRunner.js:245

Fires when all tests in a test case have been executed.

testsuitebegin

static

Defined in test/js/TestRunner.js:252

Fires when a test suite is opened but before the first test is executed.

testsuitecomplete

static

Defined in test/js/TestRunner.js:260

Fires when all test cases in a test suite have been completed.