PdoBackendTest.php

Go to the documentation of this file.

<?php
 
declare(strict_types=1);
 
/*
 * This file is part of the TYPO3 CMS project.
 *
 * It is free software; you can redistribute it and/or modify it under
 * the terms of the GNU General Public License, either version 2
 * of the License, or any later version.
 *
 * For the full copyright and license information, please read the
 * LICENSE.txt file that was distributed with this source code.
 *
 * The TYPO3 project - inspiring people to share!
 */
 
namespace ‪TYPO3\CMS\Core\Tests\UnitDeprecated\Cache\Backend;
 
use ‪TYPO3\CMS\Core\Cache\Backend\PdoBackend;
use ‪TYPO3\CMS\Core\Cache\Exception;
use ‪TYPO3\CMS\Core\Cache\Frontend\FrontendInterface;
use ‪TYPO3\CMS\Core\Utility\GeneralUtility;
use ‪TYPO3\CMS\Core\Utility\StringUtility;
use TYPO3\TestingFramework\Core\Unit\UnitTestCase;
 
class ‪PdoBackendTest extends UnitTestCase
{
    protected ‪$resetSingletonInstances = true;
 
    protected function ‪setUp(): void
    {
        parent::setUp();
        ‪$GLOBALS['TYPO3_CONF_VARS']['SYS']['encryptionKey'] = 'secret-encryption-key-test';
    }
 
    protected function ‪tearDown(): void
    {
        unset(‪$GLOBALS['TYPO3_CONF_VARS']['SYS']['encryptionKey']);
        parent::tearDown();
    }
 
    public function ‪setThrowsExceptionIfNoFrontEndHasBeenSet(): void
    {
        $this->expectException(Exception::class);
        $this->expectExceptionCode(1259515600);
 
        $backend = new ‪PdoBackend('Testing');
        $data = 'Some data';
        $identifier = 'MyIdentifier';
        $backend->set($identifier, $data);
    }
 
    public function ‪itIsPossibleToSetAndCheckExistenceInCache(): void
    {
        $backend = $this->‪setUpBackend();
        $data = 'Some data';
        $identifier = 'MyIdentifier';
        $backend->set($identifier, $data);
        self::assertTrue($backend->has($identifier));
    }
 
    public function ‪itIsPossibleToSetAndGetEntry(): void
    {
        $backend = $this->‪setUpBackend();
        $data = 'Some data';
        $identifier = 'MyIdentifier';
        $backend->set($identifier, $data);
        $fetchedData = $backend->get($identifier);
        self::assertEquals($data, $fetchedData);
    }
 
    public function ‪itIsPossibleToRemoveEntryFromCache(): void
    {
        $backend = $this->‪setUpBackend();
        $data = 'Some data';
        $identifier = 'MyIdentifier';
        $backend->set($identifier, $data);
        $backend->remove($identifier);
        self::assertFalse($backend->has($identifier));
    }
 
    public function ‪itIsPossibleToOverwriteAnEntryInTheCache(): void
    {
        $backend = $this->‪setUpBackend();
        $data = 'Some data';
        $identifier = 'MyIdentifier';
        $backend->set($identifier, $data);
        $otherData = 'some other data';
        $backend->set($identifier, $otherData);
        $fetchedData = $backend->get($identifier);
        self::assertEquals($otherData, $fetchedData);
    }
 
    public function ‪findIdentifiersByTagFindsSetEntries(): void
    {
        $backend = $this->‪setUpBackend();
        $data = 'Some data';
        $entryIdentifier = 'MyIdentifier';
        $backend->set($entryIdentifier, $data, ['UnitTestTag%tag1', 'UnitTestTag%tag2']);
        $retrieved = $backend->findIdentifiersByTag('UnitTestTag%tag1');
        self::assertEquals($entryIdentifier, $retrieved[0]);
        $retrieved = $backend->findIdentifiersByTag('UnitTestTag%tag2');
        self::assertEquals($entryIdentifier, $retrieved[0]);
    }
 
    public function ‪setRemovesTagsFromPreviousSet(): void
    {
        $backend = $this->‪setUpBackend();
        $data = 'Some data';
        $entryIdentifier = 'MyIdentifier';
        $backend->set($entryIdentifier, $data, ['UnitTestTag%tag1', 'UnitTestTag%tag2']);
        $backend->set($entryIdentifier, $data, ['UnitTestTag%tag3']);
        $retrieved = $backend->findIdentifiersByTag('UnitTestTag%tag2');
        self::assertEquals([], $retrieved);
    }
 
    public function ‪setOverwritesExistingEntryThatExceededItsLifetimeWithNewData(): void
    {
        $backend = $this->‪setUpBackend();
        $data1 = 'data1';
        $entryIdentifier = ‪StringUtility::getUniqueId('test');
        $backend->set($entryIdentifier, $data1, [], 1);
        $data2 = 'data2';
        ‪$GLOBALS['EXEC_TIME'] += 2;
        $backend->set($entryIdentifier, $data2, [], 10);
        self::assertEquals($data2, $backend->get($entryIdentifier));
    }
 
    public function ‪hasReturnsFalseIfTheEntryDoesntExist(): void
    {
        $backend = $this->‪setUpBackend();
        $identifier = 'NonExistingIdentifier';
        self::assertFalse($backend->has($identifier));
    }
 
    public function ‪removeReturnsFalseIfTheEntryDoesntExist(): void
    {
        $backend = $this->‪setUpBackend();
        $identifier = 'NonExistingIdentifier';
        self::assertFalse($backend->remove($identifier));
    }
 
    public function ‪flushByTagRemovesCacheEntriesWithSpecifiedTag(): void
    {
        $backend = $this->‪setUpBackend();
        $data = 'some data' . microtime();
        $backend->set('PdoBackendTest1', $data, ['UnitTestTag%test', 'UnitTestTag%boring']);
        $backend->set('PdoBackendTest2', $data, ['UnitTestTag%test', 'UnitTestTag%special']);
        $backend->set('PdoBackendTest3', $data, ['UnitTestTag%test']);
        $backend->flushByTag('UnitTestTag%special');
        self::assertTrue($backend->has('PdoBackendTest1'), 'PdoBackendTest1');
        self::assertFalse($backend->has('PdoBackendTest2'), 'PdoBackendTest2');
        self::assertTrue($backend->has('PdoBackendTest3'), 'PdoBackendTest3');
    }
 
    public function ‪flushByTagsRemovesCacheEntriesWithSpecifiedTags(): void
    {
        $backend = $this->‪setUpBackend();
        $data = 'some data' . microtime();
        $backend->set('PdoBackendTest1', $data, ['UnitTestTag%test', 'UnitTestTags%boring']);
        $backend->set('PdoBackendTest2', $data, ['UnitTestTag%test', 'UnitTestTag%special']);
        $backend->set('PdoBackendTest3', $data, ['UnitTestTag%test']);
        $backend->flushByTags(['UnitTestTag%special', 'UnitTestTags%boring']);
        self::assertFalse($backend->has('PdoBackendTest1'), 'PdoBackendTest1');
        self::assertFalse($backend->has('PdoBackendTest2'), 'PdoBackendTest2');
        self::assertTrue($backend->has('PdoBackendTest3'), 'PdoBackendTest3');
    }
 
    public function ‪flushRemovesAllCacheEntries(): void
    {
        $backend = $this->‪setUpBackend();
        $data = 'some data' . microtime();
        $backend->set('PdoBackendTest1', $data);
        $backend->set('PdoBackendTest2', $data);
        $backend->set('PdoBackendTest3', $data);
        $backend->flush();
        self::assertFalse($backend->has('PdoBackendTest1'), 'PdoBackendTest1');
        self::assertFalse($backend->has('PdoBackendTest2'), 'PdoBackendTest2');
        self::assertFalse($backend->has('PdoBackendTest3'), 'PdoBackendTest3');
    }
 
    public function ‪flushRemovesOnlyOwnEntries(): void
    {
        $thisCache = $this->createMock(FrontendInterface::class);
        $thisCache->method('getIdentifier')->willReturn('thisCache');
        $thisBackend = $this->‪setUpBackend();
        $thisBackend->setCache($thisCache);
        $thatCache = $this->createMock(FrontendInterface::class);
        $thatCache->method('getIdentifier')->willReturn('thatCache');
        $thatBackend = $this->‪setUpBackend();
        $thatBackend->setCache($thatCache);
        $thisBackend->set('thisEntry', 'Hello');
        $thatBackend->set('thatEntry', 'World!');
        $thatBackend->flush();
        self::assertEquals('Hello', $thisBackend->get('thisEntry'));
        self::assertFalse($thatBackend->has('thatEntry'));
    }
 
    public function ‪collectGarbageReallyRemovesAnExpiredCacheEntry(): void
    {
        $backend = $this->‪setUpBackend();
        $data = 'some data' . microtime();
        $entryIdentifier = 'BackendPDORemovalTest';
        $backend->set($entryIdentifier, $data, [], 1);
        self::assertTrue($backend->has($entryIdentifier));
        ‪$GLOBALS['EXEC_TIME'] += 2;
        $backend->collectGarbage();
        self::assertFalse($backend->has($entryIdentifier));
    }
 
    public function ‪collectGarbageReallyRemovesAllExpiredCacheEntries(): void
    {
        $backend = $this->‪setUpBackend();
        $data = 'some data' . microtime();
        $entryIdentifier = 'BackendPDORemovalTest';
        $backend->set($entryIdentifier . 'A', $data, [], null);
        $backend->set($entryIdentifier . 'B', $data, [], 10);
        $backend->set($entryIdentifier . 'C', $data, [], 1);
        $backend->set($entryIdentifier . 'D', $data, [], 1);
        self::assertTrue($backend->has($entryIdentifier . 'A'));
        self::assertTrue($backend->has($entryIdentifier . 'B'));
        self::assertTrue($backend->has($entryIdentifier . 'C'));
        self::assertTrue($backend->has($entryIdentifier . 'D'));
        ‪$GLOBALS['EXEC_TIME'] += 2;
        $backend->collectGarbage();
        self::assertTrue($backend->has($entryIdentifier . 'A'));
        self::assertTrue($backend->has($entryIdentifier . 'B'));
        self::assertFalse($backend->has($entryIdentifier . 'C'));
        self::assertFalse($backend->has($entryIdentifier . 'D'));
    }
 
    protected function ‪setUpBackend(): PdoBackend
    {
        $mockCache = $this->createMock(FrontendInterface::class);
        $mockCache->method('getIdentifier')->willReturn('TestCache');
        $backend = GeneralUtility::makeInstance(PdoBackend::class, 'Testing');
        $backend->setCache($mockCache);
        $backend->setDataSourceName('sqlite::memory:');
        $backend->initializeObject();
        return $backend;
    }
}