Page MenuHomeWickedGov Phorge
Files F4130255

TextSlotDiffRendererTest.php
No OneTemporary
Actions

Size
6 KB
Referenced Files
None
Subscribers
None

TextSlotDiffRendererTest.php
View Options

<?php
use MediaWiki\Content\ContentHandler;
use MediaWiki\Content\TextContent;
use MediaWiki\Context\RequestContext;
use MediaWiki\Diff\TextDiffer\ManifoldTextDiffer;
use MediaWiki\Diff\TextDiffer\Wikidiff2TextDiffer;
use MediaWiki\Tests\Diff\TextDiffer\TextDifferData;
use Wikimedia\Assert\ParameterTypeException;
use Wikimedia\Stats\StatsFactory;
/**
* @covers \TextSlotDiffRenderer
*/
class TextSlotDiffRendererTest extends MediaWikiIntegrationTestCase {
public function setUp(): void {
Wikidiff2TextDiffer::$fakeVersionForTesting = '1.14.1';
}
public function tearDown(): void {
Wikidiff2TextDiffer::$fakeVersionForTesting = null;
}
public function testGetExtraCacheKeys() {
$slotDiffRenderer = $this->getTextSlotDiffRenderer();
$key = $slotDiffRenderer->getExtraCacheKeys();
$slotDiffRenderer->setEngine( TextSlotDiffRenderer::ENGINE_WIKIDIFF2_INLINE );
$inlineKey = $slotDiffRenderer->getExtraCacheKeys();
ksort( $key );
ksort( $inlineKey );
$this->assertSame( [ '10-formats-and-engines' => 'php=table' ], $key );
$this->assertSame(
[
'10-formats-and-engines' => 'wikidiff2=inline',
'20-wikidiff2-version' => '1.14.1',
'21-wikidiff2-options' => 'bc2a06be',
],
$inlineKey
);
}
/**
* @dataProvider provideGetDiff
* @param array|null $oldContentArgs To pass to makeContent() (if not null)
* @param array|null $newContentArgs
* @param string|Exception $expectedResult
*/
public function testGetDiff(
?array $oldContentArgs, ?array $newContentArgs, $expectedResult
) {
$this->mergeMwGlobalArrayValue( 'wgContentHandlers', [
'testing' => DummyContentHandlerForTesting::class,
'testing-nontext' => DummyNonTextContentHandler::class,
] );
$oldContent = $oldContentArgs ? self::makeContent( ...$oldContentArgs ) : null;
$newContent = $newContentArgs ? self::makeContent( ...$newContentArgs ) : null;
if ( $expectedResult instanceof Exception ) {
$this->expectException( get_class( $expectedResult ) );
$this->expectExceptionMessage( $expectedResult->getMessage() );
}
$slotDiffRenderer = $this->getTextSlotDiffRenderer();
$diff = $slotDiffRenderer->getDiff( $oldContent, $newContent );
if ( $expectedResult instanceof Exception ) {
return;
}
$plainDiff = $this->getPlainDiff( $diff );
$this->assertSame( $expectedResult, $plainDiff );
}
public static function provideGetDiff() {
return [
'same text' => [
[ "aaa\nbbb\nccc" ],
[ "aaa\nbbb\nccc" ],
"",
],
'different text' => [
[ "aaa\nbbb\nccc" ],
[ "aaa\nxxx\nccc" ],
" aaa aaa\n-bbb+xxx\n ccc ccc",
],
'no right content' => [
[ "aaa\nbbb\nccc" ],
null,
"-aaa+ \n-bbb \n-ccc ",
],
'no left content' => [
null,
[ "aaa\nbbb\nccc" ],
"- +aaa\n +bbb\n +ccc",
],
'no content' => [
null,
null,
new InvalidArgumentException( '$oldContent and $newContent cannot both be null' ),
],
'non-text left content' => [
[ '', 'testing-nontext' ],
[ "aaa\nbbb\nccc" ],
new IncompatibleDiffTypesException( 'testing-nontext', 'text' ),
],
'non-text right content' => [
[ "aaa\nbbb\nccc" ],
[ '', 'testing-nontext' ],
new ParameterTypeException( '$newContent', 'MediaWiki\Content\TextContent|null' ),
],
];
}
// no separate test for getTextDiff() as getDiff() is just a thin wrapper around it
/**
* @param string $langCode
* @return TextSlotDiffRenderer
*/
private function getTextSlotDiffRenderer( $langCode = 'en' ) {
$slotDiffRenderer = new TextSlotDiffRenderer();
$slotDiffRenderer->setStatsFactory( StatsFactory::newNull() );
$lang = $this->getServiceContainer()->getLanguageFactory()->getLanguage( $langCode );
$context = new RequestContext;
$context->setLanguage( $lang );
$differ = new ManifoldTextDiffer(
$context,
$lang,
'php',
null,
[]
);
$slotDiffRenderer->setTextDiffer( $differ );
$slotDiffRenderer->setFormat( 'table' );
return $slotDiffRenderer;
}
/**
* Convert a HTML diff to a human-readable format and hopefully make the test less fragile.
* @param string $diff
* @return string
*/
private function getPlainDiff( $diff ) {
$replacements = [
html_entity_decode( '&nbsp;' ) => ' ',
html_entity_decode( '&minus;' ) => '-',
];
// Preserve markers when stripping tags
$diff = str_replace( '<td class="diff-marker"></td>', ' ', $diff );
$diff = preg_replace( '@<td colspan="2"( class="(?:diff-side-deleted|diff-side-added)")?></td>@', ' ', $diff );
$diff = preg_replace( '/data-marker="([^"]*)">/', '>$1', $diff );
return str_replace( array_keys( $replacements ), array_values( $replacements ),
trim( strip_tags( $diff ), "\n" ) );
}
/**
* @param string $str
* @param string $model
* @return null|TextContent
*/
private static function makeContent( $str, $model = CONTENT_MODEL_TEXT ) {
return ContentHandler::makeContent( $str, null, $model );
}
public static function provideGetTablePrefix() {
return [
'php' => [
TextSlotDiffRenderer::ENGINE_PHP,
[
TextSlotDiffRenderer::INLINE_LEGEND_KEY => '<div></div>',
TextSlotDiffRenderer::INLINE_SWITCHER_KEY => null
]
],
'wikidiff2' => [
TextSlotDiffRenderer::ENGINE_WIKIDIFF2,
[
TextSlotDiffRenderer::INLINE_LEGEND_KEY =>
'class="mw-diff-inline-legend oo-ui-element-hidden"',
TextSlotDiffRenderer::INLINE_SWITCHER_KEY => 'mw-diffPage-inlineToggle-container'
]
],
'inline' => [
TextSlotDiffRenderer::ENGINE_WIKIDIFF2_INLINE,
[
TextSlotDiffRenderer::INLINE_LEGEND_KEY =>
'class="mw-diff-inline-legend".*\(diff-inline-tooltip-ins\)',
TextSlotDiffRenderer::INLINE_SWITCHER_KEY => 'mw-diffPage-inlineToggle-container'
]
]
];
}
/**
* @dataProvider provideGetTablePrefix
* @param string $engine
* @param string[] $expectedPatterns
*/
public function testGetTablePrefix( $engine, $expectedPatterns ) {
OOUI\Theme::setSingleton( new OOUI\BlankTheme() );
$slotDiffRenderer = $this->getTextSlotDiffRenderer( 'qqx' );
$slotDiffRenderer->setHookContainer( $this->createHookContainer() );
$slotDiffRenderer->setEngine( $engine );
$slotDiffRenderer->setInlineToggleEnabled();
$context = new RequestContext;
$context->setLanguage( 'qqx' );
$title = $this->getServiceContainer()->getTitleFactory()->newFromText( 'Test' );
$result = $slotDiffRenderer->getTablePrefix( $context, $title );
$this->assertSameSize( $expectedPatterns, $result );
foreach ( $expectedPatterns as $key => $pattern ) {
if ( $pattern === null ) {
$this->assertNull( $result[$key], "\$result[$key]" );
} else {
$this->assertMatchesRegularExpression(
"#$pattern#", $result[$key], "\$result[$key]" );
}
}
}
public function testLocalizeDiff() {
$slotDiffRenderer = $this->getTextSlotDiffRenderer( 'en' );
$slotDiffRenderer->setHookContainer( $this->createHookContainer() );
$slotDiffRenderer->setEngine( 'php' );
$result = $slotDiffRenderer->localizeDiff( TextDifferData::PHP_TABLE );
$this->assertStringContainsString( 'Line 1:', $result );
}
}

File Metadata

Mime Type
text/x-php
Expires
Wed, Aug 19, 10:19 (2 w, 6 d ago)
Storage Engine
local-disk
Storage Format
Raw Data
Storage Handle
f9/b6/62fe9741698f5258ffd4a98351ba
Default Alt Text
TextSlotDiffRendererTest.php (6 KB)

Event Timeline