Page MenuHomeWickedGov Phorge

CheckUserGetActionsPagerTest.php
No OneTemporary

Size
16 KB
Referenced Files
None
Subscribers
None

CheckUserGetActionsPagerTest.php

<?php
namespace MediaWiki\CheckUser\Tests\Integration\CheckUser\Pagers;
use MediaWiki\CheckUser\CheckUser\SpecialCheckUser;
use MediaWiki\CheckUser\ClientHints\ClientHintsBatchFormatterResults;
use MediaWiki\CheckUser\Services\UserAgentClientHintsManager;
use MediaWiki\CheckUser\Tests\Integration\CheckUser\Pagers\Mocks\MockTemplateParser;
use MediaWiki\Linker\Linker;
use MediaWiki\Logging\LogEntryBase;
use MediaWiki\Logging\LogFormatter;
use MediaWiki\Logging\LogPage;
use MediaWiki\Logging\ManualLogEntry;
use MediaWiki\Title\Title;
use MediaWiki\User\UserIdentityValue;
use Wikimedia\IPUtils;
use Wikimedia\Rdbms\FakeResultWrapper;
/**
* Test class for CheckUserGetActionsPager class
*
* @group CheckUser
* @group Database
*
* @covers \MediaWiki\CheckUser\CheckUser\Pagers\CheckUserGetActionsPager
*/
class CheckUserGetActionsPagerTest extends CheckUserPagerTestBase {
protected function setUp(): void {
parent::setUp();
$this->checkSubtype = SpecialCheckUser::SUBTYPE_GET_ACTIONS;
$this->defaultUserIdentity = UserIdentityValue::newAnonymous( '127.0.0.1' );
$this->defaultCheckType = 'ipedits';
}
/** @dataProvider providePreCacheMessages */
public function testPreCacheMessages( $messageKeys ) {
$object = $this->setUpObject();
$this->assertArrayEquals(
$messageKeys,
array_keys( $object->message ),
false,
false,
'preCacheMessage has missed or has too many message keys to cache.'
);
foreach ( $messageKeys as $key ) {
$this->assertSame(
wfMessage( $key )->escaped(),
$object->message[$key],
'preCacheMessage did not cache the correct message.'
);
}
}
public static function providePreCacheMessages() {
return [
'All message keys to be cached' => [ [
'diff', 'hist', 'minoreditletter', 'newpageletter',
'blocklink', 'checkuser-log-link-text', 'checkuser-logs-link-text',
] ],
];
}
/**
* Tests that the template parameters provided to the GetActionsLine.mustache match
* the expected values. Does not test the mustache file which includes some
* conditional logic, HTML and whitespace.
*
* @dataProvider provideFormatRow
*/
public function testFormatRow(
$row, $flagCache, $usernameVisibility, $formattedRevisionComments, $formattedClientHintsData,
$expectedTemplateParams
) {
$object = $this->setUpObject();
$object->templateParser = new MockTemplateParser();
$row = array_merge( $this->getDefaultRowFieldValues(), $row );
$object->flagCache = $flagCache;
$object->usernameVisibility = $usernameVisibility;
$object->formattedRevisionComments = $formattedRevisionComments;
if ( $formattedClientHintsData !== null ) {
$object->formattedClientHintsData = $formattedClientHintsData;
}
$object->formatRow( (object)$row );
$this->assertNotNull(
$object->templateParser->lastCalledWith,
'The template parser was not called by formatRow.'
);
$this->assertSame(
'GetActionsLine',
$object->templateParser->lastCalledWith[0],
'formatRow did not call the correct mustache file.'
);
$this->assertArrayEquals(
$expectedTemplateParams,
array_filter(
$object->templateParser->lastCalledWith[1],
static function ( $key ) use ( $expectedTemplateParams ) {
return array_key_exists( $key, $expectedTemplateParams );
},
ARRAY_FILTER_USE_KEY
),
false,
true,
'The template parameters do not match the expected template parameters. If changes have been ' .
'made to the template parameters make sure you update the tests.'
);
}
public function testFormatRowForLog() {
$deleteLogEntry = new ManualLogEntry( 'delete', 'delete' );
$deleteLogEntry->setPerformer( UserIdentityValue::newAnonymous( '127.0.0.1' ) );
$deleteLogEntry->setTarget( Title::newFromText( 'Testing page' ) );
$this->testFormatRow(
[
'log_type' => $deleteLogEntry->getType(),
'log_action' => $deleteLogEntry->getSubtype(),
'title' => $deleteLogEntry->getTarget()->getText(),
'log_deleted' => 0,
'type' => RC_LOG,
'user_text' => $deleteLogEntry->getPerformerIdentity()->getName(),
'user' => $deleteLogEntry->getPerformerIdentity()->getId(),
'client_hints_reference_id' => 1,
'client_hints_reference_type' => UserAgentClientHintsManager::IDENTIFIER_CU_CHANGES,
'agent' => 'Test',
],
[ $deleteLogEntry->getPerformerIdentity()->getName() => '' ],
[ $deleteLogEntry->getPerformerIdentity()->getId() => true ],
[],
new ClientHintsBatchFormatterResults( [ 0 => [ 1 => 0 ] ], [ 0 => 'Test Client Hints data' ] ),
[
'actionText' => $this->getServiceContainer()->getLogFormatterFactory()
->newFromEntry( $deleteLogEntry )->getActionText(),
'clientHints' => 'Test Client Hints data', 'userAgent' => 'Test',
]
);
}
public function testFormatRowForLogWithDeletedActionText() {
$deleteLogEntry = new ManualLogEntry( 'delete', 'delete' );
$deleteLogEntry->setPerformer( UserIdentityValue::newAnonymous( '127.0.0.1' ) );
$deleteLogEntry->setTarget( Title::newFromText( 'Testing page' ) );
$deleteLogEntry->setDeleted( LogPage::DELETED_ACTION );
$logFormatter = $this->getServiceContainer()->getLogFormatterFactory()->newFromEntry( $deleteLogEntry );
$logFormatter->setAudience( LogFormatter::FOR_THIS_USER );
$this->testFormatRow(
[
'log_type' => $deleteLogEntry->getType(),
'log_action' => $deleteLogEntry->getSubtype(),
'title' => $deleteLogEntry->getTarget()->getText(),
'log_deleted' => LogPage::DELETED_ACTION,
'type' => RC_LOG,
'user_text' => $deleteLogEntry->getPerformerIdentity()->getName(),
'user' => $deleteLogEntry->getPerformerIdentity()->getId(),
'client_hints_reference_id' => 1,
'client_hints_reference_type' => UserAgentClientHintsManager::IDENTIFIER_CU_CHANGES,
],
[ $deleteLogEntry->getPerformerIdentity()->getName() => '' ],
[ $deleteLogEntry->getPerformerIdentity()->getId() => true ],
[],
new ClientHintsBatchFormatterResults( [], [] ),
[ 'actionText' => $logFormatter->getActionText() ]
);
}
public function testFormatRowLogFromUnnormalisedIPv6() {
$user_text = '2A02:EC80:101:0:0:0:2:8';
$ip = '2a02:ec80:101::2:8';
$normalisedIP = IPUtils::prettifyIP( $user_text ) ?? $user_text;
$wrapper = $this->setUpObject();
$this->testFormatRow(
[
'user_text' => $user_text,
'ip' => $ip,
'client_hints_reference_id' => 1,
'client_hints_reference_type' => UserAgentClientHintsManager::IDENTIFIER_CU_LOG_EVENT,
],
[ $user_text => '' ],
[],
[],
new ClientHintsBatchFormatterResults( [], [] ),
[
'userLink' => Linker::userLink( 0, $normalisedIP, $normalisedIP ),
'ipLink' => $wrapper->getSelfLink( $normalisedIP,
[
'user' => $normalisedIP,
'reason' => '',
]
),
]
);
}
/** @dataProvider provideFormatRowForLogWithLogParameters */
public function testFormatRowForLogWithLogParameters(
$logParametersAsArray, $logParametersAsBlob
) {
$moveLogEntry = new ManualLogEntry( 'move', 'move' );
$moveLogEntry->setPerformer( UserIdentityValue::newAnonymous( '127.0.0.1' ) );
$moveLogEntry->setTarget( Title::newFromText( 'Testing page' ) );
$moveLogEntry->setParameters( $logParametersAsArray );
$this->testFormatRow(
[
'log_type' => $moveLogEntry->getType(),
'log_action' => $moveLogEntry->getSubtype(),
'log_deleted' => 0,
'title' => $moveLogEntry->getTarget()->getText(),
'type' => RC_LOG,
'user_text' => $moveLogEntry->getPerformerIdentity()->getName(),
'user' => $moveLogEntry->getPerformerIdentity()->getId(),
'log_params' => $logParametersAsBlob,
'client_hints_reference_id' => 1,
'client_hints_reference_type' => UserAgentClientHintsManager::IDENTIFIER_CU_CHANGES,
],
[ $moveLogEntry->getPerformerIdentity()->getName() => '' ],
[ $moveLogEntry->getPerformerIdentity()->getId() => true ],
[],
new ClientHintsBatchFormatterResults( [ 0 => [ 1 => 0 ] ], [ 0 => 'Test Client Hints data' ] ),
[
'actionText' => $this->getServiceContainer()->getLogFormatterFactory()
->newFromEntry( $moveLogEntry )->getActionText(),
'clientHints' => 'Test Client Hints data',
]
);
}
public static function provideFormatRowForLogWithLogParameters() {
return [
'Legacy log parameters' => [
[
'4::target' => 'Testing',
'5::noredir' => '0',
],
LogPage::makeParamBlob( [
'4::target' => 'Testing',
'5::noredir' => '0',
] ),
],
'Normal log parameters' => [
[
'4::target' => 'Testing',
'5::noredir' => '0',
],
LogEntryBase::makeParamBlob( [
'4::target' => 'Testing',
'5::noredir' => '0',
] ),
],
];
}
public function testFormatRowForLogWhenLogCommentDeleted() {
$moveLogEntry = new ManualLogEntry( 'move', 'move' );
$moveLogEntry->setPerformer( UserIdentityValue::newAnonymous( '127.0.0.1' ) );
$moveLogEntry->setTarget( Title::newFromText( 'Testing page' ) );
$moveLogEntry->setParameters( [
'4::target' => 'Testing',
'5::noredir' => '0',
] );
$this->testFormatRow(
[
'log_type' => $moveLogEntry->getType(),
'log_action' => $moveLogEntry->getSubtype(),
'log_deleted' => LogPage::DELETED_COMMENT,
'title' => $moveLogEntry->getTarget()->getText(),
'type' => RC_LOG,
'user_text' => $moveLogEntry->getPerformerIdentity()->getName(),
'user' => $moveLogEntry->getPerformerIdentity()->getId(),
'log_params' => LogEntryBase::makeParamBlob( [
'4::target' => 'Testing',
'5::noredir' => '0',
] ),
'comment_text' => 'test',
'client_hints_reference_id' => 1,
'client_hints_reference_type' => UserAgentClientHintsManager::IDENTIFIER_CU_CHANGES,
],
[ $moveLogEntry->getPerformerIdentity()->getName() => '' ],
[ $moveLogEntry->getPerformerIdentity()->getId() => true ],
[],
new ClientHintsBatchFormatterResults( [ 0 => [ 1 => 0 ] ], [ 0 => 'Test Client Hints data' ] ),
[
'actionText' => $this->getServiceContainer()->getLogFormatterFactory()
->newFromEntry( $moveLogEntry )->getActionText(),
'clientHints' => 'Test Client Hints data',
'comment' => '',
]
);
}
public function testFormatRowWhenTitleIsHiddenUser() {
// Get a user which has been blocked with the 'hideuser' enabled.
$hiddenUser = $this->getTestUser()->getUser();
$blockStatus = $this->getServiceContainer()->getBlockUserFactory()
->newBlockUser(
$hiddenUser,
$this->getTestUser( [ 'suppress', 'sysop' ] )->getAuthority(),
'infinity',
'block to hide the test user',
[ 'isHideUser' => true ]
)->placeBlock();
$this->assertStatusGood( $blockStatus );
// Test that when the title is the username of a hidden user, the 'logs' link is not set (as this uses the
// the title for the row).
$this->testFormatRow(
[
'log_type' => 'test',
'log_action' => 'phpunit',
'log_deleted' => 0,
'type' => RC_LOG,
'namespace' => NS_USER,
'title' => $hiddenUser->getUserPage()->getText(),
'user_text' => $hiddenUser->getName(),
'user' => $hiddenUser->getId(),
'log_params' => LogEntryBase::makeParamBlob( [] ),
'client_hints_reference_id' => 1,
'client_hints_reference_type' => UserAgentClientHintsManager::IDENTIFIER_CU_CHANGES,
],
[ $hiddenUser->getName() => '' ],
[ $hiddenUser->getId() => true ],
[],
new ClientHintsBatchFormatterResults( [], [] ),
[ 'showLinks' => false ]
);
}
public static function provideFormatRow() {
// @todo test the rest of the template parameters.
return [
'Test non-existent user has appropriate CSS class' => [
// $row as an array
[
'user' => 0, 'user_text' => 'Non existent user 1234',
'client_hints_reference_id' => 1,
'client_hints_reference_type' => UserAgentClientHintsManager::IDENTIFIER_CU_CHANGES,
],
// The $object->flagCache
[ 'Non existent user 1234' => '' ],
// The $object->usernameVisibility
[ 0 => true ],
// The $object->formattedRevisionComments
[],
// The $object->formattedClientHintsData
new ClientHintsBatchFormatterResults( [], [] ),
// The expected template parameters
[ 'userLinkClass' => 'mw-checkuser-nonexistent-user' ],
],
'Testing using a user that is hidden who made an edit' => [
[
'user' => 10, 'user_text' => 'User1234', 'type' => RC_EDIT,
'client_hints_reference_id' => 1,
'client_hints_reference_type' => UserAgentClientHintsManager::IDENTIFIER_CU_LOG_EVENT,
],
[],
[ 0 => false ],
[ 0 => 'Test' ],
new ClientHintsBatchFormatterResults( [], [] ),
[ 'comment' => 'Test' ],
],
'Row for IP address when temporary accounts are enabled' => [
[
'user_text' => null, 'user' => null, 'actor' => null, 'ip' => '127.0.0.1',
'client_hints_reference_id' => 1,
'client_hints_reference_type' => UserAgentClientHintsManager::IDENTIFIER_CU_PRIVATE_EVENT,
],
[ '127.0.0.1' => 'test-flag' ],
[ 0 => true ],
[],
new ClientHintsBatchFormatterResults( [], [] ),
[ 'flags' => 'test-flag' ],
],
];
}
public function testPreprocessResultsForIPRowWithTemporaryAccountsEnabled() {
// Tests that ::preprocessResults correctly sets the flagCache for rows where the actor ID is null.
$object = $this->setUpObject();
$row = array_merge( $this->getDefaultRowFieldValues(), [
'user_text' => null,
'user' => null,
'actor' => null,
'ip' => '127.0.0.1',
'client_hints_reference_id' => 1,
'client_hints_reference_type' => UserAgentClientHintsManager::IDENTIFIER_CU_CHANGES,
] );
$object->preprocessResults( new FakeResultWrapper( [ $row ] ) );
$this->assertArrayHasKey(
'127.0.0.1',
$object->flagCache,
'::preprocessResults did not correctly set flagCache.'
);
}
/** @dataProvider provideGetQueryInfo */
public function testGetQueryInfo( $target, $xfor, $table, $expectedQueryInfo ) {
$this->overrideConfigValue( 'CheckUserCIDRLimit', [ 'IPv4' => 16, 'IPv6' => 19 ] );
if ( IPUtils::isIPAddress( $target->getName() ) ) {
// Add the IExpression for the IP target as a string to the expected query info for comparison.
// This is done for IP targets as we cannot add the SQL representation of the IExpression result
// in the static data provider because it does not have access to the service container.
$expectedQueryInfo['conds'][] = $this->getServiceContainer()->get( 'CheckUserLookupUtils' )
->getIPTargetExpr( $target, $xfor, $table )
->toSql( $this->getDb() );
}
$this->commonTestGetQueryInfo( $target, $xfor, $table, $expectedQueryInfo );
}
public static function provideGetQueryInfo() {
return [
'cu_changes table for IP address' => [
// The target of the check
UserIdentityValue::newAnonymous( '127.0.0.1' ),
// The xfor property of the object (false for normal IP address, true for XFF IP, null for user target)
false,
// The $table argument to ::getQueryInfo
'cu_changes',
// The expected query info returned by ::getQueryInfo (we are only interested in testing the query info
// added by ::getQueryInfo and not the info added by the table specific methods).
[
'tables' => [ 'cu_changes' ],
'conds' => [],
'options' => [ 'USE INDEX' => [ 'cu_changes' => 'cuc_ip_hex_time' ] ],
// Verify that fields and join_conds set as arrays, but we are not testing their values.
'fields' => [], 'join_conds' => [],
],
],
'cu_log_event table for IP address' => [
UserIdentityValue::newAnonymous( '127.0.0.1' ), false, 'cu_log_event',
[
'tables' => [ 'cu_log_event' ],
'conds' => [],
'options' => [ 'USE INDEX' => [ 'cu_log_event' => 'cule_ip_hex_time' ] ],
'fields' => [], 'join_conds' => [],
],
],
'cu_private_event table for IP address' => [
UserIdentityValue::newAnonymous( '127.0.0.1' ), false, 'cu_private_event',
[
'tables' => [ 'cu_private_event' ],
'conds' => [],
'options' => [ 'USE INDEX' => [ 'cu_private_event' => 'cupe_ip_hex_time' ] ],
'fields' => [], 'join_conds' => [],
],
],
'cu_private_event table for XFF IP address' => [
UserIdentityValue::newAnonymous( '127.0.0.1' ), true, 'cu_private_event',
[
'tables' => [ 'cu_private_event' ],
'conds' => [],
'options' => [ 'USE INDEX' => [ 'cu_private_event' => 'cupe_xff_hex_time' ] ],
'fields' => [], 'join_conds' => [],
],
],
'cu_log_event table for user target' => [
UserIdentityValue::newRegistered( 1, 'Testing' ), null, 'cu_log_event',
[
'tables' => [ 'cu_log_event' ],
'conds' => [ 'actor_user' => 1 ],
'options' => [ 'USE INDEX' => [ 'cu_log_event' => 'cule_actor_ip_time' ] ],
'fields' => [], 'join_conds' => [],
],
],
];
}
/** @inheritDoc */
public function getDefaultRowFieldValues(): array {
return [
'namespace' => 0,
'title' => '',
'user' => 0,
'user_text' => '127.0.0.1',
'actor' => 1,
'actiontext' => '',
'minor' => 0,
'page_id' => 0,
'this_oldid' => 0,
'last_oldid' => 0,
'type' => RC_EDIT,
'timestamp' => $this->getDb()->timestamp(),
'ip' => '127.0.0.1',
'xff' => '',
'agent' => '',
'comment_id' => 0,
'comment_text' => '',
'comment_data' => null,
'comment_cid' => 0,
'log_id' => 0,
'log_type' => '',
'log_action' => '',
'log_params' => null,
];
}
}

File Metadata

Mime Type
text/x-php
Expires
Sun, Nov 22, 07:44 (20 h, 14 m)
Storage Engine
local-disk
Storage Format
Raw Data
Storage Handle
66/9e/f74427705a044880c7e1a1b839bb
Default Alt Text
CheckUserGetActionsPagerTest.php (16 KB)

Event Timeline