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',
168 [ 'foo', 'foo.baz', 'baz.quux', 'foo.bar' ],
169 'foo|foo.baz,bar|baz.quux',
170 [ 'foo', 'foo.baz', 'foo.bar', 'baz.quux' ],
176 * @dataProvider providePackedModules
177 * @covers ResourceLoader::makePackedModulesString
179 public function testMakePackedModulesString( $desc, $modules, $packed ) {
180 $this->assertEquals( $packed, ResourceLoader
::makePackedModulesString( $modules ), $desc );
184 * @dataProvider providePackedModules
185 * @covers ResourceLoaderContext::expandModuleNames
187 public function testExpandModuleNames( $desc, $modules, $packed, $unpacked = null ) {
189 $unpacked ?
: $modules,
190 ResourceLoaderContext
::expandModuleNames( $packed ),
195 public static function provideAddSource() {
197 [ 'foowiki', 'https://example.org/w/load.php', 'foowiki' ],
198 [ 'foowiki', [ 'loadScript' => 'https://example.org/w/load.php' ], 'foowiki' ],
201 'foowiki' => 'https://example.org/w/load.php',
202 'bazwiki' => 'https://example.com/w/load.php',
205 [ 'foowiki', 'bazwiki' ]
211 * @dataProvider provideAddSource
212 * @covers ResourceLoader::addSource
213 * @covers ResourceLoader::getSources
215 public function testAddSource( $name, $info, $expected ) {
216 $rl = new ResourceLoader
;
217 $rl->addSource( $name, $info );
218 if ( is_array( $expected ) ) {
219 foreach ( $expected as $source ) {
220 $this->assertArrayHasKey( $source, $rl->getSources() );
223 $this->assertArrayHasKey( $expected, $rl->getSources() );
228 * @covers ResourceLoader::addSource
230 public function testAddSourceDupe() {
231 $rl = new ResourceLoader
;
232 $this->setExpectedException( 'MWException', 'ResourceLoader duplicate source addition error' );
233 $rl->addSource( 'foo', 'https://example.org/w/load.php' );
234 $rl->addSource( 'foo', 'https://example.com/w/load.php' );
238 * @covers ResourceLoader::addSource
240 public function testAddSourceInvalid() {
241 $rl = new ResourceLoader
;
242 $this->setExpectedException( 'MWException', 'with no "loadScript" key' );
243 $rl->addSource( 'foo', [ 'x' => 'https://example.org/w/load.php' ] );
246 public static function provideLoaderImplement() {
249 'title' => 'Implement scripts, styles and messages',
251 'name' => 'test.example',
252 'scripts' => 'mw.example();',
253 'styles' => [ 'css' => [ '.mw-example {}' ] ],
254 'messages' => [ 'example' => '' ],
257 'expected' => 'mw.loader.implement( "test.example", function ( $, jQuery, require, module ) {
268 'title' => 'Implement scripts',
270 'name' => 'test.example',
271 'scripts' => 'mw.example();',
274 'expected' => 'mw.loader.implement( "test.example", function ( $, jQuery, require, module ) {
279 'title' => 'Implement styles',
281 'name' => 'test.example',
283 'styles' => [ 'css' => [ '.mw-example {}' ] ],
285 'expected' => 'mw.loader.implement( "test.example", [], {
292 'title' => 'Implement scripts and messages',
294 'name' => 'test.example',
295 'scripts' => 'mw.example();',
296 'messages' => [ 'example' => '' ],
298 'expected' => 'mw.loader.implement( "test.example", function ( $, jQuery, require, module ) {
305 'title' => 'Implement scripts and templates',
307 'name' => 'test.example',
308 'scripts' => 'mw.example();',
309 'templates' => [ 'example.html' => '' ],
311 'expected' => 'mw.loader.implement( "test.example", function ( $, jQuery, require, module ) {
318 'title' => 'Implement unwrapped user script',
321 'scripts' => 'mw.example( 1 );',
324 'expected' => 'mw.loader.implement( "user", "mw.example( 1 );" );',
330 * @dataProvider provideLoaderImplement
331 * @covers ResourceLoader::makeLoaderImplementScript
332 * @covers ResourceLoader::trimArray
334 public function testMakeLoaderImplementScript( $case ) {
337 'styles' => [], 'templates' => [], 'messages' => new XmlJsCode( '{}' )
339 ResourceLoader
::clearCache();
340 $this->setMwGlobals( 'wgResourceLoaderDebug', true );
342 $rl = TestingAccessWrapper
::newFromClass( 'ResourceLoader' );
345 $rl->makeLoaderImplementScript(
347 ( $case['wrap'] && is_string( $case['scripts'] ) )
348 ?
new XmlJsCode( $case['scripts'] )
358 * @covers ResourceLoader::makeLoaderImplementScript
360 public function testMakeLoaderImplementScriptInvalid() {
361 $this->setExpectedException( 'MWException', 'Invalid scripts error' );
362 $rl = TestingAccessWrapper
::newFromClass( 'ResourceLoader' );
363 $rl->makeLoaderImplementScript(
373 * @covers ResourceLoader::makeLoaderSourcesScript
375 public function testMakeLoaderSourcesScript() {
377 'mw.loader.addSource( "local", "/w/load.php" );',
378 ResourceLoader
::makeLoaderSourcesScript( 'local', '/w/load.php' )
381 'mw.loader.addSource( {
382 "local": "/w/load.php"
384 ResourceLoader
::makeLoaderSourcesScript( [ 'local' => '/w/load.php' ] )
387 'mw.loader.addSource( {
388 "local": "/w/load.php",
389 "example": "https://example.org/w/load.php"
391 ResourceLoader
::makeLoaderSourcesScript( [
392 'local' => '/w/load.php',
393 'example' => 'https://example.org/w/load.php'
397 'mw.loader.addSource( [] );',
398 ResourceLoader
::makeLoaderSourcesScript( [] )
402 private static function fakeSources() {
405 'loadScript' => '//example.org/w/load.php',
406 'apiScript' => '//example.org/w/api.php',
409 'loadScript' => '//example.com/w/load.php',
410 'apiScript' => '//example.com/w/api.php',
416 * @covers ResourceLoader::getLoadScript
418 public function testGetLoadScript() {
419 $this->setMwGlobals( 'wgResourceLoaderSources', [] );
420 $rl = new ResourceLoader();
421 $sources = self
::fakeSources();
422 $rl->addSource( $sources );
423 foreach ( [ 'examplewiki', 'example2wiki' ] as $name ) {
424 $this->assertEquals( $rl->getLoadScript( $name ), $sources[$name]['loadScript'] );
428 $rl->getLoadScript( 'thiswasneverreigstered' );
429 $this->assertTrue( false, 'ResourceLoader::getLoadScript should have thrown an exception' );
430 } catch ( MWException
$e ) {
431 $this->assertTrue( true );