5 * @group ResourceLoader
7 class ResourceLoaderFileModuleTest
extends ResourceLoaderTestCase
{
9 protected function setUp() {
12 // The return value of the closure shouldn't matter since this test should
14 SkinFactory
::getDefaultInstance()->register(
22 private static function getModules() {
24 'localBasePath' => realpath( __DIR__
),
28 'noTemplateModule' => [],
30 'deprecatedModule' => $base +
[
33 'deprecatedTomorrow' => $base +
[
34 'deprecated' => 'Will be removed tomorrow.'
37 'htmlTemplateModule' => $base +
[
39 'templates/template.html',
40 'templates/template2.html',
44 'htmlTemplateUnknown' => $base +
[
46 'templates/notfound.html',
50 'aliasedHtmlTemplateModule' => $base +
[
52 'foo.html' => 'templates/template.html',
53 'bar.html' => 'templates/template2.html',
57 'templateModuleHandlebars' => $base +
[
59 'templates/template_awesome.handlebars',
63 'aliasFooFromBar' => $base +
[
65 'foo.foo' => 'templates/template.bar',
71 public static function providerTemplateDependencies() {
72 $modules = self
::getModules();
76 $modules['noTemplateModule'],
80 $modules['htmlTemplateModule'],
86 $modules['templateModuleHandlebars'],
89 'mediawiki.template.handlebars',
93 $modules['aliasFooFromBar'],
96 'mediawiki.template.foo',
103 * @dataProvider providerTemplateDependencies
104 * @covers ResourceLoaderFileModule::__construct
105 * @covers ResourceLoaderFileModule::getDependencies
107 public function testTemplateDependencies( $module, $expected ) {
108 $rl = new ResourceLoaderFileModule( $module );
109 $rl->setName( 'testing' );
110 $this->assertEquals( $rl->getDependencies(), $expected );
113 public static function providerDeprecatedModules() {
117 'mw.log.warn("This page is using the deprecated ResourceLoader module \"deprecatedModule\".");',
120 'deprecatedTomorrow',
122 '"This page is using the deprecated ResourceLoader module \"deprecatedTomorrow\".\\n' .
123 "Will be removed tomorrow." .
130 * @dataProvider providerDeprecatedModules
131 * @covers ResourceLoaderFileModule::getScript
133 public function testDeprecatedModules( $name, $expected ) {
134 $modules = self
::getModules();
135 $module = new ResourceLoaderFileModule( $modules[$name] );
136 $module->setName( $name );
137 $ctx = $this->getResourceLoaderContext();
138 $this->assertEquals( $module->getScript( $ctx ), $expected );
142 * @covers ResourceLoaderFileModule::getScript
143 * @covers ResourceLoaderFileModule::getScriptFiles
144 * @covers ResourceLoaderFileModule::readScriptFiles
146 public function testGetScript() {
147 $module = new ResourceLoaderFileModule( [
148 'localBasePath' => __DIR__
. '/../../data/resourceloader',
149 'scripts' => [ 'script-nosemi.js', 'script-comment.js' ],
151 $module->setName( 'testing' );
152 $ctx = $this->getResourceLoaderContext();
154 "/* eslint-disable */\nmw.foo()\n" .
156 "/* eslint-disable */\nmw.foo()\n// mw.bar();\n" .
158 $module->getScript( $ctx ),
159 'scripts are concatenated with a new-line'
164 * @covers ResourceLoaderFileModule::getAllStyleFiles
165 * @covers ResourceLoaderFileModule::getAllSkinStyleFiles
166 * @covers ResourceLoaderFileModule::getSkinStyleFiles
168 public function testGetAllSkinStyleFiles() {
176 'bar.css' => [ 'media' => 'print' ],
177 'screen.less' => [ 'media' => 'screen' ],
178 'screen-query.css' => [ 'media' => 'screen and (min-width: 400px)' ],
181 'default' => 'quux-fallback.less',
193 $module = new ResourceLoaderFileModule( $baseParams );
194 $module->setName( 'testing' );
201 'quux-fallback.less',
206 array_map( 'basename', $module->getAllStyleFiles() )
211 * Strip @noflip annotations from CSS code.
215 private static function stripNoflip( $css ) {
216 return str_replace( '/*@noflip*/ ', '', $css );
220 * What happens when you mix @embed and @noflip?
221 * This really is an integration test, but oh well.
223 * @covers ResourceLoaderFileModule::getStyles
224 * @covers ResourceLoaderFileModule::getStyleFiles
225 * @covers ResourceLoaderFileModule::readStyleFiles
226 * @covers ResourceLoaderFileModule::readStyleFile
228 public function testMixedCssAnnotations() {
229 $basePath = __DIR__
. '/../../data/css';
230 $testModule = new ResourceLoaderFileModule( [
231 'localBasePath' => $basePath,
232 'styles' => [ 'test.css' ],
234 $testModule->setName( 'testing' );
235 $expectedModule = new ResourceLoaderFileModule( [
236 'localBasePath' => $basePath,
237 'styles' => [ 'expected.css' ],
239 $expectedModule->setName( 'testing' );
241 $contextLtr = $this->getResourceLoaderContext( [
245 $contextRtl = $this->getResourceLoaderContext( [
250 // Since we want to compare the effect of @noflip+@embed against the effect of just @embed, and
251 // the @noflip annotations are always preserved, we need to strip them first.
253 $expectedModule->getStyles( $contextLtr ),
254 self
::stripNoflip( $testModule->getStyles( $contextLtr ) ),
255 "/*@noflip*/ with /*@embed*/ gives correct results in LTR mode"
258 $expectedModule->getStyles( $contextLtr ),
259 self
::stripNoflip( $testModule->getStyles( $contextRtl ) ),
260 "/*@noflip*/ with /*@embed*/ gives correct results in RTL mode"
264 public static function providerGetTemplates() {
265 $modules = self
::getModules();
269 $modules['noTemplateModule'],
273 $modules['templateModuleHandlebars'],
275 'templates/template_awesome.handlebars' => "wow\n",
279 $modules['htmlTemplateModule'],
281 'templates/template.html' => "<strong>hello</strong>\n",
282 'templates/template2.html' => "<div>goodbye</div>\n",
286 $modules['aliasedHtmlTemplateModule'],
288 'foo.html' => "<strong>hello</strong>\n",
289 'bar.html' => "<div>goodbye</div>\n",
293 $modules['htmlTemplateUnknown'],
300 * @dataProvider providerGetTemplates
301 * @covers ResourceLoaderFileModule::getTemplates
303 public function testGetTemplates( $module, $expected ) {
304 $rl = new ResourceLoaderFileModule( $module );
305 $rl->setName( 'testing' );
307 if ( $expected === false ) {
308 $this->setExpectedException( MWException
::class );
311 $this->assertEquals( $rl->getTemplates(), $expected );
316 * @covers ResourceLoaderFileModule::stripBom
318 public function testBomConcatenation() {
319 $basePath = __DIR__
. '/../../data/css';
320 $testModule = new ResourceLoaderFileModule( [
321 'localBasePath' => $basePath,
322 'styles' => [ 'bom.css' ],
324 $testModule->setName( 'testing' );
326 substr( file_get_contents( "$basePath/bom.css" ), 0, 10 ),
327 "\xef\xbb\xbf.efbbbf",
328 'File has leading BOM'
331 $context = $this->getResourceLoaderContext();
333 $testModule->getStyles( $context ),
334 [ 'all' => ".efbbbf_bom_char_at_start_of_file {}\n" ],
335 'Leading BOM removed when concatenating files'
340 * @covers ResourceLoaderFileModule::compileLessFile
342 public function testLessFileCompilation() {
343 $context = $this->getResourceLoaderContext();
344 $basePath = __DIR__
. '/../../data/less/module';
345 $module = new ResourceLoaderFileTestModule( [
346 'localBasePath' => $basePath,
347 'styles' => [ 'styles.less' ],
349 'lessVars' => [ 'foo' => '2px', 'Foo' => '#eeeeee' ]
351 $module->setName( 'test.less' );
352 $styles = $module->getStyles( $context );
353 $this->assertStringEqualsFile( $basePath . '/styles.css', $styles['all'] );
357 * @covers ResourceLoaderFileModule::getDefinitionSummary
358 * @covers ResourceLoaderFileModule::getFileHashes
360 public function testGetVersionHash() {
361 $context = $this->getResourceLoaderContext();
364 $module = new ResourceLoaderFileTestModule();
365 $version = $module->getVersionHash( $context );
366 $module = new ResourceLoaderFileTestModule( [], [
367 'lessVars' => [ 'key' => 'value' ],
369 $this->assertNotEquals(
371 $module->getVersionHash( $context ),
372 'Using less variables is significant'
376 public function providerGetScriptPackageFiles() {
377 $basePath = __DIR__
. '/../../data/resourceloader';
378 $base = [ 'localBasePath' => $basePath ];
379 $commentScript = file_get_contents( "$basePath/script-comment.js" );
380 $nosemiScript = file_get_contents( "$basePath/script-nosemi.js" );
381 $config = RequestContext
::getMain()->getConfig();
392 'script-comment.js' => [
394 'content' => $commentScript,
396 'script-nosemi.js' => [
398 'content' => $nosemiScript
401 'main' => 'script-comment.js'
408 [ 'name' => 'script-nosemi.js', 'main' => true ]
410 'deprecated' => 'Deprecation test',
411 'name' => 'test-deprecated'
415 'script-comment.js' => [
417 'content' => $commentScript,
419 'script-nosemi.js' => [
421 'content' => 'mw.log.warn(' .
422 '"This page is using the deprecated ResourceLoader module \"test-deprecated\".\\n' .
428 'main' => 'script-nosemi.js'
434 [ 'name' => 'init.js', 'file' => 'script-comment.js', 'main' => true ],
435 [ 'name' => 'nosemi.js', 'file' => 'script-nosemi.js' ],
442 'content' => $commentScript,
446 'content' => $nosemiScript
455 [ 'name' => 'foo.json', 'content' => [ 'Hello' => 'world' ] ],
457 [ 'name' => 'bar.js', 'content' => "console.log('Hello');" ],
458 [ 'name' => 'data.json', 'callback' => function ( $context ) {
459 return [ 'langCode' => $context->getLanguage() ];
461 [ 'name' => 'config.json', 'config' => [
463 'wgVersion' => 'Version',
471 'content' => [ 'Hello' => 'world' ],
475 'content' => (object)[ 'foo' => 'bar', 'answer' => 42 ],
479 'content' => "console.log('Hello');",
483 'content' => [ 'langCode' => 'fy' ]
488 'Sitename' => $config->get( 'Sitename' ),
489 'wgVersion' => $config->get( 'Version' ),
502 [ 'file' => 'script-comment.js' ]
510 [ 'name' => 'foo.json', 'callback' => 'functionThatDoesNotExist142857' ]
518 'foo.json' => [ 'type' => 'script', 'config' => [ 'Sitename' ] ]
526 [ 'name' => 'foo.js', 'config' => 'Sitename' ]
534 'foo.js' => [ 'garbage' => 'data' ]
542 'filethatdoesnotexist142857.js'
551 [ 'name' => 'foo.json', 'content' => [ 'Hello' => 'world' ], 'main' => true ]
560 * @dataProvider providerGetScriptPackageFiles
561 * @covers ResourceLoaderFileModule::getScript
562 * @covers ResourceLoaderFileModule::getPackageFiles
563 * @covers ResourceLoaderFileModule::expandPackageFiles
565 public function testGetScriptPackageFiles( $moduleDefinition, $expected, $contextOptions = [] ) {
566 $module = new ResourceLoaderFileModule( $moduleDefinition );
567 $context = $this->getResourceLoaderContext( $contextOptions );
568 if ( isset( $moduleDefinition['name'] ) ) {
569 $module->setName( $moduleDefinition['name'] );
571 if ( $expected === false ) {
572 $this->setExpectedException( MWException
::class );
573 $module->getScript( $context );
575 $this->assertEquals( $expected, $module->getScript( $context ) );