PopupsContextTest.php
No OneTemporary
Actions

Size

6 KB

Referenced Files

None

Subscribers

None

PopupsContextTest.php
View Options

	<?php
	/*
	* This file is part of the MediaWiki extension Popups.
	*
	* Popups is free software: you can redistribute it and/or modify
	* it under the terms of the GNU General Public License as published by
	* the Free Software Foundation, either version 2 of the License, or
	* (at your option) any later version.
	*
	* Popups is distributed in the hope that it will be useful,
	* but WITHOUT ANY WARRANTY; without even the implied warranty of
	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	* GNU General Public License for more details.
	*
	* You should have received a copy of the GNU General Public License
	* along with Popups. If not, see <http://www.gnu.org/licenses/>.
	*
	* @file
	* @ingroup extensions
	*/

	use MediaWiki\Config\GlobalVarConfig;
	use MediaWiki\MainConfigNames;
	use MediaWiki\Registration\ExtensionRegistry;
	use MediaWiki\Title\Title;
	use MediaWiki\User\User;
	use PHPUnit\Framework\MockObject\Stub\ConsecutiveCalls;
	use Popups\PopupsContext;
	use Popups\PopupsGadgetsIntegration;

	/**
	* @group Popups
	* @coversDefaultClass \Popups\PopupsContext
	*/
	class PopupsContextTest extends MediaWikiIntegrationTestCase {

	/**
	* Anonymous user id
	* @see MediaWikiIntegrationTestCase::addCoreDBData()
	*/
	private const ANONYMOUS_USER = 0;

	/**
	* Helper method to quickly build Popups Context
	* @param ExtensionRegistry\|null $registry
	* @param PopupsGadgetsIntegration\|null $integration
	* @return PopupsContext
	*/
	protected function getContext( $registry = null, $integration = null ) {
	$config = new GlobalVarConfig();
	$registry = $registry ?: ExtensionRegistry::getInstance();
	if ( $integration === null ) {
	$integration = $this->createMock( PopupsGadgetsIntegration::class );
	$integration->method( 'conflictsWithNavPopupsGadget' )
	->willReturn( false );
	}
	$services = $this->getServiceContainer();
	return new PopupsContext(
	$config,
	$registry,
	$integration,
	$services->getSpecialPageFactory(),
	$services->getUserOptionsLookup()
	);
	}

	/**
	* @covers ::showPreviewsOptInOnPreferencesPage
	* @dataProvider provideConfigForShowPreviewsInOptIn
	* @param array $config
	* @param bool $expected
	*/
	public function testShowPreviewsPreferencesPage( array $config, $expected ) {
	$this->overrideConfigValues( $config );
	$context = $this->getContext();
	$this->assertSame( $expected,
	$context->showPreviewsOptInOnPreferencesPage(),
	'The previews opt-in is ' . ( $expected ? 'shown.' : 'hidden.' ) );
	}

	public static function provideConfigForShowPreviewsInOptIn() {
	return [
	[
	[
	'PopupsHideOptInOnPreferencesPage' => false
	],
	true
	],
	[
	[
	'PopupsHideOptInOnPreferencesPage' => true
	],
	false
	]
	];
	}

	/**
	* @covers ::areDependenciesMet
	* @covers ::__construct
	* @dataProvider provideTestDataForTestAreDependenciesMet
	* @param bool $textExtracts
	* @param bool $pageImages
	* @param string $gateway
	* @param bool $expected
	*/
	public function testAreDependenciesMet( $textExtracts, $pageImages,
	$gateway, $expected ) {
	$this->overrideConfigValue( 'PopupsGateway', $gateway );
	$returnValues = [ $textExtracts, $pageImages ];

	$mock = $this->createMock( ExtensionRegistry::class );
	$mock->method( 'isLoaded' )
	->will( new ConsecutiveCalls( $returnValues ) );
	$context = $this->getContext( $mock );
	$this->assertSame( $expected,
	$context->areDependenciesMet(),
	'Dependencies are ' . ( $expected ? '' : 'not ' ) . 'met.' );
	}

	public static function provideTestDataForTestAreDependenciesMet() {
	return [
	// Dependencies are met
	[
	'textExtracts' => true,
	'pageImages' => true,
	'gateway' => 'mwApiPlain',
	'expected' => true
	],
	// textExtracts dep is missing
	[
	'textExtracts' => false,
	'pageImages' => true,
	'gateway' => 'mwApiPlain',
	'expected' => false
	],
	// PageImages dep is missing
	[
	'textExtracts' => true,
	'pageImages' => false,
	'gateway' => 'mwApiPlain',
	'expected' => false
	],
	// when Popups uses gateway!=mwApiPlain we don't require PageImages nor TextExtracts
	[
	'textExtracts' => false,
	'pageImages' => false,
	'gateway' => 'restbaseHTML',
	'expected' => true
	],
	];
	}

	/**
	* @covers ::isTitleExcluded
	* @dataProvider provideTestIsTitleExcluded
	* @param string[] $excludedPages
	* @param Title $title
	* @param bool $expected
	*/
	public function testIsTitleExcluded( array $excludedPages, Title $title, $expected ) {
	$this->overrideConfigValue( 'PopupsPageDisabled', $excludedPages );
	$context = $this->getContext();
	$this->assertSame( $expected,
	$context->isTitleExcluded( $title ),
	'The title is' . ( $expected ? ' ' : ' not ' ) . 'excluded.' );
	}

	public static function provideTestIsTitleExcluded() {
	$excludedPages = [ 'Special:Userlogin', 'Special:CreateAccount', 'User:A' ];
	return [
	[ $excludedPages, Title::newFromText( 'Main_Page' ), false ],
	[ $excludedPages, Title::newFromText( 'Special:CreateAccount' ), true ],
	[ $excludedPages, Title::newFromText( 'User:A' ), true ],
	[ $excludedPages, Title::newFromText( 'User:A/B' ), true ],
	[ $excludedPages, Title::newFromText( 'User:B' ), false ],
	[ $excludedPages, Title::newFromText( 'User:B/A' ), false ],
	// test canonical name handling
	[ $excludedPages, Title::newFromText( 'Special:UserLogin' ), true ],
	];
	}

	/**
	* Test if special page in different language is excluded
	*
	* @covers ::isTitleExcluded
	*/
	public function testIsTranslatedTitleExcluded() {
	$page = 'Specjalna:Preferencje';
	$excludedPages = [ 'Special:Preferences' ];

	$this->overrideConfigValues( [
	'PopupsPageDisabled' => $excludedPages,
	MainConfigNames::LanguageCode => 'pl',
	] );
	$context = $this->getContext();
	$this->assertTrue(
	$context->isTitleExcluded( Title::newFromText( $page ) ),
	'The title is excluded.' );
	}

	/**
	* @covers ::conflictsWithNavPopupsGadget
	*/
	public function testConflictsWithNavPopupsGadget() {
	$integrationMock = $this->createMock( PopupsGadgetsIntegration::class );

	$user = $this->createMock( User::class );

	$integrationMock->expects( $this->once() )
	->method( 'conflictsWithNavPopupsGadget' )
	->with( $user )
	->willReturn( true );

	$context = $this->getContext( null, $integrationMock );
	$this->assertTrue(
	$context->conflictsWithNavPopupsGadget( $user ),
	'A conflict is identified.' );
	}

	/**
	* @covers ::getConfigBitmaskFromUser
	* @dataProvider provideTestGetConfigBitmaskFromUser
	* @param bool $navPops
	* @param int $expected
	*/
	public function testGetConfigBitmaskFromUser(
	$navPops,
	$expected
	) {
	$contextMock = $this->createPartialMock(
	PopupsContext::class,
	[
	'conflictsWithNavPopupsGadget'
	]
	);
	$contextMock->method( 'conflictsWithNavPopupsGadget' )
	->willReturn( $navPops );

	$this->assertSame(
	$expected,
	$contextMock->getConfigBitmaskFromUser( $this->createMock( User::class ) )
	);
	}

	public static function provideTestGetConfigBitmaskFromUser() {
	return [
	[
	true,
	1,
	],
	[
	false,
	0,
	],
	];
	}
	}

File Metadata

Mime Type: text/x-php
Expires: Sat, May 16, 16:52 (11 h, 36 m)
Storage Engine: local-disk
Storage Format: Raw Data
Storage Handle: 18/6c/68779221f38e5e181e6b1c808bbd
Default Alt Text: PopupsContextTest.php (6 KB)

PopupsContextTest.phpNo OneTemporaryActions

PopupsContextTest.phpView Options

File Metadata

Event Timeline

PopupsContextTest.php
No OneTemporary
Actions

PopupsContextTest.php
View Options