The goog.testing.ContinuationTestCase Class

goog.testing.ContinuationTestCase
> goog.testing.TestCase

goog.testing.ContinuationTestCase(opt_name)

Constructs a test case that supports tests with continuations. Test functions may issue "wait" commands that suspend the test temporarily and continue once the wait condition is met.

opt_name {string=}
Optional name for the test case.

.MAX_TIMEOUT {number}

The default maximum time to wait for a single test step in milliseconds.

The goog.testing.ContinuationTestCase.Step Class

Constructs a single step in a larger continuation test. Each step is similar to a typical TestCase test, except it may wait for an event or timeout to occur before running the test function. … more

The goog.testing.ContinuationTestCase.Test Class

Creates a continuation test case, which consists of multiple test steps that occur in several phases. The steps are distributed between setUp, test, and tearDown phases. During the execution of each step, 0 or more steps may be added to the current phase. Once all steps in a phase have completed, the next phase will be executed. If any errors occur (such as an assertion failure), the setUp and Test phases will be cancelled immediately. The tearDown phase will always start, but may be cancelled as well if it raises an error. … more

.add(test)

Inherited from goog.testing.TestCase .

Adds a new test to the test case.

test {goog.testing.TestCase.Test}
The test to add.

.autoDiscoverTests()

Inherited from goog.testing.TestCase .

Adds any functions defined in the global scope that are prefixed with "test" to the test case. Also overrides setUp, tearDown, setUpPage, tearDownPage and runTests if they are defined.

.cycleTests()

Cycles through the tests, breaking out using a setTimeout if the execution time has execeeded {@link #MAX_RUN_TIME}.

.execute()

Inherited from goog.testing.TestCase .

Executes each of the tests.

.finalize()

Finalizes the test case, called when the tests have finished executing.

.getActuallyRunCount()

Inherited from goog.testing.TestCase .

Returns the number of tests actually run in the test case, i.e. subtracting any which are skipped.

returns {number}
The number of un-ignored tests.

.getCount()

Inherited from goog.testing.TestCase .

Returns the number of tests contained in the test case.

returns {number}
The number of tests.

.getGlobals(opt_prefix)

Inherited from goog.testing.TestCase .

Gets the object with all globals.

opt_prefix {string=}
An optional prefix. If specified, only get things under this prefix.
returns {Object}
An object with all globals starting with the prefix.

.getNumFilesLoaded()

Inherited from goog.testing.TestCase .

Returns the number of script files that were loaded in order to run the test.

returns {number}
The number of script files.

.getReport(opt_verbose)

Inherited from goog.testing.TestCase .

Returns a string detailing the results from the test.

opt_verbose {boolean=}
If true results will include data about all tests, not just what failed.
returns {string}
The results from the test.

.getRunTime()

Inherited from goog.testing.TestCase .

Returns the amount of time it took for the test to run.

returns {number}
The run time, in milliseconds.

.isInsideMultiTestRunner()

Inherited from goog.testing.TestCase .

returns {boolean}
Whether the test case is running inside the multi test runner.

.isSuccess()

Inherited from goog.testing.TestCase .

returns {boolean}
Whether the test was a success.

.log(val)

Inherited from goog.testing.TestCase .

Logs an object to the console, if available.

val {*}
The value to log. Will be ToString'd.

.logError(name, opt_e)

Inherited from goog.testing.TestCase .

name {string}
Failed test name.
opt_e {*=}
The exception object associated with the failure or a string.
returns {goog.testing.TestCase.Error}
Error object.

.next()

Inherited from goog.testing.TestCase .

Returns the current test and increments the pointer.

returns {goog.testing.TestCase.Test?}
The current test case.

.order {string}

Inherited from goog.testing.TestCase .

The order to run the auto-discovered tests in.

.reset()

Inherited from goog.testing.TestCase .

Resets the test case pointer, so that next returns the first test.

.runTests()

Executes each of the tests. Overridable by the individual test case. This allows test cases to defer when the test is actually started. If overridden, finalize must be called by the test to indicate it has finished.

.running {boolean}

Inherited from goog.testing.TestCase .

Whether the test case is running.

.saveMessage(message)

Inherited from goog.testing.TestCase .

Saves a message to the result set.

message {string}
The message to save.

.setCompletedCallback(fn)

Inherited from goog.testing.TestCase .

Sets the callback function that should be executed when the tests have completed.

fn {Function}
The callback function.

.setTestRunner(tr)

Inherited from goog.testing.TestCase .

Sets the test runner that is running this test case.

tr {goog.testing.TestRunner}
The test runner.

.setUp()

Inherited from goog.testing.TestCase .

Gets called before every goog.testing.TestCase.Test is been executed. Can be overridden to add set up functionality to each test.

.setUpPage()

Inherited from goog.testing.TestCase .

Gets called before any tests are executed. Can be overridden to set up the environment for the whole test case.

.shouldRunTests()

Inherited from goog.testing.TestCase .

Can be overridden in test classes to indicate whether the tests in a case should be run in that particular situation. For example, this could be used to stop tests running in a particular browser, where browser support for the class under test was absent.

returns {boolean}
Whether any of the tests in the case should be run.

.started {boolean}

Inherited from goog.testing.TestCase .

Whether the test case has ever tried to execute.

.tearDown()

Inherited from goog.testing.TestCase .

Gets called after every goog.testing.TestCase.Test has been executed. Can be overriden to add tear down functionality to each test.

.tearDownPage()

Inherited from goog.testing.TestCase .

Gets called after all tests have been executed. Can be overridden to tear down the entire test case.

.waitForCondition(condition, continuation, opt_interval, opt_maxTimeout)

Creates a new test step which will run once a condition becomes true. The condition will be polled at a user-specified interval until it becomes true, or until a maximum timeout is reached.

condition {Function}
The condition to poll.
continuation {Function}
The test code to evaluate once the condition becomes true.
opt_interval {number=}
The polling interval in milliseconds.
opt_maxTimeout {number=}
The maximum amount of time to wait for the condition in milliseconds (defaults to 1000).

.waitForEvent(eventTarget, eventType, continuation)

Creates a new test step that will run after an event has fired. If the event does not fire within a reasonable timeout, the test will fail.

eventTarget {goog.events.EventTarget|EventTarget}
The target that will fire the event.
eventType {string}
The type of event to listen for.
continuation {Function}
The test function to invoke after the event fires.

.waitForTimeout(continuation, opt_duration)

Creates a new test step that will run after a user-specified timeout. No guarantee is made on the execution order of the continuation, except for those provided by each browser's window.setTimeout. In particular, if two continuations are registered at the same time with very small delta for their durations, this class can not guarantee that the continuation with the smaller duration will be executed first.

continuation {Function}
The test function to invoke after the timeout.
opt_duration {number=}
The length of the timeout in milliseconds.