AlloyUI - API Docs

  • API Docs for Version: 3.1.0-deprecated.60

    • Show:

    Test.Runner Class

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

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

    Index

    Methods

    Properties

    Events

    Methods

    _addTestCaseToTestTree

    (
    • parentNode
    • testCase
    )
    private static

    Defined in yui3/src/test/js/TestRunner.js:314

    Adds a test case to the test tree as a child of the specified node.

    Parameters:

    • parentNode TestNode

      The node to add the test case to as a child.

    • testCase Test.TestCase

      The test case to add.

    _addTestSuiteToTestTree

    (
    • parentNode
    • testSuite
    )
    private static

    Defined in yui3/src/test/js/TestRunner.js:338

    Adds a test suite to the test tree as a child of the specified node.

    Parameters:

    • parentNode TestNode

      The node to add the test suite to as a child.

    • testSuite Test.TestSuite

      The test suite to add.

    _buildTestTree

    () private static

    Defined in yui3/src/test/js/TestRunner.js:361

    Builds the test tree based on items in the master suite. The tree is a hierarchical representation of the test suites, test cases, and test functions. The resulting tree is stored in _root and the pointer _cur is set to the root initially.

    _execNonTestMethod

    (
    • node
    • methodName
    • allowAsync
    )
    Boolean private

    Defined in yui3/src/test/js/TestRunner.js:462

    Executes a non-test method (init, setUp, tearDown, destroy) and traps an errors. If an error occurs, an error event is fired.

    Parameters:

    • node Object

      The test node in the testing tree.

    • methodName String

      The name of the method to execute.

    • allowAsync Boolean

      Determines if the method can be called asynchronously.

    Returns:

    Boolean:

    True if an async method was called, false if not.

    _handleError

    (
    • error
    )
    private static

    Defined in yui3/src/test/js/TestRunner.js:734

    Handles an error as if it occurred within the currently executing test. This is for mock methods that may be called asynchronously and therefore out of the scope of the TestRunner. Previously, this error would bubble up to the browser. Now, this method is used to tell TestRunner about the error. This should never be called by anyplace other than the Mock object.

    Parameters:

    • error Error

      The error object.

    _handleTestObjectComplete

    (
    • node
    )
    private

    Defined in yui3/src/test/js/TestRunner.js:389

    Handles the completion of a test object's tests. Tallies test results from one level up to the next.

    Parameters:

    • node TestNode

      The TestNode representing the test object.

    _next

    () TestNode private static

    Defined in yui3/src/test/js/TestRunner.js:423

    Retrieves the next node in the test tree.

    Returns:

    TestNode:

    The next node in the test tree or null if the end is reached.

    _run

    (
    • testObject
    )
    Object private static

    Defined in yui3/src/test/js/TestRunner.js:499

    Runs a test case or test suite, returning the results.

    Parameters:

    • testObject Test.TestCase | YUITest.TestSuite

      The test case or test suite to run.

    Returns:

    Object:

    Results of the execution with properties passed, failed, and total.

    _runTest

    (
    • node
    )
    private static

    Defined in yui3/src/test/js/TestRunner.js:758

    Runs a single test based on the data provided in the node.

    Parameters:

    • node TestNode

      The TestNode representing the test to run.

    add

    (
    • testObject
    )
    static

    Defined in yui3/src/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.

    callback

    () Function private

    Defined in yui3/src/test/js/TestRunner.js:933

    Used to continue processing when a method marked with "async:" is executed. This should not be used in test methods, only in init(). Each argument is a string, and when the returned function is executed, the arguments are assigned to the context data object using the string as the key name (value is the argument itself).

    Returns:

    Function:

    A callback function.

    clear

    () static

    Defined in yui3/src/test/js/TestRunner.js:854

    Removes all test objects from the runner.

    getCoverage

    (
    • format
    )
    Object | String

    Defined in yui3/src/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 yui3/src/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 yui3/src/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 yui3/src/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 yui3/src/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 yui3/src/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 yui3/src/test/js/TestRunner.js:972

    Runs the test suite.

    Parameters:

    • options Object | Boolean

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

    setName

    (
    • name
    )

    Defined in yui3/src/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

    _cur

    TestNode private static

    Defined in yui3/src/test/js/TestRunner.js:141

    Pointer to the current node in the test tree.

    _data

    Object private static

    Defined in yui3/src/test/js/TestRunner.js:197

    Data object that is passed around from method to method.

    _groups

    String private static

    Defined in yui3/src/test/js/TestRunner.js:206

    The list of test groups to run. The list is represented by a comma delimited string with commas at the start and end.

    _ignoreEmpty

    Boolean private static

    Defined in yui3/src/test/js/TestRunner.js:221

    If true, YUITest will not fire an error for tests with no Asserts.

    _lastResults

    Object private static

    Defined in yui3/src/test/js/TestRunner.js:187

    Holds copy of the results object generated when all tests are complete.

    _log

    Boolean private static

    Defined in yui3/src/test/js/TestRunner.js:159

    Indicates if the TestRunner will log events or not.

    _root

    TestNode private static

    Defined in yui3/src/test/js/TestRunner.js:150

    Pointer to the root node in the test tree.

    _running

    Boolean private static

    Defined in yui3/src/test/js/TestRunner.js:178

    Indicates if the TestRunner is currently running tests.

    _waiting

    Boolean private static

    Defined in yui3/src/test/js/TestRunner.js:168

    Indicates if the TestRunner is waiting as a result of wait() being called.

    masterSuite

    YUITest.TestSuite private static

    Defined in yui3/src/test/js/TestRunner.js:132

    Suite on which to attach all TestSuites and TestCases to be run.

    Events

    begin

    static

    Defined in yui3/src/test/js/TestRunner.js:303

    Fires when the run() method is called.

    complete

    static

    Defined in yui3/src/test/js/TestRunner.js:296

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

    error

    static

    Defined in yui3/src/test/js/TestRunner.js:282

    Fires when a non-test method has an error.

    fail

    static

    Defined in yui3/src/test/js/TestRunner.js:275

    Fires when a test has failed.

    ignore

    static

    Defined in yui3/src/test/js/TestRunner.js:289

    Fires when a test has been ignored.

    pass

    static

    Defined in yui3/src/test/js/TestRunner.js:268

    Fires when a test has passed.

    testcasebegin

    static

    Defined in yui3/src/test/js/TestRunner.js:237

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

    testcasecomplete

    static

    Defined in yui3/src/test/js/TestRunner.js:245

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

    testsuitebegin

    static

    Defined in yui3/src/test/js/TestRunner.js:252

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

    testsuitecomplete

    static

    Defined in yui3/src/test/js/TestRunner.js:260

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