SessionTest.php

<?php

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

namespace Symfony\Tests\Component\HttpFoundation;

use Symfony\Component\HttpFoundation\Session;
use Symfony\Component\HttpFoundation\SessionStorage\ArraySessionStorage;

/**
 * SessionTest
 *
 * @author Fabien Potencier <fabien@symfony.com>
 * @author Robert Schönthal <seroscho@googlemail.com>
 */
class SessionTest extends \PHPUnit_Framework_TestCase
{
    /**
     * @var SessionStorage
     */
    protected $storage;
    
    /**
     * @var Session
     */
    protected $session;

    public function setUp()
    {
        $this->storage = new ArraySessionStorage();
        $this->session = $this->getSession();
    }

    protected function tearDown()
    {
        $this->storage = null;
        $this->session = null;
    }

    public function testFlash()
    {
        $this->session->clearFlashes();

        $this->assertSame(array(), $this->session->getFlashes());

        $this->assertFalse($this->session->hasFlash('foo'));

        $this->session->setFlash('foo', 'bar');

        $this->assertTrue($this->session->hasFlash('foo'));
        $this->assertSame('bar', $this->session->getFlash('foo'));

        $this->session->removeFlash('foo');

        $this->assertFalse($this->session->hasFlash('foo'));

        $flashes = array('foo' => 'bar', 'bar' => 'foo');

        $this->session->setFlashes($flashes);

        $this->assertSame($flashes, $this->session->getFlashes());

        $this->session->clearFlashes();
        $this->session->addFlash('foo');
        $compare = $this->session->getFlashes();
        $this->assertSame($compare, array(0 => 'foo'));
    }
    
    /**
     * @expectedException InvalidArgumentException
     */
    public function testGetFlashException()
    {
        $this->session->getFlash('foo', null, 'notexisting');
    }
    
    /**
     * @expectedException InvalidArgumentException
     */
    public function testHasFlashException()
    {
        $this->session->hasFlash('foo', 'notexisting');
    }
    
    public function testGetFlashes()
    {
        $this->assertEquals(array(), $this->session->getFlashes(Session::FLASH_INFO));
        $this->session->setFlash(Session::FLASH_INFO, 'hello');
        $this->assertEquals(array(Session::FLASH_INFO => 'hello'), $this->session->getFlashes(Session::FLASH_INFO));
    }
    
    /**
     * @expectedException InvalidArgumentException
     */
    public function testGetFlashesException()
    {
        $this->session->getFlashes('notexisting');
    }
    
    public function testSetFlashes()
    {
        $this->session->setFlashes(array('hello', 'world'));
        $this->assertEquals(array('hello', 'world'), $this->session->getFlashes(Session::FLASH_INFO));
    }
    
    public function testAllFlashes()
    {
        $this->assertEquals(array(Session::FLASH_INFO => array()), $this->session->getAllFlashes());
        $this->session->setAllFlashes(array(Session::FLASH_INFO => array('hello', 'world')));
        $this->assertEquals(array(Session::FLASH_INFO => array('hello', 'world')), $this->session->getAllFlashes());
    }

    public function testFlashesAreFlushedWhenNeeded()
    {
        $this->session->setFlash('foo', 'bar');
        $this->session->save();

        $this->session = $this->getSession();
        $this->assertTrue($this->session->hasFlash('foo'));
        $this->session->save();

        $this->session = $this->getSession();
        $this->assertFalse($this->session->hasFlash('foo'));
    }

    public function testAll()
    {
        $this->assertFalse($this->session->has('foo'));
        $this->assertNull($this->session->get('foo'));

        $this->session->set('foo', 'bar');

        $this->assertTrue($this->session->has('foo'));
        $this->assertSame('bar', $this->session->get('foo'));

        $this->session = $this->getSession();

        $this->session->remove('foo');
        $this->session->set('foo', 'bar');

        $this->session->remove('foo');

        $this->assertFalse($this->session->has('foo'));

        $attrs = array('foo' => 'bar', 'bar' => 'foo');

        $this->session = $this->getSession();

        $this->session->replace($attrs);

        $this->assertSame($attrs, $this->session->all());

        $this->session->clear();

        $this->assertSame(array(), $this->session->all());
    }

    public function testMigrateAndInvalidate()
    {
        $this->session->set('foo', 'bar');
        $this->session->setFlash('foo', 'bar');

        $this->assertSame('bar', $this->session->get('foo'));
        $this->assertSame('bar', $this->session->getFlash('foo'));

        $this->session->migrate();

        $this->assertSame('bar', $this->session->get('foo'));
        $this->assertSame('bar', $this->session->getFlash('foo'));

        $this->session = $this->getSession();
        $this->session->invalidate();

        $this->assertSame(array(), $this->session->all());
        $this->assertSame(array(), $this->session->getFlashes());
    }

    public function testSerialize()
    {
        $this->session = new Session($this->storage);

        $compare = serialize($this->storage);

        $this->assertSame($compare, $this->session->serialize());

        $this->session->unserialize($compare);

        $_storage = new \ReflectionProperty(get_class($this->session), 'storage');
        $_storage->setAccessible(true);

        $this->assertEquals($_storage->getValue($this->session), $this->storage, 'storage match');
    }
    
    /**
     * @expectedException InvalidArgumentException
     */
    public function testUnserializeException()
    {
        $serialized = serialize('not an instance of SessionStorage');
        $this->session->unserialize($serialized);
    }

    public function testSave()
    {
        $this->storage = new ArraySessionStorage();
        $this->session = new Session($this->storage);
        $this->session->set('foo', 'bar');

        $this->session->save();
        $compare = array('_symfony2' => array('attributes' => array('foo' => 'bar'), 'flashes' => array(Session::FLASH_INFO => array())));

        $r = new \ReflectionObject($this->storage);
        $p = $r->getProperty('data');
        $p->setAccessible(true);

        $this->assertSame($p->getValue($this->storage), $compare);
    }

    public function testGetId()
    {
        $this->assertNull($this->session->getId());
    }

    public function testStart()
    {
        $this->session->start();

        $this->assertSame(array(), $this->session->getFlashes());
        $this->assertSame(array(), $this->session->all());
    }
    
    public function testSavedOnDestruct()
    {
        $this->session->set('foo', 'bar');
        
        $this->session->__destruct();
        
        $expected = array(
            'attributes'=>array('foo'=>'bar'),
            'flashes'=>array(Session::FLASH_INFO => array()),
        );
        $saved = $this->storage->read('_symfony2');
        $this->assertSame($expected, $saved);
    }
    
    public function testSavedOnDestructAfterManualSave()
    {
        $this->session->set('foo', 'nothing');
        $this->session->save();
        $this->session->set('foo', 'bar');
        
        $this->session->__destruct();
        
        $expected = array(
            'attributes'=>array('foo'=>'bar'),
            'flashes'=>array(Session::FLASH_INFO => array()),
        );
        $saved = $this->storage->read('_symfony2');
        $this->assertSame($expected, $saved);
    }

    public function testStorageRegenerate()
    {
        $this->storage->write('foo', 'bar');

        $this->assertTrue($this->storage->regenerate());

        $this->assertEquals('bar', $this->storage->read('foo'));

        $this->assertTrue($this->storage->regenerate(true));

        $this->assertNull($this->storage->read('foo'));
    }

    public function testStorageRemove()
    {
        $this->storage->write('foo', 'bar');

        $this->assertEquals('bar', $this->storage->read('foo'));

        $this->storage->remove('foo');

        $this->assertNull($this->storage->read('foo'));
    }

    protected function getSession()
    {
        return new Session($this->storage);
    }
}