# HG changeset patch
# User Rémi Cardona <remi.cardona@logilab.fr>
# Date 1432131448 -7200
# Node ID 2b1ea3e8e080471823c586033d5833af05244adc
# Parent  98ea2b865210676eb7dda11d8ebdb4709f1c5adb
[devtools] qunit: use new async testing APIs

http://qunitjs.com/cookbook/#asynchronous-callbacks

QUnit keeps track of all the assert.async() objects created inside the
test functions and expects all done() functions to be called. Failure to
do so will result in the test being failed.

Unlike .start and .stop which were internal APIs, assert.async() is
stricter and fails tests if assert methods are used *after* all done()
functions are called (see "test callback execution order").

Related to #5533333.

diff -r 98ea2b865210 -r 2b1ea3e8e080 web/test/jstests/test_ajax.js
--- a/web/test/jstests/test_ajax.js	Wed May 20 15:45:43 2015 +0200
+++ b/web/test/jstests/test_ajax.js	Wed May 20 16:17:28 2015 +0200
@@ -25,14 +25,14 @@
     QUnit.test('test simple h1 inclusion (ajax_url0.html)', function (assert) {
         assert.expect(3);
         assert.equal(jQuery('#qunit-fixture').children().length, 0);
-        stop();
+        var done = assert.async();
         jQuery('#qunit-fixture').loadxhtml(BASE_URL + 'cwsoftwareroot/web/test/jstests/ajax_url0.html')
         .addCallback(function() {
                 try {
                     assert.equal(jQuery('#qunit-fixture').children().length, 1);
                     assert.equal(jQuery('#qunit-fixture h1').html(), 'Hello');
                 } finally {
-                    start();
+                    done();
                 };
             }
         );
@@ -42,7 +42,7 @@
         assert.expect(6);
         var scriptsIncluded = jsSources();
         assert.equal(jQuery.inArray('http://foo.js', scriptsIncluded), - 1);
-        stop();
+        var done = assert.async();
         jQuery('#qunit-fixture').loadxhtml(BASE_URL + 'cwsoftwareroot/web/test/jstests/ajax_url1.html')
         .addCallback(function() {
                 try {
@@ -56,7 +56,7 @@
                     assert.equal(jQuery('div.ajaxHtmlHead').length, 0);
                     assert.equal(jQuery('#qunit-fixture h1').html(), 'Hello');
                 } finally {
-                    start();
+                    done();
                 };
             }
         );
@@ -65,14 +65,14 @@
     QUnit.test('test addCallback', function (assert) {
         assert.expect(3);
         assert.equal(jQuery('#qunit-fixture').children().length, 0);
-        stop();
+        var done = assert.async();
         var d = jQuery('#qunit-fixture').loadxhtml(BASE_URL + 'cwsoftwareroot/web/test/jstests/ajax_url0.html');
         d.addCallback(function() {
             try {
                 assert.equal(jQuery('#qunit-fixture').children().length, 1);
                 assert.equal(jQuery('#qunit-fixture h1').html(), 'Hello');
             } finally {
-                start();
+                done();
             };
         });
     });
@@ -90,13 +90,13 @@
                 deferred.success(data);
             }
         });
-        stop();
+        var done = assert.async();
         deferred.addCallback(function() {
             try {
                 // add an assertion to ensure the callback is executed
                 assert.ok(true, "callback is executed");
             } finally {
-                start();
+                done();
             };
         });
     });
@@ -104,14 +104,14 @@
     QUnit.test('test addCallback with parameters', function (assert) {
         assert.expect(3);
         assert.equal(jQuery('#qunit-fixture').children().length, 0);
-        stop();
+        var done = assert.async();
         var d = jQuery('#qunit-fixture').loadxhtml(BASE_URL + 'cwsoftwareroot/web/test/jstests/ajax_url0.html');
         d.addCallback(function(data, req, arg1, arg2) {
             try {
                 assert.equal(arg1, 'Hello');
                 assert.equal(arg2, 'world');
             } finally {
-                start();
+                done();
             };
         },
         'Hello', 'world');
@@ -127,7 +127,7 @@
                 assert.equal(arg1, 'Hello');
                 assert.equal(arg2, 'world');
             } finally {
-                start();
+                done();
             };
         },
         'Hello', 'world');
@@ -136,10 +136,10 @@
             try {
                 throw this._error;
             } finally {
-                start();
+                done();
             };
         });
-        stop();
+        var done = assert.async();
         var result = jQuery.ajax({
             url: BASE_URL + 'cwsoftwareroot/web/test/jstests/ajax_url0.html',
             async: false,
@@ -154,7 +154,7 @@
 
   QUnit.test('test addErrback', function (assert) {
         assert.expect(1);
-        stop();
+        var done = assert.async();
         var d = jQuery('#qunit-fixture').loadxhtml(BASE_URL + 'cwsoftwareroot/web/test/jstests/nonexistent.html');
         d.addCallback(function() {
             // should not be executed
@@ -164,7 +164,7 @@
             try {
                 assert.ok(true, "errback is executed");
             } finally {
-                start();
+                done();
             };
         });
     });
@@ -172,21 +172,20 @@
     QUnit.test('test callback execution order', function (assert) {
         assert.expect(3);
         var counter = 0;
-        stop();
+        var done = assert.async();
         var d = jQuery('#qunit-fixture').loadxhtml(BASE_URL + 'cwsoftwareroot/web/test/jstests/ajax_url0.html');
         d.addCallback(function() {
-                try {
-                    assert.equal(++counter, 1); // should be executed first
-                } finally {
-                    start();
-                };
-            }
-        );
+            assert.equal(++counter, 1); // should be executed first
+        });
         d.addCallback(function() {
             assert.equal(++counter, 2);
         });
         d.addCallback(function() {
-            assert.equal(++counter, 3);
+            try {
+                assert.equal(++counter, 3);
+            } finally {
+                done();
+            }
         });
     });
 
@@ -198,7 +197,7 @@
         assert.equal(jQuery('head link').length, 1);
         /* use endswith because in pytest context we have an absolute path */
         assert.ok(jQuery('head link').attr('href').endswith('/qunit.css'), 'qunit.css is loaded');
-        stop();
+        var done = assert.async();
         jQuery('#qunit-fixture').loadxhtml(BASE_URL + 'cwsoftwareroot/web/test/jstests/ajax_url1.html')
         .addCallback(function() {
                 var origLength = scriptsIncluded.length;
@@ -216,7 +215,7 @@
                     /* use endswith because in pytest context we have an absolute path */
                     assert.ok(jQuery('head link').attr('href').endswith('/qunit.css'), 'qunit.css is loaded');
                 } finally {
-                    start();
+                    done();
                 }
             }
         );
@@ -230,7 +229,7 @@
 
     QUnit.test('test event on CubicWeb', function (assert) {
         assert.expect(1);
-        stop();
+        var done = assert.async();
         var events = null;
         jQuery(CubicWeb).bind('server-response', function() {
             // check that server-response event on CubicWeb is triggered
@@ -241,7 +240,7 @@
                 try {
                     assert.equal(events, 'CubicWeb');
                 } finally {
-                    start();
+                    done();
                 };
             }
         );
@@ -249,7 +248,7 @@
 
     QUnit.test('test event on node', function (assert) {
         assert.expect(3);
-        stop();
+        var done = assert.async();
         var nodes = [];
         jQuery('#qunit-fixture').bind('server-response', function() {
             nodes.push('node');
@@ -266,7 +265,7 @@
                     assert.equal(nodes[0], 'CubicWeb');
                     assert.equal(nodes[1], 'node');
                 } finally {
-                    start();
+                    done();
                 };
             }
         );