Tests: Ensure no timers are running at the end of each test (#1920)

This helps fix issues that make tooltip tests sometimes fail when run against
jQuery 3.2 or newer due to timing differences.

Details:
* Add the `moduleAfterEach` function ensuring no timers are running.
* Attach this function via `common.testWidget`.
* Attach this function to most test suites.
* Add a tooltip test helper cleaning up leftover timers.
* Rename legacy `setup`/`teardown` hooks to `beforeEach`/`afterEach`.

Closes gh-1920

Author: mgol

tests/lib/common.js

@@ -1,7 +1,8 @@
 define( [
 	"qunit",
-	"jquery" ],
-function( QUnit, $ ) {
+	"jquery",
+	"lib/helper"
+], function( QUnit, $, helper ) {
 
 var exports = {};
 
@@ -66,7 +67,7 @@ function testBasicUsage( widget ) {
 }
 
 exports.testWidget = function( widget, settings ) {
-	QUnit.module( widget + ": common widget" );
+	QUnit.module( widget + ": common widget", { afterEach: helper.moduleAfterEach } );
 
 	exports.testJshint( "/widgets/" + widget );
 	testWidgetDefaults( widget, settings.defaults );

tests/lib/helper.js

@@ -2,7 +2,12 @@ define( [
 	"jquery"
 ], function( $ ) {
 
-var exports = {};
+var exports = {},
+
+	// Store the old count so that we only assert on tests that have actually leaked,
+	// instead of asserting every time a test has leaked sometime in the past
+	oldActive = 0,
+	splice = [].splice;
 
 exports.forceScrollableWindow = function( appendTo ) {
 
@@ -28,6 +33,24 @@ exports.onFocus = function( element, onFocus ) {
 	element.on( "focus", fn )[ 0 ].focus();
 };
 
+/**
+ * Ensures that tests have cleaned up properly after themselves. Should be passed as the
+ * afterEach function on all modules' lifecycle object.
+ */
+exports.moduleAfterEach = function( assert ) {
+
+	// Check for (and clean up, if possible) incomplete animations/requests/etc.
+	if ( jQuery.timers && jQuery.timers.length !== 0 ) {
+		assert.equal( jQuery.timers.length, 0, "No timers are still running" );
+		splice.call( jQuery.timers, 0, jQuery.timers.length );
+		jQuery.fx.stop();
+	}
+	if ( jQuery.active !== undefined && jQuery.active !== oldActive ) {
+		assert.equal( jQuery.active, oldActive, "No AJAX requests are still active" );
+		oldActive = jQuery.active;
+	}
+};
+
 return exports;
 
 } );

tests/unit/accordion/core.js

@@ -5,10 +5,10 @@ define( [
 	"ui/widgets/accordion"
 ], function( QUnit, $, testHelper ) {
 
-var setupTeardown = testHelper.setupTeardown,
+var beforeAfterEach = testHelper.beforeAfterEach,
 	state = testHelper.state;
 
-QUnit.module( "accordion: core", setupTeardown() );
+QUnit.module( "accordion: core", beforeAfterEach() );
 
 $.each( { div: "#list1", ul: "#navigation", dl: "#accordion-dl" }, function( type, selector ) {
 	QUnit.test( "markup structure: " + type, function( assert ) {

tests/unit/accordion/events.js

@@ -5,10 +5,10 @@ define( [
 	"ui/widgets/accordion"
 ], function( QUnit, $, testHelper ) {
 
-var setupTeardown = testHelper.setupTeardown,
+var beforeAfterEach = testHelper.beforeAfterEach,
 	state = testHelper.state;
 
-QUnit.module( "accordion: events", setupTeardown() );
+QUnit.module( "accordion: events", beforeAfterEach() );
 
 QUnit.test( "create", function( assert ) {
 	assert.expect( 10 );

tests/unit/accordion/helper.js

@@ -12,14 +12,15 @@ return $.extend( helper, {
 		} );
 	},
 
-	setupTeardown: function() {
+	beforeAfterEach: function() {
 		var animate = $.ui.accordion.prototype.options.animate;
 		return {
-			setup: function() {
+			beforeEach: function() {
 				$.ui.accordion.prototype.options.animate = false;
 			},
-			teardown: function() {
+			afterEach: function() {
 				$.ui.accordion.prototype.options.animate = animate;
+				return helper.moduleAfterEach.apply( this, arguments );
 			}
 		};
 	},

tests/unit/accordion/methods.js

@@ -6,10 +6,10 @@ define( [
 ], function( QUnit, $, testHelper ) {
 
 var equalHeight = testHelper.equalHeight,
-	setupTeardown = testHelper.setupTeardown,
+	beforeAfterEach = testHelper.beforeAfterEach,
 	state = testHelper.state;
 
-QUnit.module( "accordion: methods", setupTeardown() );
+QUnit.module( "accordion: methods", beforeAfterEach() );
 
 QUnit.test( "destroy", function( assert ) {
 	assert.expect( 1 );

tests/unit/accordion/options.js

@@ -6,10 +6,10 @@ define( [
 ], function( QUnit, $, testHelper ) {
 
 var equalHeight = testHelper.equalHeight,
-	setupTeardown = testHelper.setupTeardown,
+	beforeAfterEach = testHelper.beforeAfterEach,
 	state = testHelper.state;
 
-QUnit.module( "accordion: options", setupTeardown() );
+QUnit.module( "accordion: options", beforeAfterEach() );
 
 QUnit.test( "{ active: default }", function( assert ) {
 	assert.expect( 2 );

tests/unit/autocomplete/core.js

@@ -1,10 +1,11 @@
 define( [
 	"qunit",
 	"jquery",
+	"lib/helper",
 	"ui/widgets/autocomplete"
-], function( QUnit, $ ) {
+], function( QUnit, $, helper ) {
 
-QUnit.module( "autocomplete: core" );
+QUnit.module( "autocomplete: core", { afterEach: helper.moduleAfterEach }  );
 
 QUnit.test( "markup structure", function( assert ) {
 	assert.expect( 2 );

tests/unit/autocomplete/events.js

@@ -1,10 +1,11 @@
 define( [
 	"qunit",
 	"jquery",
+	"lib/helper",
 	"ui/widgets/autocomplete"
-], function( QUnit, $ ) {
+], function( QUnit, $, helper ) {
 
-QUnit.module( "autocomplete: events" );
+QUnit.module( "autocomplete: events", { afterEach: helper.moduleAfterEach }  );
 
 var data = [ "Clojure", "COBOL", "ColdFusion", "Java", "JavaScript", "Scala", "Scheme" ];
 

tests/unit/autocomplete/methods.js

@@ -1,10 +1,11 @@
 define( [
 	"qunit",
 	"jquery",
+	"lib/helper",
 	"ui/widgets/autocomplete"
-], function( QUnit, $ ) {
+], function( QUnit, $, helper ) {
 
-QUnit.module( "autocomplete: methods" );
+QUnit.module( "autocomplete: methods", { afterEach: helper.moduleAfterEach }  );
 
 QUnit.test( "destroy", function( assert ) {
 	assert.expect( 1 );