4 * This file is part of the Symfony package.
6 * (c) Fabien Potencier <fabien@symfony.com>
8 * For the full copyright and license information, please view the LICENSE
9 * file that was distributed with this source code.
12 namespace Symfony\Component\HttpFoundation\Tests;
14 use PHPUnit\Framework\TestCase;
15 use Symfony\Component\HttpFoundation\Cookie;
20 * @author John Kary <john@johnkary.net>
21 * @author Hugo Hamon <hugo.hamon@sensio.com>
23 * @group time-sensitive
25 class CookieTest extends TestCase
27 public function invalidNames()
43 * @dataProvider invalidNames
44 * @expectedException \InvalidArgumentException
46 public function testInstantiationThrowsExceptionIfCookieNameContainsInvalidCharacters($name)
52 * @expectedException \InvalidArgumentException
54 public function testInvalidExpiration()
56 new Cookie('MyCookie', 'foo', 'bar');
59 public function testNegativeExpirationIsNotPossible()
61 $cookie = new Cookie('foo', 'bar', -100);
63 $this->assertSame(0, $cookie->getExpiresTime());
66 public function testGetValue()
69 $cookie = new Cookie('MyCookie', $value);
71 $this->assertSame($value, $cookie->getValue(), '->getValue() returns the proper value');
74 public function testGetPath()
76 $cookie = new Cookie('foo', 'bar');
78 $this->assertSame('/', $cookie->getPath(), '->getPath() returns / as the default path');
81 public function testGetExpiresTime()
83 $cookie = new Cookie('foo', 'bar');
85 $this->assertEquals(0, $cookie->getExpiresTime(), '->getExpiresTime() returns the default expire date');
87 $cookie = new Cookie('foo', 'bar', $expire = time() + 3600);
89 $this->assertEquals($expire, $cookie->getExpiresTime(), '->getExpiresTime() returns the expire date');
92 public function testGetExpiresTimeIsCastToInt()
94 $cookie = new Cookie('foo', 'bar', 3600.9);
96 $this->assertSame(3600, $cookie->getExpiresTime(), '->getExpiresTime() returns the expire date as an integer');
99 public function testConstructorWithDateTime()
101 $expire = new \DateTime();
102 $cookie = new Cookie('foo', 'bar', $expire);
104 $this->assertEquals($expire->format('U'), $cookie->getExpiresTime(), '->getExpiresTime() returns the expire date');
110 public function testConstructorWithDateTimeImmutable()
112 $expire = new \DateTimeImmutable();
113 $cookie = new Cookie('foo', 'bar', $expire);
115 $this->assertEquals($expire->format('U'), $cookie->getExpiresTime(), '->getExpiresTime() returns the expire date');
118 public function testGetExpiresTimeWithStringValue()
121 $cookie = new Cookie('foo', 'bar', $value);
122 $expire = strtotime($value);
124 $this->assertEquals($expire, $cookie->getExpiresTime(), '->getExpiresTime() returns the expire date', 1);
127 public function testGetDomain()
129 $cookie = new Cookie('foo', 'bar', 0, '/', '.myfoodomain.com');
131 $this->assertEquals('.myfoodomain.com', $cookie->getDomain(), '->getDomain() returns the domain name on which the cookie is valid');
134 public function testIsSecure()
136 $cookie = new Cookie('foo', 'bar', 0, '/', '.myfoodomain.com', true);
138 $this->assertTrue($cookie->isSecure(), '->isSecure() returns whether the cookie is transmitted over HTTPS');
141 public function testIsHttpOnly()
143 $cookie = new Cookie('foo', 'bar', 0, '/', '.myfoodomain.com', false, true);
145 $this->assertTrue($cookie->isHttpOnly(), '->isHttpOnly() returns whether the cookie is only transmitted over HTTP');
148 public function testCookieIsNotCleared()
150 $cookie = new Cookie('foo', 'bar', time() + 3600 * 24);
152 $this->assertFalse($cookie->isCleared(), '->isCleared() returns false if the cookie did not expire yet');
155 public function testCookieIsCleared()
157 $cookie = new Cookie('foo', 'bar', time() - 20);
159 $this->assertTrue($cookie->isCleared(), '->isCleared() returns true if the cookie has expired');
161 $cookie = new Cookie('foo', 'bar');
163 $this->assertFalse($cookie->isCleared());
165 $cookie = new Cookie('foo', 'bar', 0);
167 $this->assertFalse($cookie->isCleared());
169 $cookie = new Cookie('foo', 'bar', -1);
171 $this->assertFalse($cookie->isCleared());
174 public function testToString()
176 $cookie = new Cookie('foo', 'bar', $expire = strtotime('Fri, 20-May-2011 15:25:52 GMT'), '/', '.myfoodomain.com', true);
177 $this->assertEquals('foo=bar; expires=Fri, 20-May-2011 15:25:52 GMT; Max-Age=0; path=/; domain=.myfoodomain.com; secure; httponly', (string) $cookie, '->__toString() returns string representation of the cookie');
179 $cookie = new Cookie('foo', 'bar with white spaces', strtotime('Fri, 20-May-2011 15:25:52 GMT'), '/', '.myfoodomain.com', true);
180 $this->assertEquals('foo=bar%20with%20white%20spaces; expires=Fri, 20-May-2011 15:25:52 GMT; Max-Age=0; path=/; domain=.myfoodomain.com; secure; httponly', (string) $cookie, '->__toString() encodes the value of the cookie according to RFC 3986 (white space = %20)');
182 $cookie = new Cookie('foo', null, 1, '/admin/', '.myfoodomain.com');
183 $this->assertEquals('foo=deleted; expires='.gmdate('D, d-M-Y H:i:s T', $expire = time() - 31536001).'; Max-Age=0; path=/admin/; domain=.myfoodomain.com; httponly', (string) $cookie, '->__toString() returns string representation of a cleared cookie if value is NULL');
185 $cookie = new Cookie('foo', 'bar', 0, '/', '');
186 $this->assertEquals('foo=bar; path=/; httponly', (string) $cookie);
189 public function testRawCookie()
191 $cookie = new Cookie('foo', 'b a r', 0, '/', null, false, false);
192 $this->assertFalse($cookie->isRaw());
193 $this->assertEquals('foo=b%20a%20r; path=/', (string) $cookie);
195 $cookie = new Cookie('foo', 'b+a+r', 0, '/', null, false, false, true);
196 $this->assertTrue($cookie->isRaw());
197 $this->assertEquals('foo=b+a+r; path=/', (string) $cookie);
200 public function testGetMaxAge()
202 $cookie = new Cookie('foo', 'bar');
203 $this->assertEquals(0, $cookie->getMaxAge());
205 $cookie = new Cookie('foo', 'bar', $expire = time() + 100);
206 $this->assertEquals($expire - time(), $cookie->getMaxAge());
208 $cookie = new Cookie('foo', 'bar', $expire = time() - 100);
209 $this->assertEquals(0, $cookie->getMaxAge());
212 public function testFromString()
214 $cookie = Cookie::fromString('foo=bar; expires=Fri, 20-May-2011 15:25:52 GMT; path=/; domain=.myfoodomain.com; secure; httponly');
215 $this->assertEquals(new Cookie('foo', 'bar', strtotime('Fri, 20-May-2011 15:25:52 GMT'), '/', '.myfoodomain.com', true, true, true), $cookie);
217 $cookie = Cookie::fromString('foo=bar', true);
218 $this->assertEquals(new Cookie('foo', 'bar', 0, '/', null, false, false), $cookie);
221 public function testFromStringWithHttpOnly()
223 $cookie = Cookie::fromString('foo=bar; expires=Fri, 20-May-2011 15:25:52 GMT; path=/; domain=.myfoodomain.com; secure; httponly');
224 $this->assertTrue($cookie->isHttpOnly());
226 $cookie = Cookie::fromString('foo=bar; expires=Fri, 20-May-2011 15:25:52 GMT; path=/; domain=.myfoodomain.com; secure');
227 $this->assertFalse($cookie->isHttpOnly());
230 public function testSameSiteAttributeIsCaseInsensitive()
232 $cookie = new Cookie('foo', 'bar', 0, '/', null, false, true, false, 'Lax');
233 $this->assertEquals('lax', $cookie->getSameSite());