The goog.testing.DeferredTestCase Class

`.activeTest` [protected] {`goog.testing.TestCase.Test`|`undefined`}

Inherited from goog.testing.AsyncTestCase .

The currently active test.

.add(test)

.addWaitForAsync(msg, d)

Adds a callback to update the wait message of this async test case. Using this method generously also helps to document the test flow.

.autoDiscoverTests()

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.

`.clearTimeout(id)` [protected]

Inherited from goog.testing.TestCase .

Clears a timeout created by {@code this.timeout()}.

id {number}: A timeout id.

.continueTesting()

.createAndInstall(opt_name)

Preferred way of creating a DeferredTestCase. Creates one and initializes it with the G_testRunner.

`.createTestFromAutoDiscoveredFunction(name, ref)` [protected]

Inherited from goog.testing.TestCase .

Creates a {@code goog.testing.TestCase.Test} from an auto-discovered function.

name {string}: The name of the function.
ref {function() : void}: The auto-discovered function.
returns {goog.testing.TestCase.Test}: The newly created test.

.cycleTests()

.doAsyncError(opt_e)

`.doError(test, opt_e)` [protected]

Inherited from goog.testing.TestCase .

Handles a test that failed.

test {goog.testing.TestCase.Test}: The test that failed.
opt_e {*=}: The exception object associated with the failure or a string.

`.doSuccess(test)` [protected]

Inherited from goog.testing.TestCase .

Handles a test that passed.

test {goog.testing.TestCase.Test}: The test that passed.

.enableDebugLogging()

`.exceptionBeforeTest` [protected] {*}

Inherited from goog.testing.TestCase .

Exception object that was detected before a test runs.

.execute()

.finalize()

.getActuallyRunCount()

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

`.getAutoDiscoveryPrefix()` [protected]

Inherited from goog.testing.TestCase .

returns {string}: The function name prefix used to auto-discover tests.

`.getBatchTime()` [protected]

Inherited from goog.testing.TestCase .

returns {number}: Time since the last batch of tests was started.

.getCount()

`.getCurrentStepName()` [protected]

Inherited from goog.testing.AsyncTestCase .

The current step name.

returns {!string}: Step name.

.getGlobals(opt_prefix)

.getNumFilesLoaded()

.getReport(opt_verbose)

.getRunTime()

`.getTests()` [protected]

Inherited from goog.testing.TestCase .

Gets the tests.

returns {Array.<goog.testing.TestCase.Test>}: The test array.

.isInsideMultiTestRunner()

.isSuccess()

.log(val)

.logError(name, opt_e)

`.maybeFailTestEarly(testCase)` [protected]

Inherited from goog.testing.TestCase .

Checks to see if the test should be marked as failed before it is run. If there was an error in setUpPage, we treat that as a failure for all tests and mark them all as having failed.

testCase {goog.testing.TestCase.Test}: The current test case.
returns {boolean}: Whether the test was marked as failed.

.next()

`.now()` [protected]

Inherited from goog.testing.TestCase .

returns {number}: The current time in milliseconds, don't use goog.now as some tests override it.

`.onError(err)` [protected]

Handler for when the test produces an error.

err {Error|string}: The error object.
@throws: Always throws a ControlBreakingException.

`.onSuccess()` [protected]

Handler for when the test succeeds.

.order {string}

.reset()

.runTests()

Sets up the test page and then waits until the test case has been marked as ready before executing the tests.

.running {boolean}

.saveMessage(message)

`.setBatchTime(batchTime)` [protected]

Inherited from goog.testing.TestCase .

batchTime {number}: Time since the last batch of tests was started.

.setCompletedCallback(fn)

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

.setTestRunner(tr)

`.setTests(tests)` [protected]

Inherited from goog.testing.TestCase .

Sets the tests.

tests {Array.<goog.testing.TestCase.Test>}: A new test array.

.setUp()

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

.setUpPage()

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

.shouldRunTests()

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.

.started {boolean}

.stepTimeout {number}

How long to wait for a single step of a test to complete in milliseconds. A step starts when a call to waitForAsync() is made.

.tearDown()

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

.tearDownPage()

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

.timeToSleepAfterFailure {number}

How long to wait after a failed test before moving onto the next one. The purpose of this is to allow any pending async callbacks from the failing test to finish up and not cause the next test to fail.

`.timeout(fn, time)` [protected]

Inherited from goog.testing.TestCase .

Calls a function after a delay, using the protected timeout.

fn {Function}: The function to call.
time {number}: Delay in milliseconds.
returns {number}: The timeout id.

.waitForAsync(opt_name)

Informs the testcase not to continue to the next step in the test cycle until continueTesting is called.

.waitForDeferred(a, opt_b)

Wires up given Deferred object to the test case, then starts the goog.async.Deferred object's callback.

The goog.testing.DeferredTestCase Class

goog.testing.DeferredTestCase(opt_name)

.activeTest [protected] {goog.testing.TestCase.Test|undefined}

.add(test)

.addWaitForAsync(msg, d)

.autoDiscoverTests()

.clearTimeout(id) [protected]

.continueTesting()

.createAndInstall(opt_name)

.createTestFromAutoDiscoveredFunction(name, ref) [protected]

.cycleTests()

.doAsyncError(opt_e)

.doError(test, opt_e) [protected]

.doSuccess(test) [protected]

.enableDebugLogging()

.exceptionBeforeTest [protected] {*}

.execute()

.finalize()

.getActuallyRunCount()

.getAutoDiscoveryPrefix() [protected]

.getBatchTime() [protected]

.getCount()

.getCurrentStepName() [protected]

.getGlobals(opt_prefix)

.getNumFilesLoaded()

.getReport(opt_verbose)

.getRunTime()

.getTests() [protected]

.isInsideMultiTestRunner()

.isSuccess()

.log(val)

.logError(name, opt_e)

.maybeFailTestEarly(testCase) [protected]

.next()

.now() [protected]

.onError(err) [protected]

.onSuccess() [protected]

.order {string}

.reset()

.runTests()

.running {boolean}

.saveMessage(message)

.setBatchTime(batchTime) [protected]

.setCompletedCallback(fn)

.setTestRunner(tr)

.setTests(tests) [protected]

.setUp()

.setUpPage()

.shouldRunTests()

.started {boolean}

.stepTimeout {number}

.tearDown()

.tearDownPage()

.timeToSleepAfterFailure {number}

.timeout(fn, time) [protected]

.waitForAsync(opt_name)

.waitForDeferred(a, opt_b)

The `goog.testing.DeferredTestCase` Class

`goog.testing.DeferredTestCase(opt_name)`

`.activeTest` [protected] {`goog.testing.TestCase.Test`|`undefined`}

`.add(test)`

`.addWaitForAsync(msg, d)`

`.autoDiscoverTests()`

`.clearTimeout(id)` [protected]

`.continueTesting()`

`.createAndInstall(opt_name)`

`.createTestFromAutoDiscoveredFunction(name, ref)` [protected]

`.cycleTests()`

`.doAsyncError(opt_e)`

`.doError(test, opt_e)` [protected]

`.doSuccess(test)` [protected]

`.enableDebugLogging()`

`.exceptionBeforeTest` [protected] {*}

`.execute()`

`.finalize()`

`.getActuallyRunCount()`

`.getAutoDiscoveryPrefix()` [protected]

`.getBatchTime()` [protected]

`.getCount()`

`.getCurrentStepName()` [protected]

`.getGlobals(opt_prefix)`

`.getNumFilesLoaded()`

`.getReport(opt_verbose)`

`.getRunTime()`

`.getTests()` [protected]

`.isInsideMultiTestRunner()`

`.isSuccess()`

`.log(val)`

`.logError(name, opt_e)`

`.maybeFailTestEarly(testCase)` [protected]

`.next()`

`.now()` [protected]

`.onError(err)` [protected]

`.onSuccess()` [protected]

`.order` {`string`}

`.reset()`

`.runTests()`

`.running` {`boolean`}

`.saveMessage(message)`

`.setBatchTime(batchTime)` [protected]

`.setCompletedCallback(fn)`

`.setTestRunner(tr)`

`.setTests(tests)` [protected]

`.setUp()`

`.setUpPage()`

`.shouldRunTests()`

`.started` {`boolean`}

`.stepTimeout` {`number`}

`.tearDown()`

`.tearDownPage()`

`.timeToSleepAfterFailure` {`number`}

`.timeout(fn, time)` [protected]

`.waitForAsync(opt_name)`

`.waitForDeferred(a, opt_b)`