tests/phpunit/includes/OutputPageTest.php

   1 <?php
   2
   3 /**
   4  *
   5  * @author Matthew Flaschen
   6  *
   7  * @group Output
   8  *
   9  * @todo factor tests in this class into providers and test methods
  10  *
  11  */
  12 class OutputPageTest extends MediaWikiTestCase {
  13         const SCREEN_MEDIA_QUERY = 'screen and (min-width: 982px)';
  14         const SCREEN_ONLY_MEDIA_QUERY = 'only screen and (min-width: 982px)';
  15
  16         /**
  17          * Tests a particular case of transformCssMedia, using the given input, globals,
  18          * expected return, and message
  19          *
  20          * Asserts that $expectedReturn is returned.
  21          *
  22          * options['printableQuery'] - value of query string for printable, or omitted for none
  23          * options['handheldQuery'] - value of query string for handheld, or omitted for none
  24          * options['media'] - passed into the method under the same name
  25          * options['expectedReturn'] - expected return value
  26          * options['message'] - PHPUnit message for assertion
  27          *
  28          * @param array $args Key-value array of arguments as shown above
  29          */
  30         protected function assertTransformCssMediaCase( $args ) {
  31                 $queryData = array();
  32                 if ( isset( $args['printableQuery'] ) ) {
  33                         $queryData['printable'] = $args['printableQuery'];
  34                 }
  35
  36                 if ( isset( $args['handheldQuery'] ) ) {
  37                         $queryData['handheld'] = $args['handheldQuery'];
  38                 }
  39
  40                 $fauxRequest = new FauxRequest( $queryData, false );
  41                 $this->setMwGlobals( array(
  42                         'wgRequest' => $fauxRequest,
  43                 ) );
  44
  45                 $actualReturn = OutputPage::transformCssMedia( $args['media'] );
  46                 $this->assertSame( $args['expectedReturn'], $actualReturn, $args['message'] );
  47         }
  48
  49         /**
  50          * Tests print requests
  51          * @covers OutputPage::transformCssMedia
  52          */
  53         public function testPrintRequests() {
  54                 $this->assertTransformCssMediaCase( array(
  55                         'printableQuery' => '1',
  56                         'media' => 'screen',
  57                         'expectedReturn' => null,
  58                         'message' => 'On printable request, screen returns null'
  59                 ) );
  60
  61                 $this->assertTransformCssMediaCase( array(
  62                         'printableQuery' => '1',
  63                         'media' => self::SCREEN_MEDIA_QUERY,
  64                         'expectedReturn' => null,
  65                         'message' => 'On printable request, screen media query returns null'
  66                 ) );
  67
  68                 $this->assertTransformCssMediaCase( array(
  69                         'printableQuery' => '1',
  70                         'media' => self::SCREEN_ONLY_MEDIA_QUERY,
  71                         'expectedReturn' => null,
  72                         'message' => 'On printable request, screen media query with only returns null'
  73                 ) );
  74
  75                 $this->assertTransformCssMediaCase( array(
  76                         'printableQuery' => '1',
  77                         'media' => 'print',
  78                         'expectedReturn' => '',
  79                         'message' => 'On printable request, media print returns empty string'
  80                 ) );
  81         }
  82
  83         /**
  84          * Tests screen requests, without either query parameter set
  85          * @covers OutputPage::transformCssMedia
  86          */
  87         public function testScreenRequests() {
  88                 $this->assertTransformCssMediaCase( array(
  89                         'media' => 'screen',
  90                         'expectedReturn' => 'screen',
  91                         'message' => 'On screen request, screen media type is preserved'
  92                 ) );
  93
  94                 $this->assertTransformCssMediaCase( array(
  95                         'media' => 'handheld',
  96                         'expectedReturn' => 'handheld',
  97                         'message' => 'On screen request, handheld media type is preserved'
  98                 ) );
  99
 100                 $this->assertTransformCssMediaCase( array(
 101                         'media' => self::SCREEN_MEDIA_QUERY,
 102                         'expectedReturn' => self::SCREEN_MEDIA_QUERY,
 103                         'message' => 'On screen request, screen media query is preserved.'
 104                 ) );
 105
 106                 $this->assertTransformCssMediaCase( array(
 107                         'media' => self::SCREEN_ONLY_MEDIA_QUERY,
 108                         'expectedReturn' => self::SCREEN_ONLY_MEDIA_QUERY,
 109                         'message' => 'On screen request, screen media query with only is preserved.'
 110                 ) );
 111
 112                 $this->assertTransformCssMediaCase( array(
 113                         'media' => 'print',
 114                         'expectedReturn' => 'print',
 115                         'message' => 'On screen request, print media type is preserved'
 116                 ) );
 117         }
 118
 119         /**
 120          * Tests handheld behavior
 121          * @covers OutputPage::transformCssMedia
 122          */
 123         public function testHandheld() {
 124                 $this->assertTransformCssMediaCase( array(
 125                         'handheldQuery' => '1',
 126                         'media' => 'handheld',
 127                         'expectedReturn' => '',
 128                         'message' => 'On request with handheld querystring and media is handheld, returns empty string'
 129                 ) );
 130
 131                 $this->assertTransformCssMediaCase( array(
 132                         'handheldQuery' => '1',
 133                         'media' => 'screen',
 134                         'expectedReturn' => null,
 135                         'message' => 'On request with handheld querystring and media is screen, returns null'
 136                 ) );
 137         }
 138
 139         public static function provideMakeResourceLoaderLink() {
 140                 return array(
 141                         // Load module script only
 142                         array(
 143                                 array( 'test.foo', ResourceLoaderModule::TYPE_SCRIPTS ),
 144                                 '<script>var _mwq = _mwq || []; _mwq.push( function ( mw ) {' .
 145                                 ' document.write("\u003Cscript src=\"http://127.0.0.1:8080/w/load.php?debug=' .
 146                                 'false\u0026amp;lang=en\u0026amp;modules=test.foo\u0026amp;only=scripts\u0026' .
 147                                 'amp;skin=fallback\u0026amp;*\"\u003E\u003C/script\u003E"); } );</script>
 148 '
 149                         ),
 150                         array(
 151                                 // Don't condition wrap raw modules (like the startup module)
 152                                 array( 'test.raw', ResourceLoaderModule::TYPE_SCRIPTS ),
 153                                 '<script src="http://127.0.0.1:8080/w/load.php?debug=false&amp;lang=en&amp;' .
 154                                 'modules=test.raw&amp;only=scripts&amp;skin=fallback&amp;*"></script>
 155 '
 156                         ),
 157                         // Load module styles only
 158                         // This also tests the order the modules are put into the url
 159                         array(
 160                                 array( array( 'test.baz', 'test.foo', 'test.bar' ), ResourceLoaderModule::TYPE_STYLES ),
 161                                 '<link rel=stylesheet href="http://127.0.0.1:8080/w/load.php?debug=false&amp;' .
 162                                 'lang=en&amp;modules=test.bar%2Cbaz%2Cfoo&amp;only=styles&amp;skin=fallback&amp;*">
 163 '
 164                         ),
 165                         // Load private module (only=scripts)
 166                         array(
 167                                 array( 'test.quux', ResourceLoaderModule::TYPE_SCRIPTS ),
 168                                 '<script>var _mwq = _mwq || []; _mwq.push( function ( mw ) {' .
 169                                 ' mw.test.baz({token:123});mw.loader.state({"test.quux":"ready"});
 170 ' . ' } );</script>
 171 '
 172                         ),
 173                         // Load private module (combined)
 174                         array(
 175                                 array( 'test.quux', ResourceLoaderModule::TYPE_COMBINED ),
 176                                 '<script>var _mwq = _mwq || []; _mwq.push( function ( mw ) {' .
 177                                 ' mw.loader.implement("test.quux",function($,jQuery){mw.test.baz({token:123});}' .
 178                                 ',{"css":[".mw-icon{transition:none}\n"]},{},{});
 179 ' . ' } );</script>
 180 '
 181                         ),
 182                         // Load module script with ESI
 183                         array(
 184                                 array( 'test.foo', ResourceLoaderModule::TYPE_SCRIPTS, true ),
 185                                 '<script><esi:include src="http://127.0.0.1:8080/w/load.php?debug=false&amp;' .
 186                                 'lang=en&amp;modules=test.foo&amp;only=scripts&amp;skin=fallback&amp;*" /></script>
 187 '
 188                         ),
 189                         // Load module styles with ESI
 190                         array(
 191                                 array( 'test.foo', ResourceLoaderModule::TYPE_STYLES, true ),
 192                                 '<style><esi:include src="http://127.0.0.1:8080/w/load.php?debug=false&amp;' .
 193                                 'lang=en&amp;modules=test.foo&amp;only=styles&amp;skin=fallback&amp;*" /></style>
 194 ',
 195                         ),
 196                         // Load no modules
 197                         array(
 198                                 array( array(), ResourceLoaderModule::TYPE_COMBINED ),
 199                                 '',
 200                         ),
 201                         // noscript group
 202                         array(
 203                                 array( 'test.noscript', ResourceLoaderModule::TYPE_STYLES ),
 204                                 '<noscript><link rel=stylesheet href="http://127.0.0.1:8080/w/load.php?debug=' .
 205                                 'false&amp;lang=en&amp;modules=test.noscript&amp;only=styles&amp;skin=fallback' .
 206                                 '&amp;*"></noscript>
 207 '
 208                         ),
 209                         // Load two modules in separate groups
 210                         array(
 211                                 array( array( 'test.group.foo', 'test.group.bar' ), ResourceLoaderModule::TYPE_COMBINED ),
 212                                 '<script>var _mwq = _mwq || []; _mwq.push( function ( mw ) { ' .
 213                                 'document.write("\u003Cscript src=\"http://127.0.0.1:8080/w/load.php?debug=false' .
 214                                 '\u0026amp;lang=en\u0026amp;modules=test.group.bar\u0026amp;skin=fallback\u0026' .
 215                                 'amp;*\"\u003E\u003C/script\u003E"); } );</script>
 216 <script>var _mwq = _mwq || []; _mwq.push( function ( mw ) { document.write(' .
 217                                 '"\u003Cscript src=\"http://127.0.0.1:8080/w/load.php?debug=false\u0026amp;' .
 218                                 'lang=en\u0026amp;modules=test.group.foo\u0026amp;skin=fallback\u0026amp;*\\' .
 219                                 '"\u003E\u003C/script\u003E"); } );</script>
 220 '
 221                         ),
 222                 );
 223         }
 224
 225         /**
 226          * @dataProvider provideMakeResourceLoaderLink
 227          * @covers OutputPage::makeResourceLoaderLink
 228          */
 229         public function testMakeResourceLoaderLink( $args, $expectedHtml ) {
 230                 $this->setMwGlobals( array(
 231                         'wgResourceLoaderDebug' => false,
 232                         'wgResourceLoaderUseESI' => true,
 233                         'wgLoadScript' => 'http://127.0.0.1:8080/w/load.php',
 234                         // Affects whether CDATA is inserted
 235                         'wgWellFormedXml' => false,
 236                 ) );
 237                 $class = new ReflectionClass( 'OutputPage' );
 238                 $method = $class->getMethod( 'makeResourceLoaderLink' );
 239                 $method->setAccessible( true );
 240                 $ctx = new RequestContext();
 241                 $ctx->setSkin( SkinFactory::getDefaultInstance()->makeSkin( 'fallback' ) );
 242                 $ctx->setLanguage( 'en' );
 243                 $out = new OutputPage( $ctx );
 244                 $rl = $out->getResourceLoader();
 245                 $rl->register( array(
 246                         'test.foo' => new ResourceLoaderTestModule( array(
 247                                 'script' => 'mw.test.foo( { a: true } );',
 248                                 'styles' => '.mw-test-foo { content: "style"; }',
 249                         )),
 250                         'test.bar' => new ResourceLoaderTestModule( array(
 251                                 'script' => 'mw.test.bar( { a: true } );',
 252                                 'styles' => '.mw-test-bar { content: "style"; }',
 253                         )),
 254                         'test.baz' => new ResourceLoaderTestModule( array(
 255                                 'script' => 'mw.test.baz( { a: true } );',
 256                                 'styles' => '.mw-test-baz { content: "style"; }',
 257                         )),
 258                         'test.quux' => new ResourceLoaderTestModule( array(
 259                                 'script' => 'mw.test.baz( { token: 123 } );',
 260                                 'styles' => '/* pref-animate=off */ .mw-icon { transition: none; }',
 261                                 'group' => 'private',
 262                         )),
 263                         'test.raw' => new ResourceLoaderTestModule( array(
 264                                 'script' => 'mw.test.baz( { token: 123 } );',
 265                                 'isRaw' => true,
 266                         )),
 267                         'test.noscript' => new ResourceLoaderTestModule( array(
 268                                 'styles' => '.mw-test-noscript { content: "style"; }',
 269                                 'group' => 'noscript',
 270                         )),
 271                         'test.group.bar' => new ResourceLoaderTestModule( array(
 272                                 'styles' => '.mw-group-bar { content: "style"; }',
 273                                 'group' => 'bar',
 274                         )),
 275                         'test.group.foo' => new ResourceLoaderTestModule( array(
 276                                 'styles' => '.mw-group-foo { content: "style"; }',
 277                                 'group' => 'foo',
 278                         )),
 279                 ) );
 280                 $links = $method->invokeArgs( $out, $args );
 281                 // Strip comments to avoid variation due to wgDBname in WikiID and cache key
 282                 $actualHtml = preg_replace( '#/\*[^*]+\*/#', '', $links['html'] );
 283                 $this->assertEquals( $expectedHtml, $actualHtml );
 284         }
 285 }