MemcachedBackendTest.php

Go to the documentation of this file.

<?php
namespace TYPO3\CMS\Core\Tests\Unit\Cache\Backend;

use TYPO3\CMS\Core\Cache\Backend\MemcachedBackend;

class MemcachedBackendTest extends \TYPO3\CMS\Core\Tests\UnitTestCase {

    public function setUp() {
        if (!extension_loaded('memcache')) {
            $this->markTestSkipped('memcache extension was not available');
        }
        try {
            if (!@fsockopen('localhost', 11211)) {
                $this->markTestSkipped('memcached not reachable');
            }
        } catch (\Exception $e) {
            $this->markTestSkipped('memcached not reachable');
        }
    }

    public function setThrowsExceptionIfNoFrontEndHasBeenSet() {
        $backendOptions = array('servers' => array('localhost:11211'));
        $backend = new MemcachedBackend('Testing', $backendOptions);
        $backend->initializeObject();
        $data = 'Some data';
        $identifier = $this->getUniqueId('MyIdentifier');
        $backend->set($identifier, $data);
    }

    public function initializeObjectThrowsExceptionIfNoMemcacheServerIsConfigured() {
        $backend = new MemcachedBackend('Testing');
        $backend->initializeObject();
    }

    public function itIsPossibleToSetAndCheckExistenceInCache() {
        $backend = $this->setUpBackend();
        $data = 'Some data';
        $identifier = $this->getUniqueId('MyIdentifier');
        $backend->set($identifier, $data);
        $inCache = $backend->has($identifier);
        $this->assertTrue($inCache, 'Memcache failed to set and check entry');
    }

    public function itIsPossibleToSetAndGetEntry() {
        $backend = $this->setUpBackend();
        $data = 'Some data';
        $identifier = $this->getUniqueId('MyIdentifier');
        $backend->set($identifier, $data);
        $fetchedData = $backend->get($identifier);
        $this->assertEquals($data, $fetchedData, 'Memcache failed to set and retrieve data');
    }

    public function itIsPossibleToRemoveEntryFromCache() {
        $backend = $this->setUpBackend();
        $data = 'Some data';
        $identifier = $this->getUniqueId('MyIdentifier');
        $backend->set($identifier, $data);
        $backend->remove($identifier);
        $inCache = $backend->has($identifier);
        $this->assertFalse($inCache, 'Failed to set and remove data from Memcache');
    }

    public function itIsPossibleToOverwriteAnEntryInTheCache() {
        $backend = $this->setUpBackend();
        $data = 'Some data';
        $identifier = $this->getUniqueId('MyIdentifier');
        $backend->set($identifier, $data);
        $otherData = 'some other data';
        $backend->set($identifier, $otherData);
        $fetchedData = $backend->get($identifier);
        $this->assertEquals($otherData, $fetchedData, 'Memcache failed to overwrite and retrieve data');
    }

    public function findIdentifiersByTagFindsCacheEntriesWithSpecifiedTag() {
        $backend = $this->setUpBackend();
        $data = 'Some data';
        $identifier = $this->getUniqueId('MyIdentifier');
        $backend->set($identifier, $data, array('UnitTestTag%tag1', 'UnitTestTag%tag2'));
        $retrieved = $backend->findIdentifiersByTag('UnitTestTag%tag1');
        $this->assertEquals($identifier, $retrieved[0], 'Could not retrieve expected entry by tag.');
        $retrieved = $backend->findIdentifiersByTag('UnitTestTag%tag2');
        $this->assertEquals($identifier, $retrieved[0], 'Could not retrieve expected entry by tag.');
    }

    public function setRemovesTagsFromPreviousSet() {
        $backend = $this->setUpBackend();
        $data = 'Some data';
        $identifier = $this->getUniqueId('MyIdentifier');
        $backend->set($identifier, $data, array('UnitTestTag%tag1', 'UnitTestTag%tag2'));
        $backend->set($identifier, $data, array('UnitTestTag%tag3'));
        $retrieved = $backend->findIdentifiersByTag('UnitTestTag%tagX');
        $this->assertEquals(array(), $retrieved, 'Found entry which should no longer exist.');
    }

    public function hasReturnsFalseIfTheEntryDoesntExist() {
        $backend = $this->setUpBackend();
        $identifier = $this->getUniqueId('NonExistingIdentifier');
        $inCache = $backend->has($identifier);
        $this->assertFalse($inCache, '"has" did not return FALSE when checking on non existing identifier');
    }

    public function removeReturnsFalseIfTheEntryDoesntExist() {
        $backend = $this->setUpBackend();
        $identifier = $this->getUniqueId('NonExistingIdentifier');
        $inCache = $backend->remove($identifier);
        $this->assertFalse($inCache, '"remove" did not return FALSE when checking on non existing identifier');
    }

    public function flushByTagRemovesCacheEntriesWithSpecifiedTag() {
        $backend = $this->setUpBackend();
        $data = 'some data' . microtime();
        $backend->set('BackendMemcacheTest1', $data, array('UnitTestTag%test', 'UnitTestTag%boring'));
        $backend->set('BackendMemcacheTest2', $data, array('UnitTestTag%test', 'UnitTestTag%special'));
        $backend->set('BackendMemcacheTest3', $data, array('UnitTestTag%test'));
        $backend->flushByTag('UnitTestTag%special');
        $this->assertTrue($backend->has('BackendMemcacheTest1'), 'BackendMemcacheTest1');
        $this->assertFalse($backend->has('BackendMemcacheTest2'), 'BackendMemcacheTest2');
        $this->assertTrue($backend->has('BackendMemcacheTest3'), 'BackendMemcacheTest3');
    }

    public function flushRemovesAllCacheEntries() {
        $backend = $this->setUpBackend();
        $data = 'some data' . microtime();
        $backend->set('BackendMemcacheTest1', $data);
        $backend->set('BackendMemcacheTest2', $data);
        $backend->set('BackendMemcacheTest3', $data);
        $backend->flush();
        $this->assertFalse($backend->has('BackendMemcacheTest1'), 'BackendMemcacheTest1');
        $this->assertFalse($backend->has('BackendMemcacheTest2'), 'BackendMemcacheTest2');
        $this->assertFalse($backend->has('BackendMemcacheTest3'), 'BackendMemcacheTest3');
    }

    public function flushRemovesOnlyOwnEntries() {
        $backendOptions = array('servers' => array('localhost:11211'));
        $thisCache = $this->getMock('TYPO3\\CMS\\Core\\Cache\\Frontend\\AbstractFrontend', array(), array(), '', FALSE);
        $thisCache->expects($this->any())->method('getIdentifier')->will($this->returnValue('thisCache'));
        $thisBackend = new MemcachedBackend('Testing', $backendOptions);
        $thisBackend->setCache($thisCache);
        $thisBackend->initializeObject();

        $thatCache = $this->getMock('TYPO3\\CMS\\Core\\Cache\\Frontend\\AbstractFrontend', array(), array(), '', FALSE);
        $thatCache->expects($this->any())->method('getIdentifier')->will($this->returnValue('thatCache'));
        $thatBackend = new MemcachedBackend('Testing', $backendOptions);
        $thatBackend->setCache($thatCache);
        $thatBackend->initializeObject();
        $thisBackend->set('thisEntry', 'Hello');
        $thatBackend->set('thatEntry', 'World!');
        $thatBackend->flush();
        $this->assertEquals('Hello', $thisBackend->get('thisEntry'));
        $this->assertFalse($thatBackend->has('thatEntry'));
    }

    public function largeDataIsStored() {
        $backend = $this->setUpBackend();
        $data = str_repeat('abcde', 1024 * 1024);
        $backend->set('tooLargeData', $data);
        $this->assertTrue($backend->has('tooLargeData'));
        $this->assertEquals($backend->get('tooLargeData'), $data);
    }

    public function setTagsOnlyOnceToIdentifier() {
        $backendOptions = array('servers' => array('localhost:11211'));
        $identifier = $this->getUniqueId('MyIdentifier');
        $tags = array('UnitTestTag%test', 'UnitTestTag%boring');

        $backend = $this->setUpBackend($backendOptions, TRUE);
        $backend->_call('addIdentifierToTags', $identifier, $tags);
        $this->assertSame(
            $tags,
            $backend->_call('findTagsByIdentifier', $identifier)
        );

        $backend->_call('addIdentifierToTags', $identifier, $tags);
        $this->assertSame(
            $tags,
            $backend->_call('findTagsByIdentifier', $identifier)
        );
    }

    protected function setUpBackend(array $backendOptions = array(), $accessible = FALSE) {
        $cache = $this->getMock('TYPO3\\CMS\\Core\\Cache\\Frontend\\FrontendInterface', array(), array(), '', FALSE);
        if ($backendOptions == array()) {
            $backendOptions = array('servers' => array('localhost:11211'));
        }
        if ($accessible) {
            $accessibleClassName = $this->buildAccessibleProxy('\\TYPO3\\CMS\\Core\\Cache\\Backend\\MemcachedBackend');
            $backend = new $accessibleClassName('Testing', $backendOptions);
        } else {
            $backend = new MemcachedBackend('Testing', $backendOptions);
        }
        $backend->setCache($cache);
        $backend->initializeObject();
        return $backend;
    }

}