tests/phpunit/includes/resourceloader/ResourceLoaderSkinModuleTest.php

   1 <?php
   2
   3 use Wikimedia\TestingAccessWrapper;
   4
   5 /**
   6  * @group ResourceLoader
   7  */
   8 class ResourceLoaderSkinModuleTest extends MediaWikiTestCase {
   9
  10         public static function provideGetStyles() {
  11                 // phpcs:disable Generic.Files.LineLength
  12                 return [
  13                         [
  14                                 'parent' => [],
  15                                 'logo' => '/logo.png',
  16                                 'expected' => [
  17                                         'all' => [ '.mw-wiki-logo { background-image: url(/logo.png); }' ],
  18                                 ],
  19                         ],
  20                         [
  21                                 'parent' => [
  22                                         'screen' => '.example {}',
  23                                 ],
  24                                 'logo' => '/logo.png',
  25                                 'expected' => [
  26                                         'screen' => [ '.example {}' ],
  27                                         'all' => [ '.mw-wiki-logo { background-image: url(/logo.png); }' ],
  28                                 ],
  29                         ],
  30                         [
  31                                 'parent' => [],
  32                                 'logo' => [
  33                                         '1x' => '/logo.png',
  34                                         '1.5x' => '/logo@1.5x.png',
  35                                         '2x' => '/logo@2x.png',
  36                                 ],
  37                                 'expected' => [
  38                                         'all' => [ <<<CSS
  39 .mw-wiki-logo { background-image: url(/logo.png); }
  40 CSS
  41                                         ],
  42                                         '(-webkit-min-device-pixel-ratio: 1.5), (min--moz-device-pixel-ratio: 1.5), (min-resolution: 1.5dppx), (min-resolution: 144dpi)' => [ <<<CSS
  43 .mw-wiki-logo { background-image: url(/logo@1.5x.png);background-size: 135px auto; }
  44 CSS
  45                                         ],
  46                                         '(-webkit-min-device-pixel-ratio: 2), (min--moz-device-pixel-ratio: 2), (min-resolution: 2dppx), (min-resolution: 192dpi)' => [ <<<CSS
  47 .mw-wiki-logo { background-image: url(/logo@2x.png);background-size: 135px auto; }
  48 CSS
  49                                         ],
  50                                 ],
  51                         ],
  52                         [
  53                                 'parent' => [],
  54                                 'logo' => [
  55                                         '1x' => '/logo.png',
  56                                         'svg' => '/logo.svg',
  57                                 ],
  58                                 'expected' => [
  59                                         'all' => [ <<<CSS
  60 .mw-wiki-logo { background-image: url(/logo.png); }
  61 CSS
  62                                         , <<<CSS
  63 .mw-wiki-logo { background-image: -webkit-linear-gradient(transparent, transparent), url(/logo.svg); background-image: linear-gradient(transparent, transparent), url(/logo.svg);background-size: 135px auto; }
  64 CSS
  65                                         ],
  66                                 ],
  67                         ],
  68                 ];
  69                 // phpcs:enable
  70         }
  71
  72         /**
  73          * @dataProvider provideGetStyles
  74          * @covers ResourceLoaderSkinModule
  75          */
  76         public function testGetStyles( $parent, $logo, $expected ) {
  77                 $module = $this->getMockBuilder( ResourceLoaderSkinModule::class )
  78                         ->disableOriginalConstructor()
  79                         ->setMethods( [ 'readStyleFiles', 'getConfig', 'getLogoData' ] )
  80                         ->getMock();
  81                 $module->expects( $this->once() )->method( 'readStyleFiles' )
  82                         ->willReturn( $parent );
  83                 $module->expects( $this->once() )->method( 'getConfig' )
  84                         ->willReturn( new HashConfig() );
  85                 $module->expects( $this->once() )->method( 'getLogoData' )
  86                         ->willReturn( $logo );
  87
  88                 $ctx = $this->getMockBuilder( ResourceLoaderContext::class )
  89                         ->disableOriginalConstructor()->getMock();
  90
  91                 $this->assertEquals(
  92                         $expected,
  93                         $module->getStyles( $ctx )
  94                 );
  95         }
  96
  97         /**
  98          * @covers ResourceLoaderSkinModule::isKnownEmpty
  99          */
 100         public function testIsKnownEmpty() {
 101                 $module = $this->getMockBuilder( ResourceLoaderSkinModule::class )
 102                         ->disableOriginalConstructor()->setMethods( null )->getMock();
 103                 $ctx = $this->getMockBuilder( ResourceLoaderContext::class )
 104                         ->disableOriginalConstructor()->getMock();
 105
 106                 $this->assertFalse( $module->isKnownEmpty( $ctx ) );
 107         }
 108
 109         /**
 110          * @dataProvider provideGetLogoData
 111          * @covers ResourceLoaderSkinModule::getLogoData
 112          */
 113         public function testGetLogoData( $config, $expected, $baseDir = null ) {
 114                 if ( $baseDir ) {
 115                         $this->setMwGlobals( 'IP', $baseDir );
 116                 }
 117                 // Allow testing of protected method
 118                 $module = TestingAccessWrapper::newFromObject( new ResourceLoaderSkinModule() );
 119
 120                 $this->assertEquals(
 121                         $expected,
 122                         $module->getLogoData( new HashConfig( $config ) )
 123                 );
 124         }
 125
 126         public function provideGetLogoData() {
 127                 return [
 128                         'simple' => [
 129                                 'config' => [
 130                                         'ResourceBasePath' => '/w',
 131                                         'Logo' => '/img/default.png',
 132                                         'LogoHD' => false,
 133                                 ],
 134                                 'expected' => '/img/default.png',
 135                         ],
 136                         'default and 2x' => [
 137                                 'config' => [
 138                                         'ResourceBasePath' => '/w',
 139                                         'Logo' => '/img/default.png',
 140                                         'LogoHD' => [
 141                                                 '2x' => '/img/two-x.png',
 142                                         ],
 143                                 ],
 144                                 'expected' => [
 145                                         '1x' => '/img/default.png',
 146                                         '2x' => '/img/two-x.png',
 147                                 ],
 148                         ],
 149                         'default and all HiDPIs' => [
 150                                 'config' => [
 151                                         'ResourceBasePath' => '/w',
 152                                         'Logo' => '/img/default.png',
 153                                         'LogoHD' => [
 154                                                 '1.5x' => '/img/one-point-five.png',
 155                                                 '2x' => '/img/two-x.png',
 156                                         ],
 157                                 ],
 158                                 'expected' => [
 159                                         '1x' => '/img/default.png',
 160                                         '1.5x' => '/img/one-point-five.png',
 161                                         '2x' => '/img/two-x.png',
 162                                 ],
 163                         ],
 164                         'default and SVG' => [
 165                                 'config' => [
 166                                         'ResourceBasePath' => '/w',
 167                                         'Logo' => '/img/default.png',
 168                                         'LogoHD' => [
 169                                                 'svg' => '/img/vector.svg',
 170                                         ],
 171                                 ],
 172                                 'expected' => [
 173                                         '1x' => '/img/default.png',
 174                                         'svg' => '/img/vector.svg',
 175                                 ],
 176                         ],
 177                         'everything' => [
 178                                 'config' => [
 179                                         'ResourceBasePath' => '/w',
 180                                         'Logo' => '/img/default.png',
 181                                         'LogoHD' => [
 182                                                 '1.5x' => '/img/one-point-five.png',
 183                                                 '2x' => '/img/two-x.png',
 184                                                 'svg' => '/img/vector.svg',
 185                                         ],
 186                                 ],
 187                                 'expected' => [
 188                                         '1x' => '/img/default.png',
 189                                         'svg' => '/img/vector.svg',
 190                                 ],
 191                         ],
 192                         'versioned url' => [
 193                                 'config' => [
 194                                         'ResourceBasePath' => '/w',
 195                                         'Logo' => '/w/test.jpg',
 196                                         'LogoHD' => false,
 197                                         'UploadPath' => '/w/images',
 198                                 ],
 199                                 'expected' => '/w/test.jpg?edcf2',
 200                                 'baseDir' => dirname( dirname( __DIR__ ) ) . '/data/media',
 201                         ],
 202                 ];
 203         }
 204
 205         /**
 206          * @dataProvider providePreloadLinks
 207          * @covers ResourceLoaderSkinModule::getPreloadLinks
 208          * @covers ResourceLoaderSkinModule::getLogoPreloadlinks
 209          * @covers ResourceLoaderSkinModule::getLogoData
 210          */
 211         public function testPreloadLinkHeaders( $config, $result ) {
 212                 $this->setMwGlobals( $config );
 213                 $ctx = $this->getMockBuilder( ResourceLoaderContext::class )
 214                         ->disableOriginalConstructor()->getMock();
 215                 $module = new ResourceLoaderSkinModule();
 216
 217                 $this->assertEquals( [ $result ], $module->getHeaders( $ctx ) );
 218         }
 219
 220         public function providePreloadLinks() {
 221                 return [
 222                         [
 223                                 [
 224                                         'wgResourceBasePath' => '/w',
 225                                         'wgLogo' => '/img/default.png',
 226                                         'wgLogoHD' => [
 227                                                 '1.5x' => '/img/one-point-five.png',
 228                                                 '2x' => '/img/two-x.png',
 229                                         ],
 230                                 ],
 231                                 'Link: </img/default.png>;rel=preload;as=image;media=' .
 232                                 'not all and (min-resolution: 1.5dppx),' .
 233                                 '</img/one-point-five.png>;rel=preload;as=image;media=' .
 234                                 '(min-resolution: 1.5dppx) and (max-resolution: 1.999999dppx),' .
 235                                 '</img/two-x.png>;rel=preload;as=image;media=(min-resolution: 2dppx)'
 236                         ],
 237                         [
 238                                 [
 239                                         'wgResourceBasePath' => '/w',
 240                                         'wgLogo' => '/img/default.png',
 241                                         'wgLogoHD' => false,
 242                                 ],
 243                                 'Link: </img/default.png>;rel=preload;as=image'
 244                         ],
 245                         [
 246                                 [
 247                                         'wgResourceBasePath' => '/w',
 248                                         'wgLogo' => '/img/default.png',
 249                                         'wgLogoHD' => [
 250                                                 '2x' => '/img/two-x.png',
 251                                         ],
 252                                 ],
 253                                 'Link: </img/default.png>;rel=preload;as=image;media=' .
 254                                 'not all and (min-resolution: 2dppx),' .
 255                                 '</img/two-x.png>;rel=preload;as=image;media=(min-resolution: 2dppx)'
 256                         ],
 257                         [
 258                                 [
 259                                         'wgResourceBasePath' => '/w',
 260                                         'wgLogo' => '/img/default.png',
 261                                         'wgLogoHD' => [
 262                                                 'svg' => '/img/vector.svg',
 263                                         ],
 264                                 ],
 265                                 'Link: </img/vector.svg>;rel=preload;as=image'
 266
 267                         ],
 268                         [
 269                                 [
 270                                         'wgResourceBasePath' => '/w',
 271                                         'wgLogo' => '/w/test.jpg',
 272                                         'wgLogoHD' => false,
 273                                         'wgUploadPath' => '/w/images',
 274                                         'IP' => dirname( dirname( __DIR__ ) ) . '/data/media',
 275                                 ],
 276                                 'Link: </w/test.jpg?edcf2>;rel=preload;as=image',
 277                         ],
 278                 ];
 279         }
 280 }