CsrfListenerTest - Code Metrics - Inspection of "Fix CS" - ezsystems/ezpublish-kernel - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — EZP-26146-location-swap-urlali... ( 334d77...8d4853 )

unknown

created 2016-09-26 13:51 UTC

CsrfListenerTest A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	309
Duplicated Lines	17.15 %

Coupling/Cohesion

Components	1
Dependencies	3

Importance

Changes

Metric	Value
c	0
b	0
f	0
dl	53
loc	309
rs	10
wmc	28
lcom	1
cbo	3

18 Methods

Rating	Name	Duplication	Size	Complexity
A	provideExpectedSubscribedEventTypes()	0	6	1
A	testIsNotRestRequest()	0	12	1
A	testCsrfDisabled()	9	9	1
A	testNoSessionStarted()	10	10	1
A	testIgnoredRequestMethods()	0	8	1
A	getIgnoredRequestMethods()	0	8	1
A	testSessionRequests()	0	7	1
A	testNoHeader()	0	6	1
A	testInvalidToken()	0	6	1
A	testValidToken()	0	8	1
A	getCsrfProviderMock()	0	19	2
A	getEventMock()	13	13	2
A	getSessionMock()	0	12	2
B	getRequestHeadersMock()	0	30	3
B	getRequestMock()	21	31	4
A	getEventDispatcherMock()	0	10	2
A	getEventListener()	0	17	2
A	provideSessionRoutes()	0	8	1

How to fix Duplicated Code

<?php

/**
 * File containing the RestValueResponseListener class.
 *
 * @copyright Copyright (C) eZ Systems AS. All rights reserved.
 * @license For full copyright and license information view LICENSE file distributed with this source code.
 *
 * @version //autogentag//
 */
namespace eZ\Bundle\EzPublishRestBundle\Tests\EventListener;

use PHPUnit_Framework_MockObject_MockObject;
use Symfony\Component\EventDispatcher\EventDispatcherInterface;
use Symfony\Component\HttpFoundation\ParameterBag;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\HttpKernel\Event\GetResponseEvent;
use Symfony\Component\Form\Extension\Csrf\CsrfProvider\CsrfProviderInterface;
use eZ\Bundle\EzPublishRestBundle\EventListener\CsrfListener;
use Symfony\Component\HttpKernel\KernelEvents;
use Symfony\Component\Security\Csrf\CsrfToken;

class CsrfListenerTest extends EventListenerTest
{
    const VALID_TOKEN = 'valid';
    const INVALID_TOKEN = 'invalid';
    const INTENTION = 'rest';

    /** @var EventDispatcherInterface */
    protected $eventDispatcherMock;

    /**
     * If set to null before initializing mocks, Request::getSession() is expected not to be called.
     *
     * @var \Symfony\Component\HttpFoundation\Session\SessionInterface
     */
    protected $sessionMock;

    protected $sessionIsStarted = true;

    protected $csrfTokenHeaderValue = self::VALID_TOKEN;

    /**
     * Route returned by Request::get( '_route' )
     * If set to false, get( '_route' ) is expected not to be called.
     *
     * @var string
     */
    protected $route = 'ezpublish_rest_something';

    /**
     * If set to false, Request::getRequestMethod() is expected not to be called.
     */
    protected $requestMethod = 'POST';

    public function provideExpectedSubscribedEventTypes()
    {
        return array(
            array(array(KernelEvents::REQUEST)),
        );
    }

    public function testIsNotRestRequest()
    {
        $this->isRestRequest = false;

        $this->requestMethod = false;
$answer = 42;

$correct = false;

$correct = (bool) $answer;
        $this->sessionMock = false;

        $this->route = false;
$answer = 42;

$correct = false;

$correct = (bool) $answer;
        $this->csrfTokenHeaderValue = null;

        $listener = $this->getEventListener();
        $listener->onKernelRequest($this->getEventMock());
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
    }

    public function testCsrfDisabled()
    {
        $this->requestMethod = false;
$answer = 42;

$correct = false;

$correct = (bool) $answer;
        $this->sessionMock = false;

        $this->route = false;
$answer = 42;

$correct = false;

$correct = (bool) $answer;
        $this->csrfTokenHeaderValue = null;

        $this->getEventListener(false)->onKernelRequest($this->getEventMock());
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
    }

    public function testNoSessionStarted()
    {
        $this->sessionIsStarted = false;

        $this->requestMethod = false;
$answer = 42;

$correct = false;

$correct = (bool) $answer;
        $this->route = false;
$answer = 42;

$correct = false;

$correct = (bool) $answer;
        $this->csrfTokenHeaderValue = null;

        $this->getEventListener()->onKernelRequest($this->getEventMock());
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
    }

    /**
     * Tests that method CSRF check don't apply to are indeed ignored.
     *
     * @param string $ignoredMethod
     * @dataProvider getIgnoredRequestMethods
     */
    public function testIgnoredRequestMethods($ignoredMethod)
    {
        $this->requestMethod = $ignoredMethod;
        $this->route = false;
$answer = 42;

$correct = false;

$correct = (bool) $answer;
        $this->csrfTokenHeaderValue = null;

        $this->getEventListener()->onKernelRequest($this->getEventMock());
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
    }

    public function getIgnoredRequestMethods()
    {
        return array(
            array('GET'),
            array('HEAD'),
            array('OPTIONS'),
        );
    }

    /**
     * @dataProvider provideSessionRoutes
     */
    public function testSessionRequests($route)
    {
        $this->route = $route;
        $this->csrfTokenHeaderValue = null;

        $this->getEventListener()->onKernelRequest($this->getEventMock());
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
    }

    public static function provideSessionRoutes()
    {
        return [
            ['ezpublish_rest_createSession'],
            ['ezpublish_rest_refreshSession'],
            ['ezpublish_rest_deleteSession'],
        ];
    }

    /**
     * @expectedException \eZ\Publish\Core\Base\Exceptions\UnauthorizedException
     */
    public function testNoHeader()
    {
        $this->csrfTokenHeaderValue = false;

        $this->getEventListener()->onKernelRequest($this->getEventMock());
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
    }

    /**
     * @expectedException \eZ\Publish\Core\Base\Exceptions\UnauthorizedException
     */
    public function testInvalidToken()
    {
        $this->csrfTokenHeaderValue = self::INVALID_TOKEN;

        $this->getEventListener()->onKernelRequest($this->getEventMock());
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
    }

    public function testValidToken()
    {
        $this->getEventDispatcherMock()
            ->expects($this->once())
            ->method('dispatch');

        $this->getEventListener()->onKernelRequest($this->getEventMock());
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
    }

    /**
     * @return CsrfProviderInterface|PHPUnit_Framework_MockObject_MockObject
     */
    protected function getCsrfProviderMock()
    {
        $provider = $this->getMock('\Symfony\Component\Security\Csrf\CsrfTokenManagerInterface');
        $provider->expects($this->any())
            ->method('isTokenValid')
            ->will(
                $this->returnCallback(
                    function (CsrfToken $token) {
                        if ($token == new CsrfToken(self::INTENTION, self::VALID_TOKEN)) {
                            return true;
                        }

                        return false;
                    }
                )
            );

        return $provider;
    }

    /**
     * @return PHPUnit_Framework_MockObject_MockObject|GetResponseEvent
     */
    protected function getEventMock($class = null)
    {
        if (!isset($this->eventMock)) {
            parent::getEventMock('Symfony\Component\HttpKernel\Event\GetResponseEvent');

            $this->eventMock

                ->expects($this->any())
                ->method('getRequestType')
                ->will($this->returnValue($this->requestType));
        }

        return $this->eventMock;
    }

    /**
     * @return \Symfony\Component\HttpFoundation\Session\SessionInterface|PHPUnit_Framework_MockObject_MockObject
     */
    protected function getSessionMock()
    {
        if (!isset($this->sessionMock)) {
            $this->sessionMock = $this->getMock('Symfony\Component\HttpFoundation\Session\SessionInterface');
            $this->sessionMock
                ->expects($this->atLeastOnce())
                ->method('isStarted')
                ->will($this->returnValue($this->sessionIsStarted));
        }

        return $this->sessionMock;
    }

    /**
     * @return ParameterBag|PHPUnit_Framework_MockObject_MockObject
     */
    protected function getRequestHeadersMock()
    {
        if (!isset($this->requestHeadersMock)) {
            $this->requestHeadersMock = parent::getRequestHeadersMock();

            if ($this->csrfTokenHeaderValue === null) {
                $this->requestHeadersMock
                    ->expects($this->never())
                    ->method('has');

                $this->requestHeadersMock
                    ->expects($this->never())
                    ->method('get');
            } else {
                $this->requestHeadersMock
                    ->expects($this->atLeastOnce())
                    ->method('has')
                    ->with(CsrfListener::CSRF_TOKEN_HEADER)
                    ->will($this->returnValue(true));

                $this->requestHeadersMock
                    ->expects($this->atLeastOnce())
                    ->method('get')
                    ->with(CsrfListener::CSRF_TOKEN_HEADER)
                    ->will($this->returnValue($this->csrfTokenHeaderValue));
            }
        }

        return $this->requestHeadersMock;
    }

    /**
     * @return PHPUnit_Framework_MockObject_MockObject|Request
     */
    protected function getRequestMock()
    {
        if (!isset($this->requestMock)) {
            $this->requestMock = parent::getRequestMock();

            if ($this->sessionMock === false) {

                $this->requestMock
                    ->expects($this->never())
                    ->method('getSession');
            } else {
                $this->requestMock
                    ->expects($this->atLeastOnce())
                    ->method('getSession')
                    ->will($this->returnValue($this->getSessionMock()));
            }

            if ($this->route === false) {

                $this->requestMock
                    ->expects($this->never())
                    ->method('get');
            } else {
                $this->requestMock
                    ->expects($this->atLeastOnce())
                    ->method('get')
                    ->with('_route')
                    ->will($this->returnValue($this->route));
            }
        }

        return $this->requestMock;
    }

    /**
     * @return PHPUnit_Framework_MockObject_MockObject|EventDispatcherInterface
     */
    protected function getEventDispatcherMock()
    {
        if (!isset($this->eventDispatcherMock)) {
            $this->eventDispatcherMock = $this->getMock(
                'Symfony\Component\EventDispatcher\EventDispatcherInterface'
            );
        }

        return $this->eventDispatcherMock;
    }

    /**
     * @param bool $csrfEnabled
     *
     * @return CsrfListener
     */
    protected function getEventListener($csrfEnabled = true)
    {
        if ($csrfEnabled) {
            return new CsrfListener(
                $this->getEventDispatcherMock(),

                $csrfEnabled,
                self::INTENTION,
                $this->getCsrfProviderMock()

            );
        }

        return new CsrfListener(
            $this->getEventDispatcherMock(),

            $csrfEnabled,
            self::INTENTION
        );
    }
}


1			<?php
2
3			/**
4			* File containing the RestValueResponseListener class.
5			*
6			* @copyright Copyright (C) eZ Systems AS. All rights reserved.
7			* @license For full copyright and license information view LICENSE file distributed with this source code.
8			*
9			* @version //autogentag//
10			*/
11			namespace eZ\Bundle\EzPublishRestBundle\Tests\EventListener;
12
13			use PHPUnit_Framework_MockObject_MockObject;
14			use Symfony\Component\EventDispatcher\EventDispatcherInterface;
15			use Symfony\Component\HttpFoundation\ParameterBag;
16			use Symfony\Component\HttpFoundation\Request;
17			use Symfony\Component\HttpKernel\Event\GetResponseEvent;
18			use Symfony\Component\Form\Extension\Csrf\CsrfProvider\CsrfProviderInterface;
19			use eZ\Bundle\EzPublishRestBundle\EventListener\CsrfListener;
20			use Symfony\Component\HttpKernel\KernelEvents;
21			use Symfony\Component\Security\Csrf\CsrfToken;
22
23			class CsrfListenerTest extends EventListenerTest
24			{
25			const VALID_TOKEN = 'valid';
26			const INVALID_TOKEN = 'invalid';
27			const INTENTION = 'rest';
28
29			/** @var EventDispatcherInterface */
30			protected $eventDispatcherMock;
31
32			/**
33			* If set to null before initializing mocks, Request::getSession() is expected not to be called.
34			*
35			* @var \Symfony\Component\HttpFoundation\Session\SessionInterface
36			*/
37			protected $sessionMock;
38
39			protected $sessionIsStarted = true;
40

ezsystems / ezpublish-kernel

Push — EZP-26146-location-swap-urlali... ( 334d77...8d4853 )

CsrfListenerTest A

Complexity

Size/Duplication

Coupling/Cohesion

Importance

18 Methods

How to fix Duplicated Code

Duplicated Code

Duplication Side-by-Side

Filter issues like