aboutsummaryrefslogtreecommitdiffstats
path: root/tests/phpunit/integration/includes/logging/ManualLogEntryTest.php
diff options
context:
space:
mode:
Diffstat (limited to 'tests/phpunit/integration/includes/logging/ManualLogEntryTest.php')
-rw-r--r--tests/phpunit/integration/includes/logging/ManualLogEntryTest.php101
1 files changed, 101 insertions, 0 deletions
diff --git a/tests/phpunit/integration/includes/logging/ManualLogEntryTest.php b/tests/phpunit/integration/includes/logging/ManualLogEntryTest.php
new file mode 100644
index 000000000000..80995a63449c
--- /dev/null
+++ b/tests/phpunit/integration/includes/logging/ManualLogEntryTest.php
@@ -0,0 +1,101 @@
+<?php
+
+namespace MediaWiki\Tests\Integration\Logging;
+
+use MediaWiki\Deferred\DeferredUpdates;
+use MediaWiki\Logging\LogEntryBase;
+use MediaWiki\Logging\LogPage;
+use MediaWiki\Logging\ManualLogEntry;
+use MediaWiki\RecentChanges\RecentChange;
+use MediaWikiIntegrationTestCase;
+use Wikimedia\ScopedCallback;
+
+/**
+ * @group Database
+ * @covers \MediaWiki\Logging\ManualLogEntry
+ */
+class ManualLogEntryTest extends MediaWikiIntegrationTestCase {
+ /** @dataProvider provideCreationAndPublishingToRecentChanges */
+ public function testCreationAndPublishingToRecentChanges( bool $userHasBotRight ) {
+ $performer = $this->getTestUser()->getUser();
+ $target = $this->getExistingTestPage()->getTitle();
+ $logParams = [ '4::test' => 'testabc1234', 'testing' => 'testingabc' ];
+
+ // Give the performer the bot right temporarily to allow testing that ::publish
+ // (if specified by this test case), so that we can test that ::publish sets the RecentChanges bot flag
+ // outside any DeferredUpdates to prevent issues such as described in T387659.
+ if ( $userHasBotRight ) {
+ $userRightScope = $this->getServiceContainer()->getPermissionManager()
+ ->addTemporaryUserRights( $performer, 'bot' );
+ }
+
+ // Create a log entry and publish it to just RecentChanges
+ $logEntry = new ManualLogEntry( 'phpunit', 'test' );
+ $logEntry->setPerformer( $performer );
+ $logEntry->setTarget( $target );
+ $logEntry->setComment( 'A very good reason' );
+ $logEntry->setTimestamp( '20300405060708' );
+ $logEntry->setParameters( $logParams );
+ $logEntry->setDeleted( LogPage::DELETED_ACTION );
+ $logId = $logEntry->insert();
+ $logEntry->publish( $logId, 'rc' );
+ ScopedCallback::consume( $userRightScope );
+
+ // Actually cause the writes to RecentChanges, as they are queued using DeferredUpdates.
+ DeferredUpdates::doUpdates();
+
+ // Assert that the log entry exists and that it matches what we provided above.
+ $this->newSelectQueryBuilder()
+ ->select( [
+ 'log_type', 'log_action', 'log_timestamp', 'log_namespace', 'log_title', 'log_deleted',
+ 'log_actor', 'comment_text'
+ ] )
+ ->from( 'logging' )
+ ->join( 'comment', null, 'log_comment_id=comment_id' )
+ ->where( [ 'log_id' => $logId ] )
+ ->caller( __METHOD__ )
+ ->assertRowValue( [
+ 'phpunit', 'test', $this->getDb()->timestamp( '20300405060708' ), $target->getNamespace(),
+ $target->getDBkey(), LogPage::DELETED_ACTION, $performer->getActorId(), 'A very good reason',
+ ] );
+ $this->assertArrayEquals(
+ $logParams,
+ LogEntryBase::extractParams(
+ $this->newSelectQueryBuilder()
+ ->select( 'log_params' )
+ ->from( 'logging' )
+ ->caller( __METHOD__ )
+ ->where( [ 'log_id' => $logId ] )
+ ->fetchField()
+ ),
+ false,
+ true
+ );
+
+ // Assert that the entry was sent to RecentChanges
+ $actualRecentChangeObject = RecentChange::newFromConds( [ 'rc_logid' => $logId ] );
+ $actualRecentChangeTitle = $actualRecentChangeObject->getPage();
+ $this->assertNotNull( $actualRecentChangeTitle );
+ $this->assertTrue( $target->isSamePageAs( $actualRecentChangeTitle ) );
+ $this->assertTrue( $performer->equals( $actualRecentChangeObject->getPerformerIdentity() ) );
+ $this->assertArrayContains(
+ [
+ // DB stores booleans as integers and we get back that integer as a string.
+ 'rc_bot' => (string)intval( $userHasBotRight ),
+ 'rc_log_type' => 'phpunit',
+ 'rc_log_action' => 'test',
+ // The RecentChanges object stores the timestamp as TS_MW, even if DB stores it in a different
+ // format.
+ 'rc_timestamp' => '20300405060708',
+ ],
+ $actualRecentChangeObject->getAttributes()
+ );
+ }
+
+ public static function provideCreationAndPublishingToRecentChanges() {
+ return [
+ 'User does not have bot right' => [ false ],
+ 'User temporarily has the bot right' => [ true ],
+ ];
+ }
+}