X-Git-Url: https://scripts.mit.edu/gitweb/autoinstallsdev/mediawiki.git/blobdiff_plain/19e297c21b10b1b8a3acad5e73fc71dcb35db44a..6932310fd58ebef145fa01eb76edf7150284d8ea:/tests/phpunit/includes/resourceloader/ResourceLoaderWikiModuleTest.php

diff --git a/tests/phpunit/includes/resourceloader/ResourceLoaderWikiModuleTest.php b/tests/phpunit/includes/resourceloader/ResourceLoaderWikiModuleTest.php
new file mode 100644
index 00000000..78eec6a6
--- /dev/null
+++ b/tests/phpunit/includes/resourceloader/ResourceLoaderWikiModuleTest.php
@@ -0,0 +1,380 @@
+<?php
+
+use MediaWiki\MediaWikiServices;
+use Wikimedia\Rdbms\IDatabase;
+use Wikimedia\TestingAccessWrapper;
+
+class ResourceLoaderWikiModuleTest extends ResourceLoaderTestCase {
+
+	/**
+	 * @covers ResourceLoaderWikiModule::__construct
+	 * @dataProvider provideConstructor
+	 */
+	public function testConstructor( $params ) {
+		$module = new ResourceLoaderWikiModule( $params );
+		$this->assertInstanceOf( 'ResourceLoaderWikiModule', $module );
+	}
+
+	public static function provideConstructor() {
+		return [
+			// Nothing
+			[ null ],
+			[ [] ],
+			// Unrecognized settings
+			[ [ 'foo' => 'baz' ] ],
+			// Real settings
+			[ [ 'scripts' => [ 'MediaWiki:Common.js' ] ] ],
+		];
+	}
+
+	/**
+	 * @dataProvider provideGetPages
+	 * @covers ResourceLoaderWikiModule::getPages
+	 */
+	public function testGetPages( $params, Config $config, $expected ) {
+		$module = new ResourceLoaderWikiModule( $params );
+		$module->setConfig( $config );
+
+		// Because getPages is protected..
+		$getPages = new ReflectionMethod( $module, 'getPages' );
+		$getPages->setAccessible( true );
+		$out = $getPages->invoke( $module, ResourceLoaderContext::newDummyContext() );
+		$this->assertEquals( $expected, $out );
+	}
+
+	public static function provideGetPages() {
+		$settings = self::getSettings() + [
+			'UseSiteJs' => true,
+			'UseSiteCss' => true,
+		];
+
+		$params = [
+			'styles' => [ 'MediaWiki:Common.css' ],
+			'scripts' => [ 'MediaWiki:Common.js' ],
+		];
+
+		return [
+			[ [], new HashConfig( $settings ), [] ],
+			[ $params, new HashConfig( $settings ), [
+				'MediaWiki:Common.js' => [ 'type' => 'script' ],
+				'MediaWiki:Common.css' => [ 'type' => 'style' ]
+			] ],
+			[ $params, new HashConfig( [ 'UseSiteCss' => false ] + $settings ), [
+				'MediaWiki:Common.js' => [ 'type' => 'script' ],
+			] ],
+			[ $params, new HashConfig( [ 'UseSiteJs' => false ] + $settings ), [
+				'MediaWiki:Common.css' => [ 'type' => 'style' ],
+			] ],
+			[ $params,
+				new HashConfig(
+					[ 'UseSiteJs' => false, 'UseSiteCss' => false ]
+				),
+				[]
+			],
+		];
+	}
+
+	/**
+	 * @covers ResourceLoaderWikiModule::getGroup
+	 * @dataProvider provideGetGroup
+	 */
+	public function testGetGroup( $params, $expected ) {
+		$module = new ResourceLoaderWikiModule( $params );
+		$this->assertEquals( $expected, $module->getGroup() );
+	}
+
+	public static function provideGetGroup() {
+		return [
+			// No group specified
+			[ [], null ],
+			// A random group
+			[ [ 'group' => 'foobar' ], 'foobar' ],
+		];
+	}
+
+	/**
+	 * @covers ResourceLoaderWikiModule::isKnownEmpty
+	 * @dataProvider provideIsKnownEmpty
+	 */
+	public function testIsKnownEmpty( $titleInfo, $group, $expected ) {
+		$module = $this->getMockBuilder( 'ResourceLoaderWikiModule' )
+			->setMethods( [ 'getTitleInfo', 'getGroup' ] )
+			->getMock();
+		$module->expects( $this->any() )
+			->method( 'getTitleInfo' )
+			->will( $this->returnValue( $titleInfo ) );
+		$module->expects( $this->any() )
+			->method( 'getGroup' )
+			->will( $this->returnValue( $group ) );
+		$context = $this->getMockBuilder( 'ResourceLoaderContext' )
+			->disableOriginalConstructor()
+			->getMock();
+		$this->assertEquals( $expected, $module->isKnownEmpty( $context ) );
+	}
+
+	public static function provideIsKnownEmpty() {
+		return [
+			// No valid pages
+			[ [], 'test1', true ],
+			// 'site' module with a non-empty page
+			[
+				[ 'MediaWiki:Common.js' => [ 'page_len' => 1234 ] ],
+				'site',
+				false,
+			],
+			// 'site' module with an empty page
+			[
+				[ 'MediaWiki:Foo.js' => [ 'page_len' => 0 ] ],
+				'site',
+				false,
+			],
+			// 'user' module with a non-empty page
+			[
+				[ 'User:Example/common.js' => [ 'page_len' => 25 ] ],
+				'user',
+				false,
+			],
+			// 'user' module with an empty page
+			[
+				[ 'User:Example/foo.js' => [ 'page_len' => 0 ] ],
+				'user',
+				true,
+			],
+		];
+	}
+
+	/**
+	 * @covers ResourceLoaderWikiModule::getTitleInfo
+	 */
+	public function testGetTitleInfo() {
+		$pages = [
+			'MediaWiki:Common.css' => [ 'type' => 'styles' ],
+			'mediawiki: fallback.css' => [ 'type' => 'styles' ],
+		];
+		$titleInfo = [
+			'MediaWiki:Common.css' => [ 'page_len' => 1234 ],
+			'MediaWiki:Fallback.css' => [ 'page_len' => 0 ],
+		];
+		$expected = $titleInfo;
+
+		$module = $this->getMockBuilder( 'TestResourceLoaderWikiModule' )
+			->setMethods( [ 'getPages' ] )
+			->getMock();
+		$module->method( 'getPages' )->willReturn( $pages );
+		// Can't mock static methods
+		$module::$returnFetchTitleInfo = $titleInfo;
+
+		$context = $this->getMockBuilder( 'ResourceLoaderContext' )
+			->disableOriginalConstructor()
+			->getMock();
+
+		$module = TestingAccessWrapper::newFromObject( $module );
+		$this->assertEquals( $expected, $module->getTitleInfo( $context ), 'Title info' );
+	}
+
+	/**
+	 * @covers ResourceLoaderWikiModule::getTitleInfo
+	 * @covers ResourceLoaderWikiModule::setTitleInfo
+	 * @covers ResourceLoaderWikiModule::preloadTitleInfo
+	 */
+	public function testGetPreloadedTitleInfo() {
+		$pages = [
+			'MediaWiki:Common.css' => [ 'type' => 'styles' ],
+			// Regression against T145673. It's impossible to statically declare page names in
+			// a canonical way since the canonical prefix is localised. As such, the preload
+			// cache computed the right cache key, but failed to find the results when
+			// doing an intersect on the canonical result, producing an empty array.
+			'mediawiki: fallback.css' => [ 'type' => 'styles' ],
+		];
+		$titleInfo = [
+			'MediaWiki:Common.css' => [ 'page_len' => 1234 ],
+			'MediaWiki:Fallback.css' => [ 'page_len' => 0 ],
+		];
+		$expected = $titleInfo;
+
+		$module = $this->getMockBuilder( 'TestResourceLoaderWikiModule' )
+			->setMethods( [ 'getPages' ] )
+			->getMock();
+		$module->method( 'getPages' )->willReturn( $pages );
+		// Can't mock static methods
+		$module::$returnFetchTitleInfo = $titleInfo;
+
+		$rl = new EmptyResourceLoader();
+		$rl->register( 'testmodule', $module );
+		$context = new ResourceLoaderContext( $rl, new FauxRequest() );
+
+		TestResourceLoaderWikiModule::invalidateModuleCache(
+			Title::newFromText( 'MediaWiki:Common.css' ),
+			null,
+			null,
+			wfWikiID()
+		);
+		TestResourceLoaderWikiModule::preloadTitleInfo(
+			$context,
+			wfGetDB( DB_REPLICA ),
+			[ 'testmodule' ]
+		);
+
+		$module = TestingAccessWrapper::newFromObject( $module );
+		$this->assertEquals( $expected, $module->getTitleInfo( $context ), 'Title info' );
+	}
+
+	/**
+	 * @covers ResourceLoaderWikiModule::preloadTitleInfo
+	 */
+	public function testGetPreloadedBadTitle() {
+		// Mock values
+		$pages = [
+			// Covers else branch for invalid page name
+			'[x]' => [ 'type' => 'styles' ],
+		];
+		$titleInfo = [];
+
+		// Set up objects
+		$module = $this->getMockBuilder( 'TestResourceLoaderWikiModule' )
+			->setMethods( [ 'getPages' ] ) ->getMock();
+		$module->method( 'getPages' )->willReturn( $pages );
+		$module::$returnFetchTitleInfo = $titleInfo;
+		$rl = new EmptyResourceLoader();
+		$rl->register( 'testmodule', $module );
+		$context = new ResourceLoaderContext( $rl, new FauxRequest() );
+
+		// Act
+		TestResourceLoaderWikiModule::preloadTitleInfo(
+			$context,
+			wfGetDB( DB_REPLICA ),
+			[ 'testmodule' ]
+		);
+
+		// Assert
+		$module = TestingAccessWrapper::newFromObject( $module );
+		$this->assertEquals( $titleInfo, $module->getTitleInfo( $context ), 'Title info' );
+	}
+
+	/**
+	 * @covers ResourceLoaderWikiModule::preloadTitleInfo
+	 */
+	public function testGetPreloadedTitleInfoEmpty() {
+		$context = new ResourceLoaderContext( new EmptyResourceLoader(), new FauxRequest() );
+		// Covers early return
+		$this->assertSame(
+			null,
+			ResourceLoaderWikiModule::preloadTitleInfo(
+				$context,
+				wfGetDB( DB_REPLICA ),
+				[]
+			)
+		);
+	}
+
+	public static function provideGetContent() {
+		return [
+			'Bad title' => [ null, '[x]' ],
+			'Dead redirect' => [ null, [
+				'text' => 'Dead redirect',
+				'title' => 'Dead_redirect',
+				'redirect' => 1,
+			] ],
+			'Bad content model' => [ null, [
+				'text' => 'MediaWiki:Wikitext',
+				'ns' => NS_MEDIAWIKI,
+				'title' => 'Wikitext',
+			] ],
+			'No JS content found' => [ null, [
+				'text' => 'MediaWiki:Script.js',
+				'ns' => NS_MEDIAWIKI,
+				'title' => 'Script.js',
+			] ],
+			'No CSS content found' => [ null, [
+				'text' => 'MediaWiki:Styles.css',
+				'ns' => NS_MEDIAWIKI,
+				'title' => 'Script.css',
+			] ],
+		];
+	}
+
+	/**
+	 * @covers ResourceLoaderWikiModule::getContent
+	 * @dataProvider provideGetContent
+	 */
+	public function testGetContent( $expected, $title ) {
+		$context = $this->getResourceLoaderContext( [], new EmptyResourceLoader );
+		$module = $this->getMockBuilder( 'ResourceLoaderWikiModule' )
+			->setMethods( [ 'getContentObj' ] ) ->getMock();
+		$module->expects( $this->any() )
+			->method( 'getContentObj' )->willReturn( null );
+
+		if ( is_array( $title ) ) {
+			$title += [ 'ns' => NS_MAIN, 'id' => 1, 'len' => 1, 'redirect' => 0 ];
+			$titleText = $title['text'];
+			// Mock Title db access via LinkCache
+			MediaWikiServices::getInstance()->getLinkCache()->addGoodLinkObj(
+				$title['id'],
+				new TitleValue( $title['ns'], $title['title'] ),
+				$title['len'],
+				$title['redirect']
+			);
+		} else {
+			$titleText = $title;
+		}
+
+		$module = TestingAccessWrapper::newFromObject( $module );
+		$this->assertEquals(
+			$expected,
+			$module->getContent( $titleText )
+		);
+	}
+
+	/**
+	 * @covers ResourceLoaderWikiModule::getContent
+	 */
+	public function testGetContentForRedirects() {
+		// Set up context and module object
+		$context = $this->getResourceLoaderContext( [], new EmptyResourceLoader );
+		$module = $this->getMockBuilder( 'ResourceLoaderWikiModule' )
+			->setMethods( [ 'getPages', 'getContentObj' ] )
+			->getMock();
+		$module->expects( $this->any() )
+			->method( 'getPages' )
+			->will( $this->returnValue( [
+				'MediaWiki:Redirect.js' => [ 'type' => 'script' ]
+			] ) );
+		$module->expects( $this->any() )
+			->method( 'getContentObj' )
+			->will( $this->returnCallback( function ( Title $title ) {
+				if ( $title->getPrefixedText() === 'MediaWiki:Redirect.js' ) {
+					$handler = new JavaScriptContentHandler();
+					return $handler->makeRedirectContent(
+						Title::makeTitle( NS_MEDIAWIKI, 'Target.js' )
+					);
+				} elseif ( $title->getPrefixedText() === 'MediaWiki:Target.js' ) {
+					return new JavaScriptContent( 'target;' );
+				} else {
+					return null;
+				}
+			} ) );
+
+		// Mock away Title's db queries with LinkCache
+		MediaWikiServices::getInstance()->getLinkCache()->addGoodLinkObj(
+			1, // id
+			new TitleValue( NS_MEDIAWIKI, 'Redirect.js' ),
+			1, // len
+			1 // redirect
+		);
+
+		$this->assertEquals(
+			"/*\nMediaWiki:Redirect.js\n*/\ntarget;\n",
+			$module->getScript( $context ),
+			'Redirect resolved by getContent'
+		);
+	}
+}
+
+class TestResourceLoaderWikiModule extends ResourceLoaderWikiModule {
+	public static $returnFetchTitleInfo = null;
+	protected static function fetchTitleInfo( IDatabase $db, array $pages, $fname = null ) {
+		$ret = self::$returnFetchTitleInfo;
+		self::$returnFetchTitleInfo = null;
+		return $ret;
+	}
+}