3 class ResourceLoaderTest
extends ResourceLoaderTestCase
{
5 protected function setUp() {
9 'wgResourceLoaderLESSImportPaths' => [
10 dirname( dirname( __DIR__
) ) . '/data/less/common',
12 'wgResourceLoaderLESSVars' => [
21 * Ensure the ResourceLoaderRegisterModules hook is called.
23 * @covers ResourceLoader::__construct
25 public function testConstructRegistrationHook() {
26 $resourceLoaderRegisterModulesHook = false;
28 $this->setMwGlobals( 'wgHooks', [
29 'ResourceLoaderRegisterModules' => [
30 function ( &$resourceLoader ) use ( &$resourceLoaderRegisterModulesHook ) {
31 $resourceLoaderRegisterModulesHook = true;
36 $unused = new ResourceLoader();
38 $resourceLoaderRegisterModulesHook,
39 'Hook ResourceLoaderRegisterModules called'
44 * @covers ResourceLoader::register
45 * @covers ResourceLoader::getModule
47 public function testRegisterValid() {
48 $module = new ResourceLoaderTestModule();
49 $resourceLoader = new EmptyResourceLoader();
50 $resourceLoader->register( 'test', $module );
51 $this->assertEquals( $module, $resourceLoader->getModule( 'test' ) );
55 * @covers ResourceLoader::register
57 public function testRegisterInvalidName() {
58 $resourceLoader = new EmptyResourceLoader();
59 $this->setExpectedException( 'MWException', "name 'test!invalid' is invalid" );
60 $resourceLoader->register( 'test!invalid', new ResourceLoaderTestModule() );
64 * @covers ResourceLoader::register
66 public function testRegisterInvalidType() {
67 $resourceLoader = new EmptyResourceLoader();
68 $this->setExpectedException( 'MWException', 'ResourceLoader module info type error' );
69 $resourceLoader->register( 'test', new stdClass() );
73 * @covers ResourceLoader::getModuleNames
75 public function testGetModuleNames() {
76 // Use an empty one so that core and extension modules don't get in.
77 $resourceLoader = new EmptyResourceLoader();
78 $resourceLoader->register( 'test.foo', new ResourceLoaderTestModule() );
79 $resourceLoader->register( 'test.bar', new ResourceLoaderTestModule() );
81 [ 'test.foo', 'test.bar' ],
82 $resourceLoader->getModuleNames()
87 * @covers ResourceLoader::isModuleRegistered
89 public function testIsModuleRegistered() {
90 $rl = new EmptyResourceLoader();
91 $rl->register( 'test', new ResourceLoaderTestModule() );
92 $this->assertTrue( $rl->isModuleRegistered( 'test' ) );
93 $this->assertFalse( $rl->isModuleRegistered( 'test.unknown' ) );
97 * @covers ResourceLoader::getModule
99 public function testGetModuleUnknown() {
100 $rl = new EmptyResourceLoader();
101 $this->assertSame( null, $rl->getModule( 'test' ) );
105 * @covers ResourceLoader::getModule
107 public function testGetModuleClass() {
108 $rl = new EmptyResourceLoader();
109 $rl->register( 'test', [ 'class' => ResourceLoaderTestModule
::class ] );
110 $this->assertInstanceOf(
111 ResourceLoaderTestModule
::class,
112 $rl->getModule( 'test' )
117 * @covers ResourceLoader::getModule
119 public function testGetModuleClassDefault() {
120 $rl = new EmptyResourceLoader();
121 $rl->register( 'test', [] );
122 $this->assertInstanceOf(
123 ResourceLoaderFileModule
::class,
124 $rl->getModule( 'test' ),
125 'Array-style module registrations default to FileModule'
130 * @covers ResourceLoaderFileModule::compileLessFile
132 public function testLessFileCompilation() {
133 $context = $this->getResourceLoaderContext();
134 $basePath = __DIR__
. '/../../data/less/module';
135 $module = new ResourceLoaderFileModule( [
136 'localBasePath' => $basePath,
137 'styles' => [ 'styles.less' ],
139 $module->setName( 'test.less' );
140 $styles = $module->getStyles( $context );
141 $this->assertStringEqualsFile( $basePath . '/styles.css', $styles['all'] );
144 public static function providePackedModules() {
147 'Example from makePackedModulesString doc comment',
148 [ 'foo.bar', 'foo.baz', 'bar.baz', 'bar.quux' ],
149 'foo.bar,baz|bar.baz,quux',
152 'Example from expandModuleNames doc comment',
153 [ 'jquery.foo', 'jquery.bar', 'jquery.ui.baz', 'jquery.ui.quux' ],
154 'jquery.foo,bar|jquery.ui.baz,quux',
157 'Regression fixed in r88706 with dotless names',
158 [ 'foo', 'bar', 'baz' ],
162 'Prefixless modules after a prefixed module',
163 [ 'single.module', 'foobar', 'foobaz' ],
164 'single.module|foobar,foobaz',
170 * @dataProvider providePackedModules
171 * @covers ResourceLoader::makePackedModulesString
173 public function testMakePackedModulesString( $desc, $modules, $packed ) {
174 $this->assertEquals( $packed, ResourceLoader
::makePackedModulesString( $modules ), $desc );
178 * @dataProvider providePackedModules
179 * @covers ResourceLoaderContext::expandModuleNames
181 public function testexpandModuleNames( $desc, $modules, $packed ) {
182 $this->assertEquals( $modules, ResourceLoaderContext
::expandModuleNames( $packed ), $desc );
185 public static function provideAddSource() {
187 [ 'foowiki', 'https://example.org/w/load.php', 'foowiki' ],
188 [ 'foowiki', [ 'loadScript' => 'https://example.org/w/load.php' ], 'foowiki' ],
191 'foowiki' => 'https://example.org/w/load.php',
192 'bazwiki' => 'https://example.com/w/load.php',
195 [ 'foowiki', 'bazwiki' ]
201 * @dataProvider provideAddSource
202 * @covers ResourceLoader::addSource
203 * @covers ResourceLoader::getSources
205 public function testAddSource( $name, $info, $expected ) {
206 $rl = new ResourceLoader
;
207 $rl->addSource( $name, $info );
208 if ( is_array( $expected ) ) {
209 foreach ( $expected as $source ) {
210 $this->assertArrayHasKey( $source, $rl->getSources() );
213 $this->assertArrayHasKey( $expected, $rl->getSources() );
218 * @covers ResourceLoader::addSource
220 public function testAddSourceDupe() {
221 $rl = new ResourceLoader
;
222 $this->setExpectedException( 'MWException', 'ResourceLoader duplicate source addition error' );
223 $rl->addSource( 'foo', 'https://example.org/w/load.php' );
224 $rl->addSource( 'foo', 'https://example.com/w/load.php' );
228 * @covers ResourceLoader::addSource
230 public function testAddSourceInvalid() {
231 $rl = new ResourceLoader
;
232 $this->setExpectedException( 'MWException', 'with no "loadScript" key' );
233 $rl->addSource( 'foo', [ 'x' => 'https://example.org/w/load.php' ] );
236 public static function provideLoaderImplement() {
239 'title' => 'Implement scripts, styles and messages',
241 'name' => 'test.example',
242 'scripts' => 'mw.example();',
243 'styles' => [ 'css' => [ '.mw-example {}' ] ],
244 'messages' => [ 'example' => '' ],
247 'expected' => 'mw.loader.implement( "test.example", function ( $, jQuery, require, module ) {
258 'title' => 'Implement scripts',
260 'name' => 'test.example',
261 'scripts' => 'mw.example();',
264 'expected' => 'mw.loader.implement( "test.example", function ( $, jQuery, require, module ) {
269 'title' => 'Implement styles',
271 'name' => 'test.example',
273 'styles' => [ 'css' => [ '.mw-example {}' ] ],
274 'messages' => new XmlJsCode( '{}' ),
276 'expected' => 'mw.loader.implement( "test.example", [], {
283 'title' => 'Implement scripts and messages',
285 'name' => 'test.example',
286 'scripts' => 'mw.example();',
287 'messages' => [ 'example' => '' ],
289 'expected' => 'mw.loader.implement( "test.example", function ( $, jQuery, require, module ) {
296 'title' => 'Implement scripts and templates',
298 'name' => 'test.example',
299 'scripts' => 'mw.example();',
300 'templates' => [ 'example.html' => '' ],
302 'expected' => 'mw.loader.implement( "test.example", function ( $, jQuery, require, module ) {
309 'title' => 'Implement unwrapped user script',
312 'scripts' => 'mw.example( 1 );',
314 'expected' => 'mw.loader.implement( "user", "mw.example( 1 );" );',
317 'title' => 'Implement unwrapped user script',
321 'scripts' => 'mw.example( 1 );',
323 'expected' => 'mw.loader.implement("user","mw.example(1);");',
329 * @dataProvider provideLoaderImplement
330 * @covers ResourceLoader::makeLoaderImplementScript
331 * @covers ResourceLoader::trimArray
333 public function testMakeLoaderImplementScript( $case ) {
335 'styles' => [], 'templates' => [], 'messages' => new XmlJsCode( '{}' ),
338 ResourceLoader
::clearCache();
339 $this->setMwGlobals( 'wgResourceLoaderDebug', $case['debug'] );
343 ResourceLoader
::makeLoaderImplementScript(
354 * @covers ResourceLoader::makeLoaderImplementScript
356 public function testMakeLoaderImplementScriptInvalid() {
357 $this->setExpectedException( 'MWException', 'Invalid scripts error' );
358 ResourceLoader
::makeLoaderImplementScript(
368 * @covers ResourceLoader::makeLoaderSourcesScript
370 public function testMakeLoaderSourcesScript() {
372 'mw.loader.addSource( "local", "/w/load.php" );',
373 ResourceLoader
::makeLoaderSourcesScript( 'local', '/w/load.php' )
376 'mw.loader.addSource( {
377 "local": "/w/load.php"
379 ResourceLoader
::makeLoaderSourcesScript( [ 'local' => '/w/load.php' ] )
382 'mw.loader.addSource( {
383 "local": "/w/load.php",
384 "example": "https://example.org/w/load.php"
386 ResourceLoader
::makeLoaderSourcesScript( [
387 'local' => '/w/load.php',
388 'example' => 'https://example.org/w/load.php'
392 'mw.loader.addSource( [] );',
393 ResourceLoader
::makeLoaderSourcesScript( [] )
397 private static function fakeSources() {
400 'loadScript' => '//example.org/w/load.php',
401 'apiScript' => '//example.org/w/api.php',
404 'loadScript' => '//example.com/w/load.php',
405 'apiScript' => '//example.com/w/api.php',
411 * @covers ResourceLoader::getLoadScript
413 public function testGetLoadScript() {
414 $this->setMwGlobals( 'wgResourceLoaderSources', [] );
415 $rl = new ResourceLoader();
416 $sources = self
::fakeSources();
417 $rl->addSource( $sources );
418 foreach ( [ 'examplewiki', 'example2wiki' ] as $name ) {
419 $this->assertEquals( $rl->getLoadScript( $name ), $sources[$name]['loadScript'] );
423 $rl->getLoadScript( 'thiswasneverreigstered' );
424 $this->assertTrue( false, 'ResourceLoader::getLoadScript should have thrown an exception' );
425 } catch ( MWException
$e ) {
426 $this->assertTrue( true );