Completed
Pull Request — master (#10)
by
unknown
03:36 queued 21s
created

UpdateUserHandlerTest::testUpdateUserGetsHandled()   B

Complexity

Conditions 1
Paths 1

Size

Total Lines 31
Code Lines 20

Duplication

Lines 0
Ratio 0 %

Importance

Changes 2
Bugs 0 Features 1
Metric Value
c 2
b 0
f 1
dl 0
loc 31
rs 8.8571
cc 1
eloc 20
nc 1
nop 0
1
<?php
2
3
namespace SumoCoders\FrameworkMultiUserBundle\Tests\Command;
4
5
use SumoCoders\FrameworkMultiUserBundle\Command\UpdateUser;
6
use SumoCoders\FrameworkMultiUserBundle\Command\UpdateUserHandler;
7
use SumoCoders\FrameworkMultiUserBundle\User\InMemoryUserRepository;
8
9
class UpdateUserHandlerTest extends \PHPUnit_Framework_TestCase
10
{
11
    private $userRepository;
12
13
    public function setUp()
14
    {
15
        $this->userRepository = new InMemoryUserRepository();
16
    }
17
18
    /**
19
     * Test if UpdateUserHandler gets handled.
20
     */
21
    public function testUpdateUserGetsHandled()
22
    {
23
        $handler = new UpdateUserHandler($this->userRepository);
24
25
        $updatingUser = $this->userRepository->findByUsername('wouter');
26
27
        $command = new UpdateUser($updatingUser, 'wouter', 'randomPassword', 'sumocoders');
0 ignored issues
show
Documentation introduced by
$updatingUser is of type object<Symfony\Component...ser\UserInterface>|null, but the function expects a object<SumoCoders\Framew...tiUserBundle\User\User>.

It seems like the type of the argument is not accepted by the function/method which you are calling.

In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug.

We suggest to add an explicit type cast like in the following example:

function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
Loading history...
28
29
        $handler->handle($command);
30
31
        $this->assertEquals(
32
            'wouter',
33
            $this->userRepository->findByUsername('wouter')->getUsername()
34
        );
35
        $this->assertEquals(
36
            'sumocoders',
37
            $this->userRepository->findByUsername('wouter')->getDisplayName()
0 ignored issues
show
Bug introduced by
It seems like you code against a concrete implementation and not the interface Symfony\Component\Security\Core\User\UserInterface as the method getDisplayName() does only exist in the following implementations of said interface: SumoCoders\FrameworkMultiUserBundle\User\User.

Let’s take a look at an example:

interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}

In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different implementation of User which does not have a getDisplayName() method, the code will break.

Available Fixes

  1. Change the type-hint for the parameter:

    class AuthSystem
    {
        public function authenticate(MyUser $user) { /* ... */ }
    }
    
  2. Add an additional type-check:

    class AuthSystem
    {
        public function authenticate(User $user)
        {
            if ($user instanceof MyUser) {
                $this->logger->info(/** ... */);
            }
    
            // or alternatively
            if ( ! $user instanceof MyUser) {
                throw new \LogicException(
                    '$user must be an instance of MyUser, '
                   .'other instances are not supported.'
                );
            }
    
        }
    }
    
Note: PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case.
  1. Add the method to the interface:

    interface User
    {
        /** @return string */
        public function getPassword();
    
        /** @return string */
        public function getDisplayName();
    }
    
Loading history...
38
        );
39
        $this->assertEquals(
40
            'randomPassword',
41
            $this->userRepository->findByUsername('wouter')->getPassword()
42
        );
43
        $this->assertNotEquals(
44
            $updatingUser->getDisplayName(),
45
            $this->userRepository->findByUsername('wouter')->getDisplayName()
0 ignored issues
show
Bug introduced by
It seems like you code against a concrete implementation and not the interface Symfony\Component\Security\Core\User\UserInterface as the method getDisplayName() does only exist in the following implementations of said interface: SumoCoders\FrameworkMultiUserBundle\User\User.

Let’s take a look at an example:

interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}

In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different implementation of User which does not have a getDisplayName() method, the code will break.

Available Fixes

  1. Change the type-hint for the parameter:

    class AuthSystem
    {
        public function authenticate(MyUser $user) { /* ... */ }
    }
    
  2. Add an additional type-check:

    class AuthSystem
    {
        public function authenticate(User $user)
        {
            if ($user instanceof MyUser) {
                $this->logger->info(/** ... */);
            }
    
            // or alternatively
            if ( ! $user instanceof MyUser) {
                throw new \LogicException(
                    '$user must be an instance of MyUser, '
                   .'other instances are not supported.'
                );
            }
    
        }
    }
    
Note: PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case.
  1. Add the method to the interface:

    interface User
    {
        /** @return string */
        public function getPassword();
    
        /** @return string */
        public function getDisplayName();
    }
    
Loading history...
46
        );
47
        $this->assertNotEquals(
48
            $updatingUser->getPassword(),
49
            $this->userRepository->findByUsername('wouter')->getPassword()
50
        );
51
    }
52
}
53