Merge "Code style cleanups to parserTest.inc and NewParserTest.php."
[lhc/web/wiklou.git] / tests / qunit / suites / resources / mediawiki / mediawiki.test.js
1 ( function ( mw, $ ) {
2 var specialCharactersPageName;
3
4 // Since QUnitTestResources.php loads both mediawiki and mediawiki.jqueryMsg as
5 // dependencies, this only tests the monkey-patched behavior with the two of them combined.
6
7 // See mediawiki.jqueryMsg.test.js for unit tests for jqueryMsg-specific functionality.
8
9 QUnit.module( 'mediawiki', QUnit.newMwEnvironment( {
10 setup: function () {
11 // Messages used in multiple tests
12 mw.messages.set( {
13 'other-message': 'Other Message',
14 'mediawiki-test-pagetriage-del-talk-page-notify-summary': 'Notifying author of deletion nomination for [[$1]]',
15 'gender-plural-msg': '{{GENDER:$1|he|she|they}} {{PLURAL:$2|is|are}} awesome',
16 'grammar-msg': 'Przeszukaj {{GRAMMAR:grammar_case_foo|{{SITENAME}}}}',
17 'formatnum-msg': '{{formatnum:$1}}',
18 'int-msg': 'Some {{int:other-message}}',
19 'mediawiki-test-version-entrypoints-index-php': '[https://www.mediawiki.org/wiki/Manual:index.php index.php]',
20 'external-link-replace': 'Foo [$1 bar]'
21 } );
22
23 mw.config.set( {
24 wgArticlePath: '/wiki/$1',
25
26 // For formatnum tests
27 wgUserLanguage: 'en'
28 } );
29
30 specialCharactersPageName = '"Who" wants to be a millionaire & live on \'Exotic Island\'?';
31 }
32 } ) );
33
34 QUnit.test( 'Initial check', 8, function ( assert ) {
35 assert.ok( window.jQuery, 'jQuery defined' );
36 assert.ok( window.$, '$j defined' );
37 assert.ok( window.$j, '$j defined' );
38 assert.strictEqual( window.$, window.jQuery, '$ alias to jQuery' );
39 assert.strictEqual( window.$j, window.jQuery, '$j alias to jQuery' );
40
41 assert.ok( window.mediaWiki, 'mediaWiki defined' );
42 assert.ok( window.mw, 'mw defined' );
43 assert.strictEqual( window.mw, window.mediaWiki, 'mw alias to mediaWiki' );
44 } );
45
46 QUnit.test( 'mw.Map', 27, function ( assert ) {
47 var arry, conf, funky, globalConf, nummy, someValues;
48
49 conf = new mw.Map();
50 // Dummy variables
51 funky = function () {};
52 arry = [];
53 nummy = 7;
54
55 // Single get and set
56
57 assert.strictEqual( conf.set( 'foo', 'Bar' ), true, 'Map.set returns boolean true if a value was set for a valid key string' );
58 assert.equal( conf.get( 'foo' ), 'Bar', 'Map.get returns a single value value correctly' );
59
60 assert.strictEqual( conf.get( 'example' ), null, 'Map.get returns null if selection was a string and the key was not found' );
61 assert.strictEqual( conf.get( 'example', arry ), arry, 'Map.get returns fallback by reference if the key was not found' );
62 assert.strictEqual( conf.get( 'example', undefined ), undefined, 'Map.get supports `undefined` as fallback instead of `null`' );
63
64 assert.strictEqual( conf.get( 'constructor' ), null, 'Map.get does not look at Object.prototype of internal storage (constructor)' );
65 assert.strictEqual( conf.get( 'hasOwnProperty' ), null, 'Map.get does not look at Object.prototype of internal storage (hasOwnProperty)' );
66
67 conf.set( 'hasOwnProperty', function () { return true; } );
68 assert.strictEqual( conf.get( 'example', 'missing' ), 'missing', 'Map.get uses neutral hasOwnProperty method (positive)' );
69
70 conf.set( 'example', 'Foo' );
71 conf.set( 'hasOwnProperty', function () { return false; } );
72 assert.strictEqual( conf.get( 'example' ), 'Foo', 'Map.get uses neutral hasOwnProperty method (negative)' );
73
74 assert.strictEqual( conf.set( 'constructor', 42 ), true, 'Map.set for key "constructor"' );
75 assert.strictEqual( conf.get( 'constructor' ), 42, 'Map.get for key "constructor"' );
76
77 assert.strictEqual( conf.set( 'ImUndefined', undefined ), true, 'Map.set allows setting value to `undefined`' );
78 assert.equal( conf.get( 'ImUndefined', 'fallback' ), undefined , 'Map.get supports retreiving value of `undefined`' );
79
80 assert.strictEqual( conf.set( funky, 'Funky' ), false, 'Map.set returns boolean false if key was invalid (Function)' );
81 assert.strictEqual( conf.set( arry, 'Arry' ), false, 'Map.set returns boolean false if key was invalid (Array)' );
82 assert.strictEqual( conf.set( nummy, 'Nummy' ), false, 'Map.set returns boolean false if key was invalid (Number)' );
83
84 assert.strictEqual( conf.get( funky ), null, 'Map.get ruturns null if selection was invalid (Function)' );
85 assert.strictEqual( conf.get( nummy ), null, 'Map.get ruturns null if selection was invalid (Number)' );
86
87 conf.set( String( nummy ), 'I used to be a number' );
88
89 assert.strictEqual( conf.exists( 'doesNotExist' ), false, 'Map.exists where property does not exist' );
90 assert.strictEqual( conf.exists( 'ImUndefined' ), true, 'Map.exists where value is `undefined`' );
91 assert.strictEqual( conf.exists( nummy ), false, 'Map.exists where key is invalid but looks like an existing key' );
92
93 // Multiple values at once
94 someValues = {
95 'foo': 'bar',
96 'lorem': 'ipsum',
97 'MediaWiki': true
98 };
99 assert.strictEqual( conf.set( someValues ), true, 'Map.set returns boolean true if multiple values were set by passing an object' );
100 assert.deepEqual( conf.get( ['foo', 'lorem'] ), {
101 'foo': 'bar',
102 'lorem': 'ipsum'
103 }, 'Map.get returns multiple values correctly as an object' );
104
105 assert.deepEqual( conf.get( ['foo', 'notExist'] ), {
106 'foo': 'bar',
107 'notExist': null
108 }, 'Map.get return includes keys that were not found as null values' );
109
110
111 // Interacting with globals and accessing the values object
112 assert.strictEqual( conf.get(), conf.values, 'Map.get returns the entire values object by reference (if called without arguments)' );
113
114 conf.set( 'globalMapChecker', 'Hi' );
115
116 assert.ok( 'globalMapChecker' in window === false, 'new mw.Map did not store its values in the global window object by default' );
117
118 globalConf = new mw.Map( true );
119 globalConf.set( 'anotherGlobalMapChecker', 'Hello' );
120
121 assert.ok( 'anotherGlobalMapChecker' in window, 'new mw.Map( true ) did store its values in the global window object' );
122
123 // Whitelist this global variable for QUnit's 'noglobal' mode
124 if ( QUnit.config.noglobals ) {
125 QUnit.config.pollution.push( 'anotherGlobalMapChecker' );
126 }
127 } );
128
129 QUnit.test( 'mw.config', 1, function ( assert ) {
130 assert.ok( mw.config instanceof mw.Map, 'mw.config instance of mw.Map' );
131 } );
132
133 QUnit.test( 'mw.message & mw.messages', 100, function ( assert ) {
134 var goodbye, hello;
135
136 // Convenience method for asserting the same result for multiple formats
137 function assertMultipleFormats( messageArguments, formats, expectedResult, assertMessage ) {
138 var len = formats.length, format, i;
139 for ( i = 0; i < len; i++ ) {
140 format = formats[i];
141 assert.equal( mw.message.apply( null, messageArguments )[format](), expectedResult, assertMessage + ' when format is ' + format );
142 }
143 }
144
145 assert.ok( mw.messages, 'messages defined' );
146 assert.ok( mw.messages instanceof mw.Map, 'mw.messages instance of mw.Map' );
147 assert.ok( mw.messages.set( 'hello', 'Hello <b>awesome</b> world' ), 'mw.messages.set: Register' );
148
149 hello = mw.message( 'hello' );
150
151 // https://bugzilla.wikimedia.org/show_bug.cgi?id=44459
152 assert.equal( hello.format, 'text', 'Message property "format" defaults to "text"' );
153
154 assert.strictEqual( hello.map, mw.messages, 'Message property "map" defaults to the global instance in mw.messages' );
155 assert.equal( hello.key, 'hello', 'Message property "key" (currect key)' );
156 assert.deepEqual( hello.parameters, [], 'Message property "parameters" defaults to an empty array' );
157
158 // Todo
159 assert.ok( hello.params, 'Message prototype "params"' );
160
161 hello.format = 'plain';
162 assert.equal( hello.toString(), 'Hello <b>awesome</b> world', 'Message.toString returns the message as a string with the current "format"' );
163
164 assert.equal( hello.escaped(), 'Hello &lt;b&gt;awesome&lt;/b&gt; world', 'Message.escaped returns the escaped message' );
165 assert.equal( hello.format, 'escaped', 'Message.escaped correctly updated the "format" property' );
166
167 assert.ok( mw.messages.set( 'multiple-curly-brace', '"{{SITENAME}}" is the home of {{int:other-message}}' ), 'mw.messages.set: Register' );
168 assertMultipleFormats( ['multiple-curly-brace'], ['text', 'parse'], '"' + mw.config.get( 'wgSiteName') + '" is the home of Other Message', 'Curly brace format works correctly' );
169 assert.equal( mw.message( 'multiple-curly-brace' ).plain(), mw.messages.get( 'multiple-curly-brace' ), 'Plain format works correctly for curly brace message' );
170 assert.equal( mw.message( 'multiple-curly-brace' ).escaped(), mw.html.escape( '"' + mw.config.get( 'wgSiteName') + '" is the home of Other Message' ), 'Escaped format works correctly for curly brace message' );
171
172 assert.ok( mw.messages.set( 'multiple-square-brackets-and-ampersand', 'Visit the [[Project:Community portal|community portal]] & [[Project:Help desk|help desk]]' ), 'mw.messages.set: Register' );
173 assertMultipleFormats( ['multiple-square-brackets-and-ampersand'], ['plain', 'text'], mw.messages.get( 'multiple-square-brackets-and-ampersand' ), 'Square bracket message is not processed' );
174 assert.equal( mw.message( 'multiple-square-brackets-and-ampersand' ).escaped(), 'Visit the [[Project:Community portal|community portal]] &amp; [[Project:Help desk|help desk]]', 'Escaped format works correctly for square bracket message' );
175 assert.htmlEqual( mw.message( 'multiple-square-brackets-and-ampersand' ).parse(), 'Visit the ' +
176 '<a title="Project:Community portal" href="/wiki/Project:Community_portal">community portal</a>' +
177 ' &amp; <a title="Project:Help desk" href="/wiki/Project:Help_desk">help desk</a>', 'Internal links work with parse' );
178
179 assertMultipleFormats( ['mediawiki-test-version-entrypoints-index-php'], ['plain', 'text', 'escaped'], mw.messages.get( 'mediawiki-test-version-entrypoints-index-php' ), 'External link markup is unprocessed' );
180 assert.htmlEqual( mw.message( 'mediawiki-test-version-entrypoints-index-php' ).parse(), '<a href="https://www.mediawiki.org/wiki/Manual:index.php">index.php</a>', 'External link works correctly in parse mode' );
181
182 assertMultipleFormats( ['external-link-replace', 'http://example.org/?x=y&z'], ['plain', 'text'] , 'Foo [http://example.org/?x=y&z bar]', 'Parameters are substituted but external link is not processed' );
183 assert.equal( mw.message( 'external-link-replace', 'http://example.org/?x=y&z' ).escaped(), 'Foo [http://example.org/?x=y&amp;z bar]', 'In escaped mode, parameters are substituted and ampersand is escaped, but external link is not processed' );
184 assert.htmlEqual( mw.message( 'external-link-replace', 'http://example.org/?x=y&z' ).parse(), 'Foo <a href="http://example.org/?x=y&amp;z">bar</a>', 'External link with replacement works in parse mode without double-escaping' );
185
186 hello.parse();
187 assert.equal( hello.format, 'parse', 'Message.parse correctly updated the "format" property' );
188
189 hello.plain();
190 assert.equal( hello.format, 'plain', 'Message.plain correctly updated the "format" property' );
191
192 hello.text();
193 assert.equal( hello.format, 'text', 'Message.text correctly updated the "format" property' );
194
195 assert.strictEqual( hello.exists(), true, 'Message.exists returns true for existing messages' );
196
197 goodbye = mw.message( 'goodbye' );
198 assert.strictEqual( goodbye.exists(), false, 'Message.exists returns false for nonexistent messages' );
199
200 assertMultipleFormats( ['goodbye'], ['plain', 'text'], '<goodbye>', 'Message.toString returns <key> if key does not exist' );
201 // bug 30684
202 assertMultipleFormats( ['goodbye'], ['parse', 'escaped'], '&lt;goodbye&gt;', 'Message.toString returns properly escaped &lt;key&gt; if key does not exist' );
203
204 assert.ok( mw.messages.set( 'plural-test-msg', 'There {{PLURAL:$1|is|are}} $1 {{PLURAL:$1|result|results}}' ), 'mw.messages.set: Register' );
205 assertMultipleFormats( ['plural-test-msg', 6], ['text', 'parse', 'escaped'], 'There are 6 results', 'plural get resolved' );
206 assert.equal( mw.message( 'plural-test-msg', 6 ).plain(), 'There {{PLURAL:6|is|are}} 6 {{PLURAL:6|result|results}}', 'Parameter is substituted but plural is not resolved in plain' );
207
208 assert.ok( mw.messages.set( 'plural-test-msg-explicit', 'There {{plural:$1|is one car|are $1 cars|0=are no cars|12=are a dozen cars}}' ), 'mw.messages.set: Register message with explicit plural forms' );
209 assertMultipleFormats( ['plural-test-msg-explicit', 12], ['text', 'parse', 'escaped'], 'There are a dozen cars', 'explicit plural get resolved' );
210
211 assert.ok( mw.messages.set( 'plural-test-msg-explicit-beginning', 'Basket has {{plural:$1|0=no eggs|12=a dozen eggs|6=half a dozen eggs|one egg|$1 eggs}}' ), 'mw.messages.set: Register message with explicit plural forms' );
212 assertMultipleFormats( ['plural-test-msg-explicit-beginning', 1], ['text', 'parse', 'escaped'], 'Basket has one egg', 'explicit plural given at beginning get resolved for singular' );
213 assertMultipleFormats( ['plural-test-msg-explicit-beginning', 4], ['text', 'parse', 'escaped'], 'Basket has 4 eggs', 'explicit plural given at beginning get resolved for plural' );
214 assertMultipleFormats( ['plural-test-msg-explicit-beginning', 6], ['text', 'parse', 'escaped'], 'Basket has half a dozen eggs', 'explicit plural given at beginning get resolved for 6' );
215 assertMultipleFormats( ['plural-test-msg-explicit-beginning', 0], ['text', 'parse', 'escaped'], 'Basket has no eggs', 'explicit plural given at beginning get resolved for 0' );
216
217
218 assertMultipleFormats( ['mediawiki-test-pagetriage-del-talk-page-notify-summary'], ['plain', 'text'], mw.messages.get( 'mediawiki-test-pagetriage-del-talk-page-notify-summary' ), 'Double square brackets with no parameters unchanged' );
219
220 assertMultipleFormats( ['mediawiki-test-pagetriage-del-talk-page-notify-summary', specialCharactersPageName], ['plain', 'text'], 'Notifying author of deletion nomination for [[' + specialCharactersPageName + ']]', 'Double square brackets with one parameter' );
221
222 assert.equal( mw.message( 'mediawiki-test-pagetriage-del-talk-page-notify-summary', specialCharactersPageName ).escaped(), 'Notifying author of deletion nomination for [[' + mw.html.escape( specialCharactersPageName ) + ']]', 'Double square brackets with one parameter, when escaped' );
223
224
225 assert.ok( mw.messages.set( 'mediawiki-test-categorytree-collapse-bullet', '[<b>−</b>]' ), 'mw.messages.set: Register' );
226 assert.equal( mw.message( 'mediawiki-test-categorytree-collapse-bullet' ).plain(), mw.messages.get( 'mediawiki-test-categorytree-collapse-bullet' ), 'Single square brackets unchanged in plain mode' );
227
228 assert.ok( mw.messages.set( 'mediawiki-test-wikieditor-toolbar-help-content-signature-result', '<a href=\'#\' title=\'{{#special:mypage}}\'>Username</a> (<a href=\'#\' title=\'{{#special:mytalk}}\'>talk</a>)' ), 'mw.messages.set: Register' );
229 assert.equal( mw.message( 'mediawiki-test-wikieditor-toolbar-help-content-signature-result' ).plain(), mw.messages.get( 'mediawiki-test-wikieditor-toolbar-help-content-signature-result' ), 'HTML message with curly braces is not changed in plain mode' );
230
231 assertMultipleFormats( ['gender-plural-msg', 'male', 1], ['text', 'parse', 'escaped'], 'he is awesome', 'Gender and plural are resolved' );
232 assert.equal( mw.message( 'gender-plural-msg', 'male', 1 ).plain(), '{{GENDER:male|he|she|they}} {{PLURAL:1|is|are}} awesome', 'Parameters are substituted, but gender and plural are not resolved in plain mode' );
233
234 assert.equal( mw.message( 'grammar-msg' ).plain(), mw.messages.get( 'grammar-msg' ), 'Grammar is not resolved in plain mode' );
235 assertMultipleFormats( ['grammar-msg'], ['text', 'parse'], 'Przeszukaj ' + mw.config.get( 'wgSiteName' ), 'Grammar is resolved' );
236 assert.equal( mw.message( 'grammar-msg' ).escaped(), 'Przeszukaj ' + mw.html.escape( mw.config.get( 'wgSiteName' ) ), 'Grammar is resolved in escaped mode' );
237
238 assertMultipleFormats( ['formatnum-msg', '987654321.654321'], ['text', 'parse', 'escaped'], '987,654,321.654', 'formatnum is resolved' );
239 assert.equal( mw.message( 'formatnum-msg' ).plain(), mw.messages.get( 'formatnum-msg' ), 'formatnum is not resolved in plain mode' );
240
241 assertMultipleFormats( ['int-msg'], ['text', 'parse', 'escaped'], 'Some Other Message', 'int is resolved' );
242 assert.equal( mw.message( 'int-msg' ).plain(), mw.messages.get( 'int-msg' ), 'int is not resolved in plain mode' );
243
244 assert.ok( mw.messages.set( 'mediawiki-italics-msg', '<i>Very</i> important' ), 'mw.messages.set: Register' );
245 assertMultipleFormats( ['mediawiki-italics-msg'], ['plain', 'text', 'parse'], mw.messages.get( 'mediawiki-italics-msg' ), 'Simple italics unchanged' );
246 assert.htmlEqual(
247 mw.message( 'mediawiki-italics-msg' ).escaped(),
248 '&lt;i&gt;Very&lt;/i&gt; important',
249 'Italics are escaped in escaped mode'
250 );
251
252 assert.ok( mw.messages.set( 'mediawiki-italics-with-link', 'An <i>italicized [[link|wiki-link]]</i>' ), 'mw.messages.set: Register' );
253 assertMultipleFormats( ['mediawiki-italics-with-link'], ['plain', 'text'], mw.messages.get( 'mediawiki-italics-with-link' ), 'Italics with link unchanged' );
254 assert.htmlEqual(
255 mw.message( 'mediawiki-italics-with-link' ).escaped(),
256 'An &lt;i&gt;italicized [[link|wiki-link]]&lt;/i&gt;',
257 'Italics and link unchanged except for escaping in escaped mode'
258 );
259 assert.htmlEqual(
260 mw.message( 'mediawiki-italics-with-link' ).parse(),
261 'An <i>italicized <a title="link" href="' + mw.util.wikiGetlink( 'link' ) + '">wiki-link</i>',
262 'Italics with link inside in parse mode'
263 );
264
265 assert.ok( mw.messages.set( 'mediawiki-script-msg', '<script >alert( "Who put this script here?" );</script>' ), 'mw.messages.set: Register' );
266 assertMultipleFormats( ['mediawiki-script-msg'], ['plain', 'text'], mw.messages.get( 'mediawiki-script-msg' ), 'Script unchanged' );
267 assert.htmlEqual(
268 mw.message( 'mediawiki-script-msg' ).escaped(),
269 '&lt;script &gt;alert( "Who put this script here?" );&lt;/script&gt;',
270 'Script escaped when using escaped format'
271 );
272 assert.htmlEqual(
273 mw.message( 'mediawiki-script-msg' ).parse(),
274 '&lt;script &gt;alert( "Who put this script here?" );&lt;/script&gt;',
275 'Script escaped when using parse format'
276 );
277
278
279 } );
280
281 QUnit.test( 'mw.msg', 14, function ( assert ) {
282 assert.ok( mw.messages.set( 'hello', 'Hello <b>awesome</b> world' ), 'mw.messages.set: Register' );
283 assert.equal( mw.msg( 'hello' ), 'Hello <b>awesome</b> world', 'Gets message with default options (existing message)' );
284 assert.equal( mw.msg( 'goodbye' ), '<goodbye>', 'Gets message with default options (nonexistent message)' );
285
286 assert.ok( mw.messages.set( 'plural-item' , 'Found $1 {{PLURAL:$1|item|items}}' ), 'mw.messages.set: Register' );
287 assert.equal( mw.msg( 'plural-item', 5 ), 'Found 5 items', 'Apply plural for count 5' );
288 assert.equal( mw.msg( 'plural-item', 0 ), 'Found 0 items', 'Apply plural for count 0' );
289 assert.equal( mw.msg( 'plural-item', 1 ), 'Found 1 item', 'Apply plural for count 1' );
290
291 assert.equal( mw.msg( 'mediawiki-test-pagetriage-del-talk-page-notify-summary', specialCharactersPageName ), 'Notifying author of deletion nomination for [[' + specialCharactersPageName + ']]', 'Double square brackets in mw.msg one parameter' );
292
293 assert.equal( mw.msg( 'gender-plural-msg', 'male', 1 ), 'he is awesome', 'Gender test for male, plural count 1' );
294 assert.equal( mw.msg( 'gender-plural-msg', 'female', '1' ), 'she is awesome', 'Gender test for female, plural count 1' );
295 assert.equal( mw.msg( 'gender-plural-msg', 'unknown', 10 ), 'they are awesome', 'Gender test for neutral, plural count 10' );
296
297 assert.equal( mw.msg( 'grammar-msg' ), 'Przeszukaj ' + mw.config.get( 'wgSiteName' ), 'Grammar is resolved' );
298
299 assert.equal( mw.msg( 'formatnum-msg', '987654321.654321' ), '987,654,321.654', 'formatnum is resolved' );
300
301 assert.equal( mw.msg( 'int-msg' ), 'Some Other Message', 'int is resolved' );
302 } );
303
304 /**
305 * The sync style load test (for @import). This is, in a way, also an open bug for
306 * ResourceLoader ("execute js after styles are loaded"), but browsers don't offer a
307 * way to get a callback from when a stylesheet is loaded (that is, including any
308 * @import rules inside). To work around this, we'll have a little time loop to check
309 * if the styles apply.
310 * Note: This test originally used new Image() and onerror to get a callback
311 * when the url is loaded, but that is fragile since it doesn't monitor the
312 * same request as the css @import, and Safari 4 has issues with
313 * onerror/onload not being fired at all in weird cases like this.
314 */
315 function assertStyleAsync( assert, $element, prop, val, fn ) {
316 var styleTestStart,
317 el = $element.get( 0 ),
318 styleTestTimeout = ( QUnit.config.testTimeout || 5000 ) - 200;
319
320 function isCssImportApplied() {
321 // Trigger reflow, repaint, redraw, whatever (cross-browser)
322 var x = $element.css( 'height' );
323 x = el.innerHTML;
324 el.className = el.className;
325 x = document.documentElement.clientHeight;
326
327 return $element.css( prop ) === val;
328 }
329
330 function styleTestLoop() {
331 var styleTestSince = new Date().getTime() - styleTestStart;
332 // If it is passing or if we timed out, run the real test and stop the loop
333 if ( isCssImportApplied() || styleTestSince > styleTestTimeout ) {
334 assert.equal( $element.css( prop ), val,
335 'style "' + prop + ': ' + val + '" from url is applied (after ' + styleTestSince + 'ms)'
336 );
337
338 if ( fn ) {
339 fn();
340 }
341
342 return;
343 }
344 // Otherwise, keep polling
345 setTimeout( styleTestLoop, 150 );
346 }
347
348 // Start the loop
349 styleTestStart = new Date().getTime();
350 styleTestLoop();
351 }
352
353 function urlStyleTest( selector, prop, val ) {
354 return QUnit.fixurl(
355 mw.config.get( 'wgScriptPath' ) +
356 '/tests/qunit/data/styleTest.css.php?' +
357 $.param( {
358 selector: selector,
359 prop: prop,
360 val: val
361 } )
362 );
363 }
364
365 QUnit.asyncTest( 'mw.loader', 2, function ( assert ) {
366 var isAwesomeDone;
367
368 mw.loader.testCallback = function () {
369 QUnit.start();
370 assert.strictEqual( isAwesomeDone, undefined, 'Implementing module is.awesome: isAwesomeDone should still be undefined' );
371 isAwesomeDone = true;
372 };
373
374 mw.loader.implement( 'test.callback', [QUnit.fixurl( mw.config.get( 'wgScriptPath' ) + '/tests/qunit/data/callMwLoaderTestCallback.js' )], {}, {} );
375
376 mw.loader.using( 'test.callback', function () {
377
378 // /sample/awesome.js declares the "mw.loader.testCallback" function
379 // which contains a call to start() and ok()
380 assert.strictEqual( isAwesomeDone, true, 'test.callback module should\'ve caused isAwesomeDone to be true' );
381 delete mw.loader.testCallback;
382
383 }, function () {
384 QUnit.start();
385 assert.ok( false, 'Error callback fired while loader.using "test.callback" module' );
386 } );
387 } );
388
389 QUnit.asyncTest( 'mw.loader.implement( styles={ "css": [text, ..] } )', 2, function ( assert ) {
390 var $element = $( '<div class="mw-test-implement-a"></div>' ).appendTo( '#qunit-fixture' );
391
392 assert.notEqual(
393 $element.css( 'float' ),
394 'right',
395 'style is clear'
396 );
397
398 mw.loader.implement(
399 'test.implement.a',
400 function () {
401 assert.equal(
402 $element.css( 'float' ),
403 'right',
404 'style is applied'
405 );
406 QUnit.start();
407 },
408 {
409 'all': '.mw-test-implement-a { float: right; }'
410 },
411 {}
412 );
413
414 mw.loader.load( [
415 'test.implement.a'
416 ] );
417 } );
418
419 QUnit.asyncTest( 'mw.loader.implement( styles={ "url": { <media>: [url, ..] } } )', 7, function ( assert ) {
420 var $element1 = $( '<div class="mw-test-implement-b1"></div>' ).appendTo( '#qunit-fixture' ),
421 $element2 = $( '<div class="mw-test-implement-b2"></div>' ).appendTo( '#qunit-fixture' ),
422 $element3 = $( '<div class="mw-test-implement-b3"></div>' ).appendTo( '#qunit-fixture' );
423
424 assert.notEqual(
425 $element1.css( 'text-align' ),
426 'center',
427 'style is clear'
428 );
429 assert.notEqual(
430 $element2.css( 'float' ),
431 'left',
432 'style is clear'
433 );
434 assert.notEqual(
435 $element3.css( 'text-align' ),
436 'right',
437 'style is clear'
438 );
439
440 mw.loader.implement(
441 'test.implement.b',
442 function () {
443 // Note: QUnit.start() must only be called when the entire test is
444 // complete. So, make sure that we don't start until *both*
445 // assertStyleAsync calls have completed.
446 var pending = 2;
447 assertStyleAsync( assert, $element2, 'float', 'left', function () {
448 assert.notEqual( $element1.css( 'text-align' ), 'center', 'print style is not applied' );
449
450 pending--;
451 if ( pending === 0 ) {
452 QUnit.start();
453 }
454 } );
455 assertStyleAsync( assert, $element3, 'float', 'right', function () {
456 assert.notEqual( $element1.css( 'text-align' ), 'center', 'print style is not applied' );
457
458 pending--;
459 if ( pending === 0 ) {
460 QUnit.start();
461 }
462 } );
463 },
464 {
465 'url': {
466 'print': [urlStyleTest( '.mw-test-implement-b1', 'text-align', 'center' )],
467 'screen': [
468 // bug 40834: Make sure it actually works with more than 1 stylesheet reference
469 urlStyleTest( '.mw-test-implement-b2', 'float', 'left' ),
470 urlStyleTest( '.mw-test-implement-b3', 'float', 'right' )
471 ]
472 }
473 },
474 {}
475 );
476
477 mw.loader.load( [
478 'test.implement.b'
479 ] );
480 } );
481
482 // Backwards compatibility
483 QUnit.asyncTest( 'mw.loader.implement( styles={ <media>: text } ) (back-compat)', 2, function ( assert ) {
484 var $element = $( '<div class="mw-test-implement-c"></div>' ).appendTo( '#qunit-fixture' );
485
486 assert.notEqual(
487 $element.css( 'float' ),
488 'right',
489 'style is clear'
490 );
491
492 mw.loader.implement(
493 'test.implement.c',
494 function () {
495 assert.equal(
496 $element.css( 'float' ),
497 'right',
498 'style is applied'
499 );
500 QUnit.start();
501 },
502 {
503 'all': '.mw-test-implement-c { float: right; }'
504 },
505 {}
506 );
507
508 mw.loader.load( [
509 'test.implement.c'
510 ] );
511 } );
512
513 // Backwards compatibility
514 QUnit.asyncTest( 'mw.loader.implement( styles={ <media>: [url, ..] } ) (back-compat)', 4, function ( assert ) {
515 var $element = $( '<div class="mw-test-implement-d"></div>' ).appendTo( '#qunit-fixture' ),
516 $element2 = $( '<div class="mw-test-implement-d2"></div>' ).appendTo( '#qunit-fixture' );
517
518 assert.notEqual(
519 $element.css( 'float' ),
520 'right',
521 'style is clear'
522 );
523 assert.notEqual(
524 $element2.css( 'text-align' ),
525 'center',
526 'style is clear'
527 );
528
529 mw.loader.implement(
530 'test.implement.d',
531 function () {
532 assertStyleAsync( assert, $element, 'float', 'right', function () {
533
534 assert.notEqual( $element2.css( 'text-align' ), 'center', 'print style is not applied (bug 40500)' );
535
536 QUnit.start();
537 } );
538 },
539 {
540 'all': [urlStyleTest( '.mw-test-implement-d', 'float', 'right' )],
541 'print': [urlStyleTest( '.mw-test-implement-d2', 'text-align', 'center' )]
542 },
543 {}
544 );
545
546 mw.loader.load( [
547 'test.implement.d'
548 ] );
549 } );
550
551 // @import (bug 31676)
552 QUnit.asyncTest( 'mw.loader.implement( styles has @import)', 5, function ( assert ) {
553 var isJsExecuted, $element;
554
555 mw.loader.implement(
556 'test.implement.import',
557 function () {
558 assert.strictEqual( isJsExecuted, undefined, 'javascript not executed multiple times' );
559 isJsExecuted = true;
560
561 assert.equal( mw.loader.getState( 'test.implement.import' ), 'ready', 'module state is "ready" while implement() is executing javascript' );
562
563 $element = $( '<div class="mw-test-implement-import">Foo bar</div>' ).appendTo( '#qunit-fixture' );
564
565 assert.equal( mw.msg( 'test-foobar' ), 'Hello Foobar, $1!', 'Messages are loaded before javascript execution' );
566
567 assertStyleAsync( assert, $element, 'float', 'right', function () {
568 assert.equal( $element.css( 'text-align' ), 'center',
569 'CSS styles after the @import rule are working'
570 );
571
572 QUnit.start();
573 } );
574 },
575 {
576 'css': [
577 '@import url(\''
578 + urlStyleTest( '.mw-test-implement-import', 'float', 'right' )
579 + '\');\n'
580 + '.mw-test-implement-import { text-align: center; }'
581 ]
582 },
583 {
584 'test-foobar': 'Hello Foobar, $1!'
585 }
586 );
587
588 mw.loader.load( 'test.implement' );
589
590 } );
591
592 QUnit.asyncTest( 'mw.loader.implement( only messages )', 2, function ( assert ) {
593 assert.assertFalse( mw.messages.exists( 'bug_29107' ), 'Verify that the test message doesn\'t exist yet' );
594
595 mw.loader.implement( 'test.implement.msgs', [], {}, { 'bug_29107': 'loaded' } );
596 mw.loader.using( 'test.implement.msgs', function () {
597 QUnit.start();
598 assert.ok( mw.messages.exists( 'bug_29107' ), 'Bug 29107: messages-only module should implement ok' );
599 }, function () {
600 QUnit.start();
601 assert.ok( false, 'Error callback fired while implementing "test.implement.msgs" module' );
602 } );
603 } );
604
605 QUnit.test( 'mw.loader erroneous indirect dependency', 3, function ( assert ) {
606 mw.loader.register( [
607 ['test.module1', '0'],
608 ['test.module2', '0', ['test.module1']],
609 ['test.module3', '0', ['test.module2']]
610 ] );
611 mw.loader.implement( 'test.module1', function () {
612 throw new Error( 'expected' );
613 }, {}, {} );
614 assert.strictEqual( mw.loader.getState( 'test.module1' ), 'error', 'Expected "error" state for test.module1' );
615 assert.strictEqual( mw.loader.getState( 'test.module2' ), 'error', 'Expected "error" state for test.module2' );
616 assert.strictEqual( mw.loader.getState( 'test.module3' ), 'error', 'Expected "error" state for test.module3' );
617 } );
618
619 QUnit.test( 'mw.loader out-of-order implementation', 9, function ( assert ) {
620 mw.loader.register( [
621 ['test.module4', '0'],
622 ['test.module5', '0', ['test.module4']],
623 ['test.module6', '0', ['test.module5']]
624 ] );
625 mw.loader.implement( 'test.module4', function () {
626 }, {}, {} );
627 assert.strictEqual( mw.loader.getState( 'test.module4' ), 'ready', 'Expected "ready" state for test.module4' );
628 assert.strictEqual( mw.loader.getState( 'test.module5' ), 'registered', 'Expected "registered" state for test.module5' );
629 assert.strictEqual( mw.loader.getState( 'test.module6' ), 'registered', 'Expected "registered" state for test.module6' );
630 mw.loader.implement( 'test.module6', function () {
631 }, {}, {} );
632 assert.strictEqual( mw.loader.getState( 'test.module4' ), 'ready', 'Expected "ready" state for test.module4' );
633 assert.strictEqual( mw.loader.getState( 'test.module5' ), 'registered', 'Expected "registered" state for test.module5' );
634 assert.strictEqual( mw.loader.getState( 'test.module6' ), 'loaded', 'Expected "loaded" state for test.module6' );
635 mw.loader.implement( 'test.module5', function () {
636 }, {}, {} );
637 assert.strictEqual( mw.loader.getState( 'test.module4' ), 'ready', 'Expected "ready" state for test.module4' );
638 assert.strictEqual( mw.loader.getState( 'test.module5' ), 'ready', 'Expected "ready" state for test.module5' );
639 assert.strictEqual( mw.loader.getState( 'test.module6' ), 'ready', 'Expected "ready" state for test.module6' );
640 } );
641
642 QUnit.test( 'mw.loader missing dependency', 13, function ( assert ) {
643 mw.loader.register( [
644 ['test.module7', '0'],
645 ['test.module8', '0', ['test.module7']],
646 ['test.module9', '0', ['test.module8']]
647 ] );
648 mw.loader.implement( 'test.module8', function () {
649 }, {}, {} );
650 assert.strictEqual( mw.loader.getState( 'test.module7' ), 'registered', 'Expected "registered" state for test.module7' );
651 assert.strictEqual( mw.loader.getState( 'test.module8' ), 'loaded', 'Expected "loaded" state for test.module8' );
652 assert.strictEqual( mw.loader.getState( 'test.module9' ), 'registered', 'Expected "registered" state for test.module9' );
653 mw.loader.state( 'test.module7', 'missing' );
654 assert.strictEqual( mw.loader.getState( 'test.module7' ), 'missing', 'Expected "missing" state for test.module7' );
655 assert.strictEqual( mw.loader.getState( 'test.module8' ), 'error', 'Expected "error" state for test.module8' );
656 assert.strictEqual( mw.loader.getState( 'test.module9' ), 'error', 'Expected "error" state for test.module9' );
657 mw.loader.implement( 'test.module9', function () {
658 }, {}, {} );
659 assert.strictEqual( mw.loader.getState( 'test.module7' ), 'missing', 'Expected "missing" state for test.module7' );
660 assert.strictEqual( mw.loader.getState( 'test.module8' ), 'error', 'Expected "error" state for test.module8' );
661 assert.strictEqual( mw.loader.getState( 'test.module9' ), 'error', 'Expected "error" state for test.module9' );
662 mw.loader.using(
663 ['test.module7'],
664 function () {
665 assert.ok( false, 'Success fired despite missing dependency' );
666 assert.ok( true, 'QUnit expected() count dummy' );
667 },
668 function ( e, dependencies ) {
669 assert.strictEqual( $.isArray( dependencies ), true, 'Expected array of dependencies' );
670 assert.deepEqual( dependencies, ['test.module7'], 'Error callback called with module test.module7' );
671 }
672 );
673 mw.loader.using(
674 ['test.module9'],
675 function () {
676 assert.ok( false, 'Success fired despite missing dependency' );
677 assert.ok( true, 'QUnit expected() count dummy' );
678 },
679 function ( e, dependencies ) {
680 assert.strictEqual( $.isArray( dependencies ), true, 'Expected array of dependencies' );
681 dependencies.sort();
682 assert.deepEqual(
683 dependencies,
684 ['test.module7', 'test.module8', 'test.module9'],
685 'Error callback called with all three modules as dependencies'
686 );
687 }
688 );
689 } );
690
691 QUnit.asyncTest( 'mw.loader dependency handling', 5, function ( assert ) {
692 mw.loader.addSource(
693 'testloader',
694 {
695 loadScript: QUnit.fixurl( mw.config.get( 'wgScriptPath' ) + '/tests/qunit/data/load.mock.php' )
696 }
697 );
698
699 mw.loader.register( [
700 // [module, version, dependencies, group, source]
701 ['testMissing', '1', [], null, 'testloader'],
702 ['testUsesMissing', '1', ['testMissing'], null, 'testloader'],
703 ['testUsesNestedMissing', '1', ['testUsesMissing'], null, 'testloader']
704 ] );
705
706 function verifyModuleStates() {
707 assert.equal( mw.loader.getState( 'testMissing' ), 'missing', 'Module not known to server must have state "missing"' );
708 assert.equal( mw.loader.getState( 'testUsesMissing' ), 'error', 'Module with missing dependency must have state "error"' );
709 assert.equal( mw.loader.getState( 'testUsesNestedMissing' ), 'error', 'Module with indirect missing dependency must have state "error"' );
710 }
711
712 mw.loader.using( ['testUsesNestedMissing'],
713 function () {
714 assert.ok( false, 'Error handler should be invoked.' );
715 assert.ok( true ); // Dummy to reach QUnit expect()
716
717 verifyModuleStates();
718
719 QUnit.start();
720 },
721 function ( e, badmodules ) {
722 assert.ok( true, 'Error handler should be invoked.' );
723 // As soon as server spits out state('testMissing', 'missing');
724 // it will bubble up and trigger the error callback.
725 // Therefor the badmodules array is not testUsesMissing or testUsesNestedMissing.
726 assert.deepEqual( badmodules, ['testMissing'], 'Bad modules as expected.' );
727
728 verifyModuleStates();
729
730 QUnit.start();
731 }
732 );
733 } );
734
735 QUnit.asyncTest( 'mw.loader( "//protocol-relative" ) (bug 30825)', 2, function ( assert ) {
736 // This bug was actually already fixed in 1.18 and later when discovered in 1.17.
737 // Test is for regressions!
738
739 // Forge an URL to the test callback script
740 var target = QUnit.fixurl(
741 mw.config.get( 'wgServer' ) + mw.config.get( 'wgScriptPath' ) + '/tests/qunit/data/qunitOkCall.js'
742 );
743
744 // Confirm that mw.loader.load() works with protocol-relative URLs
745 target = target.replace( /https?:/, '' );
746
747 assert.equal( target.substr( 0, 2 ), '//',
748 'URL must be relative to test relative URLs!'
749 );
750
751 // Async!
752 // The target calls QUnit.start
753 mw.loader.load( target );
754 } );
755
756 QUnit.test( 'mw.html', 13, function ( assert ) {
757 assert.throws( function () {
758 mw.html.escape();
759 }, TypeError, 'html.escape throws a TypeError if argument given is not a string' );
760
761 assert.equal( mw.html.escape( '<mw awesome="awesome" value=\'test\' />' ),
762 '&lt;mw awesome=&quot;awesome&quot; value=&#039;test&#039; /&gt;', 'escape() escapes special characters to html entities' );
763
764 assert.equal( mw.html.element(),
765 '<undefined/>', 'element() always returns a valid html string (even without arguments)' );
766
767 assert.equal( mw.html.element( 'div' ), '<div/>', 'element() Plain DIV (simple)' );
768
769 assert.equal( mw.html.element( 'div', {}, '' ), '<div></div>', 'element() Basic DIV (simple)' );
770
771 assert.equal(
772 mw.html.element(
773 'div', {
774 id: 'foobar'
775 }
776 ),
777 '<div id="foobar"/>',
778 'html.element DIV (attribs)' );
779
780 assert.equal( mw.html.element( 'p', null, 12 ), '<p>12</p>', 'Numbers are valid content and should be casted to a string' );
781
782 assert.equal( mw.html.element( 'p', { title: 12 }, '' ), '<p title="12"></p>', 'Numbers are valid attribute values' );
783
784 // Example from https://www.mediawiki.org/wiki/ResourceLoader/Default_modules#mediaWiki.html
785 assert.equal(
786 mw.html.element(
787 'div',
788 {},
789 new mw.html.Raw(
790 mw.html.element( 'img', { src: '<' } )
791 )
792 ),
793 '<div><img src="&lt;"/></div>',
794 'Raw inclusion of another element'
795 );
796
797 assert.equal(
798 mw.html.element(
799 'option', {
800 selected: true
801 }, 'Foo'
802 ),
803 '<option selected="selected">Foo</option>',
804 'Attributes may have boolean values. True copies the attribute name to the value.'
805 );
806
807 assert.equal(
808 mw.html.element(
809 'option', {
810 value: 'foo',
811 selected: false
812 }, 'Foo'
813 ),
814 '<option value="foo">Foo</option>',
815 'Attributes may have boolean values. False keeps the attribute from output.'
816 );
817
818 assert.equal( mw.html.element( 'div',
819 null, 'a' ),
820 '<div>a</div>',
821 'html.element DIV (content)' );
822
823 assert.equal( mw.html.element( 'a',
824 { href: 'http://mediawiki.org/w/index.php?title=RL&action=history' }, 'a' ),
825 '<a href="http://mediawiki.org/w/index.php?title=RL&amp;action=history">a</a>',
826 'html.element DIV (attribs + content)' );
827
828 } );
829
830 QUnit.test( 'mw.hook', 10, function ( assert ) {
831 var hook, add, fire, chars, callback;
832
833 mw.hook( 'test.hook.unfired' ).add( function () {
834 assert.ok( false, 'Unfired hook' );
835 } );
836
837 mw.hook( 'test.hook.basic' ).add( function () {
838 assert.ok( true, 'Basic callback' );
839 } );
840 mw.hook( 'test.hook.basic' ).fire();
841
842 mw.hook( 'test.hook.data' ).add( function ( data1, data2 ) {
843 assert.equal( data1, 'example', 'Fire with data (string param)' );
844 assert.deepEqual( data2, ['two'], 'Fire with data (array param)' );
845 } );
846 mw.hook( 'test.hook.data' ).fire( 'example', ['two'] );
847
848 mw.hook( 'test.hook.chainable' ).add( function () {
849 assert.ok( true, 'Chainable' );
850 } ).fire();
851
852 hook = mw.hook( 'test.hook.detach' );
853 add = hook.add;
854 fire = hook.fire;
855 add( function ( x, y ) {
856 assert.deepEqual( [x, y], ['x', 'y'], 'Detached (contextless) with data' );
857 } );
858 fire( 'x', 'y' );
859
860 mw.hook( 'test.hook.fireBefore' ).fire().add( function () {
861 assert.ok( true, 'Invoke handler right away if it was fired before' );
862 } );
863
864 mw.hook( 'test.hook.fireTwiceBefore' ).fire().fire().add( function () {
865 assert.ok( true, 'Invoke handler right away if it was fired before (only last one)' );
866 } );
867
868 chars = [];
869
870 mw.hook( 'test.hook.many' )
871 .add( function ( chr ) {
872 chars.push( chr );
873 } )
874 .fire( 'x' ).fire( 'y' ).fire( 'z' )
875 .add( function ( chr ) {
876 assert.equal( chr, 'z', 'Adding callback later invokes right away with last data' );
877 } );
878
879 assert.deepEqual( chars, ['x', 'y', 'z'], 'Multiple callbacks with multiple fires' );
880
881 chars = [];
882 callback = function ( chr ) {
883 chars.push( chr );
884 };
885
886 mw.hook( 'test.hook.variadic' )
887 .add(
888 callback,
889 callback,
890 function ( chr ) {
891 chars.push( chr );
892 },
893 callback
894 )
895 .fire( 'x' )
896 .remove(
897 function () {
898 'not-added';
899 },
900 callback
901 )
902 .fire( 'y' )
903 .remove( callback )
904 .fire( 'z' );
905
906 assert.deepEqual(
907 chars,
908 ['x', 'x', 'x', 'x', 'y', 'z'],
909 '"add" and "remove" support variadic arguments. ' +
910 '"add" does not filter unique. ' +
911 '"remove" removes all equal by reference. ' +
912 '"remove" is silent if the function is not found'
913 );
914 } );
915
916 }( mediaWiki, jQuery ) );