CookieTest.php

<?php

namespace Behat\Mink\Tests\Driver\Basic;

use Behat\Mink\Tests\Driver\TestCase;

/**
 * @phpstan-type TCookieRemovalMode 'session_reset'|'cookie_delete'
 */
final class CookieTest extends TestCase
{
    /**
     * test cookie decoding.
     *
     * @group issue140
     */
    public function testIssue140(): void
    {
        $this->getSession()->visit($this->pathTo('/issue140.php'));

        $this->getSession()->getPage()->fillField('cookie_value', 'some:value;');
        $this->getSession()->getPage()->pressButton('Set cookie');

        $this->getSession()->visit($this->pathTo('/issue140.php?show_value'));
        $this->assertEquals('some:value;', $this->getSession()->getCookie('tc'));
        $this->assertEquals('some:value;', $this->getSession()->getPage()->getText());
    }

    public function testCookie(): void
    {
        $this->getSession()->visit($this->pathTo('/cookie_page2.php'));
        $this->assertStringContainsString('Previous cookie: NO', $this->getSession()->getPage()->getText());
        $this->assertNull($this->getSession()->getCookie('srvr_cookie'));

        $this->getSession()->setCookie('srvr_cookie', 'client cookie set');
        $this->getSession()->reload();
        $this->assertStringContainsString('Previous cookie: client cookie set', $this->getSession()->getPage()->getText());
        $this->assertEquals('client cookie set', $this->getSession()->getCookie('srvr_cookie'));

        $this->getSession()->setCookie('srvr_cookie', null);
        $this->getSession()->reload();
        $this->assertStringContainsString('Previous cookie: NO', $this->getSession()->getPage()->getText());

        $this->getSession()->visit($this->pathTo('/cookie_page1.php'));
        $this->getSession()->visit($this->pathTo('/cookie_page2.php'));

        $this->assertStringContainsString('Previous cookie: srv_var_is_set', $this->getSession()->getPage()->getText());
        $this->getSession()->setCookie('srvr_cookie', null);
        $this->getSession()->reload();
        $this->assertStringContainsString('Previous cookie: NO', $this->getSession()->getPage()->getText());
    }

    public function testCookieWithSemicolon(): void
    {
        $this->getSession()->visit($this->pathTo('/cookie_page2.php'));
        $this->getSession()->setCookie('srvr_cookie', 'foo;bar;baz');
        $this->getSession()->visit($this->pathTo('/cookie_page2.php'));
        $this->assertEquals('foo;bar;baz', $this->getSession()->getCookie('srvr_cookie'));
        $this->assertStringContainsString('Previous cookie: foo;bar;baz', $this->getSession()->getPage()->getText());
    }

    /**
     * @dataProvider cookieWithPathsDataProvider
     */
    public function testCookieWithPaths(string $cookieRemovalMode): void
    {
        // start clean
        $session = $this->getSession();
        $session->visit($this->pathTo('/sub-folder/cookie_page2.php'));
        $this->assertStringContainsString('Previous cookie: NO', $session->getPage()->getText());

        // cookie from root path is accessible in sub-folder
        $session->visit($this->pathTo('/cookie_page1.php'));
        $session->visit($this->pathTo('/sub-folder/cookie_page2.php'));
        $this->assertStringContainsString('Previous cookie: srv_var_is_set', $session->getPage()->getText());

        // cookie from sub-folder overrides cookie from root path
        $session->visit($this->pathTo('/sub-folder/cookie_page1.php'));
        $session->visit($this->pathTo('/sub-folder/cookie_page2.php'));
        $this->assertStringContainsString('Previous cookie: srv_var_is_set_sub_folder', $session->getPage()->getText());

        if ($cookieRemovalMode === 'session_reset') {
            $session->reset();
        } elseif ($cookieRemovalMode === 'cookie_delete') {
            $session->setCookie('srvr_cookie', null);
        }

        // cookie is removed from all paths
        $session->visit($this->pathTo('/sub-folder/cookie_page2.php'));
        $this->assertStringContainsString('Previous cookie: NO', $session->getPage()->getText());
    }

    /**
     * @phpstan-return iterable<array{TCookieRemovalMode}>
     */
    public static function cookieWithPathsDataProvider(): iterable
    {
        return [
            ['session_reset'],
            ['cookie_delete'],
        ];
    }

    /**
     * @phpstan-param TCookieRemovalMode $cookieRemovalMode
     * @dataProvider cookieWithPathsDataProvider
     */
    public function testCookieInSubPath(string $cookieRemovalMode): void
    {
        // Start clean.
        // The cookie is set when viewing the page.
        $session = $this->getSession();
        $session->visit($this->pathTo('/sub-folder/cookie_page2.php'));
        $this->assertStringContainsString('Previous cookie: NO', $session->getPage()->getText());

        $session->visit($this->pathTo('/sub-folder/cookie_page4.php'));

        // On the next load, the cookie has been set.
        $session->visit($this->pathTo('/sub-folder/cookie_page2.php'));
        $this->assertStringContainsString('Previous cookie: srv_var_is_set', $session->getPage()->getText());

        if ($cookieRemovalMode === 'session_reset') {
            $session->reset();
        } elseif ($cookieRemovalMode === 'cookie_delete') {
            $session->setCookie('srvr_cookie', null);
        }

        // Cookie is removed>
        $session->visit($this->pathTo('/sub-folder/cookie_page2.php'));
        $this->assertStringContainsString('Previous cookie: NO', $session->getPage()->getText());
    }

    public function testReset(): void
    {
        $this->getSession()->visit($this->pathTo('/cookie_page1.php'));
        $this->getSession()->visit($this->pathTo('/cookie_page2.php'));
        $this->assertStringContainsString('Previous cookie: srv_var_is_set', $this->getSession()->getPage()->getText());

        $this->getSession()->reset();
        $this->getSession()->visit($this->pathTo('/cookie_page2.php'));

        $this->assertStringContainsString('Previous cookie: NO', $this->getSession()->getPage()->getText());

        $this->getSession()->setCookie('srvr_cookie', 'test_cookie');
        $this->getSession()->visit($this->pathTo('/cookie_page2.php'));
        $this->assertStringContainsString('Previous cookie: test_cookie', $this->getSession()->getPage()->getText());
        $this->getSession()->reset();
        $this->getSession()->visit($this->pathTo('/cookie_page2.php'));
        $this->assertStringContainsString('Previous cookie: NO', $this->getSession()->getPage()->getText());

        $this->getSession()->setCookie('client_cookie1', 'some_val');
        $this->getSession()->setCookie('client_cookie2', '123');
        $this->getSession()->visit($this->pathTo('/session_test.php'));
        $this->getSession()->visit($this->pathTo('/cookie_page1.php'));

        $this->getSession()->visit($this->pathTo('/print_cookies.php'));
        $this->assertStringContainsString(
            'client_cookie1 = `some_val`',
            $this->getSession()->getPage()->getText()
        );
        $this->assertStringContainsString(
            'client_cookie2 = `123`',
            $this->getSession()->getPage()->getText()
        );
        $this->assertStringContainsString(
            '_SESS = ',
            $this->getSession()->getPage()->getText()
        );
        $this->assertStringContainsString(
            ' srvr_cookie = `srv_var_is_set`',
            $this->getSession()->getPage()->getText()
        );

        $this->getSession()->reset();
        $this->getSession()->visit($this->pathTo('/print_cookies.php'));
        $this->assertStringContainsString('array()', $this->getSession()->getPage()->getText());
    }

    public function testHttpOnlyCookieIsDeleted(): void
    {
        $this->getSession()->restart();
        $this->getSession()->visit($this->pathTo('/cookie_page3.php'));
        $this->assertEquals('Has Cookie: false', $this->findById('cookie-status')->getText());

        $this->getSession()->reload();
        $this->assertEquals('Has Cookie: true', $this->findById('cookie-status')->getText());

        $this->getSession()->restart();
        $this->getSession()->visit($this->pathTo('/cookie_page3.php'));
        $this->assertEquals('Has Cookie: false', $this->findById('cookie-status')->getText());
    }

    public function testSessionPersistsBetweenRequests(): void
    {
        $this->getSession()->visit($this->pathTo('/session_test.php'));
        $webAssert = $this->getAssertSession();
        $node = $webAssert->elementExists('css', '#session-id');
        $sessionId = $node->getText();

        $this->getSession()->visit($this->pathTo('/session_test.php'));
        $node = $webAssert->elementExists('css', '#session-id');
        $this->assertEquals($sessionId, $node->getText());

        $this->getSession()->visit($this->pathTo('/session_test.php?login'));
        $node = $webAssert->elementExists('css', '#session-id');
        $this->assertNotEquals($sessionId, $newSessionId = $node->getText());

        $this->getSession()->visit($this->pathTo('/session_test.php'));
        $node = $webAssert->elementExists('css', '#session-id');
        $this->assertEquals($newSessionId, $node->getText());
    }
}