1ecdf21d9298d8fb14ab0cbda0213e6e2413ca91
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 testRegisterEmptyString() {
58 $module = new ResourceLoaderTestModule();
59 $resourceLoader = new EmptyResourceLoader();
60 $resourceLoader->register( '', $module );
61 $this->assertEquals( $module, $resourceLoader->getModule( '' ) );
65 * @covers ResourceLoader::register
67 public function testRegisterInvalidName() {
68 $resourceLoader = new EmptyResourceLoader();
69 $this->setExpectedException( 'MWException', "name 'test!invalid' is invalid" );
70 $resourceLoader->register( 'test!invalid', new ResourceLoaderTestModule() );
74 * @covers ResourceLoader::register
76 public function testRegisterInvalidType() {
77 $resourceLoader = new EmptyResourceLoader();
78 $this->setExpectedException( 'MWException', 'ResourceLoader module info type error' );
79 $resourceLoader->register( 'test', new stdClass() );
83 * @covers ResourceLoader::getModuleNames
85 public function testGetModuleNames() {
86 // Use an empty one so that core and extension modules don't get in.
87 $resourceLoader = new EmptyResourceLoader();
88 $resourceLoader->register( 'test.foo', new ResourceLoaderTestModule() );
89 $resourceLoader->register( 'test.bar', new ResourceLoaderTestModule() );
91 [ 'test.foo', 'test.bar' ],
92 $resourceLoader->getModuleNames()
97 * @covers ResourceLoader::isModuleRegistered
99 public function testIsModuleRegistered() {
100 $rl = new EmptyResourceLoader();
101 $rl->register( 'test', new ResourceLoaderTestModule() );
102 $this->assertTrue( $rl->isModuleRegistered( 'test' ) );
103 $this->assertFalse( $rl->isModuleRegistered( 'test.unknown' ) );
107 * @covers ResourceLoader::getModule
109 public function testGetModuleUnknown() {
110 $rl = new EmptyResourceLoader();
111 $this->assertSame( null, $rl->getModule( 'test' ) );
115 * @covers ResourceLoader::getModule
117 public function testGetModuleClass() {
118 $rl = new EmptyResourceLoader();
119 $rl->register( 'test', [ 'class' => ResourceLoaderTestModule
::class ] );
120 $this->assertInstanceOf(
121 ResourceLoaderTestModule
::class,
122 $rl->getModule( 'test' )
127 * @covers ResourceLoader::getModule
129 public function testGetModuleClassDefault() {
130 $rl = new EmptyResourceLoader();
131 $rl->register( 'test', [] );
132 $this->assertInstanceOf(
133 ResourceLoaderFileModule
::class,
134 $rl->getModule( 'test' ),
135 'Array-style module registrations default to FileModule'
140 * @covers ResourceLoaderFileModule::compileLessFile
142 public function testLessFileCompilation() {
143 $context = $this->getResourceLoaderContext();
144 $basePath = __DIR__
. '/../../data/less/module';
145 $module = new ResourceLoaderFileModule( [
146 'localBasePath' => $basePath,
147 'styles' => [ 'styles.less' ],
149 $module->setName( 'test.less' );
150 $styles = $module->getStyles( $context );
151 $this->assertStringEqualsFile( $basePath . '/styles.css', $styles['all'] );
154 public static function providePackedModules() {
157 'Example from makePackedModulesString doc comment',
158 [ 'foo.bar', 'foo.baz', 'bar.baz', 'bar.quux' ],
159 'foo.bar,baz|bar.baz,quux',
162 'Example from expandModuleNames doc comment',
163 [ 'jquery.foo', 'jquery.bar', 'jquery.ui.baz', 'jquery.ui.quux' ],
164 'jquery.foo,bar|jquery.ui.baz,quux',
167 'Regression fixed in r88706 with dotless names',
168 [ 'foo', 'bar', 'baz' ],
172 'Prefixless modules after a prefixed module',
173 [ 'single.module', 'foobar', 'foobaz' ],
174 'single.module|foobar,foobaz',
178 [ 'foo', 'foo.baz', 'baz.quux', 'foo.bar' ],
179 'foo|foo.baz,bar|baz.quux',
180 [ 'foo', 'foo.baz', 'foo.bar', 'baz.quux' ],
186 * @dataProvider providePackedModules
187 * @covers ResourceLoader::makePackedModulesString
189 public function testMakePackedModulesString( $desc, $modules, $packed ) {
190 $this->assertEquals( $packed, ResourceLoader
::makePackedModulesString( $modules ), $desc );
194 * @dataProvider providePackedModules
195 * @covers ResourceLoaderContext::expandModuleNames
197 public function testExpandModuleNames( $desc, $modules, $packed, $unpacked = null ) {
199 $unpacked ?
: $modules,
200 ResourceLoaderContext
::expandModuleNames( $packed ),
205 public static function provideAddSource() {
207 [ 'foowiki', 'https://example.org/w/load.php', 'foowiki' ],
208 [ 'foowiki', [ 'loadScript' => 'https://example.org/w/load.php' ], 'foowiki' ],
211 'foowiki' => 'https://example.org/w/load.php',
212 'bazwiki' => 'https://example.com/w/load.php',
215 [ 'foowiki', 'bazwiki' ]
221 * @dataProvider provideAddSource
222 * @covers ResourceLoader::addSource
223 * @covers ResourceLoader::getSources
225 public function testAddSource( $name, $info, $expected ) {
226 $rl = new ResourceLoader
;
227 $rl->addSource( $name, $info );
228 if ( is_array( $expected ) ) {
229 foreach ( $expected as $source ) {
230 $this->assertArrayHasKey( $source, $rl->getSources() );
233 $this->assertArrayHasKey( $expected, $rl->getSources() );
238 * @covers ResourceLoader::addSource
240 public function testAddSourceDupe() {
241 $rl = new ResourceLoader
;
242 $this->setExpectedException( 'MWException', 'ResourceLoader duplicate source addition error' );
243 $rl->addSource( 'foo', 'https://example.org/w/load.php' );
244 $rl->addSource( 'foo', 'https://example.com/w/load.php' );
248 * @covers ResourceLoader::addSource
250 public function testAddSourceInvalid() {
251 $rl = new ResourceLoader
;
252 $this->setExpectedException( 'MWException', 'with no "loadScript" key' );
253 $rl->addSource( 'foo', [ 'x' => 'https://example.org/w/load.php' ] );
256 public static function provideLoaderImplement() {
259 'title' => 'Implement scripts, styles and messages',
261 'name' => 'test.example',
262 'scripts' => 'mw.example();',
263 'styles' => [ 'css' => [ '.mw-example {}' ] ],
264 'messages' => [ 'example' => '' ],
267 'expected' => 'mw.loader.implement( "test.example", function ( $, jQuery, require, module ) {
278 'title' => 'Implement scripts',
280 'name' => 'test.example',
281 'scripts' => 'mw.example();',
284 'expected' => 'mw.loader.implement( "test.example", function ( $, jQuery, require, module ) {
289 'title' => 'Implement styles',
291 'name' => 'test.example',
293 'styles' => [ 'css' => [ '.mw-example {}' ] ],
295 'expected' => 'mw.loader.implement( "test.example", [], {
302 'title' => 'Implement scripts and messages',
304 'name' => 'test.example',
305 'scripts' => 'mw.example();',
306 'messages' => [ 'example' => '' ],
308 'expected' => 'mw.loader.implement( "test.example", function ( $, jQuery, require, module ) {
315 'title' => 'Implement scripts and templates',
317 'name' => 'test.example',
318 'scripts' => 'mw.example();',
319 'templates' => [ 'example.html' => '' ],
321 'expected' => 'mw.loader.implement( "test.example", function ( $, jQuery, require, module ) {
328 'title' => 'Implement unwrapped user script',
331 'scripts' => 'mw.example( 1 );',
334 'expected' => 'mw.loader.implement( "user", "mw.example( 1 );" );',
340 * @dataProvider provideLoaderImplement
341 * @covers ResourceLoader::makeLoaderImplementScript
342 * @covers ResourceLoader::trimArray
344 public function testMakeLoaderImplementScript( $case ) {
347 'styles' => [], 'templates' => [], 'messages' => new XmlJsCode( '{}' )
349 ResourceLoader
::clearCache();
350 $this->setMwGlobals( 'wgResourceLoaderDebug', true );
352 $rl = TestingAccessWrapper
::newFromClass( 'ResourceLoader' );
355 $rl->makeLoaderImplementScript(
357 ( $case['wrap'] && is_string( $case['scripts'] ) )
358 ?
new XmlJsCode( $case['scripts'] )
368 * @covers ResourceLoader::makeLoaderImplementScript
370 public function testMakeLoaderImplementScriptInvalid() {
371 $this->setExpectedException( 'MWException', 'Invalid scripts error' );
372 $rl = TestingAccessWrapper
::newFromClass( 'ResourceLoader' );
373 $rl->makeLoaderImplementScript(
383 * @covers ResourceLoader::makeLoaderSourcesScript
385 public function testMakeLoaderSourcesScript() {
387 'mw.loader.addSource( "local", "/w/load.php" );',
388 ResourceLoader
::makeLoaderSourcesScript( 'local', '/w/load.php' )
391 'mw.loader.addSource( {
392 "local": "/w/load.php"
394 ResourceLoader
::makeLoaderSourcesScript( [ 'local' => '/w/load.php' ] )
397 'mw.loader.addSource( {
398 "local": "/w/load.php",
399 "example": "https://example.org/w/load.php"
401 ResourceLoader
::makeLoaderSourcesScript( [
402 'local' => '/w/load.php',
403 'example' => 'https://example.org/w/load.php'
407 'mw.loader.addSource( [] );',
408 ResourceLoader
::makeLoaderSourcesScript( [] )
412 private static function fakeSources() {
415 'loadScript' => '//example.org/w/load.php',
416 'apiScript' => '//example.org/w/api.php',
419 'loadScript' => '//example.com/w/load.php',
420 'apiScript' => '//example.com/w/api.php',
426 * @covers ResourceLoader::getLoadScript
428 public function testGetLoadScript() {
429 $this->setMwGlobals( 'wgResourceLoaderSources', [] );
430 $rl = new ResourceLoader();
431 $sources = self
::fakeSources();
432 $rl->addSource( $sources );
433 foreach ( [ 'examplewiki', 'example2wiki' ] as $name ) {
434 $this->assertEquals( $rl->getLoadScript( $name ), $sources[$name]['loadScript'] );
438 $rl->getLoadScript( 'thiswasneverreigstered' );
439 $this->assertTrue( false, 'ResourceLoader::getLoadScript should have thrown an exception' );
440 } catch ( MWException
$e ) {
441 $this->assertTrue( true );