eZ\Publish\Core\Persistence\Cache\Adapter\Tests\InMemoryCacheAdapterTest

Complexity

Total Complexity

8

Size/Duplication

Total Lines	139
Duplicated Lines	27.34 %

Coupling/Cohesion

Components	1
Dependencies	3

Importance

Changes

0

7 Methods

Rating	Name	Duplication	Size	Complexity
A	tearDown()	0	7	1
A	testGetItemOnlyCalledOnce()	0	16	1
A	setUp()	0	26	1
A	testGetItemsOnlyCalledOnce()	19	19	1
A	testGetItemsWithGenerator()	19	19	1
A	getCacheItem()	0	6	1
A	arrayAsGenerator()	0	6	2

<?php

/**
 * @copyright Copyright (C) eZ Systems AS. All rights reserved.
 * @license For full copyright and license information view LICENSE file distributed with this source code.
 */
declare(strict_types=1);

namespace eZ\Publish\Core\Persistence\Cache\Adapter\Tests;

use eZ\Publish\Core\Persistence\Cache\Adapter\InMemoryCacheAdapter;
use Symfony\Component\Cache\Adapter\TagAwareAdapterInterface;
use Symfony\Component\Cache\CacheItem;
use PHPUnit\Framework\TestCase;

/**
 * Abstract test case for spi cache impl.
 */
class InMemoryCacheAdapterTest extends TestCase
{
    /**
     * @var \eZ\Publish\Core\Persistence\Cache\Adapter\InMemoryCacheAdapter
     */
    protected $cache;

    /**
     * @var \Symfony\Component\Cache\Adapter\TagAwareAdapterInterface|\PHPUnit\Framework\MockObject\MockObject
     */
    protected $cacheMock;

    /**
     * @var \Closure
     */
    private $cacheItemsClosure;

    /**
     * Setup the HandlerTest.
     */
    final protected function setUp()
    {
        parent::setUp();

        $this->cacheMock = $this->createMock(TagAwareAdapterInterface::class);

        $this->cache = new InMemoryCacheAdapter(
            $this->cacheMock,
            20,
            3
        );

        $this->cacheItemsClosure = \Closure::bind(
            function ($key, $value, $isHit, $defaultLifetime = 0) {
                $item = new CacheItem();
                $item->key = $key;

The property key cannot be accessed from this context as it is declared protected in class Symfony\Component\Cache\CacheItem.

                $item->value = $value;

The property value cannot be accessed from this context as it is declared protected in class Symfony\Component\Cache\CacheItem.

                $item->isHit = $isHit;

The property isHit cannot be accessed from this context as it is declared protected in class Symfony\Component\Cache\CacheItem.

                $item->defaultLifetime = $defaultLifetime;

The property defaultLifetime cannot be accessed from this context as it is declared protected in class Symfony\Component\Cache\CacheItem.

                return $item;
            },
            null,
            CacheItem::class
        );
    }

    /**
     * Tear down test (properties).
     */
    final protected function tearDown()
    {
        unset($this->cache);
        unset($this->cacheMock);
        unset($this->cacheItemsClosure);
        parent::tearDown();
    }

    public function testGetItemOnlyCalledOnce()
    {
        $item = $this->getCacheItem('some_key', true);

        $this->cacheMock
            ->expects($this->once())
            ->method('getItem')
            ->with('some_key')
            ->willReturn($item);

        $returnedItem = $this->cache->getItem('some_key');
        $this->assertSame($item, $returnedItem);

        $returnedItem = $this->cache->getItem('some_key');
        $this->assertSame($item, $returnedItem);
    }

    public function testGetItemsOnlyCalledOnce()
    {
        $items = [
            'first_key' => $this->getCacheItem('first_key', true),
            'second_key' => $this->getCacheItem('second_key', true),
        ];

        $this->cacheMock
            ->expects($this->once())
            ->method('getItems')
            ->with(['first_key', 'second_key'])
            ->willReturn($items);

        $returnedItems = iterator_to_array($this->cache->getItems(['first_key', 'second_key']));
        $this->assertSame($items, $returnedItems);

        $returnedItems = iterator_to_array($this->cache->getItems(['first_key', 'second_key']));
        $this->assertSame($items, $returnedItems);
    }

    /**
     * Symfony uses generators with getItems() so we need to make sure we handle that.
     */
    public function testGetItemsWithGenerator()
    {
        $items = [
            'first_key' => $this->getCacheItem('first_key', true),
            'second_key' => $this->getCacheItem('second_key', true),
        ];

        $this->cacheMock
            ->expects($this->once())
            ->method('getItems')
            ->with(['first_key', 'second_key'])
            ->willReturn($this->arrayAsGenerator($items));

        $returnedItems = iterator_to_array($this->cache->getItems(['first_key', 'second_key']));
        $this->assertSame($items, $returnedItems);

        $returnedItems = iterator_to_array($this->cache->getItems(['first_key', 'second_key']));
        $this->assertSame($items, $returnedItems);
    }

    /**
     * @param $key
     * @param null $value If null the cache item will be assumed to be a cache miss here.
     * @param int $defaultLifetime
     *
     * @return CacheItem
     */
    final protected function getCacheItem($key, $value = null, $defaultLifetime = 0)
    {
        $cacheItemsClosure = $this->cacheItemsClosure;

        return $cacheItemsClosure($key, $value, (bool)$value, $defaultLifetime);
    }

    final protected function arrayAsGenerator(array $array)
    {
        foreach ($array as $key => $item) {
            yield $key => $item;
        }
    }
}