Completed
Pull Request — master (#10)
by
unknown
08:37
created

UpdateUserHandlerTest::testUpdateUserGetsHandled()   B

Complexity

Conditions 1
Paths 1

Size

Total Lines 36
Code Lines 24

Duplication

Lines 0
Ratio 0 %

Importance

Changes 1
Bugs 0 Features 1
Metric Value
c 1
b 0
f 1
dl 0
loc 36
rs 8.8571
cc 1
eloc 24
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
        $command = new UpdateUser();
26
        $command->username = 'wouter';
27
        $command->displayName = 'sumocoders';
28
        $command->password = 'randomPassword';
29
30
        $updatingUser = $this->userRepository->findByUsername('wouter');
31
32
        $command->user = $updatingUser;
0 ignored issues
show
Documentation Bug introduced by
It seems like $updatingUser can also be of type object<Symfony\Component...ore\User\UserInterface>. However, the property $user is declared as type object<SumoCoders\Framew...tiUserBundle\User\User>. Maybe add an additional type check?

Our type inference engine has found a suspicous assignment of a value to a property. This check raises an issue when a value that can be of a mixed type is assigned to a property that is type hinted more strictly.

For example, imagine you have a variable $accountId that can either hold an Id object or false (if there is no account id yet). Your code now assigns that value to the id property of an instance of the Account class. This class holds a proper account, so the id value must no longer be false.

Either this assignment is in error or a type check should be added for that assignment.

class Id
{
    public $id;

    public function __construct($id)
    {
        $this->id = $id;
    }

}

class Account
{
    /** @var  Id $id */
    public $id;
}

$account_id = false;

if (starsAreRight()) {
    $account_id = new Id(42);
}

$account = new Account();
if ($account instanceof Id)
{
    $account->id = $account_id;
}
Loading history...
33
34
        $handler->handle($command);
35
36
        $this->assertEquals(
37
            'wouter',
38
            $this->userRepository->findByUsername('wouter')->getUsername()
39
        );
40
        $this->assertEquals(
41
            'sumocoders',
42
            $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...
43
        );
44
        $this->assertEquals(
45
            'randomPassword',
46
            $this->userRepository->findByUsername('wouter')->getPassword()
47
        );
48
        $this->assertNotEquals(
49
            $updatingUser->getDisplayName(),
50
            $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...
51
        );
52
        $this->assertNotEquals(
53
            $updatingUser->getPassword(),
54
            $this->userRepository->findByUsername('wouter')->getPassword()
55
        );
56
    }
57
}
58