From d4ded43a68fe8038f1178675e749d198f7ef2dea Mon Sep 17 00:00:00 2001
From: Timo Tijhof <krinklemail@gmail.com>
Date: Wed, 5 Feb 2014 12:52:56 -0800
Subject: [PATCH] mediawiki.api.test: Use sinon sandbox for unit tests

Make the unit tests faster and more standalone:

* Don't make a request to the actual API, instead provide the
  response via the fake server and purely test the mw.Api interface.

* No need for promise aggregration since the process is now
  synchronous.

* No arbitrary delays for async or animations etc. as sinon
  artificially fast-forwards setTimeout, Date and others for us.

Also:

* Move assertion for API error handling to separate test.

Change-Id: I20b17f256bc5114c6c2c3185653973076c15bc02
---
 .../mediawiki.api/mediawiki.api.test.js       | 77 ++++++++++++-------
 1 file changed, 50 insertions(+), 27 deletions(-)

diff --git a/tests/qunit/suites/resources/mediawiki.api/mediawiki.api.test.js b/tests/qunit/suites/resources/mediawiki.api/mediawiki.api.test.js
index 9eda75cef5..c903193b98 100644
--- a/tests/qunit/suites/resources/mediawiki.api/mediawiki.api.test.js
+++ b/tests/qunit/suites/resources/mediawiki.api/mediawiki.api.test.js
@@ -1,61 +1,84 @@
 ( function ( mw ) {
-	QUnit.module( 'mediawiki.api', QUnit.newMwEnvironment() );
+	QUnit.module( 'mediawiki.api', QUnit.newMwEnvironment( {
+		setup: function () {
+			this.clock = this.sandbox.useFakeTimers();
+			this.server = this.sandbox.useFakeServer();
+		},
+		teardown: function () {
+			this.clock.tick( 1 );
+		}
+	}) );
 
-	QUnit.asyncTest( 'Basic functionality', function ( assert ) {
-		var api, d1, d2, d3;
-		QUnit.expect( 3 );
+	QUnit.test( 'Basic functionality', function ( assert ) {
+		QUnit.expect( 2 );
 
-		api = new mw.Api();
+		var api = new mw.Api();
 
-		d1 = api.get( {} )
+		api.get( {} )
 			.done( function ( data ) {
 				assert.deepEqual( data, [], 'If request succeeds without errors, resolve deferred' );
 			} );
 
-		d2 = api.get( {
-			action: 'doesntexist'
-		} )
-			.fail( function ( errorCode ) {
-				assert.equal( errorCode, 'unknown_action', 'API error (e.g. "unknown_action") should reject the deferred' );
-			} );
-
-		d3 = api.post( {} )
+		api.post( {} )
 			.done( function ( data ) {
 				assert.deepEqual( data, [], 'Simple POST request' );
 			} );
 
-		// After all are completed, continue the test suite.
-		QUnit.whenPromisesComplete( d1, d2, d3 ).always( function () {
-			QUnit.start();
+		this.server.respond( function ( request ) {
+			request.respond( 200, { 'Content-Type': 'application/json' }, '[]' );
 		} );
 	} );
 
-	QUnit.asyncTest( 'Deprecated callback methods', function ( assert ) {
-		var api, d1, d2, d3;
+
+	QUnit.test( 'API error', function ( assert ) {
+		QUnit.expect( 1 );
+
+		var api = new mw.Api();
+
+		api.get( { action: 'doesntexist' } )
+			.fail( function ( errorCode ) {
+				assert.equal( errorCode, 'unknown_action', 'API error should reject the deferred' );
+			} );
+
+		this.server.respond( function ( request ) {
+			request.respond( 200, { 'Content-Type': 'application/json' },
+				'{ "error": { "code": "unknown_action" } }'
+			);
+		} );
+	} );
+
+	QUnit.test( 'Deprecated callback methods', function ( assert ) {
 		QUnit.expect( 3 );
 
-		api = new mw.Api();
+		var api = new mw.Api();
 
-		d1 = api.get( {}, function () {
+		api.get( {}, function () {
 			assert.ok( true, 'Function argument treated as success callback.' );
 		} );
 
-		d2 = api.get( {}, {
+		api.get( {}, {
 			ok: function () {
 				assert.ok( true, '"ok" property treated as success callback.' );
 			}
 		} );
 
-		d3 = api.get( {
-			action: 'doesntexist'
-		}, {
+		api.get( { action: 'doesntexist' }, {
 			err: function () {
 				assert.ok( true, '"err" property treated as error callback.' );
 			}
 		} );
 
-		QUnit.whenPromisesComplete( d1, d2, d3 ).always( function () {
-			QUnit.start();
+		this.server.respondWith( /action=query/, function ( request ) {
+			request.respond( 200, { 'Content-Type': 'application/json' }, '[]' );
 		} );
+
+		this.server.respondWith( /action=doesntexist/, function ( request ) {
+			request.respond( 200, { 'Content-Type': 'application/json' },
+				'{ "error": { "code": "unknown_action" } }'
+			);
+		} );
+
+		this.server.respond();
 	} );
+
 }( mediaWiki ) );
-- 
2.20.1