1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
|
/*
* This file is part of the MediaWiki extension MultimediaViewer.
*
* MultimediaViewer is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 2 of the License, or
* (at your option) any later version.
*
* MultimediaViewer is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with MultimediaViewer. If not, see <http://www.gnu.org/licenses/>.
*/
( function ( mw, $ ) {
QUnit.module( 'mmv.provider.Api', QUnit.newMwEnvironment() );
QUnit.test( 'Api constructor sanity check', function ( assert ) {
var api = { get: function () {} },
options = {},
apiProvider = new mw.mmv.provider.Api( api, options ),
ApiProviderWithNoOptions = new mw.mmv.provider.Api( api );
assert.ok( apiProvider );
assert.ok( ApiProviderWithNoOptions );
} );
QUnit.test( 'apiGetWithMaxAge()', function ( assert ) {
var api = {},
options = {},
apiProvider = new mw.mmv.provider.Api( api, options );
api.get = this.sandbox.stub();
apiProvider.apiGetWithMaxAge( {} );
assert.ok( !( 'maxage' in api.get.getCall( 0 ).args[ 0 ] ), 'maxage is not set by default' );
assert.ok( !( 'smaxage' in api.get.getCall( 0 ).args[ 0 ] ), 'smaxage is not set by default' );
options = { maxage: 123 };
apiProvider = new mw.mmv.provider.Api( api, options );
api.get = this.sandbox.stub();
apiProvider.apiGetWithMaxAge( {} );
assert.strictEqual( api.get.getCall( 0 ).args[ 0 ].maxage, 123, 'maxage falls back to provider default' );
assert.strictEqual( api.get.getCall( 0 ).args[ 0 ].smaxage, 123, 'smaxage falls back to provider default' );
api.get = this.sandbox.stub();
apiProvider.apiGetWithMaxAge( {}, null, 456 );
assert.strictEqual( api.get.getCall( 0 ).args[ 0 ].maxage, 456, 'maxage can be overridden' );
assert.strictEqual( api.get.getCall( 0 ).args[ 0 ].smaxage, 456, 'smaxage can be overridden' );
api.get = this.sandbox.stub();
apiProvider.apiGetWithMaxAge( {}, null, null );
assert.ok( !( 'maxage' in api.get.getCall( 0 ).args[ 0 ] ), 'maxage can be overridden to unset' );
assert.ok( !( 'smaxage' in api.get.getCall( 0 ).args[ 0 ] ), 'smaxage can be overridden to unset' );
} );
QUnit.test( 'getCachedPromise success', function ( assert ) {
var api = { get: function () {} },
apiProvider = new mw.mmv.provider.Api( api ),
oldMwLog = mw.log,
promiseSource,
promiseShouldBeCached = false;
mw.log = function () {
assert.ok( false, 'mw.log should not have been called' );
};
promiseSource = function ( result ) {
return function () {
assert.ok( !promiseShouldBeCached, 'promise was not cached' );
return $.Deferred().resolve( result );
};
};
apiProvider.getCachedPromise( 'foo', promiseSource( 1 ) ).done( function ( result ) {
assert.strictEqual( result, 1, 'result comes from the promise source' );
} );
apiProvider.getCachedPromise( 'bar', promiseSource( 2 ) ).done( function ( result ) {
assert.strictEqual( result, 2, 'result comes from the promise source' );
} );
promiseShouldBeCached = true;
apiProvider.getCachedPromise( 'foo', promiseSource( 3 ) ).done( function ( result ) {
assert.strictEqual( result, 1, 'result comes from cache' );
} );
mw.log = oldMwLog;
} );
QUnit.test( 'getCachedPromise failure', function ( assert ) {
var api = { get: function () {} },
apiProvider = new mw.mmv.provider.Api( api ),
oldMwLog = mw.log,
promiseSource,
promiseShouldBeCached = false;
mw.log = function () {
assert.ok( true, 'mw.log was called' );
};
promiseSource = function ( result ) {
return function () {
assert.ok( !promiseShouldBeCached, 'promise was not cached' );
return $.Deferred().reject( result );
};
};
apiProvider.getCachedPromise( 'foo', promiseSource( 1 ) ).fail( function ( result ) {
assert.strictEqual( result, 1, 'result comes from the promise source' );
} );
apiProvider.getCachedPromise( 'bar', promiseSource( 2 ) ).fail( function ( result ) {
assert.strictEqual( result, 2, 'result comes from the promise source' );
} );
promiseShouldBeCached = true;
apiProvider.getCachedPromise( 'foo', promiseSource( 3 ) ).fail( function ( result ) {
assert.strictEqual( result, 1, 'result comes from cache' );
} );
mw.log = oldMwLog;
} );
QUnit.test( 'getErrorMessage', function ( assert ) {
var api = { get: function () {} },
apiProvider = new mw.mmv.provider.Api( api ),
errorMessage;
errorMessage = apiProvider.getErrorMessage( {
servedby: 'mw1194',
error: {
code: 'unknown_action',
info: 'Unrecognized value for parameter \'action\': FOO'
}
} );
assert.strictEqual( errorMessage,
'unknown_action: Unrecognized value for parameter \'action\': FOO',
'error message is parsed correctly' );
assert.strictEqual( apiProvider.getErrorMessage( {} ), 'unknown error', 'missing error message is handled' );
} );
QUnit.test( 'getNormalizedTitle', function ( assert ) {
var api = { get: function () {} },
apiProvider = new mw.mmv.provider.Api( api ),
title = new mw.Title( 'Image:Stuff.jpg' ),
normalizedTitle;
normalizedTitle = apiProvider.getNormalizedTitle( title, {} );
assert.strictEqual( normalizedTitle, title, 'missing normalization block is handled' );
normalizedTitle = apiProvider.getNormalizedTitle( title, {
query: {
normalized: [
{
from: 'Image:Foo.jpg',
to: 'File:Foo.jpg'
}
]
}
} );
assert.strictEqual( normalizedTitle, title, 'irrelevant normalization info is skipped' );
normalizedTitle = apiProvider.getNormalizedTitle( title, {
query: {
normalized: [
{
from: 'Image:Stuff.jpg',
to: 'File:Stuff.jpg'
}
]
}
} );
assert.strictEqual( normalizedTitle.getPrefixedDb(), 'File:Stuff.jpg', 'normalization happens' );
} );
QUnit.test( 'getQueryField', function ( assert ) {
var api = { get: function () {} },
apiProvider = new mw.mmv.provider.Api( api ),
done = assert.async( 3 ),
data;
data = {
query: {
imageusage: [
{
pageid: 736,
ns: 0,
title: 'Albert Einstein'
}
]
}
};
apiProvider.getQueryField( 'imageusage', data ).then( function ( field ) {
assert.strictEqual( field, data.query.imageusage, 'specified field is found' );
done();
} );
apiProvider.getQueryField( 'imageusage', {} ).fail( function () {
assert.ok( true, 'promise rejected when data is missing' );
done();
} );
apiProvider.getQueryField( 'imageusage', { data: { query: {} } } ).fail( function () {
assert.ok( true, 'promise rejected when field is missing' );
done();
} );
} );
QUnit.test( 'getQueryPage', function ( assert ) {
var api = { get: function () {} },
apiProvider = new mw.mmv.provider.Api( api ),
title = new mw.Title( 'File:Stuff.jpg' ),
titleWithNamespaceAlias = new mw.Title( 'Image:Stuff.jpg' ),
otherTitle = new mw.Title( 'File:Foo.jpg' ),
done = assert.async( 6 ),
data;
data = {
normalized: [
{
from: 'Image:Stuff.jpg',
to: 'File:Stuff.jpg'
}
],
query: {
pages: {
'-1': {
title: 'File:Stuff.jpg'
}
}
}
};
apiProvider.getQueryPage( title, data ).then( function ( field ) {
assert.strictEqual( field, data.query.pages[ '-1' ], 'specified page is found' );
done();
} );
apiProvider.getQueryPage( titleWithNamespaceAlias, data ).then( function ( field ) {
assert.strictEqual( field, data.query.pages[ '-1' ],
'specified page is found even if its title was normalized' );
done();
} );
apiProvider.getQueryPage( otherTitle, {} ).fail( function () {
assert.ok( true, 'promise rejected when page has different title' );
done();
} );
apiProvider.getQueryPage( title, {} ).fail( function () {
assert.ok( true, 'promise rejected when data is missing' );
done();
} );
apiProvider.getQueryPage( title, { data: { query: {} } } ).fail( function () {
assert.ok( true, 'promise rejected when pages are missing' );
done();
} );
apiProvider.getQueryPage( title, { data: { query: { pages: {} } } } ).fail( function () {
assert.ok( true, 'promise rejected when pages are empty' );
done();
} );
} );
}( mediaWiki, jQuery ) );
|
