Page MenuHomeWickedGov Phorge
Files F5979956

SpecialPageFactoryTest.php
No OneTemporary
Actions

Size
10 KB
Referenced Files
None
Subscribers
None

SpecialPageFactoryTest.php
View Options

<?php
namespace MediaWiki\Tests\SpecialPage;
use Exception;
use MediaWiki\Context\RequestContext;
use MediaWiki\MainConfigNames;
use MediaWiki\MainConfigSchema;
use MediaWiki\Output\OutputPage;
use MediaWiki\Page\PageReferenceValue;
use MediaWiki\Request\FauxRequest;
use MediaWiki\SpecialPage\SpecialPage;
use MediaWiki\SpecialPage\SpecialPageFactory;
use MediaWiki\Specials\SpecialAllPages;
use MediaWiki\Title\Title;
use MediaWikiIntegrationTestCase;
use RuntimeException;
use Wikimedia\ScopedCallback;
use Wikimedia\TestingAccessWrapper;
/**
* Factory for handling the special page list and generating SpecialPage objects.
*
* This program 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.
*
* This program 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 this program; if not, write to the Free Software Foundation, Inc.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
* http://www.gnu.org/copyleft/gpl.html
*
* @covers \MediaWiki\SpecialPage\SpecialPageFactory
* @group SpecialPage
*/
class SpecialPageFactoryTest extends MediaWikiIntegrationTestCase {
private function getFactory() {
return $this->getServiceContainer()->getSpecialPageFactory();
}
public function testHookNotCalledTwice() {
$count = 0;
$this->setTemporaryHook(
'SpecialPage_initList',
static function () use ( &$count ) {
$count++;
}
);
$spf = $this->getServiceContainer()->getSpecialPageFactory();
$spf->getNames();
$spf->getNames();
$this->assertSame( 1, $count );
}
public static function newSpecialAllPages() {
return new SpecialAllPages();
}
public static function specialPageProvider() {
$specialPageTestHelper = new SpecialPageTestHelper();
return [
'class name' => [ 'SpecialAllPages', false ],
'closure' => [ static function () {
return new SpecialAllPages();
}, false ],
'function' => [ [ self::class, 'newSpecialAllPages' ], false ],
'callback string' => [ SpecialPageTestHelper::class . '::newSpecialAllPages', false ],
'callback with object' => [
[ $specialPageTestHelper, 'newSpecialAllPages' ],
false
],
'callback array' => [
[ SpecialPageTestHelper::class, 'newSpecialAllPages' ],
false
],
'object factory spec' => [
[ 'class' => SpecialAllPages::class ],
false
]
];
}
/**
* @covers \MediaWiki\SpecialPage\SpecialPageFactory::getPage
* @dataProvider specialPageProvider
*/
public function testGetPage( $spec, $shouldReuseInstance ) {
$this->overrideConfigValue(
MainConfigNames::SpecialPages,
[ 'testdummy' => $spec ] + MainConfigSchema::getDefaultValue( MainConfigNames::SpecialPages )
);
$factory = $this->getFactory();
$page = $factory->getPage( 'testdummy' );
$this->assertInstanceOf( SpecialPage::class, $page );
$page2 = $factory->getPage( 'testdummy' );
$this->assertEquals( $shouldReuseInstance, $page2 === $page, "Should re-use instance:" );
}
/**
* @covers \MediaWiki\SpecialPage\SpecialPageFactory::getNames
*/
public function testGetNames() {
$this->overrideConfigValue(
MainConfigNames::SpecialPages,
[ 'testdummy' => SpecialAllPages::class ] +
MainConfigSchema::getDefaultValue( MainConfigNames::SpecialPages )
);
$names = $this->getFactory()->getNames();
$this->assertIsArray( $names );
$this->assertContains( 'testdummy', $names );
}
/**
* @covers \MediaWiki\SpecialPage\SpecialPageFactory::resolveAlias
*/
public function testResolveAlias() {
$this->overrideConfigValue( MainConfigNames::LanguageCode, 'de' );
[ $name, $param ] = $this->getFactory()->resolveAlias( 'Spezialseiten/Foo' );
$this->assertEquals( 'Specialpages', $name );
$this->assertEquals( 'Foo', $param );
}
/**
* @covers \MediaWiki\SpecialPage\SpecialPageFactory::getLocalNameFor
*/
public function testGetLocalNameFor() {
$this->overrideConfigValue( MainConfigNames::LanguageCode, 'de' );
$name = $this->getFactory()->getLocalNameFor( 'Specialpages', 'Foo' );
$this->assertEquals( 'Spezialseiten/Foo', $name );
}
/**
* @covers \MediaWiki\SpecialPage\SpecialPageFactory::getTitleForAlias
*/
public function testGetTitleForAlias() {
$this->overrideConfigValue( MainConfigNames::LanguageCode, 'de' );
$title = $this->getFactory()->getTitleForAlias( 'Specialpages/Foo' );
$this->assertEquals( 'Spezialseiten/Foo', $title->getText() );
$this->assertEquals( NS_SPECIAL, $title->getNamespace() );
}
public static function provideExecutePath() {
yield [ 'BlankPage', 'intentionallyblankpage' ];
$path = new PageReferenceValue( NS_SPECIAL, 'BlankPage', PageReferenceValue::LOCAL );
yield [ $path, 'intentionallyblankpage' ];
}
/**
* @dataProvider provideExecutePath
* @covers \MediaWiki\SpecialPage\SpecialPageFactory::executePAth
*/
public function testExecutePath( $path, $expected ) {
$this->overrideConfigValue( MainConfigNames::LanguageCode, 'qqx' );
$context = new RequestContext();
$context->setRequest( new FauxRequest() );
$output = new OutputPage( $context );
$context->setOutput( $output );
$this->getFactory()->executePath( $path, $context );
$this->assertStringContainsString( $expected, $output->getHTML() );
}
/**
* @dataProvider provideTestConflictResolution
*/
public function testConflictResolution(
$test, $aliasesList, $alias, $expectedName, $expectedAlias, $expectWarnings
) {
$lang = clone $this->getServiceContainer()->getContentLanguage();
$wrappedLang = TestingAccessWrapper::newFromObject( $lang );
$wrappedLang->mExtendedSpecialPageAliases = $aliasesList;
$this->overrideConfigValues( [
MainConfigNames::DevelopmentWarnings => true,
MainConfigNames::SpecialPages =>
array_combine( array_keys( $aliasesList ), array_keys( $aliasesList ) )
] );
$this->setContentLang( $lang );
// Catch the warnings we expect to be raised
$warnings = [];
set_error_handler( static function ( $errno, $errstr ) use ( &$warnings ) {
if ( preg_match( '/First alias \'[^\']*\' for .*/', $errstr ) ||
preg_match( '/Did not find a usable alias for special page .*/', $errstr )
) {
$warnings[] = $errstr;
return true;
}
return false;
} );
$reset = new ScopedCallback( 'restore_error_handler' );
[ $name, /*...*/ ] = $this->getFactory()->resolveAlias( $alias );
$this->assertEquals( $expectedName, $name, "$test: Alias to name" );
$result = $this->getFactory()->getLocalNameFor( $name );
$this->assertEquals( $expectedAlias, $result, "$test: Alias to name to alias" );
$gotWarnings = count( $warnings );
if ( $gotWarnings !== $expectWarnings ) {
$this->fail( "Expected $expectWarnings warning(s), but got $gotWarnings:\n" .
implode( "\n", $warnings )
);
}
}
/**
* @dataProvider provideTestConflictResolution
*/
public function testConflictResolutionReversed(
$test, $aliasesList, $alias, $expectedName, $expectedAlias, $expectWarnings
) {
// Make sure order doesn't matter by reversing the list
$aliasesList = array_reverse( $aliasesList );
$this->testConflictResolution(
$test, $aliasesList, $alias, $expectedName, $expectedAlias, $expectWarnings
);
}
public static function provideTestConflictResolution() {
return [
[
'Canonical name wins',
[ 'Foo' => [ 'Foo', 'Bar' ], 'Baz' => [ 'Foo', 'BazPage', 'Baz2' ] ],
'Foo',
'Foo',
'Foo',
1,
],
[
'Doesn\'t redirect to a different special page\'s canonical name',
[ 'Foo' => [ 'Foo', 'Bar' ], 'Baz' => [ 'Foo', 'BazPage', 'Baz2' ] ],
'Baz',
'Baz',
'BazPage',
1,
],
[
'Canonical name wins even if not aliased',
[ 'Foo' => [ 'FooPage' ], 'Baz' => [ 'Foo', 'BazPage', 'Baz2' ] ],
'Foo',
'Foo',
'FooPage',
1,
],
[
'Doesn\'t redirect to a different special page\'s canonical name even if not aliased',
[ 'Foo' => [ 'FooPage' ], 'Baz' => [ 'Foo', 'BazPage', 'Baz2' ] ],
'Baz',
'Baz',
'BazPage',
1,
],
[
'First local name beats non-first',
[ 'First' => [ 'Foo' ], 'NonFirst' => [ 'Bar', 'Foo' ] ],
'Foo',
'First',
'Foo',
0,
],
[
'Doesn\'t redirect to a different special page\'s first alias',
[
'Foo' => [ 'Foo' ],
'First' => [ 'Bar' ],
'Baz' => [ 'Foo', 'Bar', 'BazPage', 'Baz2' ]
],
'Baz',
'Baz',
'BazPage',
1,
],
[
'Doesn\'t redirect wrong even if all aliases conflict',
[
'Foo' => [ 'Foo' ],
'First' => [ 'Bar' ],
'Baz' => [ 'Foo', 'Bar' ]
],
'Baz',
'Baz',
'Baz',
2,
],
];
}
public function testGetAliasListRecursion() {
$called = false;
$this->setTemporaryHook(
'SpecialPage_initList',
function () use ( &$called ) {
$this->getServiceContainer()
->getSpecialPageFactory()
->getLocalNameFor( 'Specialpages' );
$called = true;
}
);
$this->getFactory()->getLocalNameFor( 'Specialpages' );
$this->assertTrue( $called, 'Recursive call succeeded' );
}
/**
* @covers \MediaWiki\SpecialPage\SpecialPageFactory::getPage
*/
public function testSpecialPageCreationThatRequiresService() {
$type = null;
$this->overrideConfigValue( MainConfigNames::SpecialPages,
[ 'TestPage' => [
'factory' => static function ( $spf ) use ( &$type ) {
$type = get_class( $spf );
return new class() extends SpecialPage {
};
},
'services' => [
'SpecialPageFactory'
]
] ]
);
$this->getFactory()->getPage( 'TestPage' );
$this->assertEquals( SpecialPageFactory::class, $type );
}
/**
* @covers \MediaWiki\SpecialPage\SpecialPageFactory::capturePath
*/
public function testSpecialPageCapturePathExceptions() {
$expectedException = new RuntimeException( 'Uh-oh!' );
$this->overrideConfigValue( MainConfigNames::SpecialPages, [
'ExceptionPage' => [
'factory' => static function () use ( $expectedException ) {
return new class( $expectedException ) extends SpecialPage {
private Exception $expectedException;
public function __construct( $expectedException ) {
parent::__construct();
$this->expectedException = $expectedException;
}
public function execute( $par ) {
throw $this->expectedException;
}
public function isIncludable() {
return true;
}
};
},
]
] );
$factory = $this->getFactory();
$factory->getPage( 'ExceptionPage' );
$this->expectExceptionObject( $expectedException );
$factory->capturePath(
Title::makeTitle( NS_SPECIAL, 'ExceptionPage' ),
RequestContext::getMain()
);
}
}

File Metadata

Mime Type
text/x-php
Expires
Sat, Oct 3, 21:10 (5 d, 18 h ago)
Storage Engine
local-disk
Storage Format
Raw Data
Storage Handle
40/9a/4fdc3b7e65b19f6b77b4ae0528ae
Default Alt Text
SpecialPageFactoryTest.php (10 KB)

Event Timeline