OAuthEventListenerTest::getScopeFinder() - Code Metrics - Inspection of "v1.17.0" - PROCERGS/login-cidadao - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#735)

by Guilherme

created 2017-11-14 18:34 UTC

OAuthEventListenerTest::getScopeFinder() A

↳ Parent: OAuthEventListenerTest

Complexity

Conditions	2
Paths	2

Size

Total Lines	11
Code Lines	6

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	2
eloc	6
nc	2
nop	1
dl	0
loc	11
rs	9.4285
c	0
b	0
f	0

<?php
/**
 * This file is part of the login-cidadao project or it's bundles.
 *
 * (c) Guilherme Donato <guilhermednt on github>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace LoginCidadao\OAuthBundle\Tests\EventListener;

use Doctrine\ORM\EntityManagerInterface;
use FOS\OAuthServerBundle\Event\OAuthEvent;
use LoginCidadao\CoreBundle\Entity\Authorization;
use LoginCidadao\CoreBundle\Entity\Person;
use LoginCidadao\CoreBundle\Model\PersonInterface;
use LoginCidadao\OAuthBundle\Entity\Client;
use LoginCidadao\OAuthBundle\EventListener\OAuthEventListener;
use LoginCidadao\OAuthBundle\Helper\ScopeFinderHelper;
use LoginCidadao\OpenIDBundle\Service\SubjectIdentifierService;

class OAuthEventListenerTest extends \PHPUnit_Framework_TestCase
{
    public function testOnPreAuthorizationProcessNotPreAuthorized()
    {
        $person = $this->getPerson();
        $person->expects($this->once())->method('isAuthorizedClient')->willReturn(false);
class A
{
    public function foo() { }
}

class B extends A
{
    public function bar() { }
}

/**
 * @param A|B $x
 */
function someFunction($x)
{
    $x->foo(); // This call is fine as the method exists in A and B.
    $x->bar(); // This method only exists in B and might cause an error.
}

        $personRepo = $this->getPersonRepository();
        $personRepo->expects($this->once())->method('findOneBy')->willReturn($person);

        $em = $this->getEntityManager(['LoginCidadaoCoreBundle:Person' => $personRepo]);

        $subIdService = $this->getSubjectIdentifierService();

        $listener = new OAuthEventListener($em, $this->getScopeFinder(['openid']), $subIdService);
/**
 * @return array|string
 */
function returnsDifferentValues($x) {
    if ($x) {
        return 'foo';
    }

    return array();
}

$x = returnsDifferentValues($y);
if (is_array($x)) {
    // $x is an array.
}

        $event = new OAuthEvent($person, new Client(), false);
        $listener->onPreAuthorizationProcess($event);
    }

    public function testOnPreAuthorizationProcessPreAuthorizedSubNotPersisted()
    {
        $sub = 'abc123';

        $person = $this->getPerson();
        $person->expects($this->once())->method('isAuthorizedClient')->willReturn(true);
class A
{
    public function foo() { }
}

class B extends A
{
    public function bar() { }
}

/**
 * @param A|B $x
 */
function someFunction($x)
{
    $x->foo(); // This call is fine as the method exists in A and B.
    $x->bar(); // This method only exists in B and might cause an error.
}

        $personRepo = $this->getPersonRepository();
        $personRepo->expects($this->once())->method('findOneBy')->willReturn($person);

        $em = $this->getEntityManager(['LoginCidadaoCoreBundle:Person' => $personRepo]);
        $em->expects($this->once())->method('persist')
class A
{
    public function foo() { }
}

class B extends A
{
    public function bar() { }
}

/**
 * @param A|B $x
 */
function someFunction($x)
{
    $x->foo(); // This call is fine as the method exists in A and B.
    $x->bar(); // This method only exists in B and might cause an error.
}
            ->with($this->isInstanceOf('LoginCidadao\OpenIDBundle\Entity\SubjectIdentifier'));

        $subIdService = $this->getSubjectIdentifierService();
        $subIdService->expects($this->once())->method('isSubjectIdentifierPersisted')->willReturn(false);
class A
{
    public function foo() { }
}

class B extends A
{
    public function bar() { }
}

/**
 * @param A|B $x
 */
function someFunction($x)
{
    $x->foo(); // This call is fine as the method exists in A and B.
    $x->bar(); // This method only exists in B and might cause an error.
}
        $subIdService->expects($this->once())->method('getSubjectIdentifier')->willReturn($sub);

        $listener = new OAuthEventListener($em, $this->getScopeFinder(['openid']), $subIdService);
/**
 * @return array|string
 */
function returnsDifferentValues($x) {
    if ($x) {
        return 'foo';
    }

    return array();
}

$x = returnsDifferentValues($y);
if (is_array($x)) {
    // $x is an array.
}

        $event = new OAuthEvent($person, new Client(), false);
        $listener->onPreAuthorizationProcess($event);
    }

    public function testOnPreAuthorizationProcessPreAuthorizedSubPersisted()
    {
        $person = $this->getPerson();
        $person->expects($this->once())->method('isAuthorizedClient')->willReturn(true);
class A
{
    public function foo() { }
}

class B extends A
{
    public function bar() { }
}

/**
 * @param A|B $x
 */
function someFunction($x)
{
    $x->foo(); // This call is fine as the method exists in A and B.
    $x->bar(); // This method only exists in B and might cause an error.
}

        $personRepo = $this->getPersonRepository();
        $personRepo->expects($this->once())->method('findOneBy')->willReturn($person);

        $em = $this->getEntityManager(['LoginCidadaoCoreBundle:Person' => $personRepo]);

        $subIdService = $this->getSubjectIdentifierService();
        $subIdService->expects($this->once())->method('isSubjectIdentifierPersisted')->willReturn(true);
class A
{
    public function foo() { }
}

class B extends A
{
    public function bar() { }
}

/**
 * @param A|B $x
 */
function someFunction($x)
{
    $x->foo(); // This call is fine as the method exists in A and B.
    $x->bar(); // This method only exists in B and might cause an error.
}

        $listener = new OAuthEventListener($em, $this->getScopeFinder(['openid']), $subIdService);
/**
 * @return array|string
 */
function returnsDifferentValues($x) {
    if ($x) {
        return 'foo';
    }

    return array();
}

$x = returnsDifferentValues($y);
if (is_array($x)) {
    // $x is an array.
}

        $event = new OAuthEvent($person, new Client(), false);
        $listener->onPreAuthorizationProcess($event);
    }

    public function testOnPreAuthorizationProcessNoUser()
    {
        $person = $this->getPerson();
        $personRepo = $this->getPersonRepository();
        $personRepo->expects($this->once())->method('findOneBy')->willReturn(null);

        $em = $this->getEntityManager(['LoginCidadaoCoreBundle:Person' => $personRepo]);

        $subIdService = $this->getSubjectIdentifierService();

        $event = new OAuthEvent($person, new Client(), false);

        $listener = new OAuthEventListener($em, $this->getScopeFinder(['openid']), $subIdService);
/**
 * @return array|string
 */
function returnsDifferentValues($x) {
    if ($x) {
        return 'foo';
    }

    return array();
}

$x = returnsDifferentValues($y);
if (is_array($x)) {
    // $x is an array.
}
        $listener->onPreAuthorizationProcess($event);
    }

    public function testOnPostAuthorizationProcessNotAuthorized()
    {
        $event = new OAuthEvent(new Person(), new Client(), false);
        $listener = new OAuthEventListener($this->getEntityManager(), $this->getScopeFinder(['openid']),

            $this->getSubjectIdentifierService());

        $listener->onPostAuthorizationProcess($event);
    }

    public function testOnPostAuthorizationProcessNewAuth()
    {
        $sub = 'abc123';

        $person = $this->getPerson();
        $personRepo = $this->getPersonRepository();
        $personRepo->expects($this->once())->method('findOneBy')->willReturn($person);

        $authRepo = $this->getAuthorizationRepository();
        $em = $this->getEntityManager([
            'LoginCidadaoCoreBundle:Person' => $personRepo,
            'LoginCidadaoCoreBundle:Authorization' => $authRepo,
        ]);
        $em->expects($this->exactly(2))->method('persist');
class A
{
    public function foo() { }
}

class B extends A
{
    public function bar() { }
}

/**
 * @param A|B $x
 */
function someFunction($x)
{
    $x->foo(); // This call is fine as the method exists in A and B.
    $x->bar(); // This method only exists in B and might cause an error.
}

        $subIdService = $this->getSubjectIdentifierService();
        $subIdService->expects($this->once())->method('getSubjectIdentifier')->willReturn($sub);
class A
{
    public function foo() { }
}

class B extends A
{
    public function bar() { }
}

/**
 * @param A|B $x
 */
function someFunction($x)
{
    $x->foo(); // This call is fine as the method exists in A and B.
    $x->bar(); // This method only exists in B and might cause an error.
}

        $event = new OAuthEvent(new Person(), new Client(), true);
        $listener = new OAuthEventListener($em, $this->getScopeFinder(['openid']), $subIdService);
/**
 * @return array|string
 */
function returnsDifferentValues($x) {
    if ($x) {
        return 'foo';
    }

    return array();
}

$x = returnsDifferentValues($y);
if (is_array($x)) {
    // $x is an array.
}
        $listener->onPostAuthorizationProcess($event);
    }

    public function testOnPostAuthorizationProcessMergeAuth()
    {
        $client = new Client();
        $person = $this->getPerson();
        $personRepo = $this->getPersonRepository();
        $personRepo->expects($this->once())->method('findOneBy')->willReturn($person);

        $auth = new Authorization();
        $auth->setPerson($person);
/**
 * @return array|string
 */
function returnsDifferentValues($x) {
    if ($x) {
        return 'foo';
    }

    return array();
}

$x = returnsDifferentValues($y);
if (is_array($x)) {
    // $x is an array.
}
        $auth->setClient($client);
        $auth->setScope(['scope1', 'scope2']);

        $authRepo = $this->getAuthorizationRepository();
        $authRepo->expects($this->once())->method('findOneBy')->willReturn($auth);

        $em = $this->getEntityManager([
            'LoginCidadaoCoreBundle:Person' => $personRepo,
            'LoginCidadaoCoreBundle:Authorization' => $authRepo,
        ]);

        $subIdService = $this->getSubjectIdentifierService();
        $subIdService->expects($this->once())->method('isSubjectIdentifierPersisted')->willReturn(true);
class A
{
    public function foo() { }
}

class B extends A
{
    public function bar() { }
}

/**
 * @param A|B $x
 */
function someFunction($x)
{
    $x->foo(); // This call is fine as the method exists in A and B.
    $x->bar(); // This method only exists in B and might cause an error.
}

        $event = new OAuthEvent($person, $client, true);
        $listener = new OAuthEventListener($em, $this->getScopeFinder(['scope1', 'scope2', 'scope3']), $subIdService);
/**
 * @return array|string
 */
function returnsDifferentValues($x) {
    if ($x) {
        return 'foo';
    }

    return array();
}

$x = returnsDifferentValues($y);
if (is_array($x)) {
    // $x is an array.
}
        $listener->onPostAuthorizationProcess($event);

        $this->assertContains('scope3', $auth->getScope());
    }

    /**
     * @param array $repos
     * @return EntityManagerInterface|\PHPUnit_Framework_MockObject_MockObject
     */
    private function getEntityManager(array $repos = [])
    {
        $em = $this->getMock('Doctrine\ORM\EntityManagerInterface');

        if (count($repos) > 0) {
            $em->expects($this->atLeastOnce())->method('getRepository')->with($this->isType('string'))
                ->willReturnCallback(function ($key) use ($repos) {
                    return $repos[$key];
                });
        }

        return $em;
    }

    private function getPersonRepository()

    {
        return $this->getMockBuilder('LoginCidadao\CoreBundle\Entity\PersonRepository')
            ->disableOriginalConstructor()->getMock();
    }

    private function getAuthorizationRepository()

    {
        return $this->getMockBuilder('LoginCidadao\CoreBundle\Entity\AuthorizationRepository')
            ->disableOriginalConstructor()->getMock();
    }

    /**
     * @return SubjectIdentifierService|\PHPUnit_Framework_MockObject_MockObject
     */
    private function getSubjectIdentifierService()
    {
        return $this->getMockBuilder('LoginCidadao\OpenIDBundle\Service\SubjectIdentifierService')
            ->disableOriginalConstructor()->getMock();
    }

    /**
     * @return PersonInterface|\PHPUnit_Framework_MockObject_MockObject
     */
    private function getPerson()
    {
        return $this->getMock('LoginCidadao\CoreBundle\Model\PersonInterface');
    }

    /**
     * @param array|null $scope
     * @return ScopeFinderHelper|\PHPUnit_Framework_MockObject_MockObject
     */
    private function getScopeFinder(array $scope = null)
    {
        $helper = $this->getMockBuilder('LoginCidadao\OAuthBundle\Helper\ScopeFinderHelper')
            ->disableOriginalConstructor()->getMock();

        if ($scope) {
            $helper->expects($this->any())->method('getScope')->willReturn($scope);
        }

        return $helper;
    }
}


Pull Request — master (#735)

OAuthEventListenerTest::getScopeFinder() A

Complexity

Size

Duplication

Importance

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

1			<?php
2			/**
3			* This file is part of the login-cidadao project or it's bundles.
4			*
5			* (c) Guilherme Donato <guilhermednt on github>
6			*
7			* For the full copyright and license information, please view the LICENSE
8			* file that was distributed with this source code.
9			*/
10
11			namespace LoginCidadao\OAuthBundle\Tests\EventListener;
12
13			use Doctrine\ORM\EntityManagerInterface;
14			use FOS\OAuthServerBundle\Event\OAuthEvent;
15			use LoginCidadao\CoreBundle\Entity\Authorization;
16			use LoginCidadao\CoreBundle\Entity\Person;
17			use LoginCidadao\CoreBundle\Model\PersonInterface;
18			use LoginCidadao\OAuthBundle\Entity\Client;
19			use LoginCidadao\OAuthBundle\EventListener\OAuthEventListener;
20			use LoginCidadao\OAuthBundle\Helper\ScopeFinderHelper;
21			use LoginCidadao\OpenIDBundle\Service\SubjectIdentifierService;
22
23			class OAuthEventListenerTest extends \PHPUnit_Framework_TestCase
24			{
25			public function testOnPreAuthorizationProcessNotPreAuthorized()
26			{
27			$person = $this->getPerson();
28			$person->expects($this->once())->method('isAuthorizedClient')->willReturn(false);
			0 ignored issues – show Bug introduced 2017-11-08 13:11 UTC by Report Bug Copy Issue Report The method `expects` does only exist in `PHPUnit_Framework_MockObject_MockObject`, but not in `LoginCidadao\CoreBundle\Model\PersonInterface`. It seems like the method you are trying to call exists only in some of the possible types. Let’s take a look at an example: class A { public function foo() { } } class B extends A { public function bar() { } } /** * @param A\|B $x / function someFunction($x) { $x->foo(); // This call is fine as the method exists in A and B. $x->bar(); // This method only exists in B and might cause an error. } Available Fixes Add an additional type-check: /* * @param A\|B $x / function someFunction($x) { $x->foo(); if ($x instanceof B) { $x->bar(); } } Only allow a single type to be passed if the variable comes from a parameter: function someFunction(B $x) { /* ... */ } Loading history...
29
30			$personRepo = $this->getPersonRepository();
31			$personRepo->expects($this->once())->method('findOneBy')->willReturn($person);
32
33			$em = $this->getEntityManager(['LoginCidadaoCoreBundle:Person' => $personRepo]);
34
35			$subIdService = $this->getSubjectIdentifierService();
36
37			$listener = new OAuthEventListener($em, $this->getScopeFinder(['openid']), $subIdService);
			0 ignored issues – show Bug introduced 2017-11-08 13:11 UTC by Report Bug Copy Issue Report It seems like `$em` defined by `$this->getEntityManager(...erson' => $personRepo))` on line `33` can also be of type `object<PHPUnit_Framework_MockObject_MockObject>`; however, `LoginCidadao\OAuthBundle...Listener::__construct()` does only seem to accept `object<Doctrine\ORM\EntityManagerInterface>`, maybe add an additional type check? If a method or function can return multiple different values and unless you are sure that you only can receive a single value in this context, we recommend to add an additional type check: /** * @return array\|string / function returnsDifferentValues($x) { if ($x) { return 'foo'; } return array(); } $x = returnsDifferentValues($y); if (is_array($x)) { // $x is an array. } If this a common case that PHP Analyzer should handle natively, please let us know by opening an issue. Loading history... Bug introduced 2017-11-08 13:11 UTC by Report Bug Copy Issue Report It seems like `$this->getScopeFinder(array('openid'))` targeting `LoginCidadao\OAuthBundle...rTest::getScopeFinder()` can also be of type `object<PHPUnit_Framework_MockObject_MockObject>`; however, `LoginCidadao\OAuthBundle...Listener::__construct()` does only seem to accept `object<LoginCidadao\OAut...lper\ScopeFinderHelper>`, maybe add an additional type check? This check looks at variables that are passed out again to other methods. If the outgoing method call has stricter type requirements than the method itself, an issue is raised. An additional type check may prevent trouble. Loading history... Bug introduced 2017-11-08 13:11 UTC by Report Bug Copy Issue Report It seems like `$subIdService` defined by `$this->getSubjectIdentifierService()` on line `35` can also be of type `object<PHPUnit_Framework_MockObject_MockObject>`; however, `LoginCidadao\OAuthBundle...Listener::__construct()` does only seem to accept `object<LoginCidadao\Open...bjectIdentifierService>`, maybe add an additional type check? If a method or function can return multiple different values and unless you are sure that you only can receive a single value in this context, we recommend to add an additional type check: /* * @return array\|string */ function returnsDifferentValues($x) { if ($x) { return 'foo'; } return array(); } $x = returnsDifferentValues($y); if (is_array($x)) { // $x is an array. } If this a common case that PHP Analyzer should handle natively, please let us know by opening an issue. Loading history...
38

PROCERGS / login-cidadao

Pull Request — master (#735)

OAuthEventListenerTest::getScopeFinder() A

Complexity

Size

Duplication

Importance

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like