MovingImage\Bundle\VMProApiBundle\Tests\EventListener\BypassCacheListenerTest

Complexity

Total Complexity

5

Size/Duplication

Total Lines	82
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	9

Importance

Changes

0

5 Methods

Rating	Name	Duplication	Size	Complexity
A	assertIsHit()	0	7	1
A	setUp()	0	4	1
A	testOnKernelRequest()	0	19	1
A	getApiClient()	0	6	1
A	dataProvider()	0	15	1

<?php

declare(strict_types=1);

namespace MovingImage\Bundle\VMProApiBundle\Tests\EventListener;

use GuzzleHttp\ClientInterface;
use JMS\Serializer\SerializerBuilder;
use JMS\Serializer\SerializerInterface;
use MovingImage\Bundle\VMProApiBundle\EventListener\BypassCacheListener;
use MovingImage\Client\VMPro\ApiClient;
use PHPUnit\Framework\TestCase;
use Psr\Cache\CacheItemPoolInterface;
use Symfony\Component\Cache\Adapter\ArrayAdapter;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\HttpKernel\Event\GetResponseEvent;
use Symfony\Component\HttpKernel\HttpKernel;
use Symfony\Component\HttpKernel\HttpKernelInterface;

class BypassCacheListenerTest extends TestCase
{
    /**
     * @var SerializerInterface
     */
    private $serializer;

    public function setUp(): void
    {
        $this->serializer = SerializerBuilder::create()->build();
    }

    /**
     * Tests onKernelRequest method.
     *
     * @dataProvider dataProvider
     */
    public function testOnKernelRequest(
        ?string $bypassCacheArgument,
        array $query,
        array $request,
        array $attributes,
        array $cookies,
        bool $isHit
    ): void {
        $apiClient = $this->getApiClient();
        $listener = new BypassCacheListener($apiClient, $bypassCacheArgument);
        $request = new Request($query, $request, $attributes, $cookies);
        $kernel = $this->createMock(HttpKernel::class);

        $event = new GetResponseEvent($kernel, $request, HttpKernelInterface::MASTER_REQUEST);

$kernel is of type object<PHPUnit\Framework\MockObject\MockObject>, but the function expects a object<Symfony\Component\HttpKernel\HttpKernelInterface>.

The class Symfony\Component\HttpKernel\Event\GetResponseEvent has been deprecated with message: since Symfony 4.3, use RequestEvent instead

        $listener->onKernelRequest($event);

        $this->assertIsHit($isHit, $apiClient->getCacheItemPool());
    }

    /**
     * Creates an ApiClient instance with mocked dependencies
     * and ArrayAdapter as cache pool.
     */
    private function getApiClient(): ApiClient
    {
        $client = $this->createMock(ClientInterface::class);

        return new ApiClient($client, $this->serializer, new ArrayAdapter());

$client is of type object<PHPUnit\Framework\MockObject\MockObject>, but the function expects a object<GuzzleHttp\ClientInterface>.

$this->serializer of type object<JMS\Serializer\SerializerInterface> is not a sub-type of object<JMS\Serializer\Serializer>. It seems like you assume a concrete implementation of the interface JMS\Serializer\SerializerInterface to be always present.

    }

    /**
     * Asserts that storing an item to the provided pool followed by immediately
     * fetching it again from the pool will result in the specified "hit" status.
     * ($isHit = true -> expecting a cache hit; $isHit = false -> expecting a cache miss).
     */
    private function assertIsHit(bool $isHit, CacheItemPoolInterface $pool): void
    {
        $item = $pool->getItem('test');
        $item->set('test');
        $pool->save($item);
        $this->assertSame($isHit, $pool->getItem('test')->isHit());
    }

    /**
     * Data provider for testOnKernelRequest.
     * Provides various combinations of request arguments and configuration,
     * as well as the expected behavior.
     */
    public function dataProvider(): array
    {
        return [
            [null, [], [], [], [], true],
            [null, ['bypass_cache' => 1], [], [], [], true],
            [null, [], ['bypass_cache' => 1], [], [], true],
            [null, [], [], ['bypass_cache' => 1], [], true],
            [null, [], [], [], ['bypass_cache' => 1], true],

            ['bypass_cache', ['bypass_cache' => 1], [], [], [], false],
            ['bypass_cache', [], ['bypass_cache' => 1], [], [], false],
            ['bypass_cache', [], [], ['bypass_cache' => 1], [], false],
            ['bypass_cache', [], [], [], ['bypass_cache' => 1], false],
        ];
    }
}