CachedBagOStuffTest.php

Go to the documentation of this file.

<?php
 
use Wikimedia\TestingAccessWrapper;
 
class CachedBagOStuffTest extends PHPUnit\Framework\TestCase {
 
    use MediaWikiCoversValidator;
 
    public function testGetFromBackend() {
        $backend = new HashBagOStuff;
        $cache = new CachedBagOStuff( $backend );
 
        $backend->set( 'foo', 'bar' );
        $this->assertEquals( 'bar', $cache->get( 'foo' ) );
 
        $backend->set( 'foo', 'baz' );
        $this->assertEquals( 'bar', $cache->get( 'foo' ), 'cached' );
    }
 
    public function testSetAndDelete() {
        $backend = new HashBagOStuff;
        $cache = new CachedBagOStuff( $backend );
 
        for ( $i = 0; $i < 10; $i++ ) {
            $cache->set( "key$i", 1 );
            $this->assertEquals( 1, $cache->get( "key$i" ) );
            $this->assertEquals( 1, $backend->get( "key$i" ) );
 
            $cache->delete( "key$i" );
            $this->assertEquals( false, $cache->get( "key$i" ) );
            $this->assertEquals( false, $backend->get( "key$i" ) );
        }
    }
 
    public function testWriteCacheOnly() {
        $backend = new HashBagOStuff;
        $cache = new CachedBagOStuff( $backend );
 
        $cache->set( 'foo', 'bar', 0, CachedBagOStuff::WRITE_CACHE_ONLY );
        $this->assertEquals( 'bar', $cache->get( 'foo' ) );
        $this->assertFalse( $backend->get( 'foo' ) );
 
        $cache->set( 'foo', 'old' );
        $this->assertEquals( 'old', $cache->get( 'foo' ) );
        $this->assertEquals( 'old', $backend->get( 'foo' ) );
 
        $cache->set( 'foo', 'new', 0, CachedBagOStuff::WRITE_CACHE_ONLY );
        $this->assertEquals( 'new', $cache->get( 'foo' ) );
        $this->assertEquals( 'old', $backend->get( 'foo' ) );
 
        $cache->delete( 'foo', CachedBagOStuff::WRITE_CACHE_ONLY );
        $this->assertEquals( 'old', $cache->get( 'foo' ) ); // Reloaded from backend
    }
 
    public function testCacheBackendMisses() {
        $backend = new HashBagOStuff;
        $cache = new CachedBagOStuff( $backend );
 
        // First hit primes the cache with miss from the backend
        $this->assertEquals( false, $cache->get( 'foo' ) );
 
        // Change the value in the backend
        $backend->set( 'foo', true );
 
        // Second hit returns the cached miss
        $this->assertEquals( false, $cache->get( 'foo' ) );
 
        // But a fresh value is read from the backend
        $backend->set( 'bar', true );
        $this->assertEquals( true, $cache->get( 'bar' ) );
    }
 
    public function testSetDebug() {
        $backend = new HashBagOStuff();
        $cache = new CachedBagOStuff( $backend );
        // Access private property 'debugMode'
        $backend = TestingAccessWrapper::newFromObject( $backend );
        $cache = TestingAccessWrapper::newFromObject( $cache );
        $this->assertFalse( $backend->debugMode );
        $this->assertFalse( $cache->debugMode );
 
        $cache->setDebug( true );
        // Should have set both
        $this->assertTrue( $backend->debugMode, 'sets backend' );
        $this->assertTrue( $cache->debugMode, 'sets self' );
    }
 
    public function testExpire() {
        $backend = $this->getMockBuilder( HashBagOStuff::class )
            ->setMethods( [ 'deleteObjectsExpiringBefore' ] )
            ->getMock();
        $backend->expects( $this->once() )
            ->method( 'deleteObjectsExpiringBefore' )
            ->willReturn( false );
 
        $cache = new CachedBagOStuff( $backend );
        $cache->deleteObjectsExpiringBefore( '20110401000000' );
    }
 
    public function testMakeKey() {
        $backend = $this->getMockBuilder( HashBagOStuff::class )
            ->setMethods( [ 'makeKey' ] )
            ->getMock();
        $backend->method( 'makeKey' )
            ->willReturn( 'special/logic' );
 
        // CachedBagOStuff wraps any backend with a process cache
        // using HashBagOStuff. Hash has no special key limitations,
        // but backends often do. Make sure it uses the backend's
        // makeKey() logic, not the one inherited from HashBagOStuff
        $cache = new CachedBagOStuff( $backend );
 
        $this->assertEquals( 'special/logic', $backend->makeKey( 'special', 'logic' ) );
        $this->assertEquals( 'special/logic', $cache->makeKey( 'special', 'logic' ) );
    }
 
    public function testMakeGlobalKey() {
        $backend = $this->getMockBuilder( HashBagOStuff::class )
            ->setMethods( [ 'makeGlobalKey' ] )
            ->getMock();
        $backend->method( 'makeGlobalKey' )
            ->willReturn( 'special/logic' );
 
        $cache = new CachedBagOStuff( $backend );
 
        $this->assertEquals( 'special/logic', $backend->makeGlobalKey( 'special', 'logic' ) );
        $this->assertEquals( 'special/logic', $cache->makeGlobalKey( 'special', 'logic' ) );
    }
}