Typo3DatabaseBackendTest.php

Go to the documentation of this file.

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

/*
 * 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!
 */

class Typo3DatabaseBackendTest extends \TYPO3\CMS\Core\Tests\UnitTestCase
{
    protected function setUpMockFrontendOfBackend(\TYPO3\CMS\Core\Cache\Backend\Typo3DatabaseBackend $backend)
    {
        $mockCache = $this->getMock(\TYPO3\CMS\Core\Cache\Frontend\AbstractFrontend::class, [], [], '', false);
        $mockCache->expects($this->any())->method('getIdentifier')->will($this->returnValue('Testing'));
        $backend->setCache($mockCache);
        return $mockCache;
    }

    public function setCacheCalculatesCacheTableName()
    {
        $backend = $this->getMock(\TYPO3\CMS\Core\Cache\Backend\Typo3DatabaseBackend::class, ['dummy'], ['Testing']);
        $this->setUpMockFrontendOfBackend($backend);
        $this->assertEquals('cf_Testing', $backend->getCacheTable());
    }

    public function setCacheCalculatesTagsTableName()
    {
        $backend = $this->getMock(\TYPO3\CMS\Core\Cache\Backend\Typo3DatabaseBackend::class, ['dummy'], ['Testing']);
        $this->setUpMockFrontendOfBackend($backend);
        $this->assertEquals('cf_Testing_tags', $backend->getTagsTable());
    }

    public function setThrowsExceptionIfFrontendWasNotSet()
    {
        $backend = $this->getMock(\TYPO3\CMS\Core\Cache\Backend\Typo3DatabaseBackend::class, ['dummy'], ['Testing']);
        $backend->set('identifier', 'data');
    }

    public function setThrowsExceptionIfDataIsNotAString()
    {
        $backend = $this->getMock(\TYPO3\CMS\Core\Cache\Backend\Typo3DatabaseBackend::class, ['dummy'], ['Testing']);
        $this->setUpMockFrontendOfBackend($backend);
        $data = ['Some data'];
        $entryIdentifier = 'BackendDbTest';
        $backend->set($entryIdentifier, $data);
    }

    public function setInsertsEntryInTable()
    {
        $backend = $this->getMock(\TYPO3\CMS\Core\Cache\Backend\Typo3DatabaseBackend::class, ['dummy'], ['Testing']);
        $this->setUpMockFrontendOfBackend($backend);
        $GLOBALS['TYPO3_DB'] = $this->getMock(\TYPO3\CMS\Core\Database\DatabaseConnection::class, [], [], '', false);
        $GLOBALS['TYPO3_DB']
            ->expects($this->once())
            ->method('exec_INSERTquery')
            ->with('cf_Testing', $this->callback(function (array $data) {
                if ($data['content'] !== 'someData') {
                    return false;
                }
                if ($data['identifier'] !== 'anIdentifier') {
                    return false;
                }
                return true;
            }));
        $backend->set('anIdentifier', 'someData');
    }

    public function setRemovesAnAlreadyExistingCacheEntryForTheSameIdentifier()
    {
        $backend = $this->getMock(\TYPO3\CMS\Core\Cache\Backend\Typo3DatabaseBackend::class, ['remove'], ['Testing']);
        $this->setUpMockFrontendOfBackend($backend);
        $GLOBALS['TYPO3_DB'] = $this->getMock(\TYPO3\CMS\Core\Database\DatabaseConnection::class, [], [], '', false);

        $backend->expects($this->once())->method('remove');
        $data = $this->getUniqueId('someData');
        $entryIdentifier = 'anIdentifier';
        $backend->set($entryIdentifier, $data, [], 500);
    }

    public function setReallySavesSpecifiedTags()
    {
        $backend = $this->getMock(\TYPO3\CMS\Core\Cache\Backend\Typo3DatabaseBackend::class, ['dummy'], ['Testing']);
        $this->setUpMockFrontendOfBackend($backend);
        $GLOBALS['TYPO3_DB'] = $this->getMock(\TYPO3\CMS\Core\Database\DatabaseConnection::class, [], [], '', false);
        $GLOBALS['TYPO3_DB']
            ->expects($this->once())
            ->method('exec_INSERTmultipleRows')
            ->with(
                'cf_Testing_tags',
                $this->callback(function (array $data) {
                    if ($data[0] === 'identifier' && $data[1] === 'tag') {
                        return true;
                    }
                    return false;
                }),
                $this->callback(function (array $data) {
                    if ($data[0][0] !== 'anIdentifier' || $data[0][1] !== 'UnitTestTag%tag1') {
                        return false;
                    }
                    if ($data[1][0] !== 'anIdentifier' || $data[1][1] !== 'UnitTestTag%tag2') {
                        return false;
                    }
                    return true;
                })
            );
        $backend->set('anIdentifier', 'someData', ['UnitTestTag%tag1', 'UnitTestTag%tag2']);
    }

    public function setSavesCompressedDataWithEnabledCompression()
    {
        $backendOptions = [
            'compression' => true
        ];
        $backend = $this->getMock(
            \TYPO3\CMS\Core\Cache\Backend\Typo3DatabaseBackend::class,
            ['dummy'],
            ['Testing', $backendOptions]
        );
        $this->setUpMockFrontendOfBackend($backend);

        $GLOBALS['TYPO3_DB'] = $this->getMock(\TYPO3\CMS\Core\Database\DatabaseConnection::class, [], [], '', false);
        $GLOBALS['TYPO3_DB']
            ->expects($this->once())
            ->method('exec_INSERTquery')
            ->with(
                'cf_Testing',
                $this->callback(function (array $data) {
                    if (@gzuncompress($data['content']) === 'someData') {
                        return true;
                    }
                    return false;
                }
            ));

        $backend->set('anIdentifier', 'someData');
    }

    public function setWithUnlimitedLifetimeWritesCorrectEntry()
    {
        $backend = $this->getMock(\TYPO3\CMS\Core\Cache\Backend\Typo3DatabaseBackend::class, ['dummy'], ['Testing']);
        $this->setUpMockFrontendOfBackend($backend);

        $GLOBALS['TYPO3_DB'] = $this->getMock(\TYPO3\CMS\Core\Database\DatabaseConnection::class, [], [], '', false);
        $GLOBALS['TYPO3_DB']
            ->expects($this->once())
            ->method('exec_INSERTquery')
            ->with(
                'cf_Testing',
                $this->callback(function (array $data) {
                    $lifetime = $data['expires'];
                    if ($lifetime > 2000000000) {
                        return true;
                    }
                    return false;
                }
            ));

        $backend->set('aIdentifier', 'someData', [], 0);
    }

    public function getThrowsExceptionIfFrontendWasNotSet()
    {
        $backend = $this->getMock(\TYPO3\CMS\Core\Cache\Backend\Typo3DatabaseBackend::class, ['dummy'], ['Testing']);
        $backend->get('identifier');
    }

    public function getReturnsContentOfTheCorrectCacheEntry()
    {
        $backend = $this->getMock(\TYPO3\CMS\Core\Cache\Backend\Typo3DatabaseBackend::class, ['dummy'], ['Testing']);
        $this->setUpMockFrontendOfBackend($backend);

        $GLOBALS['TYPO3_DB'] = $this->getMock(\TYPO3\CMS\Core\Database\DatabaseConnection::class, [], [], '', false);
        $GLOBALS['TYPO3_DB']
            ->expects($this->once())
            ->method('exec_SELECTgetSingleRow')
            ->with('content', 'cf_Testing', $this->anything())
            ->will($this->returnValue(['content' => 'someData']));

        $loadedData = $backend->get('aIdentifier');
        $this->assertEquals('someData', $loadedData);
    }

    public function getSetsExceededLifetimeQueryPart()
    {
        $backend = $this->getMock(\TYPO3\CMS\Core\Cache\Backend\Typo3DatabaseBackend::class, ['dummy'], ['Testing']);
        $this->setUpMockFrontendOfBackend($backend);

        $GLOBALS['TYPO3_DB'] = $this->getMock(\TYPO3\CMS\Core\Database\DatabaseConnection::class, [], [], '', false);
        $GLOBALS['TYPO3_DB']
            ->expects($this->once())
            ->method('exec_SELECTgetSingleRow')
            ->with(
                'content',
                'cf_Testing',
                $this->stringContains('identifier =  AND cf_Testing.expires >=')
            );

        $backend->get('aIdentifier');
    }

    public function hasThrowsExceptionIfFrontendWasNotSet()
    {
        $backend = $this->getMock(\TYPO3\CMS\Core\Cache\Backend\Typo3DatabaseBackend::class, ['dummy'], ['Testing']);
        $backend->has('identifier');
    }

    public function hasReturnsTrueForExistingEntry()
    {
        $backend = $this->getMock(\TYPO3\CMS\Core\Cache\Backend\Typo3DatabaseBackend::class, ['dummy'], ['Testing']);
        $this->setUpMockFrontendOfBackend($backend);

        $GLOBALS['TYPO3_DB'] = $this->getMock(\TYPO3\CMS\Core\Database\DatabaseConnection::class, [], [], '', false);
        $GLOBALS['TYPO3_DB']
            ->expects($this->once())
            ->method('exec_SELECTcountRows')
            ->with('*', 'cf_Testing', $this->anything())
            ->will($this->returnValue(1));

        $this->assertTrue($backend->has('aIdentifier'));
    }

    public function hasSetsExceededLifetimeQueryPart()
    {
        $backend = $this->getMock(\TYPO3\CMS\Core\Cache\Backend\Typo3DatabaseBackend::class, ['dummy'], ['Testing']);
        $this->setUpMockFrontendOfBackend($backend);

        $GLOBALS['TYPO3_DB'] = $this->getMock(\TYPO3\CMS\Core\Database\DatabaseConnection::class, [], [], '', false);
        $GLOBALS['TYPO3_DB']
            ->expects($this->once())
            ->method('exec_SELECTcountRows')
            ->with(
                '*',
                'cf_Testing',
                $this->stringContains('identifier =  AND cf_Testing.expires >='))
            ->will($this->returnValue(1));

        $this->assertTrue($backend->has('aIdentifier'));
    }

    public function removeThrowsExceptionIfFrontendWasNotSet()
    {
        $backend = $this->getMock(\TYPO3\CMS\Core\Cache\Backend\Typo3DatabaseBackend::class, ['dummy'], ['Testing']);
        $backend->remove('identifier');
    }

    public function collectGarbageThrowsExceptionIfFrontendWasNotSet()
    {
        $backend = $this->getMock(\TYPO3\CMS\Core\Cache\Backend\Typo3DatabaseBackend::class, ['dummy'], ['Testing']);
        $backend->collectGarbage();
    }

    public function collectGarbageDeletesTagsFromExpiredEntries()
    {
        $backend = $this->getMock(\TYPO3\CMS\Core\Cache\Backend\Typo3DatabaseBackend::class, ['dummy'], ['Testing']);
        $this->setUpMockFrontendOfBackend($backend);

        $GLOBALS['TYPO3_DB'] = $this->getMock(\TYPO3\CMS\Core\Database\DatabaseConnection::class, [], [], '', false);
        $GLOBALS['TYPO3_DB']
            ->expects($this->at(1))
            ->method('sql_fetch_assoc')
            ->will($this->returnValue(['identifier' => 'aIdentifier']));
        $GLOBALS['TYPO3_DB']
            ->expects($this->at(2))
            ->method('fullQuoteStr')
            ->will($this->returnValue('aIdentifier'));
        $GLOBALS['TYPO3_DB']
            ->expects($this->at(3))
            ->method('sql_fetch_assoc')
            ->will($this->returnValue(false));
        $GLOBALS['TYPO3_DB']
            ->expects($this->at(5))
            ->method('exec_DELETEquery')
            ->with('cf_Testing_tags', 'identifier IN (aIdentifier)');

        $backend->collectGarbage();
    }

    public function findIdentifiersByTagThrowsExceptionIfFrontendWasNotSet()
    {
        $backend = $this->getMock(\TYPO3\CMS\Core\Cache\Backend\Typo3DatabaseBackend::class, ['dummy'], ['Testing']);
        $backend->findIdentifiersByTag('identifier');
    }

    public function findIdentifiersByTagFindsCacheEntriesWithSpecifiedTag()
    {
        $backend = $this->getMock(\TYPO3\CMS\Core\Cache\Backend\Typo3DatabaseBackend::class, ['dummy'], ['Testing']);
        $this->setUpMockFrontendOfBackend($backend);

        $GLOBALS['TYPO3_DB'] = $this->getMock(\TYPO3\CMS\Core\Database\DatabaseConnection::class, [], [], '', false);
        $GLOBALS['TYPO3_DB']
            ->expects($this->at(0))
            ->method('fullQuoteStr')
            ->will($this->returnValue('cf_Testing_tags'));
        $GLOBALS['TYPO3_DB']
            ->expects($this->at(1))
            ->method('exec_SELECTgetRows')
            ->with(
                'cf_Testing.identifier',
                'cf_Testing, cf_Testing_tags',
                $this->stringContains('cf_Testing_tags.tag = cf_Testing_tags AND cf_Testing.identifier = cf_Testing_tags.identifier AND cf_Testing.expires >= '),
                'cf_Testing.identifier'
            )
            ->will($this->returnValue([['identifier' => 'aIdentifier']]));
        $this->assertSame(['aIdentifier' => 'aIdentifier'], $backend->findIdentifiersByTag('aTag'));
    }

    public function flushThrowsExceptionIfFrontendWasNotSet()
    {
        $backend = $this->getMock(\TYPO3\CMS\Core\Cache\Backend\Typo3DatabaseBackend::class, ['dummy'], ['Testing']);
        $backend->flush();
    }

    public function flushRemovesAllCacheEntries()
    {
        $backend = $this->getMock(\TYPO3\CMS\Core\Cache\Backend\Typo3DatabaseBackend::class, ['dummy'], ['Testing']);
        $this->setUpMockFrontendOfBackend($backend);

        $GLOBALS['TYPO3_DB'] = $this->getMock(\TYPO3\CMS\Core\Database\DatabaseConnection::class, [], [], '', false);
        $GLOBALS['TYPO3_DB']
            ->expects($this->at(0))
            ->method('exec_TRUNCATEquery')
            ->with('cf_Testing');
        $GLOBALS['TYPO3_DB']
            ->expects($this->at(1))
            ->method('exec_TRUNCATEquery')
            ->with('cf_Testing_tags');

        $backend->flush();
    }

    public function flushByTagThrowsExceptionIfFrontendWasNotSet()
    {
        $backend = $this->getMock(\TYPO3\CMS\Core\Cache\Backend\Typo3DatabaseBackend::class, ['dummy'], ['Testing']);
        $backend->flushByTag([]);
    }

    public function flushByTagRemovesCacheEntriesWithSpecifiedTag()
    {
        $backend = $this->getMock(\TYPO3\CMS\Core\Cache\Backend\Typo3DatabaseBackend::class, ['dummy'], ['Testing']);
        $this->setUpMockFrontendOfBackend($backend);

        $GLOBALS['TYPO3_DB'] = $this->getMock(\TYPO3\CMS\Core\Database\DatabaseConnection::class, [], [], '', false);
        $GLOBALS['TYPO3_DB']
            ->expects($this->at(0))
            ->method('fullQuoteStr')
            ->will($this->returnValue('UnitTestTag%special'));
        $GLOBALS['TYPO3_DB']
            ->expects($this->at(1))
            ->method('exec_SELECTquery')
            ->with(
                'DISTINCT identifier',
                'cf_Testing_tags',
                'cf_Testing_tags.tag = UnitTestTag%special'
            );
        $GLOBALS['TYPO3_DB']
            ->expects($this->at(2))
            ->method('sql_fetch_assoc')
            ->will($this->returnValue(['identifier' => 'BackendDbTest1']));
        $GLOBALS['TYPO3_DB']
            ->expects($this->at(3))
            ->method('fullQuoteStr')
            ->with('BackendDbTest1', 'cf_Testing')
            ->will($this->returnValue('BackendDbTest1'));
        $GLOBALS['TYPO3_DB']
            ->expects($this->at(4))
            ->method('sql_fetch_assoc')
            ->will($this->returnValue(['identifier' => 'BackendDbTest2']));
        $GLOBALS['TYPO3_DB']
            ->expects($this->at(5))
            ->method('fullQuoteStr')
            ->with('BackendDbTest2', 'cf_Testing')
            ->will($this->returnValue('BackendDbTest2'));
        $GLOBALS['TYPO3_DB']
            ->expects($this->at(6))
            ->method('sql_fetch_assoc')
            ->will($this->returnValue(false));
        $GLOBALS['TYPO3_DB']
            ->expects($this->at(7))
            ->method('sql_free_result')
            ->will($this->returnValue(true));
        $GLOBALS['TYPO3_DB']
            ->expects($this->at(8))
            ->method('exec_DELETEquery')
            ->with('cf_Testing', 'identifier IN (BackendDbTest1, BackendDbTest2)');
        $GLOBALS['TYPO3_DB']
            ->expects($this->at(9))
            ->method('exec_DELETEquery')
            ->with('cf_Testing_tags', 'identifier IN (BackendDbTest1, BackendDbTest2)');

        $backend->flushByTag('UnitTestTag%special');
    }
}