Using Sessions in WebTestCase not working #45662

DigitalTimK · 2022-03-07T06:57:26Z

DigitalTimK
Mar 7, 2022

Summary

Yes, I know that session was removed and requestStack shall be used. Which I did in my controller and services. But since I upgraded to Symfony 5.4 I get a deprecation message on my PHPUnit functional tests too:

Since symfony/framework-bundle 5.3: Accessing the "session" service directly 
from the container is deprecated, use dependency injection instead

thrown by this:

 $session  = $this->client->getContainer()->get('session');

Details

class BookingControllerTest extends WebTestCase {

    // ...

    public function testToAddItemToCart()
    {
        $this->client  = static::createClient();
        self::ensureKernelShutdown();

        $item = (ProductFactory::random())->object();

        // make REQUEST (which adds stuff into the session)
        $this->client->request('GET', "/cart/add/{$item->getSlug()}");

        // assert RESPONSE
        $this->assertSame(302, $this->client->getResponse()->getStatusCode());
        $this->assertTrue($this->client->getResponse()->isRedirect('/cart/show'));

        // get cart from SESSION
        $session  = $this->client->getContainer()->get('session');
        $cart     = $session->get('cart');

        // assert content of cart
        // ...
    }
}

What I did

I found this article Symfony Session testing, but it does not explain how to uses these objects.

   // tried to replace this line
   $session = $this->client->getContainer()->get('session');

   // by this and ...
   $session = $this->client->getContainer()->get('request_stack')->getSession();

   // by this and ...
   $session = $this->client->getContainer()->get(RequestStack::class)->getSession();

   // by that
   $session = new Session(new MockFileSessionStorage());

Question

I have no idea how to solve this deprecation nor found any similar example. What would be the correct approach here? Thanks!

Answered by marien-probesys

Dec 9, 2022

Hey there, I found a way to access the controller session in my tests. It is heavily based on insights from @chyshyya and from your own code @DigitalTimK, thanks to both of you 🙏

I have to tell you that I'm using Symfony 6.1 and my solution may not totally fix your case as you're using Symfony 5.4. I hope it will!

There were two missing things in your previous attempts:

the cookie domain had to be set (e.g. localhost)
new MockFileSessionStorage() didn't create the session file in the same directory as the one of the controller session (it took me a while to figure it out), which is defined by the session.save_path configuration key

I extracted my code in a trait so it can be easily reus…

View full answer

chyshyya · 2022-03-07T09:09:02Z

chyshyya
Mar 7, 2022

Container get method is deprecated. Use dependency injection:

    public function someControllerAction(RequestStack $requestStack)
    {
        $session = $requestStack->getSession();
        // ...
    }

10 replies

chyshyya Mar 7, 2022

Try this

$session = new Session(new MockFileSessionStorage());
$session->start();

It must work

DigitalTimK Mar 8, 2022
Author

Hey @chyshyya, thanks for your support!!! But it is still not working on my end. So I made a very very basic test-example and also here I did not succeed.

Maybe you can check this example on your side? Does this work for you?

CONTROLLER

<?php

namespace App\Controller;

use Symfony\Bundle\FrameworkBundle\Controller\AbstractController;
use Symfony\Component\HttpFoundation\RedirectResponse;
use Symfony\Component\HttpFoundation\RequestStack;
use Symfony\Component\HttpFoundation\Response;
use Symfony\Component\Routing\Annotation\Route;

class TestSessionController extends AbstractController
{
    /**
     * @Route("/session_test", name="app_session_test")
     */
    function showSession(RequestStack $requestStack): Response {
        $session = $requestStack->getSession();
        $value_from_session = $session->get("product_id", "no id in session");

        return new Response("Value: {$value_from_session}");
    }

    /**
     * @Route("/session_test/add", name="app_session_test_add")
     */
    function addValueToSession(RequestStack $requestStack): RedirectResponse {
        $session = $requestStack->getSession();
        $session->clear();
        $session->set("product_id", 12345);

        return $this->redirectToRoute('app_session_test');
    }
}

FUNCTIONAL TEST

<?php

namespace App\Tests\Controller;

use Symfony\Bundle\FrameworkBundle\Test\WebTestCase;
use Symfony\Component\HttpFoundation\Session\Session;
use Symfony\Component\HttpFoundation\Session\Storage\MockFileSessionStorage;

class TestSessionControllerTest extends WebTestCase
{
    public function testAddValueToSession(): void
    {
        // prepare SESSION (new way, not working)
        $session = new Session(new MockFileSessionStorage());
        $session->start();

        // start CLIENT
        $client = static::createClient();

        // prepare SESSION (old way - working, but deprecated)
        # $session = $client->getContainer()->get('session');

        // ADD: request & assert RESPONSE
        $client->request('GET', '/session_test/add');
        $this->assertSame(302, $client->getResponse()->getStatusCode());
        $this->assertTrue($client->getResponse()->isRedirect('/session_test'));

        // SHOW: request & assert RESPONSE
        $client->request('GET', '/session_test');
        $this->assertResponseIsSuccessful();
        $this->assertSelectorTextSame('body', 'Value: 12345');

        // assert SESSION
        $product_id = $session->get('product_id');
        $this->assertSame(12345, $product_id);
    }
}

DigitalTimK Mar 25, 2022
Author

Hey @chyshyya, did you had a chance to look at the example?
Thanks for any support!

arderyp Jul 16, 2022

Seems like you two were on the cusp of figuring it out. Did you end up figuring it out on your own @DigitalTimK ?

DigitalTimK Jul 16, 2022
Author

No, unfortunately not successful so far.

marien-probesys · 2022-12-09T15:01:49Z

marien-probesys
Dec 9, 2022

Hey there, I found a way to access the controller session in my tests. It is heavily based on insights from @chyshyya and from your own code @DigitalTimK, thanks to both of you 🙏

I have to tell you that I'm using Symfony 6.1 and my solution may not totally fix your case as you're using Symfony 5.4. I hope it will!

There were two missing things in your previous attempts:

the cookie domain had to be set (e.g. localhost)
new MockFileSessionStorage() didn't create the session file in the same directory as the one of the controller session (it took me a while to figure it out), which is defined by the session.save_path configuration key

I extracted my code in a trait so it can be easily reused in my tests.

<?php

namespace App\Tests;

use Symfony\Bundle\FrameworkBundle\KernelBrowser;
use Symfony\Component\BrowserKit\Cookie;
use Symfony\Component\HttpFoundation\Session\Session;
use Symfony\Component\HttpFoundation\Session\Storage\MockFileSessionStorage;

trait SessionHelper
{
    public function createSession(KernelBrowser $client): Session
    {
        $cookie = $client->getCookieJar()->get('MOCKSESSID');

        // create a new session object
        $container = static::getContainer();
        $session = $container->get('session.factory')->createSession();

        if ($cookie) {
            // get the session id from the session cookie if it exists
            $session->setId($cookie->getValue());
            $session->start();
        } else {
            // or create a new session id and a session cookie
            $session->start();
            $session->save();

            $sessionCookie = new Cookie(
                $session->getName(),
                $session->getId(),
                null,
                null,
                'localhost',
            );
            $client->getCookieJar()->set($sessionCookie);
        }

        return $session;
    }
}

Then it can be used this way:

<?php

namespace App\Tests\Controller;

use App\Tests\SessionHelper;
use Symfony\Bundle\FrameworkBundle\Test\WebTestCase;

class SessionControllerTest extends WebTestCase
{
    use SessionHelper;

    public function testUpdateLocaleSavesTheLocaleInTheSession(): void
    {
        $client = static::createClient();
        $session = $this->createSession($client);

        $client->request('POST', '/session/locale', [
            'locale' => 'fr_FR',
        ]);

        $this->assertSame('fr_FR', $session->get('_locale'));
    }
}

I hope my solution will help you!

6 replies

The first one wasnt working though. Only the second one in the linked comment. Guess its because I also was using authentication.

You did right: the solution I gave here didn't work anymore. I forgot that I changed the solution in the linked comment. Nothing related to authentication 😄 Both solutions should work now!

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Using Sessions in WebTestCase not working #45662

{{title}}

{{editor}}'s edit

{{editor}}'s edit

Replies: 2 comments 16 replies

{{title}}

{{title}}

{{title}}

{{title}}

{{title}}

{{title}}

{{title}}

{{editor}}'s edit

{{editor}}'s edit

{{title}}

{{title}}

{{title}}

{{title}}

{{editor}}'s edit

{{editor}}'s edit

{{title}}

Select a reply

Using Sessions in WebTestCase not working #45662

Summary

Details

What I did

Question

Replies: 2 comments · 16 replies

DigitalTimK Mar 8, 2022 Author

DigitalTimK Mar 25, 2022 Author

DigitalTimK Jul 16, 2022 Author

Replies: 2 comments 16 replies

DigitalTimK Mar 8, 2022
Author

DigitalTimK Mar 25, 2022
Author

DigitalTimK Jul 16, 2022
Author