tests/phpunit/includes/resourceloader/ResourceLoaderFileModuleTest.php

   1 <?php
   2
   3 /**
   4  * @group Database
   5  * @group ResourceLoader
   6  */
   7 class ResourceLoaderFileModuleTest extends ResourceLoaderTestCase {
   8
   9         protected function setUp() {
  10                 parent::setUp();
  11
  12                 // The return value of the closure shouldn't matter since this test should
  13                 // never call it
  14                 SkinFactory::getDefaultInstance()->register(
  15                         'fakeskin',
  16                         'FakeSkin',
  17                         function () {
  18                         }
  19                 );
  20         }
  21
  22         private static function getModules() {
  23                 $base = [
  24                         'localBasePath' => realpath( __DIR__ ),
  25                 ];
  26
  27                 return [
  28                         'noTemplateModule' => [],
  29
  30                         'deprecatedModule' => $base + [
  31                                 'deprecated' => true,
  32                         ],
  33                         'deprecatedTomorrow' => $base + [
  34                                 'deprecated' => [
  35                                         'message' => 'Will be removed tomorrow.'
  36                                 ],
  37                         ],
  38
  39                         'htmlTemplateModule' => $base + [
  40                                 'templates' => [
  41                                         'templates/template.html',
  42                                         'templates/template2.html',
  43                                 ]
  44                         ],
  45
  46                         'aliasedHtmlTemplateModule' => $base + [
  47                                 'templates' => [
  48                                         'foo.html' => 'templates/template.html',
  49                                         'bar.html' => 'templates/template2.html',
  50                                 ]
  51                         ],
  52
  53                         'templateModuleHandlebars' => $base + [
  54                                 'templates' => [
  55                                         'templates/template_awesome.handlebars',
  56                                 ],
  57                         ],
  58
  59                         'aliasFooFromBar' => $base + [
  60                                 'templates' => [
  61                                         'foo.foo' => 'templates/template.bar',
  62                                 ],
  63                         ],
  64                 ];
  65         }
  66
  67         public static function providerTemplateDependencies() {
  68                 $modules = self::getModules();
  69
  70                 return [
  71                         [
  72                                 $modules['noTemplateModule'],
  73                                 [],
  74                         ],
  75                         [
  76                                 $modules['htmlTemplateModule'],
  77                                 [
  78                                         'mediawiki.template',
  79                                 ],
  80                         ],
  81                         [
  82                                 $modules['templateModuleHandlebars'],
  83                                 [
  84                                         'mediawiki.template',
  85                                         'mediawiki.template.handlebars',
  86                                 ],
  87                         ],
  88                         [
  89                                 $modules['aliasFooFromBar'],
  90                                 [
  91                                         'mediawiki.template',
  92                                         'mediawiki.template.foo',
  93                                 ],
  94                         ],
  95                 ];
  96         }
  97
  98         /**
  99          * @dataProvider providerTemplateDependencies
 100          * @covers ResourceLoaderFileModule::__construct
 101          * @covers ResourceLoaderFileModule::getDependencies
 102          */
 103         public function testTemplateDependencies( $module, $expected ) {
 104                 $rl = new ResourceLoaderFileModule( $module );
 105                 $this->assertEquals( $rl->getDependencies(), $expected );
 106         }
 107
 108         public static function providerDeprecatedModules() {
 109                 return [
 110                         [
 111                                 'deprecatedModule',
 112                                 'mw.log.warn("This page is using the deprecated ResourceLoader module \"deprecatedModule\".");',
 113                         ],
 114                         [
 115                                 'deprecatedTomorrow',
 116                                 'mw.log.warn(' .
 117                                         '"This page is using the deprecated ResourceLoader module \"deprecatedTomorrow\".\\n' .
 118                                         "Will be removed tomorrow." .
 119                                         '");'
 120                         ]
 121                 ];
 122         }
 123
 124         /**
 125          * @dataProvider providerDeprecatedModules
 126          * @covers ResourceLoaderFileModule::getScript
 127          */
 128         public function testDeprecatedModules( $name, $expected ) {
 129                 $modules = self::getModules();
 130                 $rl = new ResourceLoaderFileModule( $modules[$name] );
 131                 $rl->setName( $name );
 132                 $ctx = $this->getResourceLoaderContext( 'en', 'ltr' );
 133                 $this->assertEquals( $rl->getScript( $ctx ), $expected );
 134         }
 135
 136         /**
 137          * @covers ResourceLoaderFileModule::getAllStyleFiles
 138          * @covers ResourceLoaderFileModule::getAllSkinStyleFiles
 139          * @covers ResourceLoaderFileModule::getSkinStyleFiles
 140          */
 141         public function testGetAllSkinStyleFiles() {
 142                 $baseParams = [
 143                         'scripts' => [
 144                                 'foo.js',
 145                                 'bar.js',
 146                         ],
 147                         'styles' => [
 148                                 'foo.css',
 149                                 'bar.css' => [ 'media' => 'print' ],
 150                                 'screen.less' => [ 'media' => 'screen' ],
 151                                 'screen-query.css' => [ 'media' => 'screen and (min-width: 400px)' ],
 152                         ],
 153                         'skinStyles' => [
 154                                 'default' => 'quux-fallback.less',
 155                                 'fakeskin' => [
 156                                         'baz-vector.css',
 157                                         'quux-vector.less',
 158                                 ],
 159                         ],
 160                         'messages' => [
 161                                 'hello',
 162                                 'world',
 163                         ],
 164                 ];
 165
 166                 $module = new ResourceLoaderFileModule( $baseParams );
 167
 168                 $this->assertEquals(
 169                         [
 170                                 'foo.css',
 171                                 'baz-vector.css',
 172                                 'quux-vector.less',
 173                                 'quux-fallback.less',
 174                                 'bar.css',
 175                                 'screen.less',
 176                                 'screen-query.css',
 177                         ],
 178                         array_map( 'basename', $module->getAllStyleFiles() )
 179                 );
 180         }
 181
 182         /**
 183          * Strip @noflip annotations from CSS code.
 184          * @param string $css
 185          * @return string
 186          */
 187         private static function stripNoflip( $css ) {
 188                 return str_replace( '/*@noflip*/ ', '', $css );
 189         }
 190
 191         /**
 192          * What happens when you mix @embed and @noflip?
 193          * This really is an integration test, but oh well.
 194          *
 195          * @covers ResourceLoaderFileModule::getStyles
 196          * @covers ResourceLoaderFileModule::getStyleFiles
 197          */
 198         public function testMixedCssAnnotations() {
 199                 $basePath = __DIR__ . '/../../data/css';
 200                 $testModule = new ResourceLoaderFileModule( [
 201                         'localBasePath' => $basePath,
 202                         'styles' => [ 'test.css' ],
 203                 ] );
 204                 $expectedModule = new ResourceLoaderFileModule( [
 205                         'localBasePath' => $basePath,
 206                         'styles' => [ 'expected.css' ],
 207                 ] );
 208
 209                 $contextLtr = $this->getResourceLoaderContext( 'en', 'ltr' );
 210                 $contextRtl = $this->getResourceLoaderContext( 'he', 'rtl' );
 211
 212                 // Since we want to compare the effect of @noflip+@embed against the effect of just @embed, and
 213                 // the @noflip annotations are always preserved, we need to strip them first.
 214                 $this->assertEquals(
 215                         $expectedModule->getStyles( $contextLtr ),
 216                         self::stripNoflip( $testModule->getStyles( $contextLtr ) ),
 217                         "/*@noflip*/ with /*@embed*/ gives correct results in LTR mode"
 218                 );
 219                 $this->assertEquals(
 220                         $expectedModule->getStyles( $contextLtr ),
 221                         self::stripNoflip( $testModule->getStyles( $contextRtl ) ),
 222                         "/*@noflip*/ with /*@embed*/ gives correct results in RTL mode"
 223                 );
 224         }
 225
 226         public static function providerGetTemplates() {
 227                 $modules = self::getModules();
 228
 229                 return [
 230                         [
 231                                 $modules['noTemplateModule'],
 232                                 [],
 233                         ],
 234                         [
 235                                 $modules['templateModuleHandlebars'],
 236                                 [
 237                                         'templates/template_awesome.handlebars' => "wow\n",
 238                                 ],
 239                         ],
 240                         [
 241                                 $modules['htmlTemplateModule'],
 242                                 [
 243                                         'templates/template.html' => "<strong>hello</strong>\n",
 244                                         'templates/template2.html' => "<div>goodbye</div>\n",
 245                                 ],
 246                         ],
 247                         [
 248                                 $modules['aliasedHtmlTemplateModule'],
 249                                 [
 250                                         'foo.html' => "<strong>hello</strong>\n",
 251                                         'bar.html' => "<div>goodbye</div>\n",
 252                                 ],
 253                         ],
 254                 ];
 255         }
 256
 257         /**
 258          * @dataProvider providerGetTemplates
 259          * @covers ResourceLoaderFileModule::getTemplates
 260          */
 261         public function testGetTemplates( $module, $expected ) {
 262                 $rl = new ResourceLoaderFileModule( $module );
 263
 264                 $this->assertEquals( $rl->getTemplates(), $expected );
 265         }
 266
 267         public function testBomConcatenation() {
 268                 $basePath = __DIR__ . '/../../data/css';
 269                 $testModule = new ResourceLoaderFileModule( [
 270                         'localBasePath' => $basePath,
 271                         'styles' => [ 'bom.css' ],
 272                         ] );
 273                 $this->assertEquals(
 274                         substr( file_get_contents( "$basePath/bom.css" ), 0, 10 ),
 275                         "\xef\xbb\xbf.efbbbf",
 276                         'File has leading BOM'
 277                 );
 278
 279                 $contextLtr = $this->getResourceLoaderContext( 'en', 'ltr' );
 280                 $this->assertEquals(
 281                         $testModule->getStyles( $contextLtr ),
 282                         [ 'all' => ".efbbbf_bom_char_at_start_of_file {}\n" ],
 283                         'Leading BOM removed when concatenating files'
 284                 );
 285         }
 286 }