adding debug test suit for mediaWiki.util, visible on Special:MWUtilTest?debug=true
[mediawiki.git] / resources / mediawiki / mediawiki.utiltest.js
blob46b484979bafc410e167c78d87604100b10ce140
1 /*
2  * mediaWiki Debug Test Suit on [[Special:MWUtilJSTest]] (only when ?debug=true)
3  */
5 (function ($, mw) {
7         mediaWiki.test = {
9                 /* Variables */
10                 '$bodyContent' : null,
11                 '$table' : null,
12                 'addedTests' : [],
14                 /* Functions */
16                 /**
17                 * Adds a row to the test-table
18                 *
19                 * @param String code    Code of the test to be executed
20                 * @param String result  Expected result in 'var (vartype)' form.
21                 */
22                 'addTest' : function (code, result) {
23                         this.addedTests.push([code, result]);
24                         this.$table.append('<tr><td>' + mw.util.htmlEscape(code) + '</td><td>' + mw.util.htmlEscape(result) + '<td></td></td><td>?</td></tr>');
25                 },
27                 /* Initialisation */
28                 'initialised' : false,
29                 'init' : function () {
30                         if (this.initialised === false) {
31                                 this.initialised = true;
32                                 $(function () {
33                                         if (wgTitle == 'MWUtilJSTest' && wgCanonicalNamespace == 'Special') {
35                                                 // Build page
36                                                 document.title = 'mediaWiki.util JavaScript Test - ' + wgSiteName;
37                                                 $('#firstHeading').text('mediaWiki.util JavaScript Test');
38                                                 mw.test.bodyContent = $('#bodyContent');
39                                                 mw.test.bodyContent.html(
40                                                         '<p>Below is a list of tests to confirm proper functionality of the mediaWiki.util functions</p>' +
41                                                         '<hr />' +
42                                                         '<table id="mw-mwutiltest-table" class="wikitable sortable"><tr><th>Exec</th><th>Should return</th><th>Does return</th><th>Equal ?</th></tr></table>'
43                                                 );
44                                                 mw.test.$table = $('table#mw-mwutiltest-table');
46                                                 // Populate tests
47                                                 mw.test.addTest('typeof String.prototype.trim',
48                                                         'function (string)');
49                                                 mw.test.addTest('typeof String.prototype.trimLeft',
50                                                         'function (string)');
51                                                 mw.test.addTest('typeof String.prototype.trimRight',
52                                                         'function (string)');
53                                                 mw.test.addTest('typeof Array.prototype.compare',
54                                                         'function (string)');
55                                                 mw.test.addTest('typeof Array.prototype.indexOf',
56                                                         'function (string)');
57                                                 mw.test.addTest('4',
58                                                         '4 (number)');
59                                                 mw.test.addTest('typeof mediaWiki',
60                                                         'object (string)');
61                                                 mw.test.addTest('typeof mw',
62                                                         'object (string)');
63                                                 mw.test.addTest('typeof mw.util',
64                                                         'object (string)');
65                                                 mw.test.addTest('typeof String.prototype.ucFirst',
66                                                         'function (string)');
67                                                 mw.test.addTest('\'mediawiki\'.ucFirst()',
68                                                         'Mediawiki (string)');
69                                                 mw.test.addTest('typeof $.fn.enableCheckboxShiftClick',
70                                                         'function (string)');
71                                                 mw.test.addTest('typeof mw.util.rawurlencode',
72                                                         'function (string)');
73                                                 mw.test.addTest('mw.util.rawurlencode(\'Test: A&B/Here\')',
74                                                         'Test%3A%20A%26B%2FHere (string)');
75                                                 mw.test.addTest('typeof mw.util.getWikilink',
76                                                         'function (string)');
77                                                 mw.test.addTest('typeof mw.util.getParamValue',
78                                                         'function (string)');
79                                                 mw.test.addTest('mw.util.getParamValue(\'debug\')',
80                                                         'true (string)');
81                                                 mw.test.addTest('typeof mw.util.htmlEscape',
82                                                         'function (string)');
83                                                 mw.test.addTest('mw.util.htmlEscape(\'<a href="http://mw.org/?a=b&c=d">link</a>\')',
84                                                         '&lt;a href="http://mw.org/?a=b&amp;c=d"&gt;link&lt;/a&gt; (string)');
85                                                 mw.test.addTest('typeof mw.util.htmlUnescape',
86                                                         'function (string)');
87                                                 mw.test.addTest('mw.util.htmlUnescape(\'&lt;a href="http://mw.org/?a=b&amp;c=d"&gt;link&lt;/a&gt;\')',
88                                                         '<a href="http://mw.org/?a=b&c=d">link</a> (string)');
89                                                 mw.test.addTest('typeof mw.util.tooltipAccessKeyRegexp',
90                                                         'function (string)');
91                                                 mw.test.addTest('typeof mw.util.updateTooltipAccessKeys',
92                                                         'function (string)');
93                                                 mw.test.addTest('typeof mw.util.addPortletLink',
94                                                         'function (string)');
95                                                 mw.test.addTest('typeof mw.util.addPortletLink("p-tb", "http://mediawiki.org/", "MediaWiki.org", "t-mworg", "Go to MediaWiki.org ", "m", "#t-print")',
96                                                         'object (string)');
97                                                 mw.test.addTest('mw.util.addPortletLink("p-tb", "http://mediawiki.org/", "MediaWiki.org", "t-mworg", "Go to MediaWiki.org ", "m", "#t-print").outerHTML',
98                                                         '<li id="t-mworg"><span><a href="http://mediawiki.org/" accesskey="m" title="Go to MediaWiki.org  [ctrl-alt-m]">MediaWiki.org</a></span></li> (string)');
100                                                 // Run tests and compare results
101                                                 var     exec,
102                                                         result,
103                                                         resulttype,
104                                                         numberoftests = 0,
105                                                         numberoferrors = 0,
106                                                         $testrows;
107                                                 $testrows = mw.test.$table.find('tr');
108                                                 $.each(mw.test.addedTests, (function (i) {
109                                                                 numberoftests++;
110                                                                 
111                                                                 exec = mw.test.addedTests[i][0];
112                                                                 shouldreturn = mw.test.addedTests[i][1];
113                                                                 doesreturn = eval(exec);
114                                                                 doesreturn = doesreturn + ' (' + typeof doesreturn + ')';
115                                                                 $thisrow = $testrows.eq(i + 1);
116                                                                 $thisrow.find('> td').eq(2).text(doesreturn);
117                                                                 
118                                                                 if (shouldreturn === doesreturn) {
119                                                                         $thisrow.find('> td').eq(3).css('background', '#EFE').text('OK');
120                                                                 } else {
121                                                                         $thisrow.find('> td').eq(3).css('background', '#FEE').text('ERROR');
122                                                                         numberoferrors++;
123                                                                 }
125                                                         })
126                                                 );
127                                                 mw.test.$table.before('<p><strong>Ran ' + numberoftests + ' tests. ' + numberoferrors + ' error(s). </p>');
129                                         }
130                                 });
131                         }
132                 }
133         };
135         mediaWiki.test.init();
137 })(jQuery, mediaWiki);