Merge "Fix and make some types in PHPDoc and JSDoc tags more specific"
[lhc/web/wiklou.git] / tests / phpunit / includes / libs / CSSMinTest.php
1 <?php
2 /**
3 * This file test the CSSMin library shipped with Mediawiki.
4 *
5 * @author Timo Tijhof
6 */
7
8 /**
9 * @group ResourceLoader
10 * @group CSSMin
11 */
12 class CSSMinTest extends MediaWikiTestCase {
13
14 protected function setUp() {
15 parent::setUp();
16
17 $server = 'http://doc.example.org';
18
19 $this->setMwGlobals( [
20 'wgServer' => $server,
21 'wgCanonicalServer' => $server,
22 ] );
23 }
24
25 /**
26 * @dataProvider mimeTypeProvider
27 * @covers CSSMin::getMimeType
28 */
29 public function testGetMimeType( $fileContents, $fileExtension, $expected ) {
30 $fileName = wfTempDir() . DIRECTORY_SEPARATOR . uniqid( 'MW_PHPUnit_CSSMinTest_' ) . '.'
31 . $fileExtension;
32 $this->addTmpFiles( $fileName );
33 file_put_contents( $fileName, $fileContents );
34 $this->assertSame( $expected, CSSMin::getMimeType( $fileName ) );
35 }
36
37 public function mimeTypeProvider() {
38 return [
39 'JPEG with short extension' => [
40 "\xFF\xD8\xFF",
41 'jpg',
42 'image/jpeg'
43 ],
44 'JPEG with long extension' => [
45 "\xFF\xD8\xFF",
46 'jpeg',
47 'image/jpeg'
48 ],
49 'PNG' => [
50 "\x89\x50\x4E\x47\x0D\x0A\x1A\x0A",
51 'png',
52 'image/png'
53 ],
54
55 'PNG extension but JPEG content' => [
56 "\xFF\xD8\xFF",
57 'png',
58 'image/png'
59 ],
60 'JPEG extension but PNG content' => [
61 "\x89\x50\x4E\x47\x0D\x0A\x1A\x0A",
62 'jpg',
63 'image/jpeg'
64 ],
65 'PNG extension but SVG content' => [
66 '<?xml version="1.0"?><svg></svg>',
67 'png',
68 'image/png'
69 ],
70 'SVG extension but PNG content' => [
71 "\x89\x50\x4E\x47\x0D\x0A\x1A\x0A",
72 'svg',
73 'image/svg+xml'
74 ],
75
76 'SVG with all headers' => [
77 '<?xml version="1.0"?><!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1//EN" '
78 . '"http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd"><svg></svg>',
79 'svg',
80 'image/svg+xml'
81 ],
82 'SVG with XML header only' => [
83 '<?xml version="1.0"?><svg></svg>',
84 'svg',
85 'image/svg+xml'
86 ],
87 'SVG with DOCTYPE only' => [
88 '<!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1//EN" '
89 . '"http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd"><svg></svg>',
90 'svg',
91 'image/svg+xml'
92 ],
93 'SVG without any header' => [
94 '<svg></svg>',
95 'svg',
96 'image/svg+xml'
97 ],
98 ];
99 }
100
101 /**
102 * @dataProvider provideMinifyCases
103 * @covers CSSMin::minify
104 */
105 public function testMinify( $code, $expectedOutput ) {
106 $minified = CSSMin::minify( $code );
107
108 $this->assertEquals(
109 $expectedOutput,
110 $minified,
111 'Minified output should be in the form expected.'
112 );
113 }
114
115 public static function provideMinifyCases() {
116 return [
117 // Whitespace
118 [ "\r\t\f \v\n\r", "" ],
119 [ "foo, bar {\n\tprop: value;\n}", "foo,bar{prop:value}" ],
120
121 // Loose comments
122 [ "/* foo */", "" ],
123 [ "/*******\n foo\n *******/", "" ],
124 [ "/*!\n foo\n */", "" ],
125
126 // Inline comments in various different places
127 [ "/* comment */foo, bar {\n\tprop: value;\n}", "foo,bar{prop:value}" ],
128 [ "foo/* comment */, bar {\n\tprop: value;\n}", "foo,bar{prop:value}" ],
129 [ "foo,/* comment */ bar {\n\tprop: value;\n}", "foo,bar{prop:value}" ],
130 [ "foo, bar/* comment */ {\n\tprop: value;\n}", "foo,bar{prop:value}" ],
131 [ "foo, bar {\n\t/* comment */prop: value;\n}", "foo,bar{prop:value}" ],
132 [ "foo, bar {\n\tprop: /* comment */value;\n}", "foo,bar{prop:value}" ],
133 [ "foo, bar {\n\tprop: value /* comment */;\n}", "foo,bar{prop:value }" ],
134 [ "foo, bar {\n\tprop: value; /* comment */\n}", "foo,bar{prop:value; }" ],
135
136 // Keep track of things that aren't as minified as much as they
137 // could be (T37493)
138 [ 'foo { prop: value ;}', 'foo{prop:value }' ],
139 [ 'foo { prop : value; }', 'foo{prop :value}' ],
140 [ 'foo { prop: value ; }', 'foo{prop:value }' ],
141 [ 'foo { font-family: "foo" , "bar"; }', 'foo{font-family:"foo" ,"bar"}' ],
142 [ "foo { src:\n\turl('foo') ,\n\turl('bar') ; }", "foo{src:url('foo') ,url('bar') }" ],
143
144 // Interesting cases with string values
145 // - Double quotes, single quotes
146 [ 'foo { content: ""; }', 'foo{content:""}' ],
147 [ "foo { content: ''; }", "foo{content:''}" ],
148 [ 'foo { content: "\'"; }', 'foo{content:"\'"}' ],
149 [ "foo { content: '\"'; }", "foo{content:'\"'}" ],
150 // - Whitespace in string values
151 [ 'foo { content: " "; }', 'foo{content:" "}' ],
152 ];
153 }
154
155 public static function provideIsRemoteUrl() {
156 return [
157 [ true, 'http://localhost/w/red.gif?123' ],
158 [ true, 'https://example.org/x.png' ],
159 [ true, '//example.org/x.y.z/image.png' ],
160 [ true, '//localhost/styles.css?query=yes' ],
161 [ true, 'data:image/gif;base64,R0lGODlhAQABAIAAAP8AADAAACwAAAAAAQABAAACAkQBADs=' ],
162 [ false, 'x.gif' ],
163 [ false, '/x.gif' ],
164 [ false, './x.gif' ],
165 [ false, '../x.gif' ],
166 ];
167 }
168
169 /**
170 * @dataProvider provideIsRemoteUrl
171 * @covers CSSMin::isRemoteUrl
172 */
173 public function testIsRemoteUrl( $expect, $url ) {
174 $this->assertEquals( CSSMinTestable::isRemoteUrl( $url ), $expect );
175 }
176
177 public static function provideIsLocalUrls() {
178 return [
179 [ false, 'x.gif' ],
180 [ true, '/x.gif' ],
181 [ false, './x.gif' ],
182 [ false, '../x.gif' ],
183 ];
184 }
185
186 /**
187 * @dataProvider provideIsLocalUrls
188 * @covers CSSMin::isLocalUrl
189 */
190 public function testIsLocalUrl( $expect, $url ) {
191 $this->assertEquals( CSSMinTestable::isLocalUrl( $url ), $expect );
192 }
193
194 /**
195 * This test tests funky parameters to CSSMin::remap.
196 *
197 * @see testRemapRemapping for testing of the basic functionality
198 * @dataProvider provideRemapCases
199 * @covers CSSMin::remap
200 * @covers CSSMin::remapOne
201 */
202 public function testRemap( $message, $params, $expectedOutput ) {
203 $remapped = call_user_func_array( 'CSSMin::remap', $params );
204
205 $messageAdd = " Case: $message";
206 $this->assertEquals(
207 $expectedOutput,
208 $remapped,
209 'CSSMin::remap should return the expected url form.' . $messageAdd
210 );
211 }
212
213 public static function provideRemapCases() {
214 // Parameter signature:
215 // CSSMin::remap( $code, $local, $remote, $embedData = true )
216 return [
217 [
218 'Simple case',
219 [ 'foo { prop: url(bar.png); }', false, 'http://example.org', false ],
220 'foo { prop: url(http://example.org/bar.png); }',
221 ],
222 [
223 'Without trailing slash',
224 [ 'foo { prop: url(../bar.png); }', false, 'http://example.org/quux', false ],
225 'foo { prop: url(http://example.org/bar.png); }',
226 ],
227 [
228 'With trailing slash on remote (T29052)',
229 [ 'foo { prop: url(../bar.png); }', false, 'http://example.org/quux/', false ],
230 'foo { prop: url(http://example.org/bar.png); }',
231 ],
232 [
233 'Guard against stripping double slashes from query',
234 [ 'foo { prop: url(bar.png?corge=//grault); }', false, 'http://example.org/quux/', false ],
235 'foo { prop: url(http://example.org/quux/bar.png?corge=//grault); }',
236 ],
237 [
238 'Expand absolute paths',
239 [ 'foo { prop: url(/w/skin/images/bar.png); }', false, 'http://example.org/quux', false ],
240 'foo { prop: url(http://doc.example.org/w/skin/images/bar.png); }',
241 ],
242 [
243 "Don't barf at behavior: url(#default#behaviorName) - T162973",
244 [ 'foo { behavior: url(#default#bar); }', false, '/w/', false ],
245 'foo { behavior: url("#default#bar"); }',
246 ],
247 ];
248 }
249
250 /**
251 * This tests the basic functionality of CSSMin::remap.
252 *
253 * @see testRemap for testing of funky parameters
254 * @dataProvider provideRemapRemappingCases
255 * @covers CSSMin
256 */
257 public function testRemapRemapping( $message, $input, $expectedOutput ) {
258 $localPath = __DIR__ . '/../../data/cssmin';
259 $remotePath = 'http://localhost/w';
260
261 $realOutput = CSSMin::remap( $input, $localPath, $remotePath );
262 $this->assertEquals( $expectedOutput, $realOutput, "CSSMin::remap: $message" );
263 }
264
265 public static function provideRemapRemappingCases() {
266 // red.gif and green.gif are one-pixel 35-byte GIFs.
267 // large.png is a 35K PNG that should be non-embeddable.
268 // Full paths start with http://localhost/w/.
269 // Timestamps in output are replaced with 'timestamp'.
270
271 // data: URIs for red.gif, green.gif, circle.svg
272 $red = 'data:image/gif;base64,R0lGODlhAQABAIAAAP8AADAAACwAAAAAAQABAAACAkQBADs=';
273 $green = 'data:image/gif;base64,R0lGODlhAQABAIAAAACAADAAACwAAAAAAQABAAACAkQBADs=';
274 $svg = 'data:image/svg+xml,%3C%3Fxml%20version%3D%221.0%22%20encoding%3D%22UTF-8%22%3F%3E%0A'
275 . '%3Csvg%20xmlns%3D%22http%3A%2F%2Fwww.w3.org%2F2000%2Fsvg%22%20width%3D%228%22%20height%3D'
276 . '%228%22%3E%0A%3Ccircle%20cx%3D%224%22%20cy%3D%224%22%20r%3D%222%22%2F%3E%0A%3C%2Fsvg%3E%0A';
277
278 // @codingStandardsIgnoreStart Generic.Files.LineLength
279 return [
280 [
281 'Regular file',
282 'foo { background: url(red.gif); }',
283 'foo { background: url(http://localhost/w/red.gif?34ac6); }',
284 ],
285 [
286 'Regular file (missing)',
287 'foo { background: url(theColorOfHerHair.gif); }',
288 'foo { background: url(http://localhost/w/theColorOfHerHair.gif); }',
289 ],
290 [
291 'Remote URL',
292 'foo { background: url(http://example.org/w/foo.png); }',
293 'foo { background: url(http://example.org/w/foo.png); }',
294 ],
295 [
296 'Protocol-relative remote URL',
297 'foo { background: url(//example.org/w/foo.png); }',
298 'foo { background: url(//example.org/w/foo.png); }',
299 ],
300 [
301 'Remote URL with query',
302 'foo { background: url(http://example.org/w/foo.png?query=yes); }',
303 'foo { background: url(http://example.org/w/foo.png?query=yes); }',
304 ],
305 [
306 'Protocol-relative remote URL with query',
307 'foo { background: url(//example.org/w/foo.png?query=yes); }',
308 'foo { background: url(//example.org/w/foo.png?query=yes); }',
309 ],
310 [
311 'Domain-relative URL',
312 'foo { background: url(/static/foo.png); }',
313 'foo { background: url(http://doc.example.org/static/foo.png); }',
314 ],
315 [
316 'Domain-relative URL with query',
317 'foo { background: url(/static/foo.png?query=yes); }',
318 'foo { background: url(http://doc.example.org/static/foo.png?query=yes); }',
319 ],
320 [
321 'Remote URL (unnecessary quotes not preserved)',
322 'foo { background: url("http://example.org/w/unnecessary-quotes.png"); }',
323 'foo { background: url(http://example.org/w/unnecessary-quotes.png); }',
324 ],
325 [
326 'Embedded file',
327 'foo { /* @embed */ background: url(red.gif); }',
328 "foo { background: url($red); background: url(http://localhost/w/red.gif?34ac6)!ie; }",
329 ],
330 [
331 'Embedded file, other comments before the rule',
332 "foo { /* Bar. */ /* @embed */ background: url(red.gif); }",
333 "foo { /* Bar. */ background: url($red); /* Bar. */ background: url(http://localhost/w/red.gif?34ac6)!ie; }",
334 ],
335 [
336 'Can not re-embed data: URIs',
337 "foo { /* @embed */ background: url($red); }",
338 "foo { background: url($red); }",
339 ],
340 [
341 'Can not remap data: URIs',
342 "foo { background: url($red); }",
343 "foo { background: url($red); }",
344 ],
345 [
346 'Can not embed remote URLs',
347 'foo { /* @embed */ background: url(http://example.org/w/foo.png); }',
348 'foo { background: url(http://example.org/w/foo.png); }',
349 ],
350 [
351 'Embedded file (inline @embed)',
352 'foo { background: /* @embed */ url(red.gif); }',
353 "foo { background: url($red); "
354 . "background: url(http://localhost/w/red.gif?34ac6)!ie; }",
355 ],
356 [
357 'Can not embed large files',
358 'foo { /* @embed */ background: url(large.png); }',
359 "foo { background: url(http://localhost/w/large.png?e3d1f); }",
360 ],
361 [
362 'SVG files are embedded without base64 encoding and unnecessary IE 6 and 7 fallback',
363 'foo { /* @embed */ background: url(circle.svg); }',
364 "foo { background: url($svg); }",
365 ],
366 [
367 'Two regular files in one rule',
368 'foo { background: url(red.gif), url(green.gif); }',
369 'foo { background: url(http://localhost/w/red.gif?34ac6), '
370 . 'url(http://localhost/w/green.gif?13651); }',
371 ],
372 [
373 'Two embedded files in one rule',
374 'foo { /* @embed */ background: url(red.gif), url(green.gif); }',
375 "foo { background: url($red), url($green); "
376 . "background: url(http://localhost/w/red.gif?34ac6), "
377 . "url(http://localhost/w/green.gif?13651)!ie; }",
378 ],
379 [
380 'Two embedded files in one rule (inline @embed)',
381 'foo { background: /* @embed */ url(red.gif), /* @embed */ url(green.gif); }',
382 "foo { background: url($red), url($green); "
383 . "background: url(http://localhost/w/red.gif?34ac6), "
384 . "url(http://localhost/w/green.gif?13651)!ie; }",
385 ],
386 [
387 'Two embedded files in one rule (inline @embed), one too large',
388 'foo { background: /* @embed */ url(red.gif), /* @embed */ url(large.png); }',
389 "foo { background: url($red), url(http://localhost/w/large.png?e3d1f); "
390 . "background: url(http://localhost/w/red.gif?34ac6), "
391 . "url(http://localhost/w/large.png?e3d1f)!ie; }",
392 ],
393 [
394 'Practical example with some noise',
395 'foo { /* @embed */ background: #f9f9f9 url(red.gif) 0 0 no-repeat; }',
396 "foo { background: #f9f9f9 url($red) 0 0 no-repeat; "
397 . "background: #f9f9f9 url(http://localhost/w/red.gif?34ac6) 0 0 no-repeat!ie; }",
398 ],
399 [
400 'Does not mess with other properties',
401 'foo { color: red; background: url(red.gif); font-size: small; }',
402 'foo { color: red; background: url(http://localhost/w/red.gif?34ac6); font-size: small; }',
403 ],
404 [
405 'Spacing and miscellanea not changed (1)',
406 'foo { background: url(red.gif); }',
407 'foo { background: url(http://localhost/w/red.gif?34ac6); }',
408 ],
409 [
410 'Spacing and miscellanea not changed (2)',
411 'foo {background:url(red.gif)}',
412 'foo {background:url(http://localhost/w/red.gif?34ac6)}',
413 ],
414 [
415 'Spaces within url() parentheses are ignored',
416 'foo { background: url( red.gif ); }',
417 'foo { background: url(http://localhost/w/red.gif?34ac6); }',
418 ],
419 [
420 '@import rule to local file (should we remap this?)',
421 '@import url(/styles.css)',
422 '@import url(http://doc.example.org/styles.css)',
423 ],
424 [
425 '@import rule to local file (should we remap this?)',
426 '@import url(/styles.css)',
427 '@import url(http://doc.example.org/styles.css)',
428 ],
429 [
430 '@import rule to URL',
431 '@import url(//localhost/styles.css?query=val)',
432 '@import url(//localhost/styles.css?query=val)',
433 ],
434 [
435 'Background URL (double quotes)',
436 'foo { background: url("//localhost/styles.css?quoted=double") }',
437 'foo { background: url(//localhost/styles.css?quoted=double) }',
438 ],
439 [
440 'Background URL (single quotes)',
441 'foo { background: url(\'//localhost/styles.css?quoted=single\') }',
442 'foo { background: url(//localhost/styles.css?quoted=single) }',
443 ],
444 [
445 'Background URL (containing parentheses; T60473)',
446 'foo { background: url("//localhost/styles.css?query=(parens)") }',
447 'foo { background: url("//localhost/styles.css?query=(parens)") }',
448 ],
449 [
450 'Background URL (double quoted, containing single quotes; T60473)',
451 'foo { background: url("//localhost/styles.css?quote=\'") }',
452 'foo { background: url("//localhost/styles.css?quote=\'") }',
453 ],
454 [
455 'Background URL (single quoted, containing double quotes; T60473)',
456 'foo { background: url(\'//localhost/styles.css?quote="\') }',
457 'foo { background: url("//localhost/styles.css?quote=\"") }',
458 ],
459 [
460 'Simple case with comments before url',
461 'foo { prop: /* some {funny;} comment */ url(bar.png); }',
462 'foo { prop: /* some {funny;} comment */ url(http://localhost/w/bar.png); }',
463 ],
464 [
465 'Simple case with comments after url',
466 'foo { prop: url(red.gif)/* some {funny;} comment */ ; }',
467 'foo { prop: url(http://localhost/w/red.gif?34ac6)/* some {funny;} comment */ ; }',
468 ],
469 [
470 'Embedded file with comment before url',
471 'foo { /* @embed */ background: /* some {funny;} comment */ url(red.gif); }',
472 "foo { background: /* some {funny;} comment */ url($red); background: /* some {funny;} comment */ url(http://localhost/w/red.gif?34ac6)!ie; }",
473 ],
474 [
475 'Embedded file with comments inside and outside the rule',
476 'foo { /* @embed */ background: url(red.gif) /* some {foo;} comment */; /* some {bar;} comment */ }',
477 "foo { background: url($red) /* some {foo;} comment */; background: url(http://localhost/w/red.gif?34ac6) /* some {foo;} comment */!ie; /* some {bar;} comment */ }",
478 ],
479 [
480 'Embedded file with comment outside the rule',
481 'foo { /* @embed */ background: url(red.gif); /* some {funny;} comment */ }',
482 "foo { background: url($red); background: url(http://localhost/w/red.gif?34ac6)!ie; /* some {funny;} comment */ }",
483 ],
484 [
485 'Rule with two urls, each with comments',
486 '{ background: /*asd*/ url(something.png); background: /*jkl*/ url(something.png); }',
487 '{ background: /*asd*/ url(http://localhost/w/something.png); background: /*jkl*/ url(http://localhost/w/something.png); }',
488 ],
489 [
490 'Sanity check for offending line from jquery.ui.theme.css (T62077)',
491 '.ui-state-default, .ui-widget-content .ui-state-default, .ui-widget-header .ui-state-default { border: 1px solid #d3d3d3/*{borderColorDefault}*/; background: #e6e6e6/*{bgColorDefault}*/ url(images/ui-bg_glass_75_e6e6e6_1x400.png)/*{bgImgUrlDefault}*/ 50%/*{bgDefaultXPos}*/ 50%/*{bgDefaultYPos}*/ repeat-x/*{bgDefaultRepeat}*/; font-weight: normal/*{fwDefault}*/; color: #555555/*{fcDefault}*/; }',
492 '.ui-state-default, .ui-widget-content .ui-state-default, .ui-widget-header .ui-state-default { border: 1px solid #d3d3d3/*{borderColorDefault}*/; background: #e6e6e6/*{bgColorDefault}*/ url(http://localhost/w/images/ui-bg_glass_75_e6e6e6_1x400.png)/*{bgImgUrlDefault}*/ 50%/*{bgDefaultXPos}*/ 50%/*{bgDefaultYPos}*/ repeat-x/*{bgDefaultRepeat}*/; font-weight: normal/*{fwDefault}*/; color: #555555/*{fcDefault}*/; }',
493 ],
494 ];
495 // @codingStandardsIgnoreEnd
496 }
497
498 /**
499 * This tests basic functionality of CSSMin::buildUrlValue.
500 *
501 * @dataProvider provideBuildUrlValueCases
502 * @covers CSSMin::buildUrlValue
503 */
504 public function testBuildUrlValue( $message, $input, $expectedOutput ) {
505 $this->assertEquals(
506 $expectedOutput,
507 CSSMin::buildUrlValue( $input ),
508 "CSSMin::buildUrlValue: $message"
509 );
510 }
511
512 public static function provideBuildUrlValueCases() {
513 return [
514 [
515 'Full URL',
516 'scheme://user@domain:port/~user/fi%20le.png?query=yes&really=y+s',
517 'url(scheme://user@domain:port/~user/fi%20le.png?query=yes&really=y+s)',
518 ],
519 [
520 'data: URI',
521 'data:image/png;base64,R0lGODlh/+==',
522 'url(data:image/png;base64,R0lGODlh/+==)',
523 ],
524 [
525 'URL with quotes',
526 "https://en.wikipedia.org/wiki/Wendy's",
527 "url(\"https://en.wikipedia.org/wiki/Wendy's\")",
528 ],
529 [
530 'URL with parentheses',
531 'https://en.wikipedia.org/wiki/Boston_(band)',
532 'url("https://en.wikipedia.org/wiki/Boston_(band)")',
533 ],
534 ];
535 }
536
537 /**
538 * Seperated because they are currently broken (T37492)
539 *
540 * @group Broken
541 * @dataProvider provideStringCases
542 * @covers CSSMin::remap
543 */
544 public function testMinifyWithCSSStringValues( $code, $expectedOutput ) {
545 $this->testMinifyOutput( $code, $expectedOutput );
546 }
547
548 public static function provideStringCases() {
549 return [
550 // String values should be respected
551 // - More than one space in a string value
552 [ 'foo { content: " "; }', 'foo{content:" "}' ],
553 // - Using a tab in a string value (turns into a space)
554 [ "foo { content: '\t'; }", "foo{content:'\t'}" ],
555 // - Using css-like syntax in string values
556 [
557 'foo::after { content: "{;}"; position: absolute; }',
558 'foo::after{content:"{;}";position:absolute}'
559 ],
560 ];
561 }
562 }
563
564 class CSSMinTestable extends CSSMin {
565 // Make some protected methods public
566 public static function isRemoteUrl( $maybeUrl ) {
567 return parent::isRemoteUrl( $maybeUrl );
568 }
569 public static function isLocalUrl( $maybeUrl ) {
570 return parent::isLocalUrl( $maybeUrl );
571 }
572 }