wiki.techinc.nl/tests/phpunit/integration/includes/user/TempUser/TempUserCreatorTest.php
Dreamy Jazz 7f588780a0 Support multiple matchPatterns in temp user autocreate config
Why:
* There is a need to update the generation and match pattern on
  WMF wikis to a new format that includes the year and starts with
  `~`. As such, the 'matchPattern' key needs to be updated.
* Removing the old 'matchPattern' from the wgAutoCreateTempUser
  config currently leaves existing temporary accounts as no longer
  recongnised as temporary accounts.
* Instead, the 'matchPattern' needs to be able to take an array of
  string patterns so that old patterns can still be used for matching.

What:
* Update the MainConfigSchama to indicate that 'matchPattern' in the
  wgAutoCreateTempUser config can be an array of strings.
* Add TempUserConfig::getMatchPatterns and deprecate TempUserConfig::
  getMatchPattern. This is needed because ::getMatchPattern was typed
  to only ever return one Pattern, which is no longer the case with this
  config change.
* Update the RealTempUserConfig to support multiple patterns defined in
  the 'matchPattern' key. The RealTempUserConfig::getMatchPattern method
  returns the pattern or first pattern if multiple are defined to allow
  time for existing usages of this deprecated method to be updated.
* Update the RealTempUserConfig to rely on other methods instead of checking
  object property values where possible (e.g. use ::isEnabled instead of
  checking $this->enabled) to allow easier unit testing.
* Update UserSelectQueryBuilder and ChangesListSpecialPage to use TempUserConfig
  ::getMatchPatterns instead of ::getMatchPattern.
* Update mediawiki.util/util.js to be able to parse the 'matchPattern' value
  when it is an array of strings.
* Update maintenance/userOptions.php to use ::getMatchPatterns instead of
  ::getMatchPattern.
* Add and update unit and integration tests for the new code, as well as
  expanding coverage over existing code that was indirectly affected.

Bug: T354619
Change-Id: I3763daefe4dc7c76370bd934fb20452591c9c762
2024-01-17 11:24:26 +00:00

166 lines
5.2 KiB
PHP

<?php
namespace MediaWiki\Tests\Integration\User\TempUser;
use ExtensionRegistry;
use MediaWiki\Auth\AuthManager;
use MediaWiki\Session\Session;
use MediaWiki\Tests\User\TempUser\TempUserTestTrait;
use MediaWiki\User\CentralId\CentralIdLookup;
use MediaWiki\User\TempUser\RealTempUserConfig;
use MediaWiki\User\TempUser\SerialMapping;
use MediaWiki\User\TempUser\SerialProvider;
use MediaWiki\User\TempUser\TempUserCreator;
use MediaWiki\User\UserFactory;
use Wikimedia\TestingAccessWrapper;
use Wikimedia\Timestamp\ConvertibleTimestamp;
/**
* @group Database
* @covers \MediaWiki\User\TempUser\DBSerialProvider
* @covers \MediaWiki\User\TempUser\LocalSerialProvider
* @covers \MediaWiki\User\TempUser\TempUserCreator
* @covers \MediaWiki\User\TempUser\CreateStatus
*/
class TempUserCreatorTest extends \MediaWikiIntegrationTestCase {
use TempUserTestTrait;
public function testCreate() {
$this->enableAutoCreateTempUser();
$tuc = $this->getServiceContainer()->getTempUserCreator();
$this->assertTrue( $tuc->isAutoCreateAction( 'edit' ) );
$this->assertTrue( $tuc->isTempName( '*Unregistered 1' ) );
$status = $tuc->create();
$this->assertSame( '*Unregistered 1', $status->getUser()->getName() );
$status = $tuc->create();
$this->assertSame( '*Unregistered 2', $status->getUser()->getName() );
}
private function getTempUserCreatorUnit() {
$scope1 = ExtensionRegistry::getInstance()->setAttributeForTest(
'TempUserSerialProviders',
[
'test' => [
'factory' => static function () {
return new class implements SerialProvider {
public function acquireIndex( int $year = 0 ): int {
return 1;
}
};
}
],
]
);
$scope2 = ExtensionRegistry::getInstance()->setAttributeForTest(
'TempUserSerialMappings',
[
'test' => [
'factory' => static function () {
return new class implements SerialMapping {
public function getSerialIdForIndex( int $index ): string {
$index--;
$adjective = (int)( $index / 2 );
$animal = $index % 2;
return [ 'active' ][$adjective] . ' ' . [ 'aardvark' ][$animal];
}
};
}
]
]
);
$config = new RealTempUserConfig( [
'enabled' => true,
'expireAfterDays' => null,
'actions' => [ 'edit' ],
'genPattern' => '*Unregistered $1',
'matchPattern' => '*$1',
'serialProvider' => [ 'type' => 'test' ],
'serialMapping' => [ 'type' => 'test' ],
] );
$creator = new TempUserCreator(
$config,
$this->createSimpleObjectFactory(),
$this->createMock( UserFactory::class ),
$this->createMock( AuthManager::class ),
$this->createMock( CentralIdLookup::class ),
null
);
return [ $creator, [ $scope1, $scope2 ] ];
}
public function testAcquireName_unit() {
[ $creator, $scope ] = $this->getTempUserCreatorUnit();
/** @var TempUserCreator $creator */
$creator = TestingAccessWrapper::newFromObject( $creator );
$this->assertSame( '*Unregistered active aardvark', $creator->acquireName() );
}
public function testAcquireName_db() {
$this->enableAutoCreateTempUser();
$tuc = TestingAccessWrapper::newFromObject(
$this->getServiceContainer()->getTempUserCreator()
);
$this->assertSame( '*Unregistered 1', $tuc->acquireName() );
$this->assertSame( '*Unregistered 2', $tuc->acquireName() );
}
public function testAcquireName_dbWithYear() {
$this->enableAutoCreateTempUser( [ 'serialProvider' => [ 'type' => 'local', 'useYear' => true ] ] );
ConvertibleTimestamp::setFakeTime( '20000101000000' );
$tuc = TestingAccessWrapper::newFromObject(
$this->getServiceContainer()->getTempUserCreator()
);
$this->assertSame( '*Unregistered 2000-1', $tuc->acquireName() );
$this->assertSame( '*Unregistered 2000-2', $tuc->acquireName() );
ConvertibleTimestamp::setFakeTime( '20010101000000' );
$this->assertSame( '*Unregistered 2001-1', $tuc->acquireName() );
}
public function testAcquireNameOnDuplicate_db() {
$this->enableAutoCreateTempUser();
$tuc = TestingAccessWrapper::newFromObject(
$this->getServiceContainer()->getTempUserCreator()
);
// Create a temporary account
$this->assertSame( '*Unregistered 1', $tuc->create()->value->getName() );
// Reset the user_autocreate_serial table
$this->truncateTable( 'user_autocreate_serial' );
// Because user_autocreate_serial was truncated, the ::acquireName method should
// return null as the code attempts to return a temporary account that already exists.
$this->assertSame( null, $tuc->acquireName() );
}
public function testAcquireAndStashName() {
/** @var TempUserCreator $creator */
[ $creator, $scope ] = $this->getTempUserCreatorUnit();
$session = new class extends Session {
private $data = [];
public function __construct() {
}
public function __destruct() {
}
public function get( $key, $default = null ) {
return array_key_exists( $key, $this->data ) ? $this->data[$key] : $default;
}
public function set( $key, $value ) {
$this->data[$key] = $value;
}
public function save() {
}
};
$name = $creator->acquireAndStashName( $session );
$this->assertSame( '*Unregistered active aardvark', $name );
$name = $creator->acquireAndStashName( $session );
$this->assertSame( '*Unregistered active aardvark', $name );
}
}