PHPUnit Test Setting Cookies

It very much appears to be a bug. Here's my testcase:

$this->get('register/311');
$this->seeCookie('referral'); // Passes
$this->get('register/311')->followRedirects();
$this->seeCookie('referral'); // Fails

It seems, laravel doesn't persist cookie between request. The only possibility I'm seeing now is to manually redirect and pass cookie. Awful, I know.

Well it might not be a bug in Laravel. If you want to use a cookie in the next request you need to give that to the request. So if you then refresh, the cookie is gone since you came from another request.

@Asva have you tried it with a cookie that stays forever?

$response->withCookie(cookie()->forever('name', 'value'));

@bobbybouwmann

If you want to use a cookie in the next request you need to give that to the request

The problem is doing so is not exactly the easiest thing in the world (C). While plain Guzzle defaults to saving cookies (as it should be).

have you tried it with a cookie that stays forever?

Yep, tried a lot of things actually. Turning off encryption included.

Mmh, that makes it pretty difficult to test... Not sure how you can get around this!

@Asva you need to adjust the tests slightly. The following works:

    /** @test */
    public function it_saves_a_cookie()
    {
        $this->call('GET', 'set-cookie');

        $this->assertRedirectedToRoute('view.cookie');

        $this->seeCookie('test', 'hello');
    }

// Routes
use Illuminate\Http\Request;

Route::get('set-cookie', function() {
    return Redirect::route('view.cookie')->withCookie(cookie('test', 'hello'));
});

Route::get('view-cookie', ['as' => 'view.cookie', function(Request $request) {
    return $request->cookie('test');
}]);

It doesn't work when you use the fluent interface chaining of the tests; I presume because there is more than one request-response object needed.

Good luck!

So there is no option to test cookies are being set in subsequent requests if the $minutes value is high enough?

@Bloomanity there is no need; this is not testing, it is using :)

A test that spans multiple requests should be broken down into its individual request cycles to test each one separately.

@ifpingram actually, what you wrote is my 1st test. It passes and that's fine. Here's the second one

$cookie = cookie('referral', '311');
$this->call('post', 'api/register', $this->userData, [$cookie]);
$user = $this->getRegisteredUser();
$this->assertEquals('311', $user->referral_id);

This one doesn't work (though feature is implemented). In controller I'm not seeing any cookie.

And it'll be fun and wise for integration test to store cookies. Maybe as an option or something. I'll probably file an issue in a few days.

UPD: Created an issue.

@Asva The bug you have posted is not a bug, but instead your test is incorrect.

The cookie should be passed as an array of values, not as a Symfony\Component\HttpFoundation\Cookie instance. Test should be changed to read:

    public function test_cookie_passed_to_request(){
        $cookie = ['name' => Crypt::encrypt('value')];

        $this->call('GET', 'test', [], $cookie);

        $this->assertEquals('value', $this->response->content());
    }

@ifpingram Thank you very much for that solution :3. I was being ripping my hair, trying to make that one green.

And I did some more digging:

$cookie1 = ['name1' => Crypt::encrypt('value1')];
$cookie2 = ['name2' => Crypt::encrypt('value2')];
$this->call('get', 'test', [], [$cookie1, $cookie2]);
$this->assertEquals('value1', $this->response->content());

That test fails. And here is method definition from src:

public function call($method, $uri, $parameters = [], $cookies = [], ...

It says $cookies and not cookie. Yet it accepts only one cookie and that one should be weirdly parsed.

I will probably stay on that issue for a little bit longer. That kind of interface is not suitable for common developer. Even armed with xdebug I wasn't able to figure things out.

@Asva Try this to check the value of the first cookie.

Route::get('test', [
    'middleware' => 'web',
    function (Request $request) {
        return $request->cookie('name1');
    }
]);

    public function test_cookies_passed_to_request()
    {
        $cookies = [
            'name1' => Crypt::encrypt('value1'),
            'name2' => Crypt::encrypt('value2')
        ];
        $this->call('get', 'test', [], $cookies);
        $this->assertEquals('value1', $this->response->content());
    }

You wrapped an extra array around the cookies which was not necessary.

@ifpingram Thanks for your help again. I got it now. Forgot that cookies for HTTP request have only name and value. I expected to pass down expire date and such, for some reason.

And at least greeen! And mostly sane. Here's the test:

public function test_cookie_passed_to_request()
{
    $this->disableCookiesEncryption('name');
    $cookie = [ 'name' => 'value' ];
    $this->call('get', 'test', [ ], $cookie);
    $this->assertEquals('value', $this->response->content());
}

The route:

Route::get('test', [
    'middleware' => 'web',
    function (Request $request) {
        return $request->cookie('name');
    }
]);

TestCase function to disable cookie encryption:

/**
 * @param array|string $cookies
 * @return $this
 */
protected function disableCookiesEncryption($cookies)
{
    $this->app->resolving(EncryptCookies::class,
        function ($object) use ($cookies) {
            $object->disableFor($cookies);
        });

    return $this;
}

@Asva @ifpingram thank you for your help in getting the cookie tests to work.

@Asva You don't have to disable cookie encrypt, you can instead encrypt the cookie value: $cookie = ['name' => Crypt::encrypt('value')]

@nathanisaac .I am getting slightly modified value