Thijs/wiki.techinc.nl
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

(bug 24620) Add tests for LogFormatter

Browse source 
This change adds tests for LogFormatter. Tested are the normal log
params, the log params with type and the output of the comment.

Change-Id: I7218a1738c97db1d888605cecdfbffe21ca00fbf
This commit is contained in:
jan 2012-10-31 20:24:47 +01:00 committed by Gerrit Code Review
parent 3f51a574e2
commit 888fe0ffb3
3 changed files with 221 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
includes/logging/LogFormatter.php
View file

@ -430,7 +430,7 @@ class LogFormatter {
* - 3: target page with premade link
* @return array
*/
protected function getMessageParameters() {
public function getMessageParameters() {
if ( isset( $this->parsedParameters ) ) {
return $this->parsedParameters;
}
@ -820,7 +820,7 @@ class MoveLogFormatter extends LogFormatter {
return $key;
}
protected function getMessageParameters() {
public function getMessageParameters() {
$params = parent::getMessageParameters();
$oldname = $this->makePageLink( $this->entry->getTarget(), array( 'redirect' => 'no' ) );
$newname = $this->makePageLink( Title::newFromText( $params[3] ) );
@ -873,7 +873,7 @@ class DeleteLogFormatter extends LogFormatter {
return $key;
}
protected function getMessageParameters() {
public function getMessageParameters() {
if ( isset( $this->parsedParametersDeleteLog ) ) {
return $this->parsedParametersDeleteLog;
}
@ -1042,7 +1042,7 @@ class PatrolLogFormatter extends LogFormatter {
return $key;
}
protected function getMessageParameters() {
public function getMessageParameters() {
$params = parent::getMessageParameters();
$target = $this->entry->getTarget();
@ -1071,7 +1071,7 @@ class PatrolLogFormatter extends LogFormatter {
* @since 1.19
*/
class NewUsersLogFormatter extends LogFormatter {
protected function getMessageParameters() {
public function getMessageParameters() {
$params = parent::getMessageParameters();
if ( $this->entry->getSubtype() === 'create2' ) {
if ( isset( $params[3] ) ) {
@ -1138,7 +1138,7 @@ class RightsLogFormatter extends LogFormatter {
return $key;
}
protected function getMessageParameters() {
public function getMessageParameters() {
$params = parent::getMessageParameters();
// Really old entries

200
tests/phpunit/includes/logging/LogFormatterTest.php Executable file
View file

@ -0,0 +1,200 @@
<?php
/**
* @group Database
*/
class LogFormatterTest extends MediaWikiLangTestCase {
/**
* @var User
*/
protected $user;
/**
* @var Title
*/
protected $title;
/**
* @var RequestContext
*/
protected $context;
protected function setUp() {
parent::setUp();
global $wgLang;
$this->setMwGlobals( array(
'wgLogTypes' => array( 'phpunit' ),
'wgLogActionsHandlers' => array( 'phpunit/test' => 'LogFormatter',
'phpunit/param' => 'LogFormatter' ),
'wgUser' => User::newFromName( 'Testuser' ),
'wgExtensionMessagesFiles' => array( 'LogTests' => __DIR__.'/LogTests.i18n.php' ),
) );
$wgLang->getLocalisationCache()->recache( $wgLang->getCode() );
$this->user = User::newFromName( 'Testuser' );
$this->title = Title::newMainPage();
$this->context = new RequestContext();
$this->context->setUser( $this->user );
$this->context->setTitle( $this->title );
$this->context->setLanguage( $wgLang );
}
public function newLogEntry( $action, $params ) {
$logEntry = new ManualLogEntry( 'phpunit', $action );
$logEntry->setPerformer( $this->user );
$logEntry->setTarget( $this->title );
$logEntry->setComment( 'A very good reason' );
$logEntry->setParameters( $params );
return $logEntry;
}
public function testNormalLogParams() {
$entry = $this->newLogEntry( 'test', array() );
$formatter = LogFormatter::newFromEntry( $entry );
$formatter->setContext( $this->context );
$formatter->setShowUserToolLinks( false );
$paramsWithoutTools = $formatter->getMessageParameters();
unset( $formatter->parsedParameters );
$formatter->setShowUserToolLinks( true );
$paramsWithTools = $formatter->getMessageParameters();
$userLink = Linker::userLink(
$this->user->getId(),
$this->user->getName()
);
$userTools = Linker::userToolLinksRedContribs(
$this->user->getId(),
$this->user->getName(),
$this->user->getEditCount()
);
$titleLink = Linker::link( $this->title, null, array(), array() );
// $paramsWithoutTools and $paramsWithTools should be only different
// in index 0
$this->assertEquals( $paramsWithoutTools[1], $paramsWithTools[1] );
$this->assertEquals( $paramsWithoutTools[2], $paramsWithTools[2] );
$this->assertEquals( $userLink, $paramsWithoutTools[0]['raw'] );
$this->assertEquals( $userLink . $userTools, $paramsWithTools[0]['raw'] );
$this->assertEquals( $this->user->getName(), $paramsWithoutTools[1] );
$this->assertEquals( $titleLink, $paramsWithoutTools[2]['raw'] );
}
public function testLogParamsTypeRaw() {
$params = array( '4:raw:raw' => Linker::link( $this->title, null, array(), array() ) );
$expected = Linker::link( $this->title, null, array(), array() );
$entry = $this->newLogEntry( 'param', $params );
$formatter = LogFormatter::newFromEntry( $entry );
$formatter->setContext( $this->context );
$logParam = $formatter->getActionText();
$this->assertEquals( $expected, $logParam );
}
public function testLogParamsTypeMsg() {
$params = array( '4:msg:msg' => 'log-description-phpunit' );
$expected = wfMessage( 'log-description-phpunit' )->text();
$entry = $this->newLogEntry( 'param', $params );
$formatter = LogFormatter::newFromEntry( $entry );
$formatter->setContext( $this->context );
$logParam = $formatter->getActionText();
$this->assertEquals( $expected, $logParam );
}
public function testLogParamsTypeMsgContent() {
$params = array( '4:msg-content:msgContent' => 'log-description-phpunit' );
$expected = wfMessage( 'log-description-phpunit' )->inContentLanguage()->text();
$entry = $this->newLogEntry( 'param', $params );
$formatter = LogFormatter::newFromEntry( $entry );
$formatter->setContext( $this->context );
$logParam = $formatter->getActionText();
$this->assertEquals( $expected, $logParam );
}
public function testLogParamsTypeNumber() {
global $wgLang;
$params = array( '4:number:number' => 123456789 );
$expected = $wgLang->formatNum( 123456789 );
$entry = $this->newLogEntry( 'param', $params );
$formatter = LogFormatter::newFromEntry( $entry );
$formatter->setContext( $this->context );
$logParam = $formatter->getActionText();
$this->assertEquals( $expected, $logParam );
}
public function testLogParamsTypeUserLink() {
$params = array( '4:user-link:userLink' => $this->user->getName() );
$expected = Linker::userLink(
$this->user->getId(),
$this->user->getName()
);
$entry = $this->newLogEntry( 'param', $params );
$formatter = LogFormatter::newFromEntry( $entry );
$formatter->setContext( $this->context );
$logParam = $formatter->getActionText();
$this->assertEquals( $expected, $logParam );
}
public function testLogParamsTypeTitleLink() {
$params = array( '4:title-link:titleLink' => $this->title->getText() );
$expected = Linker::link( $this->title, null, array(), array() );
$entry = $this->newLogEntry( 'param', $params );
$formatter = LogFormatter::newFromEntry( $entry );
$formatter->setContext( $this->context );
$logParam = $formatter->getActionText();
$this->assertEquals( $expected, $logParam );
}
public function testLogParamsTypePlain() {
$params = array( '4:plain:plain' => 'Some plain text' );
$expected = 'Some plain text';
$entry = $this->newLogEntry( 'param', $params );
$formatter = LogFormatter::newFromEntry( $entry );
$formatter->setContext( $this->context );
$logParam = $formatter->getActionText();
$this->assertEquals( $expected, $logParam );
}
public function testLogComment() {
$entry = $this->newLogEntry( 'test', array() );
$formatter = LogFormatter::newFromEntry( $entry );
$formatter->setContext( $this->context );
$comment = ltrim( Linker::commentBlock( $entry->getComment() ) );
$this->assertEquals( $comment, $formatter->getComment() );
}
}

15
tests/phpunit/includes/logging/LogTests.i18n.php Executable file
View file

@ -0,0 +1,15 @@
<?php
/**
* Internationalisation file for log tests.
*
* @file
*/
$messages = array();
$messages['en'] = array(
'log-name-phpunit' => 'PHPUnit-log',
'log-description-phpunit' => 'Log for PHPUnit-tests',
'logentry-phpunit-test' => '$1 {{GENDER:$2|tests}} with page $3',
'logentry-phpunit-param' => '$4',
);