Page MenuHomeWickedGov Phorge
Files F4063635

CommentModifierTest.php
No OneTemporary
Actions

Size
6 KB
Referenced Files
None
Subscribers
None

CommentModifierTest.php
View Options

<?php
namespace MediaWiki\Extension\DiscussionTools\Tests;
use MediaWiki\Extension\DiscussionTools\CommentModifier;
use Wikimedia\Parsoid\Utils\DOMCompat;
use Wikimedia\Parsoid\Utils\DOMUtils;
use Wikimedia\Parsoid\Wt2Html\XMLSerializer;
/**
* @group DiscussionTools
* @covers \MediaWiki\Extension\DiscussionTools\CommentModifier
* @covers \MediaWiki\Extension\DiscussionTools\CommentUtils
*/
class CommentModifierTest extends IntegrationTestCase {
/**
* @dataProvider provideAddListItem
*/
public function testAddListItem(
string $name, string $title, string $dom, string $expected, string $config, string $data,
string $replyIndentation = 'invisible'
): void {
$origPath = $dom;
$dom = static::getHtml( $dom );
$expectedPath = $expected;
$expected = static::getHtml( $expected );
$config = static::getJson( $config );
$data = static::getJson( $data );
$title = $this->createTitleParser( $config )->parseTitle( $title );
$doc = static::createDocument( $dom );
$container = static::getThreadContainer( $doc );
$threadItemSet = $this->createParser( $config, $data )->parse( $container, $title );
$comments = $threadItemSet->getCommentItems();
foreach ( $comments as $comment ) {
if ( $comment->getTranscludedFrom() ) {
// Reply tool wouldn't be available for this comment on this page, because it's transcluded.
// Skip this case, because the result of addListItem() would be misleading (we add replies
// after the transclusion, which would be the wrong place for most of these comments).
continue;
}
$node = CommentModifier::addListItem( $comment, $replyIndentation );
$node->textContent = 'Reply to ' . $comment->getId();
}
$expectedDoc = static::createDocument( $expected );
// Optionally write updated content to the "modified HTML" files
if ( getenv( 'DISCUSSIONTOOLS_OVERWRITE_TESTS' ) ) {
static::overwriteHtmlFile( $expectedPath, $container, $origPath );
}
// saveHtml is not dirty-diff safe, but for testing it is probably faster than DOMCompat::getOuterHTML
static::assertEquals( $expectedDoc->saveHtml(), $doc->saveHtml(), $name );
// removeAddedListItem is not implemented on the server
}
public static function provideAddListItem(): array {
return static::getJson( '../cases/modified.json' );
}
/**
* @dataProvider provideAddReplyLink
*/
public function testAddReplyLink(
string $name, string $title, string $dom, string $expected, string $config, string $data
): void {
$origPath = $dom;
$dom = static::getHtml( $dom );
$expectedPath = $expected;
$expected = static::getHtml( $expected );
$config = static::getJson( $config );
$data = static::getJson( $data );
$title = $this->createTitleParser( $config )->parseTitle( $title );
$doc = static::createDocument( $dom );
$container = static::getThreadContainer( $doc );
$threadItemSet = $this->createParser( $config, $data )->parse( $container, $title );
$comments = $threadItemSet->getCommentItems();
foreach ( $comments as $comment ) {
$linkNode = $doc->createElement( 'a' );
$linkNode->nodeValue = 'Reply';
$linkNode->setAttribute( 'href', '#' );
CommentModifier::addReplyLink( $comment, $linkNode );
}
$expectedDoc = static::createDocument( $expected );
// Optionally write updated content to the "reply HTML" files
if ( getenv( 'DISCUSSIONTOOLS_OVERWRITE_TESTS' ) ) {
static::overwriteHtmlFile( $expectedPath, $container, $origPath );
}
// saveHtml is not dirty-diff safe, but for testing it is probably faster than DOMCompat::getOuterHTML
static::assertEquals( $expectedDoc->saveHtml(), $doc->saveHtml(), $name );
}
public static function provideAddReplyLink(): array {
return static::getJson( '../cases/reply.json' );
}
/**
* @dataProvider provideUnwrapList
*/
public function testUnwrapList( string $name, string $html, int $index, string $expected ): void {
$doc = static::createDocument( '' );
$container = $doc->createElement( 'div' );
DOMCompat::setInnerHTML( $container, $html );
CommentModifier::unwrapList( $container->childNodes[$index] );
static::assertEquals( $expected, DOMCompat::getInnerHTML( $container ) );
}
public static function provideUnwrapList(): array {
return static::getJson( '../cases/unwrap.json' );
}
/**
* @dataProvider provideUnwrapFragment
*/
public function testUnwrapFragment( string $html, string $expected ): void {
$doc = static::createDocument( '' );
$container = DOMUtils::parseHTMLToFragment( $doc, $html );
CommentModifier::unwrapFragment( $container );
static::assertEquals( $expected, DOMUtils::getFragmentInnerHTML( $container ) );
}
public static function provideUnwrapFragment() {
yield [
"<ul><li>aaa</li></ul>\n<dl><dd>bbb</dd></dl>",
"<p>aaa</p>\n<p>bbb</p>",
];
}
/**
* @dataProvider provideAppendSignature
*/
public function testAppendSignature(
string $msg, string $html, string $expected
): void {
$doc = static::createDocument( '' );
$container = DOMUtils::parseHTMLToFragment( $doc, $html );
CommentModifier::appendSignature( $container, ' ~~~~' );
static::assertEquals(
$expected,
XMLSerializer::serialize( $container, [ 'innerXML' => true, 'smartQuote' => false ] )['html'],
$msg
);
}
public static function provideAppendSignature(): array {
return static::getJson( '../cases/appendSignature.json' );
}
public function testAppendSignatureWikitext(): void {
static::assertEquals(
'Foo bar ~~~~',
CommentModifier::appendSignatureWikitext( 'Foo bar', ' ~~~~' ),
'Simple message'
);
static::assertEquals(
"Foo bar\n*A\n*B\n~~~~",
CommentModifier::appendSignatureWikitext( "Foo bar\n*A\n*B", ' ~~~~' ),
'List'
);
}
/**
* @dataProvider provideSanitizeWikitextLinebreaks
*/
public function testSanitizeWikitextLinebreaks( string $msg, string $wikitext, string $expected ): void {
static::assertEquals(
$expected,
CommentModifier::sanitizeWikitextLinebreaks( $wikitext ),
$msg
);
}
public static function provideSanitizeWikitextLinebreaks(): array {
return static::getJson( '../cases/sanitize-wikitext-linebreaks.json' );
}
}

File Metadata

Mime Type
text/x-php
Expires
Aug 16 2026, 12:49 (11 w, 6 d ago)
Storage Engine
local-disk
Storage Format
Raw Data
Storage Handle
5c/be/2f6d410056f78d17cc33e9432703
Default Alt Text
CommentModifierTest.php (6 KB)

Event Timeline