/**
* @license
* Copyright The Closure Library Authors.
* SPDX-License-Identifier: Apache-2.0
*/
goog.module('goog.testing.AsyncTestCaseSyncTest');
goog.setTestOnly();
const AsyncTestCase = goog.require('goog.testing.AsyncTestCase');
const testSuite = goog.require('goog.testing.testSuite');
// Has the setUp() function been called.
const setUpCalled = false;
// Has the current test function completed. This helps us to ensure that the
// next test is not started before the previous completed.
let curTestIsDone = true;
// For restoring it later.
const oldTimeout = window.setTimeout;
// Use an asynchronous test runner for our tests.
const asyncTestCase = AsyncTestCase.createAndInstall(document.title);
/**
* Uses window.setTimeout() to perform asynchronous behaviour and uses
* asyncTestCase.waitForAsync() and asyncTestCase.continueTesting() to mark
* the beginning and end of it.
* @param {number} numAsyncCalls The number of asynchronous calls to make.
* @param {string} name The name of the current step.
*/
function doAsyncStuff(numAsyncCalls, name) {
if (numAsyncCalls > 0) {
curTestIsDone = false;
asyncTestCase.waitForAsync(
`doAsyncStuff-${name}` +
'(' + numAsyncCalls + ')');
window.setTimeout(() => {
doAsyncStuff(numAsyncCalls - 1, name);
}, 0);
} else {
curTestIsDone = true;
asyncTestCase.continueTesting();
}
}
const callback = () => {
curTestIsDone = true;
asyncTestCase.signal();
};
const doAsyncSignals = () => {
curTestIsDone = false;
window.setTimeout(callback, 0);
};
testSuite({
/** @suppress {missingProperties} suppression added to enable type checking */
setUpPage() {
globalThis.debug('setUpPage was called.');
// Don't do anything asynchronously.
/**
* @suppress {missingReturn,checkTypes} suppression added to enable type
* checking
*/
window.setTimeout = (callback, time) => {
callback();
};
doAsyncStuff(3, 'setUpPage');
},
setUp() {
assertTrue(curTestIsDone);
doAsyncStuff(3, 'setUp');
},
tearDown() {
assertTrue(curTestIsDone);
},
test1() {
assertTrue(curTestIsDone);
doAsyncStuff(1, 'test1');
},
test2() {
assertTrue(curTestIsDone);
doAsyncStuff(2, 'test2');
},
test3() {
assertTrue(curTestIsDone);
doAsyncStuff(5, 'test3');
},
testSignalsReturn() {
doAsyncSignals();
doAsyncSignals();
doAsyncSignals();
asyncTestCase.waitForSignals(3);
},
testSignalsCallContinueTestingBeforeFinishing() {
doAsyncSignals();
asyncTestCase.waitForSignals(2);
window.setTimeout(() => {
const thrown = assertThrows(() => {
asyncTestCase.continueTesting();
});
assertEquals('Still waiting for 1 signals.', thrown.message);
}, 0);
doAsyncSignals(); // To not timeout.
},
/** @suppress {missingProperties} suppression added to enable type checking */
tearDownPage() {
globalThis.debug('tearDownPage was called.');
assertTrue(curTestIsDone);
window.setTimeout = oldTimeout;
},
});