Page MenuHomeWickedGov Phorge
Files F4141329

ParserFileProcessingHookHandlersTest.php
No OneTemporary
Actions

Size
11 KB
Referenced Files
None
Subscribers
None

ParserFileProcessingHookHandlersTest.php
View Options

<?php
namespace PageImages\Tests\Hooks;
use File;
use MediaWiki\Config\Config;
use MediaWiki\Config\HashConfig;
use MediaWiki\Http\HttpRequestFactory;
use MediaWiki\Linker\LinksMigration;
use MediaWiki\Parser\Parser;
use MediaWiki\Parser\ParserOptions;
use MediaWiki\Title\Title;
use MediaWiki\Title\TitleFactory;
use MediaWikiIntegrationTestCase;
use PageImages\Hooks\ParserFileProcessingHookHandlers;
use PageImages\PageImageCandidate;
use PageImages\PageImages;
use RepoGroup;
use Wikimedia\ObjectCache\WANObjectCache;
use Wikimedia\Rdbms\IConnectionProvider;
use Wikimedia\TestingAccessWrapper;
/**
* @covers \PageImages\Hooks\ParserFileProcessingHookHandlers
*
* @group PageImages
*
* @license WTFPL
* @author Thiemo Kreuz
*/
class ParserFileProcessingHookHandlersTest extends MediaWikiIntegrationTestCase {
/**
* @param array[] $images
*
* @return Parser
*/
private function getParser( array $images ) {
$parser = $this->getServiceContainer()->getParser();
$title = Title::newFromText( 'test' );
$options = ParserOptions::newFromAnon();
$parser->startExternalParse( $title, $options, Parser::OT_HTML );
$parser->getOutput()->setExtensionData( 'pageImages', $images );
return $parser;
}
private function getHtml( $indexes, $nonLeadIndex = INF ) {
$html = '';
$doneSectionBreak = false;
foreach ( $indexes as $index ) {
if ( $index >= $nonLeadIndex && !$doneSectionBreak ) {
$html .= '<mw:editsection page="Test" section="1"/>';
$doneSectionBreak = true;
}
$html .= "<!--MW-PAGEIMAGES-CANDIDATE-$index-->";
}
return $html;
}
/**
* Required to make RepoGroup::findFile in ParserFileProcessingHookHandlers::getScore return something.
* @return RepoGroup
*/
private function getRepoGroup() {
$file = $this->createMock( File::class );
// ugly hack to avoid all the unmockable crap in FormatMetadata
$file->method( 'isDeleted' )
->willReturn( true );
$repoGroup = $this->createMock( RepoGroup::class );
$repoGroup->method( 'findFile' )
->willReturn( $file );
return $repoGroup;
}
private function getHandler( $images, $leadOnly = false ) {
return new class ( $images, $leadOnly ) extends ParserFileProcessingHookHandlers {
private $images;
private $isFreeMap;
public function __construct( $images, $leadOnly ) {
$this->config = new HashConfig( [
'PageImagesLeadSectionOnly' => $leadOnly,
] );
$this->images = $images;
foreach ( $images as $image ) {
$this->isFreeMap[$image['filename']] = $image['isFree'];
}
}
protected function isImageFree( $fileName ) {
return $this->isFreeMap[$fileName] ?? false;
}
protected function getScore( PageImageCandidate $image, $position ) {
return $this->images[$position]['score'];
}
};
}
/**
* @dataProvider provideDoParserAfterTidy
* @covers \PageImages\Hooks\ParserFileProcessingHookHandlers::onParserAfterTidy
*/
public function testDoParserAfterTidy(
array $images,
$expectedFreeFileName,
$expectedNonFreeFileName
) {
$parser = $this->getParser( $images );
$html = $this->getHtml( array_keys( $images ) );
$handler = $this->getHandler( $images );
$handler->onParserAfterTidy( $parser, $html );
$properties = $parser->getOutput()->getPageProperties();
if ( $expectedFreeFileName === null ) {
$this->assertArrayNotHasKey( PageImages::PROP_NAME_FREE, $properties );
} else {
$this->assertSame( $expectedFreeFileName,
$properties[PageImages::PROP_NAME_FREE] );
}
if ( $expectedNonFreeFileName === null ) {
$this->assertArrayNotHasKey( PageImages::PROP_NAME, $properties );
} else {
$this->assertSame( $expectedNonFreeFileName, $properties[PageImages::PROP_NAME] );
}
}
public static function provideDoParserAfterTidy() {
return [
// both images are non-free
[
[
[ 'filename' => 'A.jpg', 'score' => 100, 'isFree' => false ],
[ 'filename' => 'B.jpg', 'score' => 90, 'isFree' => false ],
],
null,
'A.jpg'
],
// both images are free
[
[
[ 'filename' => 'A.jpg', 'score' => 100, 'isFree' => true ],
[ 'filename' => 'B.jpg', 'score' => 90, 'isFree' => true ],
],
'A.jpg',
null
],
// one free (with a higher score), one non-free image
[
[
[ 'filename' => 'A.jpg', 'score' => 100, 'isFree' => true ],
[ 'filename' => 'B.jpg', 'score' => 90, 'isFree' => false ],
],
'A.jpg',
null
],
// one non-free (with a higher score), one free image
[
[
[ 'filename' => 'A.jpg', 'score' => 100, 'isFree' => false ],
[ 'filename' => 'B.jpg', 'score' => 90, 'isFree' => true ],
],
'B.jpg',
'A.jpg'
]
];
}
/**
* @dataProvider provideDoParserAfterTidy_lead
* @covers \PageImages\Hooks\ParserFileProcessingHookHandlers::onParserAfterTidy
*/
public function testDoParserAfterTidy_lead( $leadOnly ) {
$candidates = [
[ 'filename' => 'A.jpg', 'score' => 100, 'isFree' => false ],
[ 'filename' => 'B.jpg', 'score' => 90, 'isFree' => true ],
];
$parser = $this->getParser( $candidates );
$html = $this->getHtml( array_keys( $candidates ), 1 );
$handler = $this->getHandler( $candidates, $leadOnly );
$handler->onParserAfterTidy( $parser, $html );
if ( $leadOnly ) {
$this->assertNull(
$parser->getOutput()->getPageProperty( PageImages::PROP_NAME_FREE ),
'Only lead images are returned.' );
} else {
$this->assertIsString(
$parser->getOutput()->getPageProperty( PageImages::PROP_NAME_FREE ),
'All images are returned'
);
}
}
public static function provideDoParserAfterTidy_lead() {
return [
[ false ],
[ true ]
];
}
/**
* @dataProvider provideGetScore
*/
public function testGetScore( $image, $scoreFromTable, $position, $expected ) {
$mock = TestingAccessWrapper::newFromObject(
$this->getMockBuilder( ParserFileProcessingHookHandlers::class )
->setConstructorArgs( [
$this->getServiceContainer()->getMainConfig(),
$this->getRepoGroup(),
$this->createMock( WANObjectCache::class ),
$this->createMock( HttpRequestFactory::class ),
$this->createMock( IConnectionProvider::class ),
$this->createMock( TitleFactory::class ),
$this->createMock( LinksMigration::class ),
] )
->onlyMethods( [ 'scoreFromTable', 'fetchFileMetadata', 'getRatio', 'getDenylist' ] )
->getMock()
);
$mock->method( 'scoreFromTable' )
->willReturn( $scoreFromTable );
$mock->method( 'getRatio' )
->willReturn( 0 );
$mock->method( 'getDenylist' )
->willReturn( [ 'denylisted.jpg' => 1 ] );
$score = $mock->getScore( PageImageCandidate::newFromArray( $image ), $position );
$this->assertSame( $expected, $score );
}
public static function provideGetScore() {
return [
[
[ 'filename' => 'A.jpg', 'handler' => [ 'width' => 100 ] ],
100,
0,
// width score + ratio score + position score
100 + 100 + 8
],
[
[ 'filename' => 'A.jpg', 'fullwidth' => 100 ],
50,
1,
// width score + ratio score + position score
106
],
[
[ 'filename' => 'A.jpg', 'fullwidth' => 100 ],
50,
2,
// width score + ratio score + position score
104
],
[
[ 'filename' => 'A.jpg', 'fullwidth' => 100 ],
50,
3,
// width score + ratio score + position score
103
],
[
[ 'filename' => 'denylisted.jpg', 'fullwidth' => 100 ],
50,
3,
// denylist score
- 1000
],
[
[ 'filename' => 'A.jpg', 'frame' => [ 'class' => 'notpageimage' ] ],
0,
0,
-1000
],
];
}
/**
* @dataProvider provideScoreFromTable
* @covers \PageImages\Hooks\ParserFileProcessingHookHandlers::scoreFromTable
*/
public function testScoreFromTable( array $scores, $value, $expected ) {
/** @var ParserFileProcessingHookHandlers $handlerWrapper */
$handlerWrapper = TestingAccessWrapper::newFromObject(
new ParserFileProcessingHookHandlers(
$this->createMock( Config::class ),
$this->getRepoGroup(),
$this->createMock( WANObjectCache::class ),
$this->createMock( HttpRequestFactory::class ),
$this->createMock( IConnectionProvider::class ),
$this->createMock( TitleFactory::class ),
$this->createMock( LinksMigration::class )
)
);
$score = $handlerWrapper->scoreFromTable( $value, $scores );
$this->assertEquals( $expected, $score );
}
public static function provideScoreFromTable() {
return [
'no match' => [ [], 100, 0 ],
'float' => [ [ 0.5 ], 0, 0.5 ],
'always min when below range' => [ [ 200 => 2, 800 => 1 ], 0, 2 ],
'always max when above range' => [ [ 200 => 2, 800 => 1 ], 1000, 1 ],
'always min when below range (reversed)' => [ [ 800 => 1, 200 => 2 ], 0, 2 ],
'always max when above range (reversed)' => [ [ 800 => 1, 200 => 2 ], 1000, 1 ],
'min match' => [ [ 200 => 2, 400 => 3, 800 => 1 ], 200, 2 ],
'above min' => [ [ 200 => 2, 400 => 3, 800 => 1 ], 201, 3 ],
'second last match' => [ [ 200 => 2, 400 => 3, 800 => 1 ], 400, 3 ],
'above second last' => [ [ 200 => 2, 400 => 3, 800 => 1 ], 401, 1 ],
// These test cases use the default values from extension.json
[ [ 119 => -100, 400 => 10, 600 => 5, 601 => 0 ], 100, -100 ],
[ [ 119 => -100, 400 => 10, 600 => 5, 601 => 0 ], 119, -100 ],
[ [ 119 => -100, 400 => 10, 600 => 5, 601 => 0 ], 300, 10 ],
[ [ 119 => -100, 400 => 10, 600 => 5, 601 => 0 ], 400, 10 ],
[ [ 119 => -100, 400 => 10, 600 => 5, 601 => 0 ], 500, 5 ],
[ [ 119 => -100, 400 => 10, 600 => 5, 601 => 0 ], 600, 5 ],
[ [ 119 => -100, 400 => 10, 600 => 5, 601 => 0 ], 601, 0 ],
[ [ 119 => -100, 400 => 10, 600 => 5, 601 => 0 ], 999, 0 ],
[ [ 99 => -100, 100 => 0 ], 99, -100 ],
[ [ 99 => -100, 100 => 0 ], 100, 0 ],
[ [ 99 => -100, 100 => 0 ], 500, 0 ],
[ [ 3 => -100, 5 => 0, 20 => 5, 30 => 0, 31 => -100 ], 1, -100 ],
[ [ 3 => -100, 5 => 0, 20 => 5, 30 => 0, 31 => -100 ], 3, -100 ],
[ [ 3 => -100, 5 => 0, 20 => 5, 30 => 0, 31 => -100 ], 4, 0 ],
[ [ 3 => -100, 5 => 0, 20 => 5, 30 => 0, 31 => -100 ], 5, 0 ],
[ [ 3 => -100, 5 => 0, 20 => 5, 30 => 0, 31 => -100 ], 10, 5 ],
[ [ 3 => -100, 5 => 0, 20 => 5, 30 => 0, 31 => -100 ], 20, 5 ],
[ [ 3 => -100, 5 => 0, 20 => 5, 30 => 0, 31 => -100 ], 25, 0 ],
[ [ 3 => -100, 5 => 0, 20 => 5, 30 => 0, 31 => -100 ], 30, 0 ],
[ [ 3 => -100, 5 => 0, 20 => 5, 30 => 0, 31 => -100 ], 31, -100 ],
[ [ 3 => -100, 5 => 0, 20 => 5, 30 => 0, 31 => -100 ], 40, -100 ],
'T212013' => [ [ 119 => -100, 400 => 10, 600 => 5, 601 => 0 ], 0, -100 ],
];
}
/**
* @dataProvider provideIsFreeImage
* @covers \PageImages\Hooks\ParserFileProcessingHookHandlers::isImageFree
*/
public function testIsFreeImage( $fileName, $metadata, $expected ) {
$mock = TestingAccessWrapper::newFromObject(
$this->getMockBuilder( ParserFileProcessingHookHandlers::class )
->setConstructorArgs( [
$this->getServiceContainer()->getMainConfig(),
$this->getRepoGroup(),
$this->createMock( WANObjectCache::class ),
$this->createMock( HttpRequestFactory::class ),
$this->createMock( IConnectionProvider::class ),
$this->createMock( TitleFactory::class ),
$this->createMock( LinksMigration::class ),
] )
->onlyMethods( [ 'fetchFileMetadata' ] )
->getMock()
);
$mock->method( 'fetchFileMetadata' )
->willReturn( $metadata );
/** @var ParserFileProcessingHookHandlers $mock */
$this->assertSame( $expected, $mock->isImageFree( $fileName ) );
}
public static function provideIsFreeImage() {
return [
[ 'A.jpg', [], true ],
[ 'A.jpg', [ 'NonFree' => [ 'value' => '0' ] ], true ],
[ 'A.jpg', [ 'NonFree' => [ 'value' => 0 ] ], true ],
[ 'A.jpg', [ 'NonFree' => [ 'value' => false ] ], true ],
[ 'A.jpg', [ 'NonFree' => [ 'value' => 'something' ] ], false ],
[ 'A.jpg', [ 'something' => [ 'value' => 'something' ] ], true ],
];
}
}

File Metadata

Mime Type
text/x-php
Expires
Wed, Aug 19, 15:54 (3 w, 6 d ago)
Storage Engine
local-disk
Storage Format
Raw Data
Storage Handle
a0/83/b6ab8a19686478b80b18deeb6c89
Default Alt Text
ParserFileProcessingHookHandlersTest.php (11 KB)

Event Timeline