mediawiki-extensions-Echo/tests/phpunit/DiscussionParserTest.php

<?php

use MediaWiki\MediaWikiServices;

/**
 * @group Echo
 * @group Database
 */
class EchoDiscussionParserTest extends MediaWikiTestCase {
	/**
	 * @var array
	 */
	protected $tablesUsed = array( 'user', 'revision', 'text', 'page' );

	/**
	 * Users used in these tests: signature extraction, mentioned users, ... all
	 * assume a user exists.
	 *
	 * @var array [username => [user preference => preference value]]
	 */
	protected $testUsers = array(
		// username
		'Werdna' => array(
			// user preferences
			'nickname' => '',
			'fancysig' => '0',
		),
		'Werdna2' => array(
			'nickname' => '[[User:Werdna2|Andrew]]',
			'fancysig' => '1',
		),
		'Werdna3' => array(
			'nickname' => '[[User talk:Werdna3|Andrew]]',
			'fancysig' => '1',
		),
		'Werdna4' => array(
			'nickname' => '[[User:Werdna4|wer]dna]]',
			'fancysig' => '1',
		),
		'We buried our secrets in the garden' => array(
			'nickname' => '[[User talk:We buried our secrets in the garden#top|wbositg]]',
			'fancysig' => '1',
		),
		'I Heart Spaces' => array(
			'nickname' => '[[User:I_Heart_Spaces]] ([[User_talk:I_Heart_Spaces]])',
			'fancysig' => '1',
		),
		'Jam' => array(
			'nickname' => '[[User:Jam]]',
			'fancysig' => '1',
		),
		'Reverta-me' => array(
			'nickname' => "[[User:Reverta-me|<span style=\"font-size:13px; color:blue;font-family:Lucida Handwriting;text-shadow:aqua 5px 3px 12px;\">Aaaaa Bbbbbbb</span>]]'' <sup>[[User Talk:Reverta-me|<font color=\"gold\" face=\"Lucida Calligraphy\">Discussão</font>]]</sup>''",
			'fancysig' => '1',
		),
		'Jorm' => array(
			'nickname' => '',
			'fancysig' => '0',
		),
		'Jdforrester' => array(
			'nickname' => '',
			'fancysig' => '0',
		),
		'DarTar' => array(
			'nickname' => '',
			'fancysig' => '0',
		),
		'Bsitu' => array(
			'nickname' => '',
			'fancysig' => '0',
		),
		'JarJar' => array(
			'nickname' => '',
			'fancysig' => '0',
		),
		'Schnark' => array(
			'nickname' => '[[Benutzer:Schnark]] ([[Benutzer:Schnark/js|js]])',
			'fancysig' => '1',
		),
		'Cwobeel' => array(
			'nickname' => '[[User:Cwobeel|<span style="color:#339966">Cwobeel</span>]] [[User_talk:Cwobeel|<span style="font-size:80%">(talk)</span>]]',
			'fancysig' => '1',
		),
		'Bob K31416' => array(
			'nickname' => '',
			'fancysig' => '0',
		),
		'X" onclick="alert(\'XSS\');" title="y' => array(
			'nickname' => '',
			'fancysig' => '0',
		),
		'He7d3r' => array(
			'nickname' => '',
			'fancysig' => '0',
		),
		'PauloEduardo' => array(
			'nickname' => "[[User:PauloEduardo|<span style=\"font-size:13px; color:blue;font-family:Lucida Handwriting;text-shadow:aqua 5px 3px 12px;\">Paulo Eduardo</span>]]'' <sup>[[User Talk:PauloEduardo|<font color=\"gold\" face=\"Lucida Calligraphy\">Discussão</font>]]</sup>''",
			'fancysig' => '1',
		),
		'PatHadley' => array(
			'nickname' => '',
			'fancysig' => '0',
		),
		'Samwalton9' => array(
			'nickname' => '',
			'fancysig' => '0',
		),
		'Kudpung' => array(
			'nickname' => '[[User:Kudpung|Kudpung กุดผึ้ง]] ([[User talk:Kudpung#top|talk]])',
			'fancysig' => '1',
		),
		'Jim Carter' => array(
			'nickname' => '',
			'fancysig' => '0',
		),
		'Buster7' => array(
			'nickname' => '',
			'fancysig' => '0',
		),
		'Admin' => array(
			'nickname' => '[[:User:Admin|Admin]]',
			'fancysig' => '1',
		),
		'Test11' => array(
			'nickname' => '',
			'fancysig' => '0',
		),
	);

	protected function setUp() {
		parent::setUp();

		$this->setMwGlobals( array( 'wgDiff' => false ) );

		// users need to be added for each test, resetDB() removes them
		// TODO: Only add users needed for each test, instead of adding them
		// all for every one.
		foreach ( $this->testUsers as $username => $preferences ) {
			$user = User::createNew( $username );

			// set signature preferences
			if ( $user ) {
				foreach ( $preferences as $option => $value ) {
					$user->setOption( $option, $value );
				}
				$user->saveSettings();
			}
		}
	}

	protected function tearDown() {
		parent::tearDown();

		global $wgHooks;
		unset( $wgHooks['BeforeEchoEventInsert'][999] );
	}

	public function provideHeaderExtractions() {
		return array(
			array( '', false ),
			array( '== Grand jury no bill reception ==', 'Grand jury no bill reception' ),
			array( '=== Echo-Test ===', 'Echo-Test' ),
			array( '==== Notificações ====', 'Notificações' ),
			array( '=====Me?=====', 'Me?' ),
		);
	}

	/**
	 * @dataProvider provideHeaderExtractions
	 */
	public function testExtractHeader( $text, $expected ) {
		$this->assertEquals( $expected, EchoDiscussionParser::extractHeader( $text ) );
	}

	public function generateEventsForRevisionData() {
		return array(
			array(
				'new' => 637638133,
				'old' => 637637213,
				'username' => 'Cwobeel',
				'lang' => 'en',
				'pages' => array(
					// pages expected to exist (e.g. templates to be expanded)
					'Template:u' => '[[User:{{{1}}}|{{<includeonly>safesubst:</includeonly>#if:{{{2|}}}|{{{2}}}|{{{1}}}}}]]<noinclude>{{documentation}}</noinclude>',
				),
				'title' => 'UTPage', // can't remember, not important here
				'expected' => array(
					// events expected to be fired going from old revision to new
					array(
						'type' => 'mention',
						'agent' => 'Cwobeel',
						'section-title' => 'Grand jury no bill reception',
						/*
						 * I wish I could also compare EchoEvent::$extra data to
						 * compare user ids of mentioned users. However, due to
						 * How PHPUnit works, setUp won't be run by the time
						 * this dataset is generated, so we don't yet know the
						 * user ids of the folks we're about to insert...
						 * I'll skip that part for now.
						 */
					),
				),
			),
			array(
				'new' => 138275105,
				'old' => 138274875,
				'username' => 'Schnark',
				'lang' => 'de',
				'pages' => array(),
				'title' => 'UTPage', // can't remember, not important here
				'expected' => array(
					array(
						'type' => 'mention',
						'agent' => 'Schnark',
						'section-title' => 'Echo-Test',
					),
				),
			),
			array(
				'new' => 40610292,
				'old' => 40608353,
				'username' => 'PauloEduardo',
				'lang' => 'pt',
				'pages' => array(
					'Predefinição:U' => '[[User:{{{1|<noinclude>Exemplo</noinclude>}}}|{{{{{|safesubst:}}}#if:{{{2|}}}|{{{2}}}|{{{1|<noinclude>Exemplo</noinclude>}}}}}]]<noinclude>{{Atalho|Predefinição:U}}{{Documentação|Predefinição:Usuário/doc}}</noinclude>',
				),
				'title' => 'UTPage', // can't remember, not important here
				'expected' => array(
					array(
						'type' => 'mention',
						'agent' => 'PauloEduardo',
						'section-title' => 'Notificações',
					),
				),
			),
			array(
				'new' => 646792804,
				'old' => 646790570,
				'username' => 'PatHadley',
				'lang' => 'en',
				'pages' => array(
					'Template:ping' => '{{SAFESUBST:<noinclude />#if:{{{1|<noinclude>$</noinclude>}}}
 |<span class="template-ping">@[[:User:{{SAFESUBST:<noinclude />BASEPAGENAME:{{{1|Example}}}}}|{{SAFESUBST:<noinclude />BASEPAGENAME:{{{label1|{{{1|Example}}}}}}}}]]{{SAFESUBST:<noinclude />#if:{{{2|}}}
 |, [[:User:{{SAFESUBST:<noinclude />BASEPAGENAME:{{{2|Example}}}}}|{{SAFESUBST:<noinclude />BASEPAGENAME:{{{label2|{{{2|Example}}}}}}}}]]{{SAFESUBST:<noinclude />#if:{{{3|}}}
 |, [[:User:{{SAFESUBST:<noinclude />BASEPAGENAME:{{{3|Example}}}}}|{{SAFESUBST:<noinclude />BASEPAGENAME:{{{label3|{{{3|Example}}}}}}}}]]{{SAFESUBST:<noinclude />#if:{{{4|}}}
 |, [[:User:{{SAFESUBST:<noinclude />BASEPAGENAME:{{{4|Example}}}}}|{{SAFESUBST:<noinclude />BASEPAGENAME:{{{label4|{{{4|Example}}}}}}}}]]{{SAFESUBST:<noinclude />#if:{{{5|}}}
 |, [[:User:{{SAFESUBST:<noinclude />BASEPAGENAME:{{{5|Example}}}}}|{{SAFESUBST:<noinclude />BASEPAGENAME:{{{label5|{{{5|Example}}}}}}}}]]{{SAFESUBST:<noinclude />#if:{{{6|}}}
 |, [[:User:{{SAFESUBST:<noinclude />BASEPAGENAME:{{{6|Example}}}}}|{{SAFESUBST:<noinclude />BASEPAGENAME:{{{label6|{{{6|Example}}}}}}}}]]{{SAFESUBST:<noinclude />#if:{{{7|}}}
 |, [[:User:{{SAFESUBST:<noinclude />BASEPAGENAME:{{{7|Example}}}}}|{{SAFESUBST:<noinclude />BASEPAGENAME:{{{label7|{{{7|Example}}}}}}}}]]
      }}
     }}
    }}
   }}
  }}
 }}{{{p|:}}}</span>
 |{{SAFESUBST:<noinclude />Error|Error in [[Template:Replyto]]: Username not given.}}
}}<noinclude>

{{documentation}}
</noinclude>',
					'MediaWiki:Signature' => '[[User:$1|$2]] {{#ifeq:{{FULLPAGENAME}}|User talk:$1|([[User talk:$1#top|talk]])|([[User talk:$1|talk]])}}',
				),
				'title' => 'User_talk:PatHadley',
				'expected' => array(
					array(
						'type' => 'mention',
						'agent' => 'PatHadley',
						'section-title' => 'Wizardry required',
					),
					array(
						'type' => 'edit-user-talk',
						'agent' => 'PatHadley',
						'section-title' => 'Wizardry required',
					),
				),
				'precondition' => 'isParserFunctionsInstalled',
			),
			array(
				'new' => 647260329,
				'old' => 647258025,
				'username' => 'Kudpung',
				'lang' => 'en',
				'pages' => array(
					'Template:U' => '[[User:{{{1}}}|{{<includeonly>safesubst:</includeonly>#if:{{{2|}}}|{{{2}}}|{{{1}}}}}]]<noinclude>{{documentation}}</noinclude>',
				),
				'title' => 'User_talk:Kudpung',
				'expected' => array(
					array(
						'type' => 'mention',
						'agent' => 'Kudpung',
						'section-title' => 'Me?',
					),
					array(
						'type' => 'edit-user-talk',
						'agent' => 'Kudpung',
						'section-title' => 'Me?',
					),
				),
			),
			// T68512, leading colon in user page link in signature
			array(
				'new' => 612485855,
				'old' => 612485595,
				'username' => 'Admin',
				'lang' => 'en',
				'pages' => array(),
				'title' => 'User_talk:Admin',
				'expected' => array(
					array(
						'type' => 'mention',
						'agent' => 'Admin',
						'section-title' => 'Hi',
					),
					array(
						'type' => 'edit-user-talk',
						'agent' => 'Admin',
						'section-title' => 'Hi',
					),
				),
				'precondition' => 'isParserFunctionsInstalled',
			),
		);
	}

	/**
	 * @dataProvider generateEventsForRevisionData
	 */
	public function testGenerateEventsForRevision(
		$newId, $oldId, $username, $lang, $pages, $title, $expected, $precondition = ''
	) {
		if ( $precondition !== '' ) {
			$result = $this->$precondition();
			if ( $result !== true ) {
				$this->markTestSkipped( $result );

				return;
			}
		}

		$revision = $this->setupTestRevisionsForEventGeneration(
			$newId, $oldId, $username, $lang, $pages, $title
		);
		$events = array();
		$this->setupEventCallbackForEventGeneration(
			function ( EchoEvent $event ) use ( &$events ) {
				$events[] = array(
					'type' => $event->getType(),
					'agent' => $event->getAgent()->getName(),
					'section-title' => $event->getExtraParam( 'section-title' ),
				);
				return false;
			}
		);

		// disable mention failure and success notifications
		$this->setMwGlobals( 'wgEchoMentionStatusNotifications', false );

		EchoDiscussionParser::generateEventsForRevision( $revision );

		$this->assertEquals( $expected, $events );
	}

	public function provider_generateEventsForRevision_mentionStatus() {
		return array(
			array(
				'new' => 747747748,
				'old' => 747747747,
				'username' => 'Admin',
				'lang' => 'en',
				'pages' => array(),
				'title' => 'UTPage',
				'expected' => array(
					array(
						'type' => 'mention-failure',
						'agent' => 'Admin',
						'section-title' => 'Hello Users',
						'notifyAgent' => true,
						'subject-name' => 'Ping',
					),
					array(
						'type' => 'mention-failure',
						'agent' => 'Admin',
						'section-title' => 'Hello Users',
						'notifyAgent' => true,
						'subject-name' => 'Po?ng',
					),
				),
			),
			array(
				'new' => 747747750,
				'old' => 747747747,
				'username' => 'Admin',
				'lang' => 'en',
				'pages' => array(),
				'title' => 'UTPage',
				'expected' => array(
					array(
						'type' => 'mention',
						'agent' => 'Admin',
						'section-title' => 'Hello Users',
						'notifyAgent' => null,
						'subject-name' => null,
					),
					array(
						'type' => 'mention-success',
						'agent' => 'Admin',
						'section-title' => 'Hello Users',
						'notifyAgent' => true,
						'subject-name' => 'Test11',
					),
				),
			),
			array(
				'new' => 747798766,
				'old' => 747798765,
				'username' => 'Admin',
				'lang' => 'en',
				'pages' => array(),
				'title' => 'UTPage',
				'expected' => array(
					array(
						'type' => 'mention-failure',
						'agent' => 'Admin',
						'section-title' => 'Section 2',
						'notifyAgent' => true,
						'subject-name' => 'NoUser',
					),
				),
			),
			array(
				'new' => 747798767,
				'old' => 747798765,
				'username' => 'Admin',
				'lang' => 'en',
				'pages' => array(),
				'title' => 'UTPage',
				'expected' => array(
					array(
						'type' => 'mention-failure',
						'agent' => 'Admin',
						'section-title' => 'Section 2',
						'notifyAgent' => true,
						'subject-name' => 'NoUser',
					),
				),
			),
			array(
				'new' => 747798768,
				'old' => 747798765,
				'username' => 'Admin',
				'lang' => 'en',
				'pages' => array(),
				'title' => 'UTPage',
				'expected' => array(),
			),
		);
	}

	/**
	 * @dataProvider provider_generateEventsForRevision_mentionStatus
	 */
	public function testGenerateEventsForRevision_mentionStatus(
		$newId, $oldId, $username, $lang, $pages, $title, $expected
	) {
		$revision = $this->setupTestRevisionsForEventGeneration(
			$newId, $oldId, $username, $lang, $pages, $title
		);
		$events = array();
		$this->setupEventCallbackForEventGeneration(
			function ( EchoEvent $event ) use ( &$events ) {
				$events[] = array(
					'type' => $event->getType(),
					'agent' => $event->getAgent()->getName(),
					'section-title' => $event->getExtraParam( 'section-title' ),
					'notifyAgent' => $event->getExtraParam( 'notifyAgent' ),
					'subject-name' => $event->getExtraParam( 'subject-name' ),
				);
				return false;
			}
		);

		// enable mention failure and success notifications
		$this->setMwGlobals( 'wgEchoMentionStatusNotifications', true );

		EchoDiscussionParser::generateEventsForRevision( $revision );

		$this->assertEquals( $expected, $events );
	}

	public function provider_extractSections() {
		return array(
			array(
				'content' => 'Just Text.',
				'result' => array(
					array(
						'header' => false,
						'content' => 'Just Text.',
					),
				),
			),
			array(
				'content' =>
<<<TEXT
Text and a
== Headline ==
with text
TEXT
				,
				'result' => array(
					array(
						'header' => false,
						'content' =>
<<<TEXT
Text and a
TEXT
						,
					),
					array(
						'header' => '== Headline ==',
						'content' =>
<<<TEXT
== Headline ==
with text
TEXT
						,
					),
				),
			),
			array(
				'content' =>
<<<TEXT
== Headline ==
Text and a [[User:Test]]
TEXT
			,
				'result' => array(
					array(
						'header' => '== Headline ==',
						'content' =>
<<<TEXT
== Headline ==
Text and a [[User:Test]]
TEXT
					,
					),
				),
			),
			array(
				'content' =>
<<<TEXT
Content 0
== Headline 1 ==
Content 1
=== Headline 2 ===
Content 2
TEXT
			,
				'result' => array(
					array(
						'header' => false,
						'content' => 'Content 0',
					),
					array(
						'header' => '== Headline 1 ==',
						'content' =>
<<<TEXT
== Headline 1 ==
Content 1
TEXT
					,
					),
					array(
						'header' => '=== Headline 2 ===',
						'content' =>
<<<TEXT
=== Headline 2 ===
Content 2
TEXT
					,
					),
				),
			),
			array(
				'content' =>
<<<TEXT
== Headline 1 ==
مرحبا كيف حالك 
=== Headline 2 ===
انا بخير شكرا
TEXT
			,
				'result' => array(
					array(
						'header' => '== Headline 1 ==',
						'content' =>
<<<TEXT
== Headline 1 ==
مرحبا كيف حالك
TEXT
					,
					),
					array(
						'header' => '=== Headline 2 ===',
						'content' =>
<<<TEXT
=== Headline 2 ===
انا بخير شكرا
TEXT
					,
					),
				),
			),
			array(
				'content' =>
<<<TEXT
مرحبا كيف حالك
=== Headline 1 ===
انا بخير شكرا
TEXT
			,
				'result' => array(
					array(
						'header' => false,
						'content' =>
<<<TEXT
مرحبا كيف حالك
TEXT
					,
					),
					array(
						'header' => '=== Headline 1 ===',
						'content' =>
<<<TEXT
=== Headline 1 ===
انا بخير شكرا
TEXT
					,
					),
				),
			),
		);
	}

	/**
	 * @dataProvider provider_extractSections
	 */
	public function testExtractSections( $content, $result ) {
		$discussionParser = TestingAccessWrapper::newFromClass( 'EchoDiscussionParser' );
		$sections = $discussionParser->extractSections( $content );

		$this->assertEquals( $result, $sections );
	}

	public function testGenerateEventsForRevision_tooManyMentionsFailure() {
		$expected = array(
			array(
				'type' => 'mention-failure-too-many',
				'agent' => 'Admin',
				'section-title' => 'Hello Users',
				'max-mentions' => 5,
			),
		);

		$revision = $this->setupTestRevisionsForEventGeneration( 747747749, 747747747, 'Admin', 'en', array(), 'UTPage' );

		$events = array();
		$this->setupEventCallbackForEventGeneration(
			function ( EchoEvent $event ) use ( &$events ) {
				$events[] = array(
					'type' => $event->getType(),
					'agent' => $event->getAgent()->getName(),
					'section-title' => $event->getExtraParam( 'section-title' ),
					'max-mentions' => $event->getExtraParam( 'max-mentions' ),
				);
				return false;
			}
		);

		$this->setMwGlobals( array(
			// enable mention failure and success notifications
			'wgEchoMentionStatusNotifications' => true,
			// lower limit for the mention-failure-too-many notification
			'wgEchoMaxMentionsCount' => 5
		) );

		EchoDiscussionParser::generateEventsForRevision( $revision );

		$this->assertEquals( $expected, $events );
	}

	private function setupTestRevisionsForEventGeneration( $newId, $oldId, $username, $lang, $pages, $title ) {
		$langObj = Language::factory( $lang );
		$this->setMwGlobals( array(
			// this global is used by the code that interprets the namespace part of
			// titles (Title::getTitleParser), so should be the fake language ;)
			'wgContLang' => $langObj,
			// this one allows Mediawiki:xyz pages to be set as messages
			'wgUseDatabaseMessages' => true
		) );

		// Since we reset the $wgContLang global, reset the TitleParser service
		$services = MediaWikiServices::getInstance();
		if ( is_callable( [ $services, 'getTitleParser' ] ) ) {
			// TODO: All of this should use $this->setService()
			$services->resetServiceForTesting( 'TitleParser' );
			$services->redefineService( 'TitleParser', function () use ( $langObj ) {
				global $wgLocalInterwikis;
				return new MediaWikiTitleCodec(
					$langObj,
					new GenderCache(),
					$wgLocalInterwikis
				);
			} );
			// Cleanup
			$lock = new ScopedCallback( function() use ( $services ) {
				$services->resetServiceForTesting( 'TitleParser' );
			} );
		}

		// pages to be created: templates may be used to ping users (e.g.
		// {{u|...}}) but if we don't have that template, it just won't work!
		$pages += array( $title => '' );
		foreach ( $pages as $pageTitle => $pageText ) {
			$template = WikiPage::factory( Title::newFromText( $pageTitle ) );
			$template->doEditContent( new WikitextContent( $pageText ), '' );
		}

		// force i18n messages to be reloaded (from DB, where a new message
		// might have been created as page)
		MessageCache::destroyInstance();

		// grab revision excerpts (didn't include them in this src file because
		// they can be pretty long)
		$oldText = file_get_contents( __DIR__ . '/revision_txt/' . $oldId . '.txt' );
		$newText = file_get_contents( __DIR__ . '/revision_txt/' . $newId . '.txt' );

		// revision texts can be in different languages, where links etc are
		// different (e.g. User: becomes Benutzer: in German), so let's pretend
		// the page they belong to is from that language
		$title = Title::newFromText( $title );
		$object = new ReflectionObject( $title );
		$property = $object->getProperty( 'mDbPageLanguage' );
		$property->setAccessible( true );
		$property->setValue( $title, $lang );

		// create stub Revision object
		$row = array(
			'id' => $newId,
			'user_text' => $username,
			'user' => User::newFromName( $username )->getId(),
			'parent_id' => $oldId,
			'text' => $newText,
			'title' => $title,
		);
		$revision = Revision::newFromRow( $row );

		// generate diff between 2 revisions
		$changes = EchoDiscussionParser::getMachineReadableDiff( $oldText, $newText );
		$output = EchoDiscussionParser::interpretDiff( $changes, $revision->getUserText(), $title );

		// store diff in some local cache var, to circumvent
		// EchoDiscussionParser::getChangeInterpretationForRevision's attempt to
		// retrieve parent revision from DB
		$class = new ReflectionClass( 'EchoDiscussionParser' );
		$property = $class->getProperty( 'revisionInterpretationCache' );
		$property->setAccessible( true );
		$property->setValue( array( $revision->getId() => $output ) );
		return $revision;
	}

	private function setupEventCallbackForEventGeneration( callable $callback ) {
		// to catch the generated event, I'm going to attach a callback to the
		// hook that's being run just prior to sending the notifications out
		// can't use setMwGlobals here, so I'll just re-attach to the same key
		// for every dataProvider value (and don't worry, I'm removing it on
		// tearDown too - I just felt the attaching should be happening here
		// instead of on setUp, or code would get too messy)
		global $wgHooks;
		$wgHooks['BeforeEchoEventInsert'][999] = $callback;
	}

	// TODO test cases for:
	// - stripHeader
	// - stripIndents
	// - stripSignature

	public function testDiscussionParserAcceptsInternalDiff() {
		global $wgDiff;

		$origWgDiff = $wgDiff;
		$wgDiff = '/does/not/exist/or/at/least/we/hope/not';
		try {
			$res = EchoDiscussionParser::getMachineReadableDiff(
				<<<TEXT
line 1
line 2
line 3
line 4
TEXT
,
				<<<TEXT
line 1
line c
line 4
TEXT
			);
		} catch ( MWException $e ) {
			$wgDiff = $origWgDiff;
			throw $e;
		}
		$wgDiff = $origWgDiff;

		// Test failure occurs when MWException is thrown due to parsing failure
		$this->assertTrue( true );
	}

	public function testTimestampRegex() {
		$exemplarTimestamp = self::getExemplarTimestamp();
		$timestampRegex = EchoDiscussionParser::getTimestampRegex();

		$match = preg_match( '/' . $timestampRegex . '/u', $exemplarTimestamp );
		$this->assertEquals( 1, $match );
	}

	public function testGetTimestampPosition() {
		$line = 'Hello World. ' . self::getExemplarTimestamp();
		$pos = EchoDiscussionParser::getTimestampPosition( $line );
		$this->assertEquals( 13, $pos );
	}

	/**
	 * @dataProvider signingDetectionData
	 * FIXME some of the app logic is in the test...
	 */
	public function testSigningDetection( $line, $expectedUser ) {
		if ( !EchoDiscussionParser::isSignedComment( $line ) ) {
			$this->assertEquals( $expectedUser, false );

			return;
		}

		$output = EchoDiscussionParser::getUserFromLine( $line );

		if ( $output === false ) {
			$this->assertEquals( false, $expectedUser );
		} elseif ( is_array( $expectedUser ) ) {
			// Sometimes testing for correct user detection,
			//  sometimes testing for offset detection
			$this->assertEquals( $expectedUser, $output );
		} else {
			$this->assertEquals( $expectedUser, $output[1] );
		}
	}

	public function signingDetectionData() {
		$ts = self::getExemplarTimestamp();

		return array(
			// Basic
			array(
				"I like this. [[User:Werdna|Werdna]] ([[User talk:Werdna|talk]]) $ts",
				array(
					13,
					'Werdna'
				),
			),
			// Confounding
			array(
				"[[User:Jorm]] is a meanie. --[[User:Werdna2|Andrew]] $ts",
				array(
					29,
					"Werdna2"
				),
			),
			// Talk page link only
			array(
				"[[User:Swalling|Steve]] is the best person I have ever met. --[[User talk:Werdna3|Andrew]] $ts",
				array(
					62,
					'Werdna3'
				),
			),
			// Anonymous user
			array(
				"I am anonymous because I like my IP address. --[[Special:Contributions/127.0.0.1|127.0.0.1]] $ts",
				array(
					47,
					'127.0.0.1'
				),
			),
			// No signature
			array(
				"Well, \nI do think that [[User:Newyorkbrad]] is pretty cool, but what do I know?",
				false
			),
			// Hash symbols in usernames
			array(
				"What do you think? [[User talk:We buried our secrets in the garden#top|wbositg]] $ts",
				array(
					19,
					'We buried our secrets in the garden'
				),
			),
			// Title that gets normalized different than it is provided in the wikitext
			array(
				"Beep boop [[User:I_Heart_Spaces]] ([[User_talk:I_Heart_Spaces]]) $ts",
				array(
					strlen( "Beep boop " ),
					'I Heart Spaces'
				),
			),
			// Accepts ] in the pipe
			array(
				"Shake n Bake --[[User:Werdna4|wer]dna]] $ts",
				array(
					strlen( "Shake n Bake --" ),
					'Werdna4',
				),
			),

			array(
				"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxã? [[User:Jam]] $ts",
				array(
					strlen( "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxã? " ),
					"Jam"
				),
			),
			// extra long signature
			array(
				"{{U|He7d3r}}, xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxã? [[User:Reverta-me|<span style=\"font-size:13px; color:blue;font-family:Lucida Handwriting;text-shadow:aqua 5px 3px 12px;\">Aaaaa Bbbbbbb</span>]]'' <sup>[[User Talk:Reverta-me|<font color=\"gold\" face=\"Lucida Calligraphy\">Discussão</font>]]</sup>''",
				array(
					strlen( "{{U|He7d3r}}, xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxã? " ),
					'Reverta-me',
				),
			),
			// Bug: T87852
			array(
				"Test --[[Benutzer:Schnark]] ([[Benutzer:Schnark/js|js]])",
				array(
					strlen( "Test --" ),
					'Schnark',
				),
			),
			// when adding additional tests, make sure to add the non-anon users
			// to EchoDiscussionParserTest::$testusers - the DiscussionParser
			// needs the users to exist, because it'll generate a comparison
			// signature, which is different when the user is considered anon
		);
	}

	/** @dataProvider diffData */
	public function testDiff( $oldText, $newText, $expected ) {
		$actual = EchoDiscussionParser::getMachineReadableDiff( $oldText, $newText );
		unset( $actual['_info'] );
		unset( $expected['_info'] );

		$this->assertEquals( $expected, $actual );
	}

	public function diffData() {
		return array(
			array(
				<<<TEXT
line 1
line 2
line 3
line 4
TEXT
			, <<<TEXT
line 1
line 3
line 4
TEXT
			,
				array( array(
					'action' => 'subtract',
					'content' => 'line 2',
					'left-pos' => 2,
					'right-pos' => 2,
				) )
			),
			array(
				<<<TEXT
line 1
line 2
line 3
line 4
TEXT
			, <<<TEXT
line 1
line 2
line 2.5
line 3
line 4
TEXT
			,
				array( array(
					'action' => 'add',
					'content' => 'line 2.5',
					'left-pos' => 3,
					'right-pos' => 3,
				) )
			),
			array(
				<<<TEXT
line 1
line 2
line 3
line 4
TEXT
			, <<<TEXT
line 1
line b
line 3
line 4
TEXT
			,
				array( array(
					'action' => 'change',
					'old_content' => 'line 2',
					'new_content' => 'line b',
					'left-pos' => 2,
					'right-pos' => 2,
				) )
			),
			array(
				<<<TEXT
line 1
line 2
line 3
line 4
TEXT
			, <<<TEXT
line 1
line b
line c
line d
line 3
line 4
TEXT
			,
				array(
					array(
						'action' => 'change',
						'old_content' => 'line 2',
						'new_content' => 'line b',
						'left-pos' => 2,
						'right-pos' => 2,
					),
					array(
						'action' => 'add',
						'content' => 'line c
line d',
						'left-pos' => 3,
						'right-pos' => 3,
					),
				),
			),
		);
	}

	/** @dataProvider annotationData */
	public function testAnnotation( $message, $diff, $user, $expectedAnnotation ) {
		$actual = EchoDiscussionParser::interpretDiff( $diff, $user );
		$this->assertEquals( $expectedAnnotation, $actual, $message );
	}

	public function annotationData() {
		$ts = self::getExemplarTimestamp();

		return array(

			array(
				'Must detect added comments',
				// Diff
				array(
					// Action
					array(
						'action' => 'add',
						'content' => ":What do you think? [[User:Werdna|Werdna]] ([[User talk:Werdna|talk]]) $ts",
						'left-pos' => 3,
						'right-pos' => 3,
					),
					'_info' => array(
						'lhs' => array(
							'== Section 1 ==',
							"I do not like you. [[User:Jorm|Jorm]] ([[User talk:Jorm|talk]]) $ts",
						),
						'rhs' => array(
							'== Section 1 ==',
							"I do not like you. [[User:Jorm|Jorm]] ([[User talk:Jorm|talk]]) $ts",
							":What do you think? [[User:Werdna|Werdna]] ([[User talk:Werdna|talk]]) $ts",
						),
					),
				),
				// User
				'Werdna',
				// Expected annotation
				array(
					array(
						'type' => 'add-comment',
						'content' => ":What do you think? [[User:Werdna|Werdna]] ([[User talk:Werdna|talk]]) $ts",
						'full-section' => <<<TEXT
== Section 1 ==
I do not like you. [[User:Jorm|Jorm]] ([[User talk:Jorm|talk]]) $ts
:What do you think? [[User:Werdna|Werdna]] ([[User talk:Werdna|talk]]) $ts
TEXT
					),
				),
			),

			array(
				'Full Section must not include the following pre-existing section',
				// Diff
				array(
					// Action
					array(
						'action' => 'add',
						'content' => ":What do you think? [[User:Werdna|Werdna]] ([[User talk:Werdna|talk]]) $ts",
						'left-pos' => 3,
						'right-pos' => 3,
					),
					'_info' => array(
						'lhs' => array(
							'== Section 1 ==',
							"I do not like you. [[User:Jorm|Jorm]] ([[User talk:Jorm|talk]]) $ts",
							'== Section 2 ==',
							"Well well well. [[User:DarTar|DarTar]] ([[User talk:DarTar|talk]]) $ts",
						),
						'rhs' => array(
							'== Section 1 ==',
							"I do not like you. [[User:Jorm|Jorm]] ([[User talk:Jorm|talk]]) $ts",
							":What do you think? [[User:Werdna|Werdna]] ([[User talk:Werdna|talk]]) $ts",
							'== Section 2 ==',
							"Well well well. [[User:DarTar|DarTar]] ([[User talk:DarTar|talk]]) $ts",
						),
					),
				),
				// User
				'Werdna',
				// Expected annotation
				array(
					array(
						'type' => 'add-comment',
						'content' => ":What do you think? [[User:Werdna|Werdna]] ([[User talk:Werdna|talk]]) $ts",
						'full-section' => <<<TEXT
== Section 1 ==
I do not like you. [[User:Jorm|Jorm]] ([[User talk:Jorm|talk]]) $ts
:What do you think? [[User:Werdna|Werdna]] ([[User talk:Werdna|talk]]) $ts
TEXT
					),
				),
			),

			array(
				'Must detect new-section-with-comment when a new section is added',
				// Diff
				array(
					// Action
					array(
						'action' => 'add',
						'content' => <<<TEXT
== Section 1a ==
Hmmm? [[User:Jdforrester|Jdforrester]] ([[User talk:Jdforrester|talk]]) $ts
TEXT
					,
						'left-pos' => 4,
						'right-pos' => 4,
					),
					'_info' => array(
						'lhs' => array(
							'== Section 1 ==',
							"I do not like you. [[User:Jorm|Jorm]] ([[User talk:Jorm|talk]]) $ts",
							":What do you think? [[User:Werdna|Werdna]] ([[User talk:Werdna|talk]]) $ts",
							'== Section 2 ==',
							"Well well well. [[User:DarTar|DarTar]] ([[User talk:DarTar|talk]]) $ts",
						),
						'rhs' => array(
							'== Section 1 ==',
							"I do not like you. [[User:Jorm|Jorm]] ([[User talk:Jorm|talk]]) $ts",
							":What do you think? [[User:Werdna|Werdna]] ([[User talk:Werdna|talk]]) $ts",
							'== Section 1a ==',
							'Hmmm? [[User:Jdforrester|Jdforrester]] ([[User talk:Jdforrested|talk]]) $ts',
							'== Section 2 ==',
							"Well well well. [[User:DarTar|DarTar]] ([[User talk:DarTar|talk]]) $ts",
						),
					),
				),
				// User
				'Jdforrester',
				// Expected annotation
				array(
					array(
						'type' => 'new-section-with-comment',
						'content' => <<<TEXT
== Section 1a ==
Hmmm? [[User:Jdforrester|Jdforrester]] ([[User talk:Jdforrester|talk]]) $ts
TEXT
					,
					),
				),
			),

			array(
				'Must detect multiple added comments when multiple sections are edited',
				EchoDiscussionParser::getMachineReadableDiff(
					<<<TEXT
== Section 1 ==
I do not like you. [[User:Jorm|Jorm]] ([[User talk:Jorm|talk]]) $ts
:What do you think? [[User:Werdna|Werdna]] ([[User talk:Werdna|talk]]) $ts
== Section 2 ==
Well well well. [[User:DarTar|DarTar]] ([[User talk:DarTar|talk]]) $ts
== Section 3 ==
Hai [[User:Bsitu|Bsitu]] ([[User talk:Bsitu|talk]]) $ts
TEXT
,
					<<<TEXT
== Section 1 ==
I do not like you. [[User:Jorm|Jorm]] ([[User talk:Jorm|talk]]) $ts
:What do you think? [[User:Werdna|Werdna]] ([[User talk:Werdna|talk]]) $ts
:New Comment [[User:JarJar|JarJar]] ([[User talk:JarJar|talk]]) $ts
== Section 2 ==
Well well well. [[User:DarTar|DarTar]] ([[User talk:DarTar|talk]]) $ts
== Section 3 ==
Hai [[User:Bsitu|Bsitu]] ([[User talk:Bsitu|talk]]) $ts
:Other New Comment [[User:JarJar|JarJar]] ([[User talk:JarJar|talk]]) $ts
TEXT
				),
				// User
				'JarJar',
				// Expected annotation
				array(
					array(
						'type' => 'add-comment',
						'content' => ":New Comment [[User:JarJar|JarJar]] ([[User talk:JarJar|talk]]) $ts",
						'full-section' => <<<TEXT
== Section 1 ==
I do not like you. [[User:Jorm|Jorm]] ([[User talk:Jorm|talk]]) $ts
:What do you think? [[User:Werdna|Werdna]] ([[User talk:Werdna|talk]]) $ts
:New Comment [[User:JarJar|JarJar]] ([[User talk:JarJar|talk]]) $ts
TEXT
					),
					array(
						'type' => 'add-comment',
						'content' => ":Other New Comment [[User:JarJar|JarJar]] ([[User talk:JarJar|talk]]) $ts",
						'full-section' => <<<TEXT
== Section 3 ==
Hai [[User:Bsitu|Bsitu]] ([[User talk:Bsitu|talk]]) $ts
:Other New Comment [[User:JarJar|JarJar]] ([[User talk:JarJar|talk]]) $ts
TEXT
					),
				),
			),

			array(
				'Bug T78424',
				EchoDiscussionParser::getMachineReadableDiff(
					<<<TEXT
== Washington Post Reception Source ==

''The Boston Post'' source that was used in the reception section has a couple of problems. First, it's actually a repost of ''The Washington Post'', but ''The Washington Post'' doesn't allow the Internet Archive to preserve it. Should it still be sourced to Boston or to Washington? Second, it seems to be a lot of analysis that can't be summed up easily without trimming it out, and doesn't really fit with the reception section and should probably moved next to Wilson's testimony. Any suggestions? --[[User:RAN1|RAN1]] ([[User talk:RAN1|talk]]) 01:44, 11 December 2014 (UTC)
TEXT
,
					<<<TEXT
== Washington Post Reception Source ==

''The Boston Post'' source that was used in the reception section has a couple of problems. First, it's actually a repost of ''The Washington Post'', but ''The Washington Post'' doesn't allow the Internet Archive to preserve it. Should it still be sourced to Boston or to Washington? Second, it seems to be a lot of analysis that can't be summed up easily without trimming it out, and doesn't really fit with the reception section and should probably moved next to Wilson's testimony. Any suggestions? --[[User:RAN1|RAN1]] ([[User talk:RAN1|talk]]) 01:44, 11 December 2014 (UTC)

== Grand jury no bill reception ==

{{u|Bob K31416}} has started a process of summarizing that section, in a manner that I believe it to be counter productive. We have expert opinions from legal, law enforcement, politicians, and media outlets all of which are notable and informative. [[WP:NOTPAPER|Wikipedia is not paper]] – If the section is too long, the correct process to avoid losing good content that is well sources, is to create a sub-article with all the detail, and summarize here per [[WP:SUMMARY]]. But deleting useful and well sourced material, is not acceptable. We are here to build an encyclopedia. - [[User:Cwobeel|<span style="color:#339966">Cwobeel</span>]] [[User_talk:Cwobeel|<span style="font-size:80%">(talk)</span>]] 16:02, 11 December 2014 (UTC)
TEXT
				),
				// User
				'Cwobeel',
				// Expected annotation
				array(
					array(
						'type' => 'new-section-with-comment',
						'content' => '== Grand jury no bill reception ==

{{u|Bob K31416}} has started a process of summarizing that section, in a manner that I believe it to be counter productive. We have expert opinions from legal, law enforcement, politicians, and media outlets all of which are notable and informative. [[WP:NOTPAPER|Wikipedia is not paper]] – If the section is too long, the correct process to avoid losing good content that is well sources, is to create a sub-article with all the detail, and summarize here per [[WP:SUMMARY]]. But deleting useful and well sourced material, is not acceptable. We are here to build an encyclopedia. - [[User:Cwobeel|<span style="color:#339966">Cwobeel</span>]] [[User_talk:Cwobeel|<span style="font-size:80%">(talk)</span>]] 16:02, 11 December 2014 (UTC)',
					),
				),
			),
			// when adding additional tests, make sure to add the non-anon users
			// to EchoDiscussionParserTest::$testusers - the DiscussionParser
			// needs the users to exist, because it'll generate a comparison
			// signature, which is different when the user is considered anon
		);
	}

	public static function getExemplarTimestamp() {
		$title = Title::newMainPage();
		$user = User::newFromName( 'Test' );
		$options = new ParserOptions;

		global $wgParser;
		$exemplarTimestamp =
			$wgParser->preSaveTransform( '~~~~~', $title, $user, $options );

		return $exemplarTimestamp;
	}

	public static function provider_detectSectionTitleAndText() {
		$name = 'Werdna'; // See EchoDiscussionParserTest::$testusers
		$comment = self::signedMessage( $name );

		return array(
			array(
				'Must detect first sub heading when inserting in the middle of two sub headings',
				// expected header content
				'Sub Heading 1',
				// test content format
				"
== Heading ==
$comment

== Sub Heading 1 ==
$comment
%s

== Sub Heading 2 ==
$comment
				",
				// user signing new comment
				$name
			),

			array(
				'Must detect second sub heading when inserting in the end of two sub headings',
				// expected header content
				'Sub Heading 2',
				// test content format
				"
== Heading ==
$comment

== Sub Heading 1 ==
$comment

== Sub Heading 2 ==
$comment
%s
				",
				// user signing new comment
				$name
			),

			array(
				'Commenting in multiple sub-headings must result in no section link',
				// expected header content
				'',
				// test content format
				"
== Heading ==
$comment

== Sub Heading 1 ==
$comment
%s

== Sub Heading 2 ==
$comment
%s

				",
				// user signing new comment
				$name
			),

			array(
				'Must accept headings without a space between the = and the section name',
				// expected header content
				'Heading',
				// test content format
				"
==Heading==
$comment
%s
				",
				// user signing new comment
				$name
			),

			array(
				'Must not accept invalid headings split with a return',
				// expected header content
				'',
				// test content format
				"
==Some
Heading==
$comment
%s
				",
				// user signing new comment
				$name
			),
		);
	}

	/**
	 * @dataProvider provider_detectSectionTitleAndText
	 */
	public function testDetectSectionTitleAndText( $message, $expect, $format, $name ) {
		// str_replace because we want to replace multiple instances of '%s' with the same value
		$before = str_replace( '%s', '', $format );
		$after = str_replace( '%s', self::signedMessage( $name ), $format );

		$diff = EchoDiscussionParser::getMachineReadableDiff( $before, $after );
		$interp = EchoDiscussionParser::interpretDiff( $diff, $name );

		// There should be a section-text only if there is section-title
		$expectText = $expect ? self::message( $name ) : '';
		$this->assertEquals(
			array( 'section-title' => $expect, 'section-text' => $expectText ),
			EchoDiscussionParser::detectSectionTitleAndText( $interp ),
			$message
		);
	}

	protected static function signedMessage( $name ) {
		return ": " . self::message() . " [[User:$name|$name]] ([[User talk:$name|talk]]) 00:17, 7 May 2013 (UTC)";
	}

	protected static function message() {
		return 'foo';
	}

	public static function provider_getFullSection() {
		$tests = array(
			array(
				'Extracts full section',
				// Full document content
				<<<TEXT
==Header 1==
foo
===Header 2===
bar
==Header 3==
baz
TEXT
			,
				// Map of Line numbers to expanded section content
				array(
					1 => "==Header 1==\nfoo",
					2 => "==Header 1==\nfoo",
					3 => "===Header 2===\nbar",
					4 => "===Header 2===\nbar",
					5 => "==Header 3==\nbaz",
					6 => "==Header 3==\nbaz",
				),
			),
		);

		// Allow for setting an array of line numbers to expand from rather than
		// just a single line number
		$retval = array();
		foreach ( $tests as $test ) {
			foreach ( $test[2] as $lineNum => $expected ) {
				$retval[] = array(
					$test[0],
					$expected,
					$test[1],
					$lineNum,
				);
			}
		}

		return $retval;
	}

	/**
	 * @dataProvider provider_getFullSection
	 */
	public function testGetFullSection( $message, $expect, $lines, $startLineNum ) {
		$section = EchoDiscussionParser::getFullSection( explode( "\n", $lines ), $startLineNum );
		$this->assertEquals( $expect, $section, $message );
	}

	public function testGetSectionCount() {
		$one = "==Zomg==\nfoobar\n";
		$two = "===SubZomg===\nHi there\n";
		$three = "==Header==\nOh Hai!\n";

		$this->assertEquals( 1, EchoDiscussionParser::getSectionCount( $one ) );
		$this->assertEquals( 2, EchoDiscussionParser::getSectionCount( $one . $two ) );
		$this->assertEquals( 2, EchoDiscussionParser::getSectionCount( $one . $three ) );
		$this->assertEquals( 3, EchoDiscussionParser::getSectionCount( $one . $two . $three ) );
		$this->assertEquals( 30, EchoDiscussionParser::getSectionCount(
			file_get_contents( __DIR__ . '/revision_txt/637638133.txt' )
		) );
	}

	public function testGetOverallUserMentionsCount() {
		$userMentions = array(
			'validMentions' => array( 1 => 1 ),
			'unknownUsers' => array( 'NotKnown1', 'NotKnown2' ),
			'anonymousUsers' => array( '127.0.0.1' ),
		);

		$discussionParser = TestingAccessWrapper::newFromClass( 'EchoDiscussionParser' );
		$this->assertEquals( 4, $discussionParser->getOverallUserMentionsCount( $userMentions ) );
	}

	public function provider_getUserMentions() {
		return array(
			array(
				array( 'NotKnown1' => 0 ),
				array(
					'validMentions' => array(),
					'unknownUsers' => array( 'NotKnown1' ),
					'anonymousUsers' => array(),
				),
				1
			),
			array(
				array( '127.0.0.1' => 0 ),
				array(
					'validMentions' => array(),
					'unknownUsers' => array(),
					'anonymousUsers' => array( '127.0.0.1' ),
				),
				1
			),
		);
	}

	/**
	 * @dataProvider provider_getUserMentions
	 */
	public function testGetUserMentions( $userLinks, $expectedUserMentions, $agent ) {
		$title = Title::newFromText( 'Test' );
		$discussionParser = TestingAccessWrapper::newFromClass( 'EchoDiscussionParser' );
		$this->assertEquals( $expectedUserMentions, $discussionParser->getUserMentions( $title, $agent, $userLinks ) );
	}

	public function testGetUserMentions_validMention() {
		$userName = 'Admin';
		$userId = User::newFromName( $userName )->getId();
		$expectedUserMentions = array(
			'validMentions' => array( $userId => $userId ),
			'unknownUsers' => array(),
			'anonymousUsers' => array(),
		);
		$userLinks = array( $userName => $userId );
		$this->testGetUserMentions( $userLinks, $expectedUserMentions, 1 );
	}

	public function testGetUserMentions_ownMention() {
		$userName = 'Admin';
		$userId = User::newFromName( 'Admin' )->getId();
		$expectedUserMentions = array(
			'validMentions' => array(),
			'unknownUsers' => array(),
			'anonymousUsers' => array(),
		);
		$userLinks = array( $userName => $userId );
		$this->testGetUserMentions( $userLinks, $expectedUserMentions, $userId );
	}

	public function testGetUserMentions_tooManyMentions() {
		$userLinks = array(
			'NotKnown1' => 0,
			'NotKnown2' => 0,
			'NotKnown3' => 0,
			'127.0.0.1' => 0,
			'127.0.0.2' => 0,
		);

		$this->setMwGlobals( array(
			// lower limit for the mention-too-many notification
			'wgEchoMaxMentionsCount' => 3
		) );

		$title = Title::newFromText( 'Test' );
		$discussionParser = TestingAccessWrapper::newFromClass( 'EchoDiscussionParser' );
		$this->assertEquals( 4, $discussionParser->getOverallUserMentionsCount( $discussionParser->getUserMentions( $title, 1, $userLinks ) ) );
	}

	protected function isParserFunctionsInstalled() {
		if ( class_exists( 'ExtParserFunctions' ) ) {
			return true;
		} else {
			return "ParserFunctions not enabled";
		}
	}
}