2020-10-19 20:59:55 +00:00
|
|
|
<?php
|
|
|
|
|
|
|
|
namespace MediaWiki\Extension\DiscussionTools\Tests;
|
|
|
|
|
2021-06-02 19:42:45 +00:00
|
|
|
use MediaWiki\MediaWikiServices;
|
2022-01-11 15:50:44 +00:00
|
|
|
use Title;
|
2021-01-29 18:31:27 +00:00
|
|
|
use Wikimedia\TestingAccessWrapper;
|
2020-10-19 20:59:55 +00:00
|
|
|
|
|
|
|
/**
|
|
|
|
* @coversDefaultClass \MediaWiki\Extension\DiscussionTools\CommentFormatter
|
|
|
|
*/
|
2021-02-02 14:12:51 +00:00
|
|
|
class CommentFormatterTest extends IntegrationTestCase {
|
2020-10-19 20:59:55 +00:00
|
|
|
|
|
|
|
/**
|
2021-04-19 18:34:55 +00:00
|
|
|
* @dataProvider provideAddDiscussionToolsInternal
|
|
|
|
* @covers ::addDiscussionToolsInternal
|
2020-10-19 20:59:55 +00:00
|
|
|
*/
|
2021-04-19 18:34:55 +00:00
|
|
|
public function testAddDiscussionToolsInternal(
|
2022-01-11 15:45:55 +00:00
|
|
|
string $name, string $title, string $dom, string $expected, string $config, string $data
|
2021-07-22 07:25:13 +00:00
|
|
|
): void {
|
2022-06-09 13:51:33 +00:00
|
|
|
$dom = static::getHtml( $dom );
|
2020-10-19 20:59:55 +00:00
|
|
|
$expectedPath = $expected;
|
2022-06-09 13:51:33 +00:00
|
|
|
$expected = static::getText( $expected );
|
|
|
|
$config = static::getJson( $config );
|
|
|
|
$data = static::getJson( $data );
|
2020-10-19 20:59:55 +00:00
|
|
|
|
|
|
|
$this->setupEnv( $config, $data );
|
2022-03-04 17:13:21 +00:00
|
|
|
$title = Title::newFromText( $title );
|
Change CommentParser into a service
Goal:
-----
To have a method like CommentParser::parse(), which just takes a node
to parse and a title and returns plain data, so that we don't need to
keep track of the config to construct a CommentParser object (the
required config like content language is provided by services) and
we don't need to keep that object around after parsing.
Changes:
--------
CommentParser.php:
* …is now a service. Constructor only takes services as arguments.
The node and title are passed to a new parse() method.
* parse() should return plain data, but I split this part to a separate
patch for ease of review: I49bfe019aa460651447fd383f73eafa9d7180a92.
* CommentParser still cheats and accesses global state in a few places,
e.g. calling Title::makeTitleSafe or CommentUtils::getTitleFromUrl,
so we can't turn its tests into true unit tests. This work is left
for future commits.
LanguageData.php:
* …is now a service, instead of a static class.
Parser.js:
* …is not a real service, but it's changed to behave in a similar way.
Constructor takes only the required config as argument,
and node and title are instead passed to a new parse() method.
CommentParserTest.php:
parser.test.js:
* Can be simplified, now that we don't need a useless node and title
to test internal methods that don't use them.
testUtils.js:
* Can be simplified, now that we don't need to override internal
ResourceLoader stuff just to change the parser config.
Change-Id: Iadb7757debe000025e52770ca51ebcf24ca8ee66
2022-02-19 02:43:21 +00:00
|
|
|
MockCommentFormatter::$parser = TestUtils::createParser( $data );
|
2020-10-19 20:59:55 +00:00
|
|
|
|
2021-01-29 18:31:27 +00:00
|
|
|
$commentFormatter = TestingAccessWrapper::newFromClass( MockCommentFormatter::class );
|
|
|
|
|
2022-01-11 15:50:44 +00:00
|
|
|
$actual = $commentFormatter->addDiscussionToolsInternal( $dom, $title );
|
2021-01-06 17:06:27 +00:00
|
|
|
|
2021-04-19 19:42:53 +00:00
|
|
|
$mockSubStore = new MockSubscriptionStore();
|
2021-06-02 19:42:45 +00:00
|
|
|
$qqxLang = MediaWikiServices::getInstance()->getLanguageFactory()->getLanguage( 'qqx' );
|
|
|
|
|
2021-01-28 17:19:52 +00:00
|
|
|
\OutputPage::setupOOUI();
|
2021-04-19 19:42:53 +00:00
|
|
|
$actual = MockCommentFormatter::postprocessTopicSubscription(
|
2022-06-09 13:51:33 +00:00
|
|
|
$actual, $qqxLang, $mockSubStore, static::getTestUser()->getUser()
|
2021-04-19 19:42:53 +00:00
|
|
|
);
|
|
|
|
|
2021-01-28 17:19:52 +00:00
|
|
|
$actual = MockCommentFormatter::postprocessVisualEnhancements(
|
|
|
|
$actual, $qqxLang, static::getTestUser()->getUser()
|
|
|
|
);
|
|
|
|
|
2021-04-15 21:09:55 +00:00
|
|
|
$actual = MockCommentFormatter::postprocessReplyTool(
|
2021-06-02 19:42:45 +00:00
|
|
|
$actual, $qqxLang
|
2021-04-15 21:09:55 +00:00
|
|
|
);
|
|
|
|
|
2021-01-28 17:19:52 +00:00
|
|
|
// OOUI ID's are non-deterministic, so strip them from test output
|
|
|
|
$actual = preg_replace( '/ id=[\'"]ooui-php-[0-9]+[\'"]/', '', $actual );
|
|
|
|
|
2020-10-19 20:59:55 +00:00
|
|
|
// Optionally write updated content to the "reply HTML" files
|
|
|
|
if ( getenv( 'DISCUSSIONTOOLS_OVERWRITE_TESTS' ) ) {
|
2022-06-09 13:51:33 +00:00
|
|
|
static::overwriteTextFile( $expectedPath, $actual );
|
2020-10-19 20:59:55 +00:00
|
|
|
}
|
|
|
|
|
2022-06-09 13:51:33 +00:00
|
|
|
static::assertEquals( $expected, $actual, $name );
|
2020-10-19 20:59:55 +00:00
|
|
|
}
|
|
|
|
|
2021-07-22 07:25:13 +00:00
|
|
|
public function provideAddDiscussionToolsInternal(): array {
|
2022-06-09 13:51:33 +00:00
|
|
|
return static::getJson( '../cases/formattedreply.json' );
|
2020-10-19 20:59:55 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
}
|