wiki.techinc.nl/tests/phpunit/includes/content/TextContentTest.php
Petr Pchelko 816e02ae51 Convert RevisionRecord to Authority and PageIdentity
As we convert the RevisionRecord to using Authority,
we no longer need Title instances, so we can convert
that to PageIdentity.

Ideally, we'd part away from using Title at all, but:
1. For foreign wikis PageIdentity has stronger validation,
so calling PageIdentity getId() on Title will break things.
There's still a lot of code depending on lax Title guarantees,
so we keep it.
2. A lot of code still depends on Title, so we try to pass it
through even if we don't nesessarily need to, to save cost
on recreating it later on.

Bug: T271458
Depends-On: I287400b967b467ea18bebbb579e881a785a19158
Change-Id: I63d9807264d7e2295afef51fc9d982447f92fcbd
2021-01-21 13:37:01 -06:00

493 lines
11 KiB
PHP

<?php
use MediaWiki\MediaWikiServices;
/**
* @group ContentHandler
* @group Database
* ^--- needed, because we do need the database to test link updates
*/
class TextContentTest extends MediaWikiLangTestCase {
protected $context;
protected function setUp() : void {
parent::setUp();
// trigger purging of all page related tables
$this->tablesUsed[] = 'page';
$this->tablesUsed[] = 'revision';
// Anon user
$user = new User();
$user->setName( '127.0.0.1' );
$this->context = new RequestContext();
$this->context->setTitle( Title::makeTitle( NS_MAIN, 'Test' ) );
$this->context->setUser( $user );
RequestContext::getMain()->setTitle( $this->context->getTitle() );
$this->setMwGlobals( [
'wgTextModelsToParse' => [
CONTENT_MODEL_WIKITEXT,
CONTENT_MODEL_CSS,
CONTENT_MODEL_JAVASCRIPT,
],
'wgCapitalLinks' => true,
'wgHooks' => [], // bypass hook ContentGetParserOutput that force custom rendering
] );
}
/**
* @param string $text
* @return TextContent
*/
public function newContent( $text ) {
return new TextContent( $text );
}
public static function dataGetParserOutput() {
return [
[
'TextContentTest_testGetParserOutput',
CONTENT_MODEL_TEXT,
"hello ''world'' & [[stuff]]\n", "hello ''world'' &amp; [[stuff]]",
[
'Links' => []
]
],
// TODO: more...?
];
}
/**
* @dataProvider dataGetParserOutput
* @covers TextContent::getParserOutput
*/
public function testGetParserOutput( $title, $model, $text, $expectedHtml,
$expectedFields = null
) {
$title = Title::newFromText( $title );
$content = ContentHandler::makeContent( $text, $title, $model );
$po = $content->getParserOutput( $title );
$html = $po->getText();
$html = preg_replace( '#<!--.*?-->#sm', '', $html ); // strip comments
$this->assertEquals( $expectedHtml, trim( $html ) );
if ( $expectedFields ) {
foreach ( $expectedFields as $field => $exp ) {
$getter = 'get' . ucfirst( $field );
$v = $po->$getter();
if ( is_array( $exp ) ) {
$this->assertArrayEquals( $exp, $v );
} else {
$this->assertEquals( $exp, $v );
}
}
}
// TODO: assert more properties
}
public static function dataPreSaveTransform() {
return [
[
# 0: no signature resolution
'hello this is ~~~',
'hello this is ~~~',
],
[
# 1: rtrim
" Foo \n ",
' Foo',
],
[
# 2: newline normalization
"LF\n\nCRLF\r\n\r\nCR\r\rEND",
"LF\n\nCRLF\n\nCR\n\nEND",
],
];
}
/**
* @dataProvider dataPreSaveTransform
* @covers TextContent::preSaveTransform
*/
public function testPreSaveTransform( $text, $expected ) {
$options = ParserOptions::newFromUserAndLang( $this->context->getUser(),
MediaWikiServices::getInstance()->getContentLanguage() );
$content = $this->newContent( $text );
$content = $content->preSaveTransform(
$this->context->getTitle(),
$this->context->getUser(),
$options
);
$this->assertEquals( $expected, $content->getText() );
}
public static function dataPreloadTransform() {
return [
[
'hello this is ~~~',
'hello this is ~~~',
],
];
}
/**
* @dataProvider dataPreloadTransform
* @covers TextContent::preloadTransform
*/
public function testPreloadTransform( $text, $expected ) {
$options = ParserOptions::newFromUserAndLang( $this->context->getUser(),
MediaWikiServices::getInstance()->getContentLanguage() );
$content = $this->newContent( $text );
$content = $content->preloadTransform( $this->context->getTitle(), $options );
$this->assertEquals( $expected, $content->getText() );
}
public static function dataGetRedirectTarget() {
return [
[ '#REDIRECT [[Test]]',
null,
],
];
}
/**
* @dataProvider dataGetRedirectTarget
* @covers TextContent::getRedirectTarget
*/
public function testGetRedirectTarget( $text, $expected ) {
$content = $this->newContent( $text );
$t = $content->getRedirectTarget();
if ( $expected === null ) {
$this->assertNull( $t, "text should not have generated a redirect target: $text" );
} else {
$this->assertEquals( $expected, $t->getPrefixedText() );
}
}
/**
* @dataProvider dataGetRedirectTarget
* @covers TextContent::isRedirect
*/
public function testIsRedirect( $text, $expected ) {
$content = $this->newContent( $text );
$this->assertEquals( $expected !== null, $content->isRedirect() );
}
public static function dataIsCountable() {
return [
[ '',
null,
'any',
true
],
[ 'Foo',
null,
'any',
true
],
];
}
/**
* @dataProvider dataIsCountable
* @covers TextContent::isCountable
*/
public function testIsCountable( $text, $hasLinks, $mode, $expected ) {
$this->setMwGlobals( 'wgArticleCountMethod', $mode );
$content = $this->newContent( $text );
$v = $content->isCountable( $hasLinks );
$this->assertEquals(
$expected,
$v,
'isCountable() returned unexpected value ' . var_export( $v, true )
. ' instead of ' . var_export( $expected, true )
. " in mode `$mode` for text \"$text\""
);
}
public static function dataGetTextForSummary() {
return [
[ "hello\nworld.",
16,
'hello world.',
],
[ 'hello world.',
8,
'hello...',
],
[ '[[hello world]].',
8,
'[[hel...',
],
];
}
/**
* @dataProvider dataGetTextForSummary
* @covers TextContent::getTextForSummary
*/
public function testGetTextForSummary( $text, $maxlength, $expected ) {
$content = $this->newContent( $text );
$this->assertEquals( $expected, $content->getTextForSummary( $maxlength ) );
}
/**
* @covers TextContent::getTextForSearchIndex
*/
public function testGetTextForSearchIndex() {
$content = $this->newContent( 'hello world.' );
$this->assertEquals( 'hello world.', $content->getTextForSearchIndex() );
}
/**
* @covers TextContent::copy
*/
public function testCopy() {
$content = $this->newContent( 'hello world.' );
$copy = $content->copy();
$this->assertTrue( $content->equals( $copy ), 'copy must be equal to original' );
$this->assertEquals( 'hello world.', $copy->getText() );
}
/**
* @covers TextContent::getSize
*/
public function testGetSize() {
$content = $this->newContent( 'hello world.' );
$this->assertEquals( 12, $content->getSize() );
}
/**
* @covers TextContent::getText
*/
public function testGetText() {
$content = $this->newContent( 'hello world.' );
$this->assertEquals( 'hello world.', $content->getText() );
}
/**
* @covers TextContent::getNativeData
*/
public function testGetNativeData() {
$content = $this->newContent( 'hello world.' );
$this->assertEquals( 'hello world.', $content->getText() );
}
/**
* @covers TextContent::getWikitextForTransclusion
*/
public function testGetWikitextForTransclusion() {
$content = $this->newContent( 'hello world.' );
$this->assertEquals( 'hello world.', $content->getWikitextForTransclusion() );
}
/**
* @covers TextContent::getModel
*/
public function testGetModel() {
$content = $this->newContent( "hello world." );
$this->assertEquals( CONTENT_MODEL_TEXT, $content->getModel() );
}
/**
* @covers TextContent::getContentHandler
*/
public function testGetContentHandler() {
$content = $this->newContent( "hello world." );
$this->assertEquals( CONTENT_MODEL_TEXT, $content->getContentHandler()->getModelID() );
}
public static function dataIsEmpty() {
return [
[ '', true ],
[ ' ', false ],
[ '0', false ],
[ 'hallo welt.', false ],
];
}
/**
* @dataProvider dataIsEmpty
* @covers TextContent::isEmpty
*/
public function testIsEmpty( $text, $empty ) {
$content = $this->newContent( $text );
$this->assertEquals( $empty, $content->isEmpty() );
}
public static function dataEquals() {
return [
[ new TextContent( "hallo" ), null, false ],
[ new TextContent( "hallo" ), new TextContent( "hallo" ), true ],
[ new TextContent( "hallo" ), new JavaScriptContent( "hallo" ), false ],
[ new TextContent( "hallo" ), new WikitextContent( "hallo" ), false ],
[ new TextContent( "hallo" ), new TextContent( "HALLO" ), false ],
];
}
/**
* @dataProvider dataEquals
* @covers TextContent::equals
*/
public function testEquals( Content $a, Content $b = null, $equal = false ) {
$this->assertEquals( $equal, $a->equals( $b ) );
}
public static function dataGetDeletionUpdates() {
return [
[
CONTENT_MODEL_TEXT, "hello ''world''\n",
[]
],
[
CONTENT_MODEL_TEXT, "hello [[world test 21344]]\n",
[]
],
// TODO: more...?
];
}
/**
* @dataProvider dataGetDeletionUpdates
* @covers TextContent::getDeletionUpdates
*/
public function testDeletionUpdates( $model, $text, $expectedStuff ) {
$page = $this->getNonexistingTestPage( __METHOD__ );
$title = $page->getTitle();
$content = ContentHandler::makeContent( $text, $title, $model );
$page->doEditContent( $content, '' );
$updates = $content->getDeletionUpdates( $page );
// make updates accessible by class name
foreach ( $updates as $update ) {
$class = get_class( $update );
$updates[$class] = $update;
}
foreach ( $expectedStuff as $class => $fieldValues ) {
$this->assertArrayHasKey( $class, $updates, "missing an update of type $class" );
$update = $updates[$class];
foreach ( $fieldValues as $field => $value ) {
$v = $update->$field; # if the field doesn't exist, just crash and burn
$this->assertEquals( $value, $v, "unexpected value for field $field in instance of $class" );
}
}
// make phpunit happy even if $expectedStuff was empty
$this->assertTrue( true );
}
public static function provideConvert() {
return [
[ // #0
'Hallo Welt',
CONTENT_MODEL_WIKITEXT,
'lossless',
'Hallo Welt'
],
[ // #1
'Hallo Welt',
CONTENT_MODEL_WIKITEXT,
'lossless',
'Hallo Welt'
],
[ // #1
'Hallo Welt',
CONTENT_MODEL_CSS,
'lossless',
'Hallo Welt'
],
[ // #1
'Hallo Welt',
CONTENT_MODEL_JAVASCRIPT,
'lossless',
'Hallo Welt'
],
];
}
/**
* @dataProvider provideConvert
* @covers TextContent::convert
*/
public function testConvert( $text, $model, $lossy, $expectedNative ) {
$content = $this->newContent( $text );
/** @var TextContent $converted */
$converted = $content->convert( $model, $lossy );
if ( $expectedNative === false ) {
$this->assertFalse( $converted, "conversion to $model was expected to fail!" );
} else {
$this->assertInstanceOf( Content::class, $converted );
$this->assertEquals( $expectedNative, $converted->getText() );
}
}
/**
* @covers TextContent::normalizeLineEndings
* @dataProvider provideNormalizeLineEndings
*/
public function testNormalizeLineEndings( $input, $expected ) {
$this->assertEquals( $expected, TextContent::normalizeLineEndings( $input ) );
}
public static function provideNormalizeLineEndings() {
return [
[
"Foo\r\nbar",
"Foo\nbar"
],
[
"Foo\rbar",
"Foo\nbar"
],
[
"Foobar\n ",
"Foobar"
]
];
}
/**
* @covers TextContent::__construct
* @covers TextContentHandler::serializeContent
*/
public function testSerialize() {
$cnt = $this->newContent( 'testing text' );
$this->assertSame( 'testing text', $cnt->serialize() );
}
}