symfony/tests/Symfony/Tests/Component/Security/Authentication/Token/TokenTest.php

<?php

/*
 * This file is part of the Symfony package.
 *
 * (c) Fabien Potencier <fabien.potencier@symfony-project.com>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Symfony\Tests\Component\Security\Authentication\Token;

use Symfony\Component\Security\Authentication\Token\Token as BaseToken;
use Symfony\Component\Security\Role\Role;

class Token extends BaseToken
{
    public function setCredentials($credentials)
    {
        $this->credentials = $credentials;
    }
}

class TestUser
{
    protected $name;

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

    public function __toString()
    {
        return $this->name;
    }
}

class TokenTest extends \PHPUnit_Framework_TestCase
{
    public function testMagicToString()
    {
        $token = new Token(array('ROLE_FOO'));
        $token->setUser('fabien');
        $this->assertEquals('fabien', (string) $token);

        $token->setUser(new TestUser('fabien'));
        $this->assertEquals('n/a', (string) $token);

        $user = $this->getMock('Symfony\Component\Security\User\AccountInterface');
        $user->expects($this->once())->method('getUsername')->will($this->returnValue('fabien'));

        $token->setUser($user);
        $this->assertEquals('fabien', (string) $token);
    }

    public function testEraseCredentials()
    {
        $token = new Token(array('ROLE_FOO'));

        $credentials = $this->getMock('Symfony\Component\Security\User\AccountInterface');
        $credentials->expects($this->once())->method('eraseCredentials');
        $token->setCredentials($credentials);

        $user = $this->getMock('Symfony\Component\Security\User\AccountInterface');
        $user->expects($this->once())->method('eraseCredentials');
        $token->setUser($user);

        $token->eraseCredentials();
    }

    public function testSerialize()
    {
        $token = new Token(array('ROLE_FOO'));

        $this->assertEquals($token, unserialize(serialize($token)));
    }

    /**
     * @covers Symfony\Component\Security\Authentication\Token\Token::__construct
     */
    public function testConstructor()
    {
        $token = new Token(array('ROLE_FOO'));
        $this->assertEquals(array(new Role('ROLE_FOO')), $token->getRoles());

        $token = new Token(array(new Role('ROLE_FOO')));
        $this->assertEquals(array(new Role('ROLE_FOO')), $token->getRoles());

        $token = new Token(array(new Role('ROLE_FOO'), 'ROLE_BAR'));
        $this->assertEquals(array(new Role('ROLE_FOO'), new Role('ROLE_BAR')), $token->getRoles());
    }

    /**
     * @covers Symfony\Component\Security\Authentication\Token\Token::addRole
     * @covers Symfony\Component\Security\Authentication\Token\Token::getRoles
     */
    public function testAddRole()
    {
        $token = new Token();
        $token->addRole(new Role('ROLE_FOO'));
        $this->assertEquals(array(new Role('ROLE_FOO')), $token->getRoles());

        $token->addRole(new Role('ROLE_BAR'));
        $this->assertEquals(array(new Role('ROLE_FOO'), new Role('ROLE_BAR')), $token->getRoles());
    }

    /**
     * @covers Symfony\Component\Security\Authentication\Token\Token::isAuthenticated
     * @covers Symfony\Component\Security\Authentication\Token\Token::setAuthenticated
     */
    public function testAuthenticatedFlag()
    {
        $token = new Token();
        $this->assertFalse($token->isAuthenticated());

        $token->setAuthenticated(true);
        $this->assertTrue($token->isAuthenticated());

        $token->setAuthenticated(false);
        $this->assertFalse($token->isAuthenticated());
    }

    /**
     * @covers Symfony\Component\Security\Authentication\Token\Token::isImmutable
     * @covers Symfony\Component\Security\Authentication\Token\Token::setImmutable
     */
    public function testImmutableFlag()
    {
        $token = new Token();
        $this->assertFalse($token->isImmutable());

        $token->setImmutable();
        $this->assertTrue($token->isImmutable());
    }

    /**
     * @expectedException \LogicException
     * @dataProvider getImmutabilityTests
     */
    public function testImmutabilityIsEnforced($setter, $value)
    {
        $token = new Token();
        $token->setImmutable(true);
        $token->$setter($value);
    }

    public function getImmutabilityTests()
    {
        return array(
            array('setUser', 'foo'),
            array('eraseCredentials', null),
            array('setAuthenticated', true),
            array('setAuthenticated', false),
            array('addRole', new Role('foo')),
            array('setRoles', array('foo', 'asdf')),
        );
    }
}