mediawiki-extensions-Discus.../tests/phpunit/CommentFormatterTest.php
Bartosz Dziewoński 4613ae78e7 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 19:51:57 +01:00

59 lines
1.7 KiB
PHP

<?php
namespace MediaWiki\Extension\DiscussionTools\Tests;
use MediaWiki\MediaWikiServices;
use Title;
use Wikimedia\TestingAccessWrapper;
/**
* @coversDefaultClass \MediaWiki\Extension\DiscussionTools\CommentFormatter
*/
class CommentFormatterTest extends IntegrationTestCase {
/**
* @dataProvider provideAddDiscussionToolsInternal
* @covers ::addDiscussionToolsInternal
*/
public function testAddDiscussionToolsInternal(
string $name, string $title, string $dom, string $expected, string $config, string $data
): void {
$title = Title::newFromText( $title );
$dom = self::getHtml( $dom );
$expectedPath = $expected;
$expected = self::getText( $expected );
$config = self::getJson( $config );
$data = self::getJson( $data );
$this->setupEnv( $config, $data );
MockCommentFormatter::$parser = TestUtils::createParser( $data );
$commentFormatter = TestingAccessWrapper::newFromClass( MockCommentFormatter::class );
$actual = $commentFormatter->addDiscussionToolsInternal( $dom, $title );
$mockSubStore = new MockSubscriptionStore();
$qqxLang = MediaWikiServices::getInstance()->getLanguageFactory()->getLanguage( 'qqx' );
$actual = MockCommentFormatter::postprocessTopicSubscription(
$actual, $qqxLang, $mockSubStore, self::getTestUser()->getUser()
);
$actual = MockCommentFormatter::postprocessReplyTool(
$actual, $qqxLang
);
// Optionally write updated content to the "reply HTML" files
if ( getenv( 'DISCUSSIONTOOLS_OVERWRITE_TESTS' ) ) {
self::overwriteTextFile( $expectedPath, $actual );
}
self::assertEquals( $expected, $actual, $name );
}
public function provideAddDiscussionToolsInternal(): array {
return self::getJson( '../cases/formattedreply.json' );
}
}