mediawiki-extensions-Echo/tests/phpunit/cache/TitleLocalCacheTest.php
Timo Tijhof 2142be10b0 cache: Reduce responsibility of subclass and remove unused parts
* Reduce responsibility of resolve() methods to only supplying
  the resolves values.
  Moved logic for populating the cache and clearing the queue
  to the base class, and made 'lookups' private.

* The second parameter to LocalCache::add() is unused, and never passed.
  Removed to avoid confusion.

* The getTargets() method is unused. Removed.

* The getLookups() method is unused. Removed.

* The internal 'lookups' member was being used both for its keys and its
  values, but never at the same time. This seemed risky, especially in
  EchoRevisionLocalCache::resolve() where the associative array was passed
  directly to the 'where' clause of IDatabase::select(), which shouldn't
  espect keys when creating the 'IN' clause.

  Using only values would keep value types flexible, but would require
  use of the less efficient in_array().
  Keeping both keys and values and calling array_values() would work.
  Using only keys also works and is simpler, so long only ints are used.

* The tests were swapping 'targets' MapCacheLRU with a HashBagOStuff.
  Following-up 4939bff7, this was forgotten, but works because the two
  called methods (get and set) exist in both, but still seems odd.

  Fixed by using TestingAccessWrapper to act on the existing object
  instead of swapping it out.

* Improved tests by asserting more of the observed behaviour and impact.

Change-Id: I530eeac8bf3b407b8c633e0e20c7d35cc49f7a9f
2018-08-17 03:28:02 +00:00

88 lines
2.4 KiB
PHP

<?php
use Wikimedia\TestingAccessWrapper;
/**
* @covers EchoTitleLocalCache
*/
class EchoTitleLocalCacheTest extends MediaWikiTestCase {
public function testCreate() {
$cache = EchoTitleLocalCache::create();
$this->assertInstanceOf( EchoTitleLocalCache::class, $cache );
}
public function testAdd() {
$cache = $this->getMockBuilder( EchoTitleLocalCache::class )
->setMethods( [ 'resolve' ] )->getMock();
$cache->add( 1 );
$cache->add( 9 );
// Resolutions should be batched
$cache->expects( $this->exactly( 1 ) )->method( 'resolve' )
->with( [ 1, 9 ] )->willReturn( [] );
// Trigger
$cache->get( 9 );
}
public function testGet() {
$cache = $this->getMockBuilder( EchoTitleLocalCache::class )
->setMethods( [ 'resolve' ] )->getMock();
$cachePriv = TestingAccessWrapper::newFromObject( $cache );
// First title included in cache
$res1 = $this->insertPage( 'EchoTitleLocalCacheTest_testGet1' );
$cachePriv->targets->set( $res1['id'], $res1['title'] );
// Second title not in internal cache, resolves from db.
$res2 = $this->insertPage( 'EchoTitleLocalCacheTest_testGet2' );
$cache->expects( $this->exactly( 1 ) )->method( 'resolve' )
->with( [ $res2['id'] ] )
->willReturn( [ $res2['id'] => $res2['title'] ] );
// Register demand for both
$cache->add( $res1['id'] );
$cache->add( $res2['id'] );
// Should not call resolve() for first title
$this->assertSame( $res1['title'], $cache->get( $res1['id'] ), 'First title' );
// Should resolve() for second title
$this->assertSame( $res2['title'], $cache->get( $res2['id'] ), 'Second title' );
}
public function testClearAll() {
$cache = $this->getMockBuilder( EchoTitleLocalCache::class )
->setMethods( [ 'resolve' ] )->getMock();
// Add 1 to cache
$cachePriv = TestingAccessWrapper::newFromObject( $cache );
$cachePriv->targets->set( 1, $this->mockTitle() );
// Add 2 and 3 to demand
$cache->add( 2 );
$cache->add( 3 );
$cache->clearAll();
$this->assertSame( null, $cache->get( 1 ), 'Cache was cleared' );
// Lookups batch was cleared
$cache->expects( $this->exactly( 1 ) )->method( 'resolve' )
->with( [ 4 ] )
->willReturn( [] );
$cache->add( 4 );
$cache->get( 4 );
}
/**
* @return Title
*/
protected function mockTitle() {
$title = $this->getMockBuilder( Title::class )
->disableOriginalConstructor()
->getMock();
return $title;
}
}