tests/qunit/suites/resources/mediawiki/mediawiki.util.test.js

   1 ( function ( mw, $ ) {
   2         QUnit.module( 'mediawiki.util', QUnit.newMwEnvironment( {
   3                 setup: function () {
   4                         this.taPrefix = mw.util.tooltipAccessKeyPrefix;
   5                         mw.util.tooltipAccessKeyPrefix = 'ctrl-alt-';
   6                 },
   7                 teardown: function () {
   8                         mw.util.tooltipAccessKeyPrefix = this.taPrefix;
   9                 }
  10         } ) );
  11
  12         QUnit.test( 'rawurlencode', 1, function ( assert ) {
  13                 assert.equal( mw.util.rawurlencode( 'Test:A & B/Here' ), 'Test%3AA%20%26%20B%2FHere' );
  14         } );
  15
  16         QUnit.test( 'wikiUrlencode', 1, function ( assert ) {
  17                 assert.equal( mw.util.wikiUrlencode( 'Test:A & B/Here' ), 'Test:A_%26_B/Here' );
  18         } );
  19
  20         QUnit.test( 'getUrl', 4, function ( assert ) {
  21                 // Not part of startUp module
  22                 mw.config.set( 'wgArticlePath', '/wiki/$1' );
  23                 mw.config.set( 'wgPageName', 'Foobar' );
  24
  25                 var href = mw.util.getUrl( 'Sandbox' );
  26                 assert.equal( href, '/wiki/Sandbox', 'Simple title; Get link for "Sandbox"' );
  27
  28                 href = mw.util.getUrl( 'Foo:Sandbox ? 5+5=10 ! (test)/subpage' );
  29                 assert.equal( href, '/wiki/Foo:Sandbox_%3F_5%2B5%3D10_%21_%28test%29/subpage',
  30                         'Advanced title; Get link for "Foo:Sandbox ? 5+5=10 ! (test)/subpage"' );
  31
  32                 href = mw.util.getUrl();
  33                 assert.equal( href, '/wiki/Foobar', 'Default title; Get link for current page ("Foobar")' );
  34
  35                 href = mw.util.getUrl( 'Sandbox', { action: 'edit' } );
  36                 assert.equal( href, '/wiki/Sandbox?action=edit',
  37                         'Simple title with query string; Get link for "Sandbox" with action=edit' );
  38         } );
  39
  40         QUnit.test( 'wikiScript', 4, function ( assert ) {
  41                 mw.config.set( {
  42                         'wgScript': '/w/i.php', // customized wgScript for bug 39103
  43                         'wgLoadScript': '/w/l.php', // customized wgLoadScript for bug 39103
  44                         'wgScriptPath': '/w',
  45                         'wgScriptExtension': '.php'
  46                 } );
  47
  48                 assert.equal( mw.util.wikiScript(), mw.config.get( 'wgScript' ),
  49                         'wikiScript() returns wgScript'
  50                 );
  51                 assert.equal( mw.util.wikiScript( 'index' ), mw.config.get( 'wgScript' ),
  52                         'wikiScript( index ) returns wgScript'
  53                 );
  54                 assert.equal( mw.util.wikiScript( 'load' ), mw.config.get( 'wgLoadScript' ),
  55                         'wikiScript( load ) returns wgLoadScript'
  56                 );
  57                 assert.equal( mw.util.wikiScript( 'api' ), '/w/api.php', 'API path' );
  58         } );
  59
  60         QUnit.test( 'addCSS', 3, function ( assert ) {
  61                 var $el, style;
  62                 $el = $( '<div>' ).attr( 'id', 'mw-addcsstest' ).appendTo( '#qunit-fixture' );
  63
  64                 style = mw.util.addCSS( '#mw-addcsstest { visibility: hidden; }' );
  65                 assert.equal( typeof style, 'object', 'addCSS returned an object' );
  66                 assert.strictEqual( style.disabled, false, 'property "disabled" is available and set to false' );
  67
  68                 assert.equal( $el.css( 'visibility' ), 'hidden', 'Added style properties are in effect' );
  69
  70                 // Clean up
  71                 $( style.ownerNode ).remove();
  72         } );
  73
  74         QUnit.asyncTest( 'toggleToc', 4, function ( assert ) {
  75                 var tocHtml, $toggleLink;
  76
  77                 function actionC() {
  78                         QUnit.start();
  79                 }
  80
  81                 function actionB() {
  82                         assert.strictEqual( mw.util.toggleToc( $toggleLink, actionC ), true, 'Return boolean true if the TOC is now visible.' );
  83                 }
  84
  85                 function actionA() {
  86                         assert.strictEqual( mw.util.toggleToc( $toggleLink, actionB ), false, 'Return boolean false if the TOC is now hidden.' );
  87                 }
  88
  89                 assert.strictEqual( mw.util.toggleToc(), null, 'Return null if there is no table of contents on the page.' );
  90
  91                 tocHtml = '<div id="toc" class="toc">' +
  92                         '<div id="toctitle">' +
  93                         '<h2>Contents</h2>' +
  94                         '<span class="toctoggle">&nbsp;[<a href="#" class="internal" id="togglelink">Hide</a>&nbsp;]</span>' +
  95                         '</div>' +
  96                         '<ul><li></li></ul>' +
  97                         '</div>';
  98                 $( tocHtml ).appendTo( '#qunit-fixture' );
  99                 $toggleLink = $( '#togglelink' );
 100
 101                 assert.strictEqual( $toggleLink.length, 1, 'Toggle link is appended to the page.' );
 102
 103                 actionA();
 104         } );
 105
 106         QUnit.test( 'getParamValue', 5, function ( assert ) {
 107                 var url;
 108
 109                 url = 'http://example.org/?foo=wrong&foo=right#&foo=bad';
 110                 assert.equal( mw.util.getParamValue( 'foo', url ), 'right', 'Use latest one, ignore hash' );
 111                 assert.strictEqual( mw.util.getParamValue( 'bar', url ), null, 'Return null when not found' );
 112
 113                 url = 'http://example.org/#&foo=bad';
 114                 assert.strictEqual( mw.util.getParamValue( 'foo', url ), null, 'Ignore hash if param is not in querystring but in hash (bug 27427)' );
 115
 116                 url = 'example.org?' + $.param( { 'TEST': 'a b+c' } );
 117                 assert.strictEqual( mw.util.getParamValue( 'TEST', url ), 'a b+c', 'Bug 30441: getParamValue must understand "+" encoding of space' );
 118
 119                 url = 'example.org?' + $.param( { 'TEST': 'a b+c d' } ); // check for sloppy code from r95332 :)
 120                 assert.strictEqual( mw.util.getParamValue( 'TEST', url ), 'a b+c d', 'Bug 30441: getParamValue must understand "+" encoding of space (multiple spaces)' );
 121         } );
 122
 123         QUnit.test( 'tooltipAccessKey', 4, function ( assert ) {
 124                 assert.equal( typeof mw.util.tooltipAccessKeyPrefix, 'string', 'tooltipAccessKeyPrefix must be a string' );
 125                 assert.equal( $.type( mw.util.tooltipAccessKeyRegexp ), 'regexp', 'tooltipAccessKeyRegexp is a regexp' );
 126                 assert.ok( mw.util.updateTooltipAccessKeys, 'updateTooltipAccessKeys is non-empty' );
 127
 128                 'Example [a]'.replace( mw.util.tooltipAccessKeyRegexp, function ( sub, m1, m2, m3, m4, m5, m6 ) {
 129                         assert.equal( m6, 'a', 'tooltipAccessKeyRegexp finds the accesskey hint' );
 130                 } );
 131         } );
 132
 133         QUnit.test( '$content', 2, function ( assert ) {
 134                 assert.ok( mw.util.$content instanceof jQuery, 'mw.util.$content instance of jQuery' );
 135                 assert.strictEqual( mw.util.$content.length, 1, 'mw.util.$content must have length of 1' );
 136         } );
 137
 138         /**
 139          * Portlet names are prefixed with 'p-test' to avoid conflict with core
 140          * when running the test suite under a wiki page.
 141          * Previously, test elements where invisible to the selector since only
 142          * one element can have a given id.
 143          */
 144         QUnit.test( 'addPortletLink', 13, function ( assert ) {
 145                 var pTestTb, pCustom, vectorTabs, tbRL, cuQuux, $cuQuux, tbMW, $tbMW, tbRLDM, caFoo,
 146                         addedAfter, tbRLDMnonexistentid, tbRLDMemptyjquery;
 147
 148                 pTestTb = '\
 149                 <div class="portlet" id="p-test-tb">\
 150                         <h3>Toolbox</h3>\
 151                         <ul class="body"></ul>\
 152                 </div>';
 153                 pCustom = '\
 154                 <div class="portlet" id="p-test-custom">\
 155                         <h3>Views</h3>\
 156                         <ul class="body">\
 157                                 <li id="c-foo"><a href="#">Foo</a></li>\
 158                                 <li id="c-barmenu">\
 159                                         <ul>\
 160                                                 <li id="c-bar-baz"><a href="#">Baz</a></a>\
 161                                         </ul>\
 162                                 </li>\
 163                         </ul>\
 164                 </div>';
 165                 vectorTabs = '\
 166                 <div id="p-test-views" class="vectorTabs">\
 167                         <h3>Views</h3>\
 168                         <ul></ul>\
 169                 </div>';
 170
 171                 $( '#qunit-fixture' ).append( pTestTb, pCustom, vectorTabs );
 172
 173                 tbRL = mw.util.addPortletLink( 'p-test-tb', '//mediawiki.org/wiki/ResourceLoader',
 174                         'ResourceLoader', 't-rl', 'More info about ResourceLoader on MediaWiki.org ', 'l'
 175                 );
 176
 177                 assert.ok( $.isDomElement( tbRL ), 'addPortletLink returns a valid DOM Element according to $.isDomElement' );
 178
 179                 tbMW = mw.util.addPortletLink( 'p-test-tb', '//mediawiki.org/',
 180                         'MediaWiki.org', 't-mworg', 'Go to MediaWiki.org ', 'm', tbRL );
 181                 $tbMW = $( tbMW );
 182
 183                 assert.propEqual(
 184                         $tbMW.getAttrs(),
 185                         {
 186                                 id: 't-mworg'
 187                         },
 188                         'Validate attributes of created element'
 189                 );
 190
 191                 assert.propEqual(
 192                         $tbMW.find( 'a' ).getAttrs(),
 193                         {
 194                                 href: '//mediawiki.org/',
 195                                 title: 'Go to MediaWiki.org [ctrl-alt-m]',
 196                                 accesskey: 'm'
 197                         },
 198                         'Validate attributes of anchor tag in created element'
 199                 );
 200
 201                 assert.equal( $tbMW.closest( '.portlet' ).attr( 'id' ), 'p-test-tb', 'Link was inserted within correct portlet' );
 202                 assert.strictEqual( $tbMW.next()[0], tbRL, 'Link is in the correct position (by passing nextnode)' );
 203
 204                 cuQuux = mw.util.addPortletLink( 'p-test-custom', '#', 'Quux', null, 'Example [shift-x]', 'q' );
 205                 $cuQuux = $( cuQuux );
 206
 207                 assert.equal( $cuQuux.find( 'a' ).attr( 'title' ), 'Example [ctrl-alt-q]', 'Existing accesskey is stripped and updated' );
 208
 209                 assert.equal(
 210                         $( '#p-test-custom #c-barmenu ul li' ).length,
 211                         1,
 212                         'addPortletLink did not add the item to all <ul> elements in the portlet (bug 35082)'
 213                 );
 214
 215                 tbRLDM = mw.util.addPortletLink( 'p-test-tb', '//mediawiki.org/wiki/RL/DM',
 216                         'Default modules', 't-rldm', 'List of all default modules ', 'd', '#t-rl' );
 217
 218                 assert.equal( $( tbRLDM ).next().attr( 'id' ), 't-rl', 'Link is in the correct position (by passing CSS selector)' );
 219
 220                 caFoo = mw.util.addPortletLink( 'p-test-views', '#', 'Foo' );
 221
 222                 assert.strictEqual( $tbMW.find( 'span' ).length, 0, 'No <span> element should be added for porlets without vectorTabs class.' );
 223                 assert.strictEqual( $( caFoo ).find( 'span' ).length, 1, 'A <span> element should be added for porlets with vectorTabs class.' );
 224
 225                 addedAfter = mw.util.addPortletLink( 'p-test-tb', '#', 'After foo', 'post-foo', 'After foo', null, $( tbRL ) );
 226                 assert.strictEqual( $( addedAfter ).next()[0], tbRL, 'Link is in the correct position (by passing a jQuery object as nextnode)' );
 227
 228                 // test case - nonexistent id as next node
 229                 tbRLDMnonexistentid = mw.util.addPortletLink( 'p-test-tb', '//mediawiki.org/wiki/RL/DM',
 230                         'Default modules', 't-rldm-nonexistent', 'List of all default modules ', 'd', '#t-rl-nonexistent' );
 231
 232                 assert.equal( tbRLDMnonexistentid, $( '#p-test-tb li:last' )[0], 'Nonexistent id as nextnode adds the portlet at end' );
 233
 234                 // test case - empty jquery object as next node
 235                 tbRLDMemptyjquery = mw.util.addPortletLink( 'p-test-tb', '//mediawiki.org/wiki/RL/DM',
 236                         'Default modules', 't-rldm-empty-jquery', 'List of all default modules ', 'd', $( '#t-rl-nonexistent' ) );
 237
 238                 assert.equal( tbRLDMemptyjquery, $( '#p-test-tb li:last' )[0], 'Empty jquery as nextnode adds the portlet at end' );
 239         } );
 240
 241         QUnit.test( 'jsMessage', 1, function ( assert ) {
 242                 var a = mw.util.jsMessage( 'MediaWiki is <b>Awesome</b>.' );
 243                 assert.ok( a, 'Basic checking of return value' );
 244
 245                 // Clean up
 246                 $( '#mw-js-message' ).remove();
 247         } );
 248
 249         QUnit.test( 'validateEmail', 6, function ( assert ) {
 250                 assert.strictEqual( mw.util.validateEmail( '' ), null, 'Should return null for empty string ' );
 251                 assert.strictEqual( mw.util.validateEmail( 'user@localhost' ), true, 'Return true for a valid e-mail address' );
 252
 253                 // testEmailWithCommasAreInvalids
 254                 assert.strictEqual( mw.util.validateEmail( 'user,foo@example.org' ), false, 'Emails with commas are invalid' );
 255                 assert.strictEqual( mw.util.validateEmail( 'userfoo@ex,ample.org' ), false, 'Emails with commas are invalid' );
 256
 257                 // testEmailWithHyphens
 258                 assert.strictEqual( mw.util.validateEmail( 'user-foo@example.org' ), true, 'Emails may contain a hyphen' );
 259                 assert.strictEqual( mw.util.validateEmail( 'userfoo@ex-ample.org' ), true, 'Emails may contain a hyphen' );
 260         } );
 261
 262         QUnit.test( 'isIPv6Address', 40, function ( assert ) {
 263                 // Shortcuts
 264                 function assertFalseIPv6( addy, summary ) {
 265                         return assert.strictEqual( mw.util.isIPv6Address( addy ), false, summary );
 266                 }
 267
 268                 function assertTrueIPv6( addy, summary ) {
 269                         return assert.strictEqual( mw.util.isIPv6Address( addy ), true, summary );
 270                 }
 271
 272                 // Based on IPTest.php > testisIPv6
 273                 assertFalseIPv6( ':fc:100::', 'IPv6 starting with lone ":"' );
 274                 assertFalseIPv6( 'fc:100:::', 'IPv6 ending with a ":::"' );
 275                 assertFalseIPv6( 'fc:300', 'IPv6 with only 2 words' );
 276                 assertFalseIPv6( 'fc:100:300', 'IPv6 with only 3 words' );
 277
 278                 $.each(
 279                         ['fc:100::',
 280                                 'fc:100:a::',
 281                                 'fc:100:a:d::',
 282                                 'fc:100:a:d:1::',
 283                                 'fc:100:a:d:1:e::',
 284                                 'fc:100:a:d:1:e:ac::'], function ( i, addy ) {
 285                                 assertTrueIPv6( addy, addy + ' is a valid IP' );
 286                         } );
 287
 288                 assertFalseIPv6( 'fc:100:a:d:1:e:ac:0::', 'IPv6 with 8 words ending with "::"' );
 289                 assertFalseIPv6( 'fc:100:a:d:1:e:ac:0:1::', 'IPv6 with 9 words ending with "::"' );
 290
 291                 assertFalseIPv6( ':::' );
 292                 assertFalseIPv6( '::0:', 'IPv6 ending in a lone ":"' );
 293
 294                 assertTrueIPv6( '::', 'IPv6 zero address' );
 295                 $.each(
 296                         ['::0',
 297                                 '::fc',
 298                                 '::fc:100',
 299                                 '::fc:100:a',
 300                                 '::fc:100:a:d',
 301                                 '::fc:100:a:d:1',
 302                                 '::fc:100:a:d:1:e',
 303                                 '::fc:100:a:d:1:e:ac',
 304
 305                                 'fc:100:a:d:1:e:ac:0'], function ( i, addy ) {
 306                                 assertTrueIPv6( addy, addy + ' is a valid IP' );
 307                         } );
 308
 309                 assertFalseIPv6( '::fc:100:a:d:1:e:ac:0', 'IPv6 with "::" and 8 words' );
 310                 assertFalseIPv6( '::fc:100:a:d:1:e:ac:0:1', 'IPv6 with 9 words' );
 311
 312                 assertFalseIPv6( ':fc::100', 'IPv6 starting with lone ":"' );
 313                 assertFalseIPv6( 'fc::100:', 'IPv6 ending with lone ":"' );
 314                 assertFalseIPv6( 'fc:::100', 'IPv6 with ":::" in the middle' );
 315
 316                 assertTrueIPv6( 'fc::100', 'IPv6 with "::" and 2 words' );
 317                 assertTrueIPv6( 'fc::100:a', 'IPv6 with "::" and 3 words' );
 318                 assertTrueIPv6( 'fc::100:a:d', 'IPv6 with "::" and 4 words' );
 319                 assertTrueIPv6( 'fc::100:a:d:1', 'IPv6 with "::" and 5 words' );
 320                 assertTrueIPv6( 'fc::100:a:d:1:e', 'IPv6 with "::" and 6 words' );
 321                 assertTrueIPv6( 'fc::100:a:d:1:e:ac', 'IPv6 with "::" and 7 words' );
 322                 assertTrueIPv6( '2001::df', 'IPv6 with "::" and 2 words' );
 323                 assertTrueIPv6( '2001:5c0:1400:a::df', 'IPv6 with "::" and 5 words' );
 324                 assertTrueIPv6( '2001:5c0:1400:a::df:2', 'IPv6 with "::" and 6 words' );
 325
 326                 assertFalseIPv6( 'fc::100:a:d:1:e:ac:0', 'IPv6 with "::" and 8 words' );
 327                 assertFalseIPv6( 'fc::100:a:d:1:e:ac:0:1', 'IPv6 with 9 words' );
 328         } );
 329
 330         QUnit.test( 'isIPv4Address', 11, function ( assert ) {
 331                 // Shortcuts
 332                 function assertFalseIPv4( addy, summary ) {
 333                         assert.strictEqual( mw.util.isIPv4Address( addy ), false, summary );
 334                 }
 335
 336                 function assertTrueIPv4( addy, summary ) {
 337                         assert.strictEqual( mw.util.isIPv4Address( addy ), true, summary );
 338                 }
 339
 340                 // Based on IPTest.php > testisIPv4
 341                 assertFalseIPv4( false, 'Boolean false is not an IP' );
 342                 assertFalseIPv4( true, 'Boolean true is not an IP' );
 343                 assertFalseIPv4( '', 'Empty string is not an IP' );
 344                 assertFalseIPv4( 'abc', '"abc" is not an IP' );
 345                 assertFalseIPv4( ':', 'Colon is not an IP' );
 346                 assertFalseIPv4( '124.24.52', 'IPv4 not enough quads' );
 347                 assertFalseIPv4( '24.324.52.13', 'IPv4 out of range' );
 348                 assertFalseIPv4( '.24.52.13', 'IPv4 starts with period' );
 349
 350                 assertTrueIPv4( '124.24.52.13', '124.24.52.134 is a valid IP' );
 351                 assertTrueIPv4( '1.24.52.13', '1.24.52.13 is a valid IP' );
 352                 assertFalseIPv4( '74.24.52.13/20', 'IPv4 ranges are not recogzized as valid IPs' );
 353         } );
 354 }( mediaWiki, jQuery ) );