Cover of the book Symfony 5: The Fast Track

Symfony 5: The Fast Track is the best book to learn modern Symfony development, from zero to production. +300 pages in full color showing how to combine Symfony with Docker, APIs, queues & async tasks, Webpack, Single-Page Applications, etc.

Buy printed version
Buy PDF version
  1. Home
  2. Documentation
  3. Components
  4. Http Foundation
  5. Testing with Sessions
WARNING: You are browsing the documentation for Symfony 2.5 which is not maintained anymore. Consider upgrading your projects to Symfony 5.1.

Testing with Sessions

2.5 version
Maintained
3.4 4.4 5.1 current 5.2 master
Unmaintained
2.1 2.2 2.3 2.4 2.6 2.7 2.8 3.0 3.1 3.2 3.3 4.0 4.1 4.2 4.3 5.0

Testing with Sessions

Symfony is designed from the ground up with code-testability in mind. In order to make your code which utilizes session easily testable we provide two separate mock storage mechanisms for both unit testing and functional testing.

Testing code using real sessions is tricky because PHP’s workflow state is global and it is not possible to have multiple concurrent sessions in the same PHP process.

The mock storage engines simulate the PHP session workflow without actually starting one allowing you to test your code without complications. You may also run multiple instances in the same PHP process.

The mock storage drivers do not read or write the system globals session_id() or session_name(). Methods are provided to simulate this if required:

Unit Testing

For unit testing where it is not necessary to persist the session, you should simply swap out the default storage engine with Symfony\Component\HttpFoundation\Session\Storage\MockArraySessionStorage:

use Symfony\Component\HttpFoundation\Session\Storage\MockArraySessionStorage;
use Symfony\Component\HttpFoundation\Session\Session;

$session = new Session(new MockArraySessionStorage());

Functional Testing

For functional testing where you may need to persist session data across separate PHP processes, simply change the storage engine to Symfony\Component\HttpFoundation\Session\Storage\MockFileSessionStorage:

use Symfony\Component\HttpFoundation\Session\Session;
use Symfony\Component\HttpFoundation\Session\Storage\MockFileSessionStorage;

$session = new Session(new MockFileSessionStorage());

This work, including the code samples, is licensed under a Creative Commons BY-SA 3.0 license.