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

Test purgeExpiredWatchlistItems.php

Browse source 
Why:
* The maintenance scripts in core are mostly untested and testing
  the less complex scripts will improve the test coverage in core.

What:
* Add integration tests for purgeExpiredWatchlistItems.php,
  which actually watch items. This is because the maintenance
  script doesn't just call a helper method which is already tested,
  so it is useful to actually do the purge for real.

Bug: T371167
Change-Id: I1e17f6b121f7a074bd271ef188dbc361ca994b2b
This commit is contained in:
Dreamy Jazz 2024-08-02 11:26:50 +01:00
parent cd80704e27
commit 661fe8bb88
1 changed files with 64 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

64
tests/phpunit/maintenance/PurgeExpiredWatchlistItemsTest.php Normal file
View file

@ -0,0 +1,64 @@
<?php
use MediaWiki\MainConfigNames;
use MediaWiki\Tests\Maintenance\MaintenanceBaseTestCase;
use Wikimedia\Timestamp\ConvertibleTimestamp;
/**
* @covers \PurgeExpiredWatchlistItems
* @group Database
* @author Dreamy Jazz
*/
class PurgeExpiredWatchlistItemsTest extends MaintenanceBaseTestCase {
public function getMaintenanceClass() {
return PurgeExpiredWatchlistItems::class;
}
public function testExecuteWhenWatchlistExpiryDisabled() {
$this->overrideConfigValue( MainConfigNames::WatchlistExpiry, false );
$this->maintenance->execute();
$this->expectOutputRegex( '/Watchlist expiry is not enabled.*/' );
}
public function testExecuteWhenNoItemsInWatchedItemStore() {
$this->overrideConfigValue( MainConfigNames::WatchlistExpiry, true );
$this->maintenance->execute();
$this->expectOutputRegex( '/0 expired watchlist entries found.*/' );
}
/** @dataProvider provideExecuteWhenItemsExpired */
public function testExecuteWhenItemsExpired( $batchSize, $expiredWatchlistCount, $nonExpiredWatchlistCount ) {
$this->overrideConfigValue( MainConfigNames::WatchlistExpiry, true );
$testPage = $this->getExistingTestPage();
$watchedItemStore = $this->getServiceContainer()->getWatchedItemStore();
// Add some items that will be expired once we run the maintenance script.
ConvertibleTimestamp::setFakeTime( '20230405060708' );
for ( $i = 0; $i < $expiredWatchlistCount; $i++ ) {
$watchedItemStore->addWatch( $this->getMutableTestUser()->getUserIdentity(), $testPage, '1 month' );
}
// Add some items that will not be expired.
for ( $i = 0; $i < $nonExpiredWatchlistCount; $i++ ) {
$watchedItemStore->addWatch( $this->getMutableTestUser()->getUserIdentity(), $testPage, '1 year' );
}
// Set the fake time to 2 months in advance of the previous take time
ConvertibleTimestamp::setFakeTime( '20230605060708' );
// Run the maintenance script
$this->maintenance->setOption( 'batch-size', $batchSize );
$this->maintenance->execute();
$this->expectOutputRegex(
"/$expiredWatchlistCount expired watchlist entries found.\nAll expired entries purged.\n/"
);
$this->assertSame(
$nonExpiredWatchlistCount,
$watchedItemStore->countWatchers( $testPage ),
'The number of watched items after the maintenance script was not as expected.'
);
}
public static function provideExecuteWhenItemsExpired() {
return [
'All items expired' => [ 3, 7, 0 ],
'Some items expired' => [ 2, 3, 3 ],
];
}
}