wiki.techinc.nl/tests/phpunit/integration/includes/user/ActorStoreTestBase.php
daniel 0ebf43b26d ActorStore: introduce findActorIdByName
The findActorIdByName method is intended to be used when we need to
select by actor ID, but all we have is a user name. We can't use
findActorId(), since it requires a UserIdentity, which would needlessly
force us to look up a user ID, resulting in two queries.

Bug: T274179
Change-Id: I0e65d3258fd3d23ebff793ae04d59e027eb51fba
2021-03-01 22:12:05 +01:00

114 lines
3.3 KiB
PHP

<?php
namespace MediaWiki\Tests\User;
use MediaWiki\User\ActorStore;
use MediaWiki\User\UserIdentity;
use MediaWikiIntegrationTestCase;
use Psr\Log\NullLogger;
use Wikimedia\Rdbms\ILoadBalancer;
/**
* Base class with utilities for testing database access to actor table.
*
* @package MediaWiki\Tests\User
*/
abstract class ActorStoreTestBase extends MediaWikiIntegrationTestCase {
protected const IP = '2600:1004:B14A:5DDD:3EBE:BBA4:BFBA:F37E';
public function addDBData() {
$this->tablesUsed[] = 'actor';
// Registered
$this->assertTrue( $this->db->insert(
'actor',
[ 'actor_id' => '42', 'actor_user' => '24', 'actor_name' => 'TestUser' ],
__METHOD__,
[ 'IGNORE' ]
) );
// Anon
$this->assertTrue( $this->db->insert(
'actor',
[ 'actor_id' => '43', 'actor_user' => null, 'actor_name' => self::IP ],
__METHOD__,
[ 'IGNORE' ]
) );
// One more registered
$this->assertTrue( $this->db->insert(
'actor',
[ 'actor_id' => '44', 'actor_user' => '25', 'actor_name' => 'TestUser1' ],
__METHOD__,
[ 'IGNORE' ]
) );
// External
$this->assertTrue( $this->db->insert(
'actor',
[ 'actor_id' => '45', 'actor_user' => null, 'actor_name' => 'acme>TestUser' ],
__METHOD__,
[ 'IGNORE' ]
) );
}
/**
* @param string|false $wikiId
* @return ActorStore
*/
protected function getStore( $wikiId = UserIdentity::LOCAL ) : ActorStore {
return $this->getServiceContainer()->getActorStoreFactory()->getActorStore( $wikiId );
}
/**
* Execute the $callback passing it an ActorStore for $wikiId,
* making sure no queries are made to local DB.
* @param string|false $wikiId
* @param callable $callback ( ActorStore $store, IDatababase $db )
*/
protected function executeWithForeignStore( $wikiId, callable $callback ) {
$dbLoadBalancer = $this->getServiceContainer()->getDBLoadBalancer();
$dbLoadBalancer->setDomainAliases( [ $wikiId => $dbLoadBalancer->getLocalDomainID() ] );
$foreignLB = $this->getServiceContainer()
->getDBLoadBalancerFactory()
->getMainLB( $wikiId );
$foreignLB->setDomainAliases( [ $wikiId => $dbLoadBalancer->getLocalDomainID() ] );
$foreignDB = $foreignLB->getConnectionRef( DB_MASTER );
$store = new ActorStore(
$dbLoadBalancer,
$this->getServiceContainer()->getUserNameUtils(),
new NullLogger(),
$wikiId
);
// Redefine the DBLoadBalancer service to verify we don't attempt to resolve its IDs via wfGetDB()
$localLoadBalancerMock = $this->createNoOpMock( ILoadBalancer::class );
try {
$this->setService( 'DBLoadBalancer', $localLoadBalancerMock );
$callback( $store, $foreignDB );
} finally {
// Restore the original loadBalancer.
$this->setService( 'DBLoadBalancer', $dbLoadBalancer );
}
}
/**
* Check whether two actors are the same in the context of $wikiId
* @param UserIdentity $expected
* @param UserIdentity $actor
* @param string|false $wikiId
*/
protected function assertSameActors(
UserIdentity $expected,
UserIdentity $actor,
$wikiId = UserIdentity::LOCAL
) {
$actor->assertWiki( $wikiId );
$this->assertSame( $expected->getActorId( $wikiId ), $actor->getActorId( $wikiId ) );
$this->assertSame( $expected->getUserId( $wikiId ), $actor->getUserId( $wikiId ) );
$this->assertSame( $expected->getName(), $actor->getName() );
$this->assertSame( $expected->getWikiId(), $actor->getWikiId() );
}
}