selenium-webdriver 2.47.0 → 2.52.0

package/lib/goog/testing/testcase.js

@@ -1,1569 +0,0 @@
-// Copyright 2007 The Closure Library Authors. All Rights Reserved.
-//
-// Licensed under the Apache License, Version 2.0 (the "License");
-// you may not use this file except in compliance with the License.
-// You may obtain a copy of the License at
-//
-//      http://www.apache.org/licenses/LICENSE-2.0
-//
-// Unless required by applicable law or agreed to in writing, software
-// distributed under the License is distributed on an "AS-IS" BASIS,
-// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-// See the License for the specific language governing permissions and
-// limitations under the License.
-
-/**
- * @fileoverview A class representing a set of test functions to be run.
- *
- * Testing code should not have dependencies outside of goog.testing so as to
- * reduce the chance of masking missing dependencies.
- *
- * This file does not compile correctly with --collapse_properties. Use
- * --property_renaming=ALL_UNQUOTED instead.
- *
- */
-
-goog.provide('goog.testing.TestCase');
-goog.provide('goog.testing.TestCase.Error');
-goog.provide('goog.testing.TestCase.Order');
-goog.provide('goog.testing.TestCase.Result');
-goog.provide('goog.testing.TestCase.Test');
-
-
-goog.require('goog.Promise');
-goog.require('goog.Thenable');
-goog.require('goog.asserts');
-goog.require('goog.dom.TagName');
-goog.require('goog.object');
-goog.require('goog.testing.asserts');
-goog.require('goog.testing.stacktrace');
-
-
-
-/**
- * A class representing a JsUnit test case.  A TestCase is made up of a number
- * of test functions which can be run.  Individual test cases can override the
- * following functions to set up their test environment:
- *   - runTests - completely override the test's runner
- *   - setUpPage - called before any of the test functions are run
- *   - tearDownPage - called after all tests are finished
- *   - setUp - called before each of the test functions
- *   - tearDown - called after each of the test functions
- *   - shouldRunTests - called before a test run, all tests are skipped if it
- *                      returns false.  Can be used to disable tests on browsers
- *                      where they aren't expected to pass.
- *
- * Use {@link #autoDiscoverLifecycle} and {@link #autoDiscoverTests}
- *
- * @param {string=} opt_name The name of the test case, defaults to
- *     'Untitled Test Case'.
- * @constructor
- */
-goog.testing.TestCase = function(opt_name) {
-  /**
-   * A name for the test case.
-   * @type {string}
-   * @private
-   */
-  this.name_ = opt_name || 'Untitled Test Case';
-
-  /**
-   * Array of test functions that can be executed.
-   * @type {!Array<!goog.testing.TestCase.Test>}
-   * @private
-   */
-  this.tests_ = [];
-
-  /**
-   * Set of test names and/or indices to execute, or null if all tests should
-   * be executed.
-   *
-   * Indices are included to allow automation tools to run a subset of the
-   * tests without knowing the exact contents of the test file.
-   *
-   * Indices should only be used with SORTED ordering.
-   *
-   * Example valid values:
-   * <ul>
-   * <li>[testName]
-   * <li>[testName1, testName2]
-   * <li>[2] - will run the 3rd test in the order specified
-   * <li>[1,3,5]
-   * <li>[testName1, testName2, 3, 5] - will work
-   * <ul>
-   * @type {Object}
-   * @private
-   */
-  this.testsToRun_ = null;
-
-  /**
-   * The order to run the auto-discovered tests in.
-   * @type {string}
-   */
-  this.order = goog.testing.TestCase.Order.SORTED;
-
-  /** @private {function(!goog.testing.TestCase.Result)} */
-  this.runNextTestCallback_ = goog.nullFunction;
-
-  /**
-   * The number of {@link runNextTest_} frames currently on the stack.
-   * When this exceeds {@link MAX_STACK_DEPTH_}, test execution is rescheduled
-   * for a later tick of the event loop.
-   * @see {finishTestInvocation_}
-   * @private {number}
-   */
-  this.depth_ = 0;
-
-  /** @private {goog.testing.TestCase.Test} */
-  this.curTest_ = null;
-
-  /**
-   * Object used to encapsulate the test results.
-   * @type {!goog.testing.TestCase.Result}
-   * @protected
-   * @suppress {underscore|visibility}
-   */
-  this.result_ = new goog.testing.TestCase.Result(this);
-};
-
-
-/**
- * The order to run the auto-discovered tests.
- * @enum {string}
- */
-goog.testing.TestCase.Order = {
-  /**
-   * This is browser dependent and known to be different in FF and Safari
-   * compared to others.
-   */
-  NATURAL: 'natural',
-
-  /** Random order. */
-  RANDOM: 'random',
-
-  /** Sorted based on the name. */
-  SORTED: 'sorted'
-};
-
-
-/**
- * @return {string} The name of the test.
- */
-goog.testing.TestCase.prototype.getName = function() {
-  return this.name_;
-};
-
-
-/**
- * The maximum amount of time in milliseconds that the test case can take
- * before it is forced to yield and reschedule. This prevents the test runner
- * from blocking the browser and potentially hurting the test harness.
- * @type {number}
- */
-goog.testing.TestCase.maxRunTime = 200;
-
-
-/**
- * The maximum number of {@link runNextTest_} frames that can be on the stack
- * before the test case is forced to yield and reschedule. Although modern
- * browsers can handle thousands of stack frames, this is set conservatively
- * because maximum stack depth has never been standardized, and engine-specific
- * techniques like tail cail optimization can affect the exact depth.
- * @private @const
- */
-goog.testing.TestCase.MAX_STACK_DEPTH_ = 100;
-
-
-/**
- * Save a reference to {@code window.setTimeout}, so any code that overrides the
- * default behavior (the MockClock, for example) doesn't affect our runner.
- * @type {function((Function|string), number=, *=): number}
- * @private
- */
-goog.testing.TestCase.protectedSetTimeout_ = goog.global.setTimeout;
-
-
-/**
- * Save a reference to {@code window.clearTimeout}, so any code that overrides
- * the default behavior (e.g. MockClock) doesn't affect our runner.
- * @type {function((null|number|undefined)): void}
- * @private
- */
-goog.testing.TestCase.protectedClearTimeout_ = goog.global.clearTimeout;
-
-
-/**
- * Save a reference to {@code window.Date}, so any code that overrides
- * the default behavior doesn't affect our runner.
- * @type {function(new: Date)}
- * @private
- */
-goog.testing.TestCase.protectedDate_ = Date;
-
-
-/**
- * Saved string referencing goog.global.setTimeout's string serialization.  IE
- * sometimes fails to uphold equality for setTimeout, but the string version
- * stays the same.
- * @type {string}
- * @private
- */
-goog.testing.TestCase.setTimeoutAsString_ = String(goog.global.setTimeout);
-
-
-/**
- * TODO(user) replace this with prototype.currentTest.
- * Name of the current test that is running, or null if none is running.
- * @type {?string}
- */
-goog.testing.TestCase.currentTestName = null;
-
-
-/**
- * Avoid a dependency on goog.userAgent and keep our own reference of whether
- * the browser is IE.
- * @type {boolean}
- */
-goog.testing.TestCase.IS_IE = typeof opera == 'undefined' &&
-    !!goog.global.navigator &&
-    goog.global.navigator.userAgent.indexOf('MSIE') != -1;
-
-
-/**
- * Exception object that was detected before a test runs.
- * @type {*}
- * @protected
- */
-goog.testing.TestCase.prototype.exceptionBeforeTest;
-
-
-/**
- * Whether the test case has ever tried to execute.
- * @type {boolean}
- */
-goog.testing.TestCase.prototype.started = false;
-
-
-/**
- * Whether the test case is running.
- * @type {boolean}
- */
-goog.testing.TestCase.prototype.running = false;
-
-
-/**
- * Timestamp for when the test was started.
- * @type {number}
- * @private
- */
-goog.testing.TestCase.prototype.startTime_ = 0;
-
-
-/**
- * Time since the last batch of tests was started, if batchTime exceeds
- * {@link #maxRunTime} a timeout will be used to stop the tests blocking the
- * browser and a new batch will be started.
- * @type {number}
- * @private
- */
-goog.testing.TestCase.prototype.batchTime_ = 0;
-
-
-/**
- * Pointer to the current test.
- * @type {number}
- * @private
- */
-goog.testing.TestCase.prototype.currentTestPointer_ = 0;
-
-
-/**
- * Optional callback that will be executed when the test has finalized.
- * @type {Function}
- * @private
- */
-goog.testing.TestCase.prototype.onCompleteCallback_ = null;
-
-
-/**
- * Adds a new test to the test case.
- * @param {goog.testing.TestCase.Test} test The test to add.
- */
-goog.testing.TestCase.prototype.add = function(test) {
-  if (this.started) {
-    throw Error('Tests cannot be added after execute() has been called. ' +
-                'Test: ' + test.name);
-  }
-
-  this.tests_.push(test);
-};
-
-
-/**
- * Creates and adds a new test.
- *
- * Convenience function to make syntax less awkward when not using automatic
- * test discovery.
- *
- * @param {string} name The test name.
- * @param {!Function} ref Reference to the test function.
- * @param {!Object=} opt_scope Optional scope that the test function should be
- *     called in.
- */
-goog.testing.TestCase.prototype.addNewTest = function(name, ref, opt_scope) {
-  var test = new goog.testing.TestCase.Test(name, ref, opt_scope || this);
-  this.add(test);
-};
-
-
-/**
- * Sets the tests.
- * @param {!Array<goog.testing.TestCase.Test>} tests A new test array.
- * @protected
- */
-goog.testing.TestCase.prototype.setTests = function(tests) {
-  this.tests_ = tests;
-};
-
-
-/**
- * Gets the tests.
- * @return {!Array<goog.testing.TestCase.Test>} The test array.
- */
-goog.testing.TestCase.prototype.getTests = function() {
-  return this.tests_;
-};
-
-
-/**
- * Returns the number of tests contained in the test case.
- * @return {number} The number of tests.
- */
-goog.testing.TestCase.prototype.getCount = function() {
-  return this.tests_.length;
-};
-
-
-/**
- * Returns the number of tests actually run in the test case, i.e. subtracting
- * any which are skipped.
- * @return {number} The number of un-ignored tests.
- */
-goog.testing.TestCase.prototype.getActuallyRunCount = function() {
-  return this.testsToRun_ ? goog.object.getCount(this.testsToRun_) : 0;
-};
-
-
-/**
- * Returns the current test and increments the pointer.
- * @return {goog.testing.TestCase.Test} The current test case.
- */
-goog.testing.TestCase.prototype.next = function() {
-  var test;
-  while ((test = this.tests_[this.currentTestPointer_++])) {
-    if (!this.testsToRun_ || this.testsToRun_[test.name] ||
-        this.testsToRun_[this.currentTestPointer_ - 1]) {
-      return test;
-    }
-  }
-  return null;
-};
-
-
-/**
- * Resets the test case pointer, so that next returns the first test.
- */
-goog.testing.TestCase.prototype.reset = function() {
-  this.currentTestPointer_ = 0;
-  this.result_ = new goog.testing.TestCase.Result(this);
-};
-
-
-/**
- * Sets the callback function that should be executed when the tests have
- * completed.
- * @param {Function} fn The callback function.
- */
-goog.testing.TestCase.prototype.setCompletedCallback = function(fn) {
-  this.onCompleteCallback_ = fn;
-};
-
-
-/**
- * @param {goog.testing.TestCase.Order} order The sort order for running tests.
- */
-goog.testing.TestCase.prototype.setOrder = function(order) {
-  this.order = order;
-};
-
-
-/**
- * @param {Object<string, boolean>} testsToRun Set of tests to run. Entries in
- *     the set may be test names, like "testFoo", or numeric indicies. Only
- *     tests identified by name or by index will be executed.
- */
-goog.testing.TestCase.prototype.setTestsToRun = function(testsToRun) {
-  this.testsToRun_ = testsToRun;
-};
-
-
-/**
- * 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.
- * @return {boolean} Whether any of the tests in the case should be run.
- */
-goog.testing.TestCase.prototype.shouldRunTests = function() {
-  return true;
-};
-
-
-/**
- * Executes the tests, yielding asynchronously if execution time exceeds
- * {@link maxRunTime}. There is no guarantee that the test case has finished
- * once this method has returned. To be notified when the test case
- * has finished, use {@link #setCompletedCallback} or
- * {@link #runTestsReturningPromise}.
- */
-goog.testing.TestCase.prototype.execute = function() {
-  if (!this.prepareForRun_()) {
-    return;
-  }
-  this.log('Starting tests: ' + this.name_);
-  this.cycleTests();
-};
-
-
-/**
- * Sets up the internal state of the test case for a run.
- * @return {boolean} If false, preparation failed because the test case
- *     is not supposed to run in the present environment.
- * @private
- */
-goog.testing.TestCase.prototype.prepareForRun_ = function() {
-  this.started = true;
-  this.reset();
-  this.startTime_ = this.now();
-  this.running = true;
-  this.result_.totalCount = this.getCount();
-  if (!this.shouldRunTests()) {
-    this.log('shouldRunTests() returned false, skipping these tests.');
-    this.result_.testSuppressed = true;
-    this.finalize();
-    return false;
-  }
-  return true;
-};
-
-
-/**
- * Finalizes the test case, called when the tests have finished executing.
- */
-goog.testing.TestCase.prototype.finalize = function() {
-  this.saveMessage('Done');
-
-  this.tearDownPage();
-
-  var restoredSetTimeout =
-      goog.testing.TestCase.protectedSetTimeout_ == goog.global.setTimeout &&
-      goog.testing.TestCase.protectedClearTimeout_ == goog.global.clearTimeout;
-  if (!restoredSetTimeout && goog.testing.TestCase.IS_IE &&
-      String(goog.global.setTimeout) ==
-          goog.testing.TestCase.setTimeoutAsString_) {
-    // In strange cases, IE's value of setTimeout *appears* to change, but
-    // the string representation stays stable.
-    restoredSetTimeout = true;
-  }
-
-  if (!restoredSetTimeout) {
-    var message = 'ERROR: Test did not restore setTimeout and clearTimeout';
-    this.saveMessage(message);
-    var err = new goog.testing.TestCase.Error(this.name_, message);
-    this.result_.errors.push(err);
-  }
-  goog.global.clearTimeout = goog.testing.TestCase.protectedClearTimeout_;
-  goog.global.setTimeout = goog.testing.TestCase.protectedSetTimeout_;
-  this.endTime_ = this.now();
-  this.running = false;
-  this.result_.runTime = this.endTime_ - this.startTime_;
-  this.result_.numFilesLoaded = this.countNumFilesLoaded_();
-  this.result_.complete = true;
-
-  this.log(this.result_.getSummary());
-  if (this.result_.isSuccess()) {
-    this.log('Tests complete');
-  } else {
-    this.log('Tests Failed');
-  }
-  if (this.onCompleteCallback_) {
-    var fn = this.onCompleteCallback_;
-    // Execute's the completed callback in the context of the global object.
-    fn();
-    this.onCompleteCallback_ = null;
-  }
-};
-
-
-/**
- * Saves a message to the result set.
- * @param {string} message The message to save.
- */
-goog.testing.TestCase.prototype.saveMessage = function(message) {
-  this.result_.messages.push(this.getTimeStamp_() + '  ' + message);
-};
-
-
-/**
- * @return {boolean} Whether the test case is running inside the multi test
- *     runner.
- */
-goog.testing.TestCase.prototype.isInsideMultiTestRunner = function() {
-  var top = goog.global['top'];
-  return top && typeof top['_allTests'] != 'undefined';
-};
-
-
-/**
- * Logs an object to the console, if available.
- * @param {*} val The value to log. Will be ToString'd.
- */
-goog.testing.TestCase.prototype.log = function(val) {
-  if (!this.isInsideMultiTestRunner() && goog.global.console) {
-    if (typeof val == 'string') {
-      val = this.getTimeStamp_() + ' : ' + val;
-    }
-    if (val instanceof Error && val.stack) {
-      // Chrome does console.log asynchronously in a different process
-      // (http://code.google.com/p/chromium/issues/detail?id=50316).
-      // This is an acute problem for Errors, which almost never survive.
-      // Grab references to the immutable strings so they survive.
-      goog.global.console.log(val, val.message, val.stack);
-      // TODO(gboyer): Consider for Chrome cloning any object if we can ensure
-      // there are no circular references.
-    } else {
-      goog.global.console.log(val);
-    }
-  }
-};
-
-
-/**
- * @return {boolean} Whether the test was a success.
- */
-goog.testing.TestCase.prototype.isSuccess = function() {
-  return !!this.result_ && this.result_.isSuccess();
-};
-
-
-/**
- * Returns a string detailing the results from the test.
- * @param {boolean=} opt_verbose If true results will include data about all
- *     tests, not just what failed.
- * @return {string} The results from the test.
- */
-goog.testing.TestCase.prototype.getReport = function(opt_verbose) {
-  var rv = [];
-
-  if (this.running) {
-    rv.push(this.name_ + ' [RUNNING]');
-  } else {
-    var label = this.result_.isSuccess() ? 'PASSED' : 'FAILED';
-    rv.push(this.name_ + ' [' + label + ']');
-  }
-
-  if (goog.global.location) {
-    rv.push(this.trimPath_(goog.global.location.href));
-  }
-
-  rv.push(this.result_.getSummary());
-
-  if (opt_verbose) {
-    rv.push('.', this.result_.messages.join('\n'));
-  } else if (!this.result_.isSuccess()) {
-    rv.push(this.result_.errors.join('\n'));
-  }
-
-  rv.push(' ');
-
-  return rv.join('\n');
-};
-
-
-/**
- * Returns the test results.
- * @return {!goog.testing.TestCase.Result}
- * @package
- */
-goog.testing.TestCase.prototype.getResult = function() {
-  return this.result_;
-};
-
-
-/**
- * Returns the amount of time it took for the test to run.
- * @return {number} The run time, in milliseconds.
- */
-goog.testing.TestCase.prototype.getRunTime = function() {
-  return this.result_.runTime;
-};
-
-
-/**
- * Returns the number of script files that were loaded in order to run the test.
- * @return {number} The number of script files.
- */
-goog.testing.TestCase.prototype.getNumFilesLoaded = function() {
-  return this.result_.numFilesLoaded;
-};
-
-
-/**
- * Returns the test results object: a map from test names to a list of test
- * failures (if any exist).
- * @return {!Object<string, !Array<string>>} Tests results object.
- */
-goog.testing.TestCase.prototype.getTestResults = function() {
-  return this.result_.resultsByName;
-};
-
-
-/**
- * Executes each of the tests, yielding asynchronously if execution time
- * exceeds {@link #maxRunTime}. There is no guarantee that the test case
- * has finished execution once this method has returned.
- * To be notified when the test case has finished execution, use
- * {@link #setCompletedCallback} or {@link #runTestsReturningPromise}.
- *
- * 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.
- */
-goog.testing.TestCase.prototype.runTests = function() {
-  try {
-    this.setUpPage();
-  } catch (e) {
-    this.exceptionBeforeTest = e;
-  }
-  this.execute();
-};
-
-
-/**
- * Executes each of the tests, returning a promise that resolves with the
- * test results once they are done running.
- * @return {!IThenable.<!goog.testing.TestCase.Result>}
- * @final
- * @package
- */
-goog.testing.TestCase.prototype.runTestsReturningPromise = function() {
-  try {
-    this.setUpPage();
-  } catch (e) {
-    this.exceptionBeforeTest = e;
-  }
-  if (!this.prepareForRun_()) {
-    return goog.Promise.resolve(this.result_);
-  }
-  this.log('Starting tests: ' + this.name_);
-  this.saveMessage('Start');
-  this.batchTime_ = this.now();
-  return new goog.Promise(function(resolve) {
-    this.runNextTestCallback_ = resolve;
-    this.runNextTest_();
-  }, this);
-};
-
-
-/**
- * Executes the next test method synchronously or with promises, depending on
- * the test method's return value.
- *
- * If the test method returns a promise, the next test method will run once
- * the promise is resolved or rejected. If the test method does not
- * return a promise, it is assumed to be synchronous, and execution proceeds
- * immediately to the next test method. This means that test cases can run
- * partially synchronously and partially asynchronously, depending on
- * the return values of their test methods. In particular, a test case
- * executes synchronously until the first promise is returned from a
- * test method (or until a resource limit is reached; see
- * {@link finishTestInvocation_}).
- * @private
- */
-goog.testing.TestCase.prototype.runNextTest_ = function() {
-  this.curTest_ = this.next();
-  if (!this.curTest_ || !this.running) {
-    this.finalize();
-    this.runNextTestCallback_(this.result_);
-    return;
-  }
-  this.result_.runCount++;
-  this.log('Running test: ' + this.curTest_.name);
-  if (this.maybeFailTestEarly(this.curTest_)) {
-    this.finishTestInvocation_();
-    return;
-  }
-  goog.testing.TestCase.currentTestName = this.curTest_.name;
-  this.invokeTestFunction_(
-      this.setUp, this.safeRunTest_, this.safeTearDown_);
-};
-
-
-/**
- * Calls the given test function, handling errors appropriately.
- * @private
- */
-goog.testing.TestCase.prototype.safeRunTest_ = function() {
-  this.invokeTestFunction_(
-      goog.bind(this.curTest_.ref, this.curTest_.scope),
-      this.safeTearDown_,
-      this.safeTearDown_);
-};
-
-
-/**
- * Calls {@link tearDown}, handling errors appropriately.
- * @param {*=} opt_error Error associated with the test, if any.
- * @private
- */
-goog.testing.TestCase.prototype.safeTearDown_ = function(opt_error) {
-  if (arguments.length == 1) {
-    this.doError(this.curTest_, opt_error);
-  }
-  this.invokeTestFunction_(
-      this.tearDown, this.finishTestInvocation_, this.finishTestInvocation_);
-};
-
-
-/**
- * Calls the given {@code fn}, then calls either {@code onSuccess} or
- * {@code onFailure}, either synchronously or using promises, depending on
- * {@code fn}'s return value.
- *
- * If {@code fn} throws an exception, {@code onFailure} is called immediately
- * with the exception.
- *
- * If {@code fn} returns a promise, and the promise is eventually resolved,
- * {@code onSuccess} is called with no arguments. If the promise is eventually
- * rejected, {@code onFailure} is called with the rejection reason.
- *
- * Otherwise, if {@code fn} neither returns a promise nor throws an exception,
- * {@code onSuccess} is called immediately with no arguments.
- *
- * {@code fn}, {@code onSuccess}, and {@code onFailure} are all called with
- * the TestCase instance as the method receiver.
- *
- * @param {function()} fn The function to call.
- * @param {function()} onSuccess Success callback.
- * @param {function(*)} onFailure Failure callback.
- * @private
- */
-goog.testing.TestCase.prototype.invokeTestFunction_ = function(
-    fn, onSuccess, onFailure) {
-  try {
-    var retval = fn.call(this);
-    if (goog.Thenable.isImplementedBy(retval) ||
-        goog.isFunction(retval && retval['then'])) {
-      var self = this;
-      retval.then(
-          function() {
-            self.resetBatchTimeAfterPromise_();
-            onSuccess.call(self);
-          },
-          function(e) {
-            self.resetBatchTimeAfterPromise_();
-            onFailure.call(self, e);
-          });
-    } else {
-      onSuccess.call(this);
-    }
-  } catch (e) {
-    onFailure.call(this, e);
-  }
-};
-
-
-/**
- * Resets the batch run timer. This should only be called after resolving a
- * promise since Promise.then() has an implicit yield.
- * @private
- */
-goog.testing.TestCase.prototype.resetBatchTimeAfterPromise_ = function() {
-  this.batchTime_ = this.now();
-};
-
-
-/**
- * Finishes up bookkeeping for the current test function, and schedules
- * the next test function to run, either immediately or asychronously.
- * @param {*=} opt_error Optional error resulting from the test invocation.
- * @private
- */
-goog.testing.TestCase.prototype.finishTestInvocation_ = function(opt_error) {
-  if (arguments.length == 1) {
-    this.doError(this.curTest_, opt_error);
-  }
-
-  // If no errors have been recorded for the test, it is a success.
-  if (!(this.curTest_.name in this.result_.resultsByName) ||
-      !this.result_.resultsByName[this.curTest_.name].length) {
-    this.doSuccess(this.curTest_);
-  }
-
-  goog.testing.TestCase.currentTestName = null;
-
-  // If the test case has consumed too much time or stack space,
-  // yield to avoid blocking the browser. Otherwise, proceed to the next test.
-  if (this.depth_ > goog.testing.TestCase.MAX_STACK_DEPTH_ ||
-      this.now() - this.batchTime_ > goog.testing.TestCase.maxRunTime) {
-    this.saveMessage('Breaking async');
-    this.timeout(goog.bind(this.startNextBatch_, this), 0);
-  } else {
-    ++this.depth_;
-    this.runNextTest_();
-  }
-};
-
-
-/**
- * Start a new batch to tests after yielding, resetting batchTime and depth.
- * @private
- */
-goog.testing.TestCase.prototype.startNextBatch_ = function() {
-  this.batchTime_ = this.now();
-  this.depth_ = 0;
-  this.runNextTest_();
-};
-
-
-/**
- * Reorders the tests depending on the {@code order} field.
- * @private
- */
-goog.testing.TestCase.prototype.orderTests_ = function() {
-  switch (this.order) {
-    case goog.testing.TestCase.Order.RANDOM:
-      // Fisher-Yates shuffle
-      var i = this.tests_.length;
-      while (i > 1) {
-        // goog.math.randomInt is inlined to reduce dependencies.
-        var j = Math.floor(Math.random() * i); // exclusive
-        i--;
-        var tmp = this.tests_[i];
-        this.tests_[i] = this.tests_[j];
-        this.tests_[j] = tmp;
-      }
-      break;
-
-    case goog.testing.TestCase.Order.SORTED:
-      this.tests_.sort(function(t1, t2) {
-        if (t1.name == t2.name) {
-          return 0;
-        }
-        return t1.name < t2.name ? -1 : 1;
-      });
-      break;
-
-      // Do nothing for NATURAL.
-  }
-};
-
-
-/**
- * Gets list of objects that potentially contain test cases. For IE 8 and below,
- * this is the global "this" (for properties set directly on the global this or
- * window) and the RuntimeObject (for global variables and functions). For all
- * other browsers, the array simply contains the global this.
- *
- * @param {string=} opt_prefix An optional prefix. If specified, only get things
- *     under this prefix. Note that the prefix is only honored in IE, since it
- *     supports the RuntimeObject:
- *     http://msdn.microsoft.com/en-us/library/ff521039%28VS.85%29.aspx
- *     TODO: Remove this option.
- * @return {!Array<!Object>} A list of objects that should be inspected.
- */
-goog.testing.TestCase.prototype.getGlobals = function(opt_prefix) {
-  return goog.testing.TestCase.getGlobals(opt_prefix);
-};
-
-
-/**
- * Gets list of objects that potentially contain test cases. For IE 8 and below,
- * this is the global "this" (for properties set directly on the global this or
- * window) and the RuntimeObject (for global variables and functions). For all
- * other browsers, the array simply contains the global this.
- *
- * @param {string=} opt_prefix An optional prefix. If specified, only get things
- *     under this prefix. Note that the prefix is only honored in IE, since it
- *     supports the RuntimeObject:
- *     http://msdn.microsoft.com/en-us/library/ff521039%28VS.85%29.aspx
- *     TODO: Remove this option.
- * @return {!Array<!Object>} A list of objects that should be inspected.
- */
-goog.testing.TestCase.getGlobals = function(opt_prefix) {
-  // Look in the global scope for most browsers, on IE we use the little known
-  // RuntimeObject which holds references to all globals. We reference this
-  // via goog.global so that there isn't an aliasing that throws an exception
-  // in Firefox.
-  return typeof goog.global['RuntimeObject'] != 'undefined' ?
-      [goog.global['RuntimeObject']((opt_prefix || '') + '*'), goog.global] :
-      [goog.global];
-};
-
-
-/**
- * Gets called before any tests are executed.  Can be overridden to set up the
- * environment for the whole test case.
- */
-goog.testing.TestCase.prototype.setUpPage = function() {};
-
-
-/**
- * Gets called after all tests have been executed.  Can be overridden to tear
- * down the entire test case.
- */
-goog.testing.TestCase.prototype.tearDownPage = function() {};
-
-
-/**
- * Gets called before every goog.testing.TestCase.Test is been executed. Can be
- * overridden to add set up functionality to each test.
- */
-goog.testing.TestCase.prototype.setUp = function() {};
-
-
-/**
- * Gets called after every goog.testing.TestCase.Test has been executed. Can be
- * overriden to add tear down functionality to each test.
- */
-goog.testing.TestCase.prototype.tearDown = function() {};
-
-
-/**
- * @return {string} The function name prefix used to auto-discover tests.
- */
-goog.testing.TestCase.prototype.getAutoDiscoveryPrefix = function() {
-  return 'test';
-};
-
-
-/**
- * @return {number} Time since the last batch of tests was started.
- * @protected
- */
-goog.testing.TestCase.prototype.getBatchTime = function() {
-  return this.batchTime_;
-};
-
-
-/**
- * @param {number} batchTime Time since the last batch of tests was started.
- * @protected
- */
-goog.testing.TestCase.prototype.setBatchTime = function(batchTime) {
-  this.batchTime_ = batchTime;
-};
-
-
-/**
- * Creates a {@code goog.testing.TestCase.Test} from an auto-discovered
- *     function.
- * @param {string} name The name of the function.
- * @param {function() : void} ref The auto-discovered function.
- * @return {!goog.testing.TestCase.Test} The newly created test.
- * @protected
- */
-goog.testing.TestCase.prototype.createTestFromAutoDiscoveredFunction =
-    function(name, ref) {
-  return new goog.testing.TestCase.Test(name, ref, goog.global);
-};
-
-
-/**
- * Adds any functions defined on 'obj' (the global object, by default)
- * that correspond to lifecycle events for the test case. Overrides
- * setUp, tearDown, setUpPage, tearDownPage, runTests, and shouldRunTests
- * if they are defined on 'obj'.
- * @param {!Object=} opt_obj Defaults to goog.global.
- */
-goog.testing.TestCase.prototype.autoDiscoverLifecycle = function(opt_obj) {
-  var obj = opt_obj || goog.global;
-  if (obj['setUp']) {
-    this.setUp = goog.bind(obj['setUp'], obj);
-  }
-  if (obj['tearDown']) {
-    this.tearDown = goog.bind(obj['tearDown'], obj);
-  }
-  if (obj['setUpPage']) {
-    this.setUpPage = goog.bind(obj['setUpPage'], obj);
-  }
-  if (obj['tearDownPage']) {
-    this.tearDownPage = goog.bind(obj['tearDownPage'], obj);
-  }
-  if (obj['runTests']) {
-    this.runTests = goog.bind(obj['runTests'], obj);
-  }
-  if (obj['shouldRunTests']) {
-    this.shouldRunTests = goog.bind(obj['shouldRunTests'], obj);
-  }
-};
-
-
-// TODO(johnlenz): make this package private
-/**
- * @param {!Object} obj  An object from which to extract test and lifecycle
- * methods.
- */
-goog.testing.TestCase.prototype.setTestObj = function(obj) {
-  // Drop any previously added (likely auto-discovered) tests, only one source
-  // of discovered test and life-cycle methods is allowed.
-  goog.asserts.assert(this.tests_.length == 0,
-      'Test methods have already been configured.');
-
-  var regex = new RegExp('^' + this.getAutoDiscoveryPrefix());
-  for (var name in obj) {
-    if (regex.test(name)) {
-      var testMethod = obj[name];
-      if (goog.isFunction(testMethod)) {
-        this.addNewTest(name, testMethod, obj);
-      }
-    }
-  }
-
-  this.autoDiscoverLifecycle(obj);
-};
-
-
-/**
- * Adds any functions defined in the global scope that are prefixed with "test"
- * to the test case.
- */
-goog.testing.TestCase.prototype.autoDiscoverTests = function() {
-  var prefix = this.getAutoDiscoveryPrefix();
-  var testSources = this.getGlobals(prefix);
-
-  var foundTests = [];
-
-  for (var i = 0; i < testSources.length; i++) {
-    var testSource = testSources[i];
-    for (var name in testSource) {
-      if ((new RegExp('^' + prefix)).test(name)) {
-        var ref;
-        try {
-          ref = testSource[name];
-        } catch (ex) {
-          // NOTE(brenneman): When running tests from a file:// URL on Firefox
-          // 3.5 for Windows, any reference to goog.global.sessionStorage raises
-          // an "Operation is not supported" exception. Ignore any exceptions
-          // raised by simply accessing global properties.
-          ref = undefined;
-        }
-
-        if (goog.isFunction(ref)) {
-          foundTests.push(this.createTestFromAutoDiscoveredFunction(name, ref));
-        }
-      }
-    }
-  }
-
-  for (var i = 0; i < foundTests.length; i++) {
-    this.add(foundTests[i]);
-  }
-  this.orderTests_();
-
-  this.log(this.getCount() + ' tests auto-discovered');
-
-  // TODO(user): Do this as a separate call. Unfortunately, a lot of projects
-  // currently override autoDiscoverTests and expect lifecycle events to be
-  // registered as a part of this call.
-  this.autoDiscoverLifecycle();
-};
-
-
-/**
- * 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.
- *
- * @param {goog.testing.TestCase.Test} testCase The current test case.
- * @return {boolean} Whether the test was marked as failed.
- * @protected
- */
-goog.testing.TestCase.prototype.maybeFailTestEarly = function(testCase) {
-  if (this.exceptionBeforeTest) {
-    // We just use the first error to report an error on a failed test.
-    this.curTest_.name = 'setUpPage for ' + this.curTest_.name;
-    this.doError(this.curTest_, this.exceptionBeforeTest);
-    return true;
-  }
-  return false;
-};
-
-
-/**
- * Cycles through the tests, yielding asynchronously if the execution time
- * execeeds {@link #maxRunTime}. In particular, there is no guarantee that
- * the test case has finished execution once this method has returned.
- * To be notified when the test case has finished execution, use
- * {@link #setCompletedCallback} or {@link #runTestsReturningPromise}.
- */
-goog.testing.TestCase.prototype.cycleTests = function() {
-  this.saveMessage('Start');
-  this.batchTime_ = this.now();
-  if (this.running) {
-    this.runNextTestCallback_ = goog.nullFunction;
-    // Kick off the tests. runNextTest_ will schedule all of the tests,
-    // using a mixture of synchronous and asynchronous strategies.
-    this.runNextTest_();
-  }
-};
-
-
-/**
- * Counts the number of files that were loaded for dependencies that are
- * required to run the test.
- * @return {number} The number of files loaded.
- * @private
- */
-goog.testing.TestCase.prototype.countNumFilesLoaded_ = function() {
-  var scripts = document.getElementsByTagName(goog.dom.TagName.SCRIPT);
-  var count = 0;
-  for (var i = 0, n = scripts.length; i < n; i++) {
-    if (scripts[i].src) {
-      count++;
-    }
-  }
-  return count;
-};
-
-
-/**
- * Calls a function after a delay, using the protected timeout.
- * @param {Function} fn The function to call.
- * @param {number} time Delay in milliseconds.
- * @return {number} The timeout id.
- * @protected
- */
-goog.testing.TestCase.prototype.timeout = function(fn, time) {
-  // NOTE: invoking protectedSetTimeout_ as a member of goog.testing.TestCase
-  // would result in an Illegal Invocation error. The method must be executed
-  // with the global context.
-  var protectedSetTimeout = goog.testing.TestCase.protectedSetTimeout_;
-  return protectedSetTimeout(fn, time);
-};
-
-
-/**
- * Clears a timeout created by {@code this.timeout()}.
- * @param {number} id A timeout id.
- * @protected
- */
-goog.testing.TestCase.prototype.clearTimeout = function(id) {
-  // NOTE: see execution note for protectedSetTimeout above.
-  var protectedClearTimeout = goog.testing.TestCase.protectedClearTimeout_;
-  protectedClearTimeout(id);
-};
-
-
-/**
- * @return {number} The current time in milliseconds, don't use goog.now as some
- *     tests override it.
- * @protected
- */
-goog.testing.TestCase.prototype.now = function() {
-  // Cannot use "new goog.testing.TestCase.protectedDate_()" due to b/8323223.
-  var protectedDate = goog.testing.TestCase.protectedDate_;
-  return new protectedDate().getTime();
-};
-
-
-/**
- * Returns the current time.
- * @return {string} HH:MM:SS.
- * @private
- */
-goog.testing.TestCase.prototype.getTimeStamp_ = function() {
-  // Cannot use "new goog.testing.TestCase.protectedDate_()" due to b/8323223.
-  var protectedDate = goog.testing.TestCase.protectedDate_;
-  var d = new protectedDate();
-
-  // Ensure millis are always 3-digits
-  var millis = '00' + d.getMilliseconds();
-  millis = millis.substr(millis.length - 3);
-
-  return this.pad_(d.getHours()) + ':' + this.pad_(d.getMinutes()) + ':' +
-         this.pad_(d.getSeconds()) + '.' + millis;
-};
-
-
-/**
- * Pads a number to make it have a leading zero if it's less than 10.
- * @param {number} number The number to pad.
- * @return {string} The resulting string.
- * @private
- */
-goog.testing.TestCase.prototype.pad_ = function(number) {
-  return number < 10 ? '0' + number : String(number);
-};
-
-
-/**
- * Trims a path to be only that after google3.
- * @param {string} path The path to trim.
- * @return {string} The resulting string.
- * @private
- */
-goog.testing.TestCase.prototype.trimPath_ = function(path) {
-  return path.substring(path.indexOf('google3') + 8);
-};
-
-
-/**
- * Handles a test that passed.
- * @param {goog.testing.TestCase.Test} test The test that passed.
- * @protected
- */
-goog.testing.TestCase.prototype.doSuccess = function(test) {
-  this.result_.successCount++;
-  // An empty list of error messages indicates that the test passed.
-  // If we already have a failure for this test, do not set to empty list.
-  if (!(test.name in this.result_.resultsByName)) {
-    this.result_.resultsByName[test.name] = [];
-  }
-  var message = test.name + ' : PASSED';
-  this.saveMessage(message);
-  this.log(message);
-};
-
-
-/**
- * Handles a test that failed.
- * @param {goog.testing.TestCase.Test} test The test that failed.
- * @param {*=} opt_e The exception object associated with the
- *     failure or a string.
- * @protected
- */
-goog.testing.TestCase.prototype.doError = function(test, opt_e) {
-  var message = test.name + ' : FAILED';
-  this.log(message);
-  this.saveMessage(message);
-  var err = this.logError(test.name, opt_e);
-  this.result_.errors.push(err);
-  if (test.name in this.result_.resultsByName) {
-    this.result_.resultsByName[test.name].push(err.toString());
-  } else {
-    this.result_.resultsByName[test.name] = [err.toString()];
-  }
-};
-
-
-/**
- * @param {string} name Failed test name.
- * @param {*=} opt_e The exception object associated with the
- *     failure or a string.
- * @return {!goog.testing.TestCase.Error} Error object.
- */
-goog.testing.TestCase.prototype.logError = function(name, opt_e) {
-  var errMsg = null;
-  var stack = null;
-  if (opt_e) {
-    this.log(opt_e);
-    if (goog.isString(opt_e)) {
-      errMsg = opt_e;
-    } else {
-      errMsg = opt_e.message || opt_e.description || opt_e.toString();
-      stack = opt_e.stack ? goog.testing.stacktrace.canonicalize(opt_e.stack) :
-          opt_e['stackTrace'];
-    }
-  } else {
-    errMsg = 'An unknown error occurred';
-  }
-  var err = new goog.testing.TestCase.Error(name, errMsg, stack);
-
-  // Avoid double logging.
-  if (!opt_e || !opt_e['isJsUnitException'] ||
-      !opt_e['loggedJsUnitException']) {
-    this.saveMessage(err.toString());
-  }
-  if (opt_e && opt_e['isJsUnitException']) {
-    opt_e['loggedJsUnitException'] = true;
-  }
-
-  return err;
-};
-
-
-
-/**
- * A class representing a single test function.
- * @param {string} name The test name.
- * @param {Function} ref Reference to the test function.
- * @param {Object=} opt_scope Optional scope that the test function should be
- *     called in.
- * @constructor
- */
-goog.testing.TestCase.Test = function(name, ref, opt_scope) {
-  /**
-   * The name of the test.
-   * @type {string}
-   */
-  this.name = name;
-
-  /**
-   * Reference to the test function.
-   * @type {Function}
-   */
-  this.ref = ref;
-
-  /**
-   * Scope that the test function should be called in.
-   * @type {Object}
-   */
-  this.scope = opt_scope || null;
-};
-
-
-/**
- * Executes the test function.
- * @package
- */
-goog.testing.TestCase.Test.prototype.execute = function() {
-  this.ref.call(this.scope);
-};
-
-
-
-/**
- * A class for representing test results.  A bag of public properties.
- * @param {goog.testing.TestCase} testCase The test case that owns this result.
- * @constructor
- * @final
- */
-goog.testing.TestCase.Result = function(testCase) {
-  /**
-   * The test case that owns this result.
-   * @type {goog.testing.TestCase}
-   * @private
-   */
-  this.testCase_ = testCase;
-
-  /**
-   * Total number of tests that should have been run.
-   * @type {number}
-   */
-  this.totalCount = 0;
-
-  /**
-   * Total number of tests that were actually run.
-   * @type {number}
-   */
-  this.runCount = 0;
-
-  /**
-   * Number of successful tests.
-   * @type {number}
-   */
-  this.successCount = 0;
-
-  /**
-   * The amount of time the tests took to run.
-   * @type {number}
-   */
-  this.runTime = 0;
-
-  /**
-   * The number of files loaded to run this test.
-   * @type {number}
-   */
-  this.numFilesLoaded = 0;
-
-  /**
-   * Whether this test case was suppressed by shouldRunTests() returning false.
-   * @type {boolean}
-   */
-  this.testSuppressed = false;
-
-  /**
-   * Test results for each test that was run. The test name is always added
-   * as the key in the map, and the array of strings is an optional list
-   * of failure messages. If the array is empty, the test passed. Otherwise,
-   * the test failed.
-   * @type {!Object<string, !Array<string>>}
-   */
-  this.resultsByName = {};
-
-  /**
-   * Errors encountered while running the test.
-   * @type {!Array<goog.testing.TestCase.Error>}
-   */
-  this.errors = [];
-
-  /**
-   * Messages to show the user after running the test.
-   * @type {!Array<string>}
-   */
-  this.messages = [];
-
-  /**
-   * Whether the tests have completed.
-   * @type {boolean}
-   */
-  this.complete = false;
-};
-
-
-/**
- * @return {boolean} Whether the test was successful.
- */
-goog.testing.TestCase.Result.prototype.isSuccess = function() {
-  return this.complete && this.errors.length == 0;
-};
-
-
-/**
- * @return {string} A summary of the tests, including total number of tests that
- *     passed, failed, and the time taken.
- */
-goog.testing.TestCase.Result.prototype.getSummary = function() {
-  var summary = this.runCount + ' of ' + this.totalCount + ' tests run in ' +
-      this.runTime + 'ms.\n';
-  if (this.testSuppressed) {
-    summary += 'Tests not run because shouldRunTests() returned false.';
-  } else {
-    var failures = this.totalCount - this.successCount;
-    var suppressionMessage = '';
-
-    var countOfRunTests = this.testCase_.getActuallyRunCount();
-    if (countOfRunTests) {
-      failures = countOfRunTests - this.successCount;
-      suppressionMessage = ', ' +
-          (this.totalCount - countOfRunTests) + ' suppressed by querystring';
-    }
-    summary += this.successCount + ' passed, ' +
-        failures + ' failed' + suppressionMessage + '.\n' +
-        Math.round(this.runTime / this.runCount) + ' ms/test. ' +
-        this.numFilesLoaded + ' files loaded.';
-  }
-
-  return summary;
-};
-
-
-/**
- * Initializes the given test case with the global test runner 'G_testRunner'.
- * @param {goog.testing.TestCase} testCase The test case to install.
- */
-goog.testing.TestCase.initializeTestRunner = function(testCase) {
-  testCase.autoDiscoverTests();
-
-  if (goog.global.location) {
-    var search = goog.global.location.search;
-    testCase.setOrder(goog.testing.TestCase.parseOrder_(search) ||
-        goog.testing.TestCase.Order.SORTED);
-    testCase.setTestsToRun(goog.testing.TestCase.parseRunTests_(search));
-  }
-
-  var gTestRunner = goog.global['G_testRunner'];
-  if (gTestRunner) {
-    gTestRunner['initialize'](testCase);
-  } else {
-    throw Error('G_testRunner is undefined. Please ensure goog.testing.jsunit' +
-        ' is included.');
-  }
-};
-
-
-/**
- * Parses URL query parameters for the 'order' parameter.
- * @param {string} search The URL query string.
- * @return {?goog.testing.TestCase.Order} The sort order for running tests.
- * @private
- */
-goog.testing.TestCase.parseOrder_ = function(search) {
-  var order = null;
-  var orderMatch = search.match(
-      /(?:\?|&)order=(natural|random|sorted)/i);
-  if (orderMatch) {
-    order = /** @type {goog.testing.TestCase.Order} */ (
-        orderMatch[1].toLowerCase());
-  }
-  return order;
-};
-
-
-/**
- * Parses URL query parameters for the 'runTests' parameter.
- * @param {string} search The URL query string.
- * @return {Object<string, boolean>} A set of test names or test indices to be
- *     run by the test runner.
- * @private
- */
-goog.testing.TestCase.parseRunTests_ = function(search) {
-  var testsToRun = null;
-  var runTestsMatch = search.match(/(?:\?|&)runTests=([^?&]+)/i);
-  if (runTestsMatch) {
-    testsToRun = {};
-    var arr = runTestsMatch[1].split(',');
-    for (var i = 0, len = arr.length; i < len; i++) {
-      testsToRun[arr[i]] = true;
-    }
-  }
-  return testsToRun;
-};
-
-
-
-/**
- * A class representing an error thrown by the test
- * @param {string} source The name of the test which threw the error.
- * @param {string} message The error message.
- * @param {string=} opt_stack A string showing the execution stack.
- * @constructor
- * @final
- */
-goog.testing.TestCase.Error = function(source, message, opt_stack) {
-  /**
-   * The name of the test which threw the error.
-   * @type {string}
-   */
-  this.source = source;
-
-  /**
-   * Reference to the test function.
-   * @type {string}
-   */
-  this.message = message;
-
-  /**
-   * The stack.
-   * @type {?string}
-   */
-  this.stack = null;
-
-  if (opt_stack) {
-    this.stack = opt_stack;
-  } else {
-    // Attempt to capture a stack trace.
-    if (Error.captureStackTrace) {
-      // See https://code.google.com/p/v8-wiki/wiki/JavaScriptStackTraceApi
-      Error.captureStackTrace(this, goog.testing.TestCase.Error);
-    } else {
-      var stack = new Error().stack;
-      if (stack) {
-        this.stack = stack;
-      }
-    }
-  }
-};
-
-
-/**
- * Returns a string representing the error object.
- * @return {string} A string representation of the error.
- * @override
- */
-goog.testing.TestCase.Error.prototype.toString = function() {
-  return 'ERROR in ' + this.source + '\n' +
-      this.message + (this.stack ? '\n' + this.stack : '');
-};