CookieJarTest::testConstruct() - Code Metrics - Inspection of "ENH Add samesite attribute to cookies." - silverstripe/silverstripe-framework - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — 4 (#10335)

by Guy

created 2022-05-31 02:40 UTC

CookieJarTest::testConstruct() A

↳ Parent: CookieJarTest

Complexity

Conditions	1
Paths	1

Size

Total Lines	26
Code Lines	11

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	1
eloc	11
nc	1
nop	0
dl	0
loc	26
rs	9.9
c	0
b	0
f	0

<?php

namespace SilverStripe\Control\Tests;

use ReflectionMethod;
use SilverStripe\Dev\SapphireTest;
use SilverStripe\Control\CookieJar;
use SilverStripe\Control\Session;
use SilverStripe\Core\Config\Config;

/**
 * Testing CookieJar
 *
 * Testing the CookieJar acts as expected and keeps track of Cookies it is loaded
 * with as well as new cookies that are set during the running of an application
 */
class CookieJarTest extends SapphireTest
{

    /**
     * Test that the construction argument is stored and returned as expected
     */
    public function testConstruct()
    {

        //some default cookies to load
        $defaultCookies = [
            'cookie1' => 1,
            'cookie2' => 'cookies',
            'cookie3' => 'test',
        ];

        $cookieJar = new CookieJar($defaultCookies);

        //make sure all the "received" cookies are as expected
        $this->assertEquals($defaultCookies, $cookieJar->getAll(false));

        //make sure there are no "phantom" cookies
        $this->assertEquals($defaultCookies, $cookieJar->getAll(true));

        //check an empty array is accepted
        $cookieJar = new CookieJar([]);
        $this->assertEmpty($cookieJar->getAll(false));


        //check no argument is accepted
        $cookieJar = new CookieJar();
        $this->assertEmpty($cookieJar->getAll(false));
    }

    /**
     * Test that we can set and get cookies
     */
    public function testSetAndGet()
    {
        $cookieJar = new CookieJar();

        $this->assertEmpty($cookieJar->get('testCookie'));

        //set a test cookie
        $cookieJar->set('testCookie', 'testVal');

        //make sure it was set
        $this->assertEquals('testVal', $cookieJar->get('testCookie'));

        //make sure we can distinguish it from ones that were "existing"
        $this->assertEmpty($cookieJar->get('testCookie', false));

        //PHP will replace an incoming COOKIE called 'var.with.dots' to 'var_with_dots'
        $cookieJar = new CookieJar(
            [
                'var_with_dots' => 'value',
            ]
        );

        $cookieJar->set('test.dots', 'dots');

        //check we can access with '.' and with '_'
        $this->assertEquals('value', $cookieJar->get('var.with.dots'));
        $this->assertEquals('value', $cookieJar->get('var_with_dots'));
        $this->assertEquals('dots', $cookieJar->get('test.dots'));
    }

    /**
     * Test that we can distinguish between vars that were loaded on instantiation
     * and those added later
     */
    public function testExistingVersusNew()
    {
        //load with a cookie
        $cookieJar = new CookieJar(
            [
                'cookieExisting' => 'i woz here',
            ]
        );

        //set a new cookie
        $cookieJar->set('cookieNew', 'i am new');

        //check we can fetch new and old cookie values
        $this->assertEquals('i woz here', $cookieJar->get('cookieExisting'));
        $this->assertEquals('i woz here', $cookieJar->get('cookieExisting', false));
        $this->assertEquals('i am new', $cookieJar->get('cookieNew'));
        //there should be no original value for the new cookie
        $this->assertEmpty($cookieJar->get('cookieNew', false));

        //change the existing cookie, can we fetch the new and old value
        $cookieJar->set('cookieExisting', 'i woz changed');

        $this->assertEquals('i woz changed', $cookieJar->get('cookieExisting'));
        $this->assertEquals('i woz here', $cookieJar->get('cookieExisting', false));

        //check we can get all cookies
        $this->assertEquals(
            [
                'cookieExisting' => 'i woz changed',
                'cookieNew' => 'i am new',
            ],
            $cookieJar->getAll()
        );

        //check we can get all original cookies
        $this->assertEquals(
            [
                'cookieExisting' => 'i woz here',
            ],
            $cookieJar->getAll(false)
        );
    }

    /**
     * Check we can remove cookies and we can access their original values
     */
    public function testForceExpiry()
    {
        //load an existing cookie
        $cookieJar = new CookieJar(
            [
                'cookieExisting' => 'i woz here',
            ]
        );

        //make sure it's available
        $this->assertEquals('i woz here', $cookieJar->get('cookieExisting'));

        //remove the cookie
        $cookieJar->forceExpiry('cookieExisting');

        //check it's gone
        $this->assertEmpty($cookieJar->get('cookieExisting'));

        //check we can get it's original value
        $this->assertEquals('i woz here', $cookieJar->get('cookieExisting', false));


        //check we can add a new cookie and remove it and it doesn't leave any phantom values
        $cookieJar->set('newCookie', 'i am new');

        //check it's set by not received
        $this->assertEquals('i am new', $cookieJar->get('newCookie'));
        $this->assertEmpty($cookieJar->get('newCookie', false));

        //remove it
        $cookieJar->forceExpiry('newCookie');

        //check it's neither set nor received
        $this->assertEmpty($cookieJar->get('newCookie'));
        $this->assertEmpty($cookieJar->get('newCookie', false));
    }

    /**
     * Check that the session cookie samesite configuration is used for session cookies.
     */
    public function testGetSameSite(): void
    {
        $cookieJar = new CookieJar();
        $methodGetSameSite = new ReflectionMethod($cookieJar, 'getSameSite');
        $methodGetSameSite->setAccessible(true);
        Config::modify()->set(Session::class, 'cookie_samesite', 'None');

        $this->assertSame('None', $methodGetSameSite->invoke($cookieJar, session_name()));
        $this->assertSame('Lax', $methodGetSameSite->invoke($cookieJar, 'some-random-cookie'));
    }

    /**
     * Check that the cookies are correctly set as secure for samesite === "None"
     * The passed in value for secure should be respected otherwise.
     */
    public function testCookieIsSecure(): void
    {
        $cookieJar = new CookieJar();
        $methodCookieIsSecure = new ReflectionMethod($cookieJar, 'cookieIsSecure');
        $methodCookieIsSecure->setAccessible(true);

        $this->assertTrue($methodCookieIsSecure->invoke($cookieJar, 'None', false));
        $this->assertTrue($methodCookieIsSecure->invoke($cookieJar, 'None', true));
        $this->assertTrue($methodCookieIsSecure->invoke($cookieJar, 'Lax', true));
        $this->assertFalse($methodCookieIsSecure->invoke($cookieJar, 'Lax', false));
        $this->assertTrue($methodCookieIsSecure->invoke($cookieJar, 'Strict', true));
        $this->assertFalse($methodCookieIsSecure->invoke($cookieJar, 'Strict', false));
    }
}


1			<?php
2
3			namespace SilverStripe\Control\Tests;
4
5			use ReflectionMethod;
6			use SilverStripe\Dev\SapphireTest;
7			use SilverStripe\Control\CookieJar;
8			use SilverStripe\Control\Session;
9			use SilverStripe\Core\Config\Config;
10
11			/**
12			* Testing CookieJar
13			*
14			* Testing the CookieJar acts as expected and keeps track of Cookies it is loaded
15			* with as well as new cookies that are set during the running of an application
16			*/
17			class CookieJarTest extends SapphireTest
18			{
19
20			/**
21			* Test that the construction argument is stored and returned as expected
22			*/
23			public function testConstruct()
24			{
25
26			//some default cookies to load
27			$defaultCookies = [
28			'cookie1' => 1,
29			'cookie2' => 'cookies',
30			'cookie3' => 'test',
31			];
32
33			$cookieJar = new CookieJar($defaultCookies);
34
35			//make sure all the "received" cookies are as expected
36			$this->assertEquals($defaultCookies, $cookieJar->getAll(false));
37
38			//make sure there are no "phantom" cookies
39			$this->assertEquals($defaultCookies, $cookieJar->getAll(true));
40
41			//check an empty array is accepted
42			$cookieJar = new CookieJar([]);
43			$this->assertEmpty($cookieJar->getAll(false));
44
45
46			//check no argument is accepted
47			$cookieJar = new CookieJar();
48			$this->assertEmpty($cookieJar->getAll(false));
49			}
50
51			/**
52			* Test that we can set and get cookies
53			*/
54			public function testSetAndGet()
55			{
56			$cookieJar = new CookieJar();
57
58			$this->assertEmpty($cookieJar->get('testCookie'));
59
60			//set a test cookie
61			$cookieJar->set('testCookie', 'testVal');
62
63			//make sure it was set
64			$this->assertEquals('testVal', $cookieJar->get('testCookie'));
65
66			//make sure we can distinguish it from ones that were "existing"
67			$this->assertEmpty($cookieJar->get('testCookie', false));
68
69			//PHP will replace an incoming COOKIE called 'var.with.dots' to 'var_with_dots'
70			$cookieJar = new CookieJar(
71			[
72			'var_with_dots' => 'value',
73			]
74			);
75
76			$cookieJar->set('test.dots', 'dots');
77
78			//check we can access with '.' and with '_'
79			$this->assertEquals('value', $cookieJar->get('var.with.dots'));
80			$this->assertEquals('value', $cookieJar->get('var_with_dots'));
81			$this->assertEquals('dots', $cookieJar->get('test.dots'));
82			}
83
84			/**
85			* Test that we can distinguish between vars that were loaded on instantiation
86			* and those added later
87			*/
88			public function testExistingVersusNew()
89			{
90			//load with a cookie
91			$cookieJar = new CookieJar(
92			[
93			'cookieExisting' => 'i woz here',
94			]
95			);
96
97			//set a new cookie
98			$cookieJar->set('cookieNew', 'i am new');
99
100			//check we can fetch new and old cookie values
101			$this->assertEquals('i woz here', $cookieJar->get('cookieExisting'));
102			$this->assertEquals('i woz here', $cookieJar->get('cookieExisting', false));
103			$this->assertEquals('i am new', $cookieJar->get('cookieNew'));
104			//there should be no original value for the new cookie
105			$this->assertEmpty($cookieJar->get('cookieNew', false));
106
107			//change the existing cookie, can we fetch the new and old value
108			$cookieJar->set('cookieExisting', 'i woz changed');
109
110			$this->assertEquals('i woz changed', $cookieJar->get('cookieExisting'));
111			$this->assertEquals('i woz here', $cookieJar->get('cookieExisting', false));
112
113			//check we can get all cookies
114			$this->assertEquals(
115			[
116			'cookieExisting' => 'i woz changed',
117			'cookieNew' => 'i am new',
118			],
119			$cookieJar->getAll()
120			);
121
122			//check we can get all original cookies
123			$this->assertEquals(
124			[
125			'cookieExisting' => 'i woz here',
126			],
127			$cookieJar->getAll(false)
128			);
129			}
130
131			/**
132			* Check we can remove cookies and we can access their original values
133			*/
134			public function testForceExpiry()
135			{
136			//load an existing cookie
137			$cookieJar = new CookieJar(
138			[
139			'cookieExisting' => 'i woz here',
140			]
141			);
142
143			//make sure it's available
144			$this->assertEquals('i woz here', $cookieJar->get('cookieExisting'));
145
146			//remove the cookie
147			$cookieJar->forceExpiry('cookieExisting');
148
149			//check it's gone
150			$this->assertEmpty($cookieJar->get('cookieExisting'));
151
152			//check we can get it's original value
153			$this->assertEquals('i woz here', $cookieJar->get('cookieExisting', false));
154
155
156			//check we can add a new cookie and remove it and it doesn't leave any phantom values
157			$cookieJar->set('newCookie', 'i am new');
158
159			//check it's set by not received
160			$this->assertEquals('i am new', $cookieJar->get('newCookie'));
161			$this->assertEmpty($cookieJar->get('newCookie', false));
162
163			//remove it
164			$cookieJar->forceExpiry('newCookie');
165
166			//check it's neither set nor received
167			$this->assertEmpty($cookieJar->get('newCookie'));
168			$this->assertEmpty($cookieJar->get('newCookie', false));
169			}
170
171			/**
172			* Check that the session cookie samesite configuration is used for session cookies.
173			*/
174			public function testGetSameSite(): void
175			{
176			$cookieJar = new CookieJar();
177			$methodGetSameSite = new ReflectionMethod($cookieJar, 'getSameSite');
178			$methodGetSameSite->setAccessible(true);
179			Config::modify()->set(Session::class, 'cookie_samesite', 'None');
180
181			$this->assertSame('None', $methodGetSameSite->invoke($cookieJar, session_name()));
182			$this->assertSame('Lax', $methodGetSameSite->invoke($cookieJar, 'some-random-cookie'));
183			}
184
185			/**
186			* Check that the cookies are correctly set as secure for samesite === "None"
187			* The passed in value for secure should be respected otherwise.
188			*/
189			public function testCookieIsSecure(): void
190			{
191			$cookieJar = new CookieJar();
192			$methodCookieIsSecure = new ReflectionMethod($cookieJar, 'cookieIsSecure');
193			$methodCookieIsSecure->setAccessible(true);
194
195			$this->assertTrue($methodCookieIsSecure->invoke($cookieJar, 'None', false));
196			$this->assertTrue($methodCookieIsSecure->invoke($cookieJar, 'None', true));
197			$this->assertTrue($methodCookieIsSecure->invoke($cookieJar, 'Lax', true));
198			$this->assertFalse($methodCookieIsSecure->invoke($cookieJar, 'Lax', false));
199			$this->assertTrue($methodCookieIsSecure->invoke($cookieJar, 'Strict', true));
200			$this->assertFalse($methodCookieIsSecure->invoke($cookieJar, 'Strict', false));
201			}
202			}
203

silverstripe / silverstripe-framework

Pull Request — 4 (#10335)

CookieJarTest::testConstruct() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like