matomo/tests/PHPUnit/Integration/Settings/Storage/Backend/CacheTest.php

<?php

/**
 * Matomo - free/libre analytics platform
 *
 * @link    https://matomo.org
 * @license https://www.gnu.org/licenses/gpl-3.0.html GPL v3 or later
 */

namespace Piwik\Tests\Integration\Settings\Storage\Backend;

use Piwik\Settings\Storage\Backend\Cache;
use Piwik\Tests\Framework\Mock\Settings\FakeBackend;
use Piwik\Tests\Framework\TestCase\IntegrationTestCase;

/**
 * @group Settings
 * @group Backend
 * @group Storage
 */
class CacheTest extends IntegrationTestCase
{
    /**
     * @var FakeBackend
     */
    private $backend;

    /**
     * @var Cache
     */
    private $cacheBackend;

    public function setUp(): void
    {
        parent::setUp();

        $this->backend = new FakeBackend('MySuperStorageKey');
        $this->cacheBackend = new Cache($this->backend);
    }

    public function testGetStorageIdShouldReturnStorageOfActualPlugin()
    {
        $this->assertSame('MySuperStorageKey', $this->cacheBackend->getStorageId());
    }

    public function testLoadShouldActuallyLoadDataFromBackend()
    {
        $this->assertSame($this->backend->load(), $this->cacheBackend->load());
        $this->assertNotEmpty($this->cacheBackend->load());
    }

    public function testLoadShouldCacheData()
    {
        $this->assertNotValueCached();

        $this->cacheBackend->load();

        $this->assertValueCached();
        $this->assertValueIsActuallyInCache();
    }

    public function testDeleteShouldClearCacheAndData()
    {
        $this->cacheBackend->load();
        $this->assertValueCached();

        $this->cacheBackend->delete();

        $this->assertNotValueCached();
        $this->assertSame(array(), $this->cacheBackend->load());
        $this->assertSame(array(), $this->backend->load());
    }

    public function testSaveShouldClearCacheAndUpdateData()
    {
        $this->cacheBackend->load();
        $this->assertValueCached();

        $value = array('new' => 'value');
        $this->cacheBackend->save($value);

        $this->assertNotValueCached();

        $this->assertSame($value, $this->cacheBackend->load());
        $this->assertSame($value, $this->backend->load());

        $this->assertValueCached();
        $this->assertValueIsActuallyInCache();
    }

    private function assertValueIsActuallyInCache()
    {
        $this->assertSame($this->backend->load(), $this->getCache()->fetch($this->getCacheKey()));
    }

    private function assertValueCached()
    {
        $this->assertTrue($this->getCache()->contains($this->getCacheKey()));
    }

    private function assertNotValueCached()
    {
        $this->assertFalse($this->getCache()->contains($this->getCacheKey()));
    }

    private function getCacheKey()
    {
        return $this->cacheBackend->getStorageId();
    }

    private function getCache()
    {
        return Cache::buildCache();
    }
}