7a2331706f
Originally we created a Parser object on every request, and so care was taken to make Parser construction lightweight. In particular, all potentially costly initialization was moved into a separate Parser::firstCallInit() method. Starting with 1.32, parser construction has instead been done lazily, via the ParserFactory registered with MediaWikiServices. The extra complexity associated with the old manual lazy initialization of Parser is therefore no longer needed. Deprecate Parser::firstCallInit() as part of a general plan to refactor the Parser class to allow subclasses and alternate parser implementations. Add some tests to assert that parsers are being created lazily, and are not being created when they are not needed. Bug: T250444 Change-Id: Iffd2b38a2f848dad88010d243250b37506b2c715
117 lines
3.4 KiB
PHP
117 lines
3.4 KiB
PHP
<?php
|
|
|
|
/**
|
|
* @covers Parser::__construct
|
|
*/
|
|
class ParserTest extends MediaWikiTestCase {
|
|
public function provideConstructorArguments() {
|
|
// Create a mock Config object that will satisfy ServiceOptions::__construct
|
|
$mockConfig = $this->createMock( 'Config' );
|
|
$mockConfig->method( 'has' )->willReturn( true );
|
|
$mockConfig->method( 'get' )->willReturn( 'I like otters.' );
|
|
|
|
// Stub out a MagicWordFactory so the Parser can initialize its
|
|
// function hooks when it is created.
|
|
$mwFactory = $this->getMockBuilder( MagicWordFactory::class )
|
|
->disableOriginalConstructor()
|
|
->setMethods( [ 'get' ] )
|
|
->getMock();
|
|
$mwFactory
|
|
->method( 'get' )->will( $this->returnCallback( function ( $arg ) {
|
|
$mw = $this->getMockBuilder( MagicWord::class )
|
|
->disableOriginalConstructor()
|
|
->setMethods( [ 'getSynonyms' ] )
|
|
->getMock();
|
|
$mw->method( 'getSynonyms' )->willReturn( [] );
|
|
return $mw;
|
|
} ) );
|
|
|
|
$newArgs = [
|
|
$this->createMock( 'MediaWiki\Config\ServiceOptions' ),
|
|
$mwFactory,
|
|
$this->createMock( 'Language' ),
|
|
$this->createMock( 'ParserFactory' ),
|
|
'a snail can sleep for three years',
|
|
$this->createMock( 'MediaWiki\Special\SpecialPageFactory' ),
|
|
$this->createMock( 'MediaWiki\Linker\LinkRendererFactory' ),
|
|
$this->createMock( 'NamespaceInfo' )
|
|
];
|
|
|
|
$oldArgs = [
|
|
[],
|
|
$mwFactory,
|
|
$this->createMock( 'Language' ),
|
|
$this->createMock( 'ParserFactory' ),
|
|
'a snail can sleep for three years',
|
|
$this->createMock( 'MediaWiki\Special\SpecialPageFactory' )
|
|
];
|
|
|
|
yield 'current_args_without_namespace_info' => [
|
|
$newArgs,
|
|
];
|
|
|
|
yield 'backward_compatible_args_minimal' => [
|
|
array_merge( $oldArgs ),
|
|
];
|
|
|
|
yield 'backward_compatible_args_with_config' => [
|
|
array_merge( $oldArgs, [ $mockConfig ] ),
|
|
];
|
|
|
|
yield 'backward_compatible_args_with_link_renderer' => [
|
|
array_merge( $oldArgs, [
|
|
$mockConfig,
|
|
$this->createMock( 'MediaWiki\Linker\LinkRendererFactory' )
|
|
] ),
|
|
];
|
|
|
|
yield 'backward_compatible_args_with_ns_info' => [
|
|
array_merge( $oldArgs, [
|
|
$mockConfig,
|
|
$this->createMock( 'MediaWiki\Linker\LinkRendererFactory' ),
|
|
$this->createMock( 'NamespaceInfo' )
|
|
] ),
|
|
];
|
|
}
|
|
|
|
/**
|
|
* @dataProvider provideConstructorArguments
|
|
* @covers Parser::__construct
|
|
*/
|
|
public function testBackwardsCompatibleConstructorArguments( $args ) {
|
|
$this->hideDeprecated( 'Parser::__construct' );
|
|
$this->hideDeprecated( 'old calling convention for Parser::__construct' );
|
|
$parser = new Parser( ...$args );
|
|
|
|
$refObject = new ReflectionObject( $parser );
|
|
|
|
// If testing backwards compatibility, test service options separately
|
|
if ( is_array( $args[0] ) ) {
|
|
$svcOptionsProp = $refObject->getProperty( 'svcOptions' );
|
|
$svcOptionsProp->setAccessible( true );
|
|
$this->assertInstanceOf(
|
|
MediaWiki\Config\ServiceOptions::class,
|
|
$svcOptionsProp->getValue( $parser )
|
|
);
|
|
unset( $args[0] );
|
|
|
|
// If a Config is passed, the fact that we were able to create a ServiceOptions
|
|
// instance without error from it proves that this argument works.
|
|
if ( isset( $args[6] ) ) {
|
|
unset( $args[6] );
|
|
}
|
|
}
|
|
|
|
foreach ( $refObject->getProperties() as $prop ) {
|
|
$prop->setAccessible( true );
|
|
foreach ( $args as $idx => $mockTest ) {
|
|
if ( $prop->getValue( $parser ) === $mockTest ) {
|
|
unset( $args[$idx] );
|
|
}
|
|
}
|
|
}
|
|
|
|
$this->assertSame( [], $args, 'Not all arguments to the Parser constructor were ' .
|
|
'found on the Parser object' );
|
|
}
|
|
}
|