1 /*global CompletenessTest, sinon */
3 ( function ( $, mw
, QUnit
, undefined ) {
6 var mwTestIgnore
, mwTester
,
13 * Add bogus to url to prevent IE crazy caching
15 * @param value {String} a relative path (eg. 'data/foo.js'
16 * or 'data/test.php?foo=bar').
17 * @return {String} Such as 'data/foo.js?131031765087663960'
19 QUnit
.fixurl = function ( value
) {
20 return value
+ (/\?/.test( value
) ? '&' : '?')
21 + String( new Date().getTime() )
22 + String( parseInt( Math
.random() * 100000, 10 ) );
29 // When a test() indicates asynchronicity with stop(),
30 // allow 10 seconds to pass before killing the test(),
31 // and assuming failure.
32 QUnit
.config
.testTimeout
= 10 * 1000;
34 // Add a checkbox to QUnit header to toggle MediaWiki ResourceLoader debug mode.
35 QUnit
.config
.urlConfig
.push( {
37 label
: 'Enable ResourceLoaderDebug',
38 tooltip
: 'Enable debug mode in ResourceLoader'
41 QUnit
.config
.requireExpects
= true;
44 * Load TestSwarm agent
46 // Only if the current url indicates that there is a TestSwarm instance watching us
47 // (TestSwarm appends swarmURL to the test suites url it loads in iframes).
48 // Otherwise this is just a simple view of Special:JavaScriptTest/qunit directly,
49 // no point in loading inject.js in that case. Also, make sure that this instance
50 // of MediaWiki has actually been configured with the required url to that inject.js
51 // script. By default it is false.
52 if ( QUnit
.urlParams
.swarmURL
&& mw
.config
.get( 'QUnitTestSwarmInjectJSPath' ) ) {
53 jQuery
.getScript( QUnit
.fixurl( mw
.config
.get( 'QUnitTestSwarmInjectJSPath' ) ) );
59 * Adds toggle checkbox to header
61 QUnit
.config
.urlConfig
.push( {
62 id
: 'completenesstest',
63 label
: 'Run CompletenessTest',
64 tooltip
: 'Run the completeness test'
70 * Glue code for nicer integration with QUnit setup/teardown
71 * Inspired by http://sinonjs.org/releases/sinon-qunit-1.0.0.js
73 * - Work properly with asynchronous QUnit by using module setup/teardown
74 * instead of synchronously wrapping QUnit.test.
76 sinon
.assert
.fail = function ( msg
) {
77 QUnit
.assert
.ok( false, msg
);
79 sinon
.assert
.pass = function ( msg
) {
80 QUnit
.assert
.ok( true, msg
);
85 properties
: ['spy', 'stub', 'mock', 'clock', 'sandbox'],
86 // Don't fake timers by default
91 var orgModule
= QUnit
.module
;
93 QUnit
.module = function ( name
, localEnv
) {
94 localEnv
= localEnv
|| {};
97 var config
= sinon
.getConfig( sinon
.config
);
98 config
.injectInto
= this;
99 sinon
.sandbox
.create( config
);
101 if ( localEnv
.setup
) {
102 localEnv
.setup
.call( this );
105 teardown: function () {
106 this.sandbox
.verifyAndRestore();
108 if ( localEnv
.teardown
) {
109 localEnv
.teardown
.call( this );
116 // Initiate when enabled
117 if ( QUnit
.urlParams
.completenesstest
) {
119 // Return true to ignore
120 mwTestIgnore = function ( val
, tester
) {
122 // Don't record methods of the properties of constructors,
123 // to avoid getting into a loop (prototype.constructor.prototype..).
124 // Since we're therefor skipping any injection for
125 // "new mw.Foo()", manually set it to true here.
126 if ( val
instanceof mw
.Map
) {
127 tester
.methodCallTracker
.Map
= true;
130 if ( val
instanceof mw
.Title
) {
131 tester
.methodCallTracker
.Title
= true;
135 // Don't record methods of the properties of a jQuery object
136 if ( val
instanceof $ ) {
143 mwTester
= new CompletenessTest( mw
, mwTestIgnore
);
147 * Test environment recommended for all QUnit test modules
149 * Whether to log environment changes to the console
151 QUnit
.config
.urlConfig
.push( 'mwlogenv' );
154 * Reset mw.config and others to a fresh copy of the live config for each test(),
155 * and restore it back to the live one afterwards.
156 * @param localEnv {Object} [optional]
157 * @example (see test suite at the bottom of this file)
160 QUnit
.newMwEnvironment
= ( function () {
161 var log
, liveConfig
, liveMessages
;
163 liveConfig
= mw
.config
.values
;
164 liveMessages
= mw
.messages
.values
;
166 function freshConfigCopy( custom
) {
167 // Tests should mock all factors that directly influence the tested code.
168 // For backwards compatibility though we set mw.config to a copy of the live config
169 // and extend it with the (optionally) given custom settings for this test
170 // (instead of starting blank with only the given custmo settings).
171 // This is a shallow copy, so we don't end up with settings taking an array value
172 // extended with the custom settings - setting a config property means you override it,
174 return $.extend( {}, liveConfig
, custom
);
177 function freshMessagesCopy( custom
) {
178 return $.extend( /*deep=*/true, {}, liveMessages
, custom
);
181 log
= QUnit
.urlParams
.mwlogenv
? mw
.log : function () {};
183 return function ( localEnv
) {
184 localEnv
= $.extend( {
195 log( 'MwEnvironment> SETUP for "' + QUnit
.config
.current
.module
196 + ': ' + QUnit
.config
.current
.testName
+ '"' );
198 // Greetings, mock environment!
199 mw
.config
.values
= freshConfigCopy( localEnv
.config
);
200 mw
.messages
.values
= freshMessagesCopy( localEnv
.messages
);
202 localEnv
.setup
.call( this );
205 teardown: function () {
206 log( 'MwEnvironment> TEARDOWN for "' + QUnit
.config
.current
.module
207 + ': ' + QUnit
.config
.current
.testName
+ '"' );
209 localEnv
.teardown
.call( this );
211 // Farewell, mock environment!
212 mw
.config
.values
= liveConfig
;
213 mw
.messages
.values
= liveMessages
;
219 // $.when stops as soon as one fails, which makes sense in most
220 // practical scenarios, but not in a unit test where we really do
221 // need to wait until all of them are finished.
222 QUnit
.whenPromisesComplete = function () {
223 var altPromises
= [];
225 $.each( arguments
, function ( i
, arg
) {
226 var alt
= $.Deferred();
227 altPromises
.push( alt
);
229 // Whether this one fails or not, forwards it to
230 // the 'done' (resolve) callback of the alternative promise.
231 arg
.always( alt
.resolve
);
234 return $.when
.apply( $, altPromises
);
238 * Recursively convert a node to a plain object representing its structure.
239 * Only considers attributes and contents (elements and text nodes).
240 * Attribute values are compared strictly and not normalised.
243 * @return {Object|string} Plain JavaScript value representing the node.
245 function getDomStructure( node
) {
246 var $node
, children
, processedChildren
, i
, len
, el
;
248 if ( node
.nodeType
=== ELEMENT_NODE
) {
249 children
= $node
.contents();
250 processedChildren
= [];
251 for ( i
= 0, len
= children
.length
; i
< len
; i
++ ) {
253 if ( el
.nodeType
=== ELEMENT_NODE
|| el
.nodeType
=== TEXT_NODE
) {
254 processedChildren
.push( getDomStructure( el
) );
259 tagName
: node
.tagName
,
260 attributes
: $node
.getAttrs(),
261 contents
: processedChildren
264 // Should be text node
270 * Gets structure of node for this HTML.
272 * @param {string} html HTML markup for one or more nodes.
274 function getHtmlStructure( html
) {
275 var el
= $( '<div>' ).append( html
)[0];
276 return getDomStructure( el
);
280 * Add-on assertion helpers
282 // Define the add-ons
285 // Expect boolean true
286 assertTrue: function ( actual
, message
) {
287 QUnit
.push( actual
=== true, actual
, true, message
);
290 // Expect boolean false
291 assertFalse: function ( actual
, message
) {
292 QUnit
.push( actual
=== false, actual
, false, message
);
295 // Expect numerical value less than X
296 lt: function ( actual
, expected
, message
) {
297 QUnit
.push( actual
< expected
, actual
, 'less than ' + expected
, message
);
300 // Expect numerical value less than or equal to X
301 ltOrEq: function ( actual
, expected
, message
) {
302 QUnit
.push( actual
<= expected
, actual
, 'less than or equal to ' + expected
, message
);
305 // Expect numerical value greater than X
306 gt: function ( actual
, expected
, message
) {
307 QUnit
.push( actual
> expected
, actual
, 'greater than ' + expected
, message
);
310 // Expect numerical value greater than or equal to X
311 gtOrEq: function ( actual
, expected
, message
) {
312 QUnit
.push( actual
>= expected
, actual
, 'greater than or equal to ' + expected
, message
);
316 * Asserts that two HTML strings are structurally equivalent.
318 * @param {string} actualHtml Actual HTML markup.
319 * @param {string} expectedHtml Expected HTML markup
320 * @param {string} message Assertion message.
322 htmlEqual: function ( actualHtml
, expectedHtml
, message
) {
323 var actual
= getHtmlStructure( actualHtml
),
324 expected
= getHtmlStructure( expectedHtml
);
338 * Asserts that two HTML strings are not structurally equivalent.
340 * @param {string} actualHtml Actual HTML markup.
341 * @param {string} expectedHtml Expected HTML markup.
342 * @param {string} message Assertion message.
344 notHtmlEqual: function ( actualHtml
, expectedHtml
, message
) {
345 var actual
= getHtmlStructure( actualHtml
),
346 expected
= getHtmlStructure( expectedHtml
);
360 $.extend( QUnit
.assert
, addons
);
363 * Small test suite to confirm proper functionality of the utilities and
364 * initializations defined above in this file.
367 QUnit
.module( 'test.mediawiki.qunit.testrunner', QUnit
.newMwEnvironment( {
370 this.mwHtmlLive
= mw
.html
;
372 escape: function () {
373 return 'mocked-' + envExecCount
;
377 teardown: function () {
378 mw
.html
= this.mwHtmlLive
;
388 QUnit
.test( 'Setup', 3, function ( assert
) {
389 assert
.equal( mw
.html
.escape( 'foo' ), 'mocked-1', 'extra setup() callback was ran.' );
390 assert
.equal( mw
.config
.get( 'testVar' ), 'foo', 'config object applied' );
391 assert
.equal( mw
.messages
.get( 'testMsg' ), 'Foo.', 'messages object applied' );
393 mw
.config
.set( 'testVar', 'bar' );
394 mw
.messages
.set( 'testMsg', 'Bar.' );
397 QUnit
.test( 'Teardown', 3, function ( assert
) {
398 assert
.equal( mw
.html
.escape( 'foo' ), 'mocked-2', 'extra setup() callback was re-ran.' );
399 assert
.equal( mw
.config
.get( 'testVar' ), 'foo', 'config object restored and re-applied after test()' );
400 assert
.equal( mw
.messages
.get( 'testMsg' ), 'Foo.', 'messages object restored and re-applied after test()' );
403 QUnit
.test( 'Loader status', 2, function ( assert
) {
405 modules
= mw
.loader
.getModuleNames(),
409 for ( i
= 0, len
= modules
.length
; i
< len
; i
++ ) {
410 state
= mw
.loader
.getState( modules
[i
] );
411 if ( state
=== 'error' ) {
412 error
.push( modules
[i
] );
413 } else if ( state
=== 'missing' ) {
414 missing
.push( modules
[i
] );
418 assert
.deepEqual( error
, [], 'Modules in error state' );
419 assert
.deepEqual( missing
, [], 'Modules in missing state' );
422 QUnit
.test( 'htmlEqual', 8, function ( assert
) {
424 '<div><p class="some classes" data-length="10">Child paragraph with <a href="http://example.com">A link</a></p>Regular text<span>A span</span></div>',
425 '<div><p data-length=\'10\' class=\'some classes\'>Child paragraph with <a href=\'http://example.com\' >A link</a></p>Regular text<span>A span</span></div>',
426 'Attribute order, spacing and quotation marks (equal)'
430 '<div><p class="some classes" data-length="10">Child paragraph with <a href="http://example.com">A link</a></p>Regular text<span>A span</span></div>',
431 '<div><p data-length=\'10\' class=\'some more classes\'>Child paragraph with <a href=\'http://example.com\' >A link</a></p>Regular text<span>A span</span></div>',
432 'Attribute order, spacing and quotation marks (not equal)'
436 '<label for="firstname" accesskey="f" class="important">First</label><input id="firstname" /><label for="lastname" accesskey="l" class="minor">Last</label><input id="lastname" />',
437 '<label for="firstname" accesskey="f" class="important">First</label><input id="firstname" /><label for="lastname" accesskey="l" class="minor">Last</label><input id="lastname" />',
438 'Multiple root nodes (equal)'
442 '<label for="firstname" accesskey="f" class="important">First</label><input id="firstname" /><label for="lastname" accesskey="l" class="minor">Last</label><input id="lastname" />',
443 '<label for="firstname" accesskey="f" class="important">First</label><input id="firstname" /><label for="lastname" accesskey="l" class="important" >Last</label><input id="lastname" />',
444 'Multiple root nodes (not equal, last label node is different)'
448 'fo"o<br/>b>ar',
450 'Extra escaping is equal'
455 'Text escaping (not equal)'
459 'foo<a href="http://example.com">example</a>bar',
460 'foo<a href="http://example.com">example</a>bar',
461 'Outer text nodes are compared (equal)'
465 'foo<a href="http://example.com">example</a>bar',
466 'foo<a href="http://example.com">example</a>quux',
467 'Outer text nodes are compared (last text node different)'
472 QUnit
.module( 'test.mediawiki.qunit.testrunner-after', QUnit
.newMwEnvironment() );
474 QUnit
.test( 'Teardown', 3, function ( assert
) {
475 assert
.equal( mw
.html
.escape( '<' ), '<', 'extra teardown() callback was ran.' );
476 assert
.equal( mw
.config
.get( 'testVar' ), null, 'config object restored to live in next module()' );
477 assert
.equal( mw
.messages
.get( 'testMsg' ), null, 'messages object restored to live in next module()' );
480 }( jQuery
, mediaWiki
, QUnit
) );