CookieTest.php 8.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235
  1. <?php
  2. /*
  3. * This file is part of the Symfony package.
  4. *
  5. * (c) Fabien Potencier <fabien@symfony.com>
  6. *
  7. * For the full copyright and license information, please view the LICENSE
  8. * file that was distributed with this source code.
  9. */
  10. namespace Symfony\Component\HttpFoundation\Tests;
  11. use PHPUnit\Framework\TestCase;
  12. use Symfony\Component\HttpFoundation\Cookie;
  13. /**
  14. * CookieTest.
  15. *
  16. * @author John Kary <john@johnkary.net>
  17. * @author Hugo Hamon <hugo.hamon@sensio.com>
  18. *
  19. * @group time-sensitive
  20. */
  21. class CookieTest extends TestCase
  22. {
  23. public function invalidNames()
  24. {
  25. return [
  26. [''],
  27. [',MyName'],
  28. [';MyName'],
  29. [' MyName'],
  30. ["\tMyName"],
  31. ["\rMyName"],
  32. ["\nMyName"],
  33. ["\013MyName"],
  34. ["\014MyName"],
  35. ];
  36. }
  37. /**
  38. * @dataProvider invalidNames
  39. * @expectedException \InvalidArgumentException
  40. */
  41. public function testInstantiationThrowsExceptionIfCookieNameContainsInvalidCharacters($name)
  42. {
  43. new Cookie($name);
  44. }
  45. /**
  46. * @expectedException \InvalidArgumentException
  47. */
  48. public function testInvalidExpiration()
  49. {
  50. new Cookie('MyCookie', 'foo', 'bar');
  51. }
  52. public function testNegativeExpirationIsNotPossible()
  53. {
  54. $cookie = new Cookie('foo', 'bar', -100);
  55. $this->assertSame(0, $cookie->getExpiresTime());
  56. }
  57. public function testGetValue()
  58. {
  59. $value = 'MyValue';
  60. $cookie = new Cookie('MyCookie', $value);
  61. $this->assertSame($value, $cookie->getValue(), '->getValue() returns the proper value');
  62. }
  63. public function testGetPath()
  64. {
  65. $cookie = new Cookie('foo', 'bar');
  66. $this->assertSame('/', $cookie->getPath(), '->getPath() returns / as the default path');
  67. }
  68. public function testGetExpiresTime()
  69. {
  70. $cookie = new Cookie('foo', 'bar');
  71. $this->assertEquals(0, $cookie->getExpiresTime(), '->getExpiresTime() returns the default expire date');
  72. $cookie = new Cookie('foo', 'bar', $expire = time() + 3600);
  73. $this->assertEquals($expire, $cookie->getExpiresTime(), '->getExpiresTime() returns the expire date');
  74. }
  75. public function testGetExpiresTimeIsCastToInt()
  76. {
  77. $cookie = new Cookie('foo', 'bar', 3600.9);
  78. $this->assertSame(3600, $cookie->getExpiresTime(), '->getExpiresTime() returns the expire date as an integer');
  79. }
  80. public function testConstructorWithDateTime()
  81. {
  82. $expire = new \DateTime();
  83. $cookie = new Cookie('foo', 'bar', $expire);
  84. $this->assertEquals($expire->format('U'), $cookie->getExpiresTime(), '->getExpiresTime() returns the expire date');
  85. }
  86. /**
  87. * @requires PHP 5.5
  88. */
  89. public function testConstructorWithDateTimeImmutable()
  90. {
  91. $expire = new \DateTimeImmutable();
  92. $cookie = new Cookie('foo', 'bar', $expire);
  93. $this->assertEquals($expire->format('U'), $cookie->getExpiresTime(), '->getExpiresTime() returns the expire date');
  94. }
  95. public function testGetExpiresTimeWithStringValue()
  96. {
  97. $value = '+1 day';
  98. $cookie = new Cookie('foo', 'bar', $value);
  99. $expire = strtotime($value);
  100. $this->assertEquals($expire, $cookie->getExpiresTime(), '->getExpiresTime() returns the expire date', 1);
  101. }
  102. public function testGetDomain()
  103. {
  104. $cookie = new Cookie('foo', 'bar', 0, '/', '.myfoodomain.com');
  105. $this->assertEquals('.myfoodomain.com', $cookie->getDomain(), '->getDomain() returns the domain name on which the cookie is valid');
  106. }
  107. public function testIsSecure()
  108. {
  109. $cookie = new Cookie('foo', 'bar', 0, '/', '.myfoodomain.com', true);
  110. $this->assertTrue($cookie->isSecure(), '->isSecure() returns whether the cookie is transmitted over HTTPS');
  111. }
  112. public function testIsHttpOnly()
  113. {
  114. $cookie = new Cookie('foo', 'bar', 0, '/', '.myfoodomain.com', false, true);
  115. $this->assertTrue($cookie->isHttpOnly(), '->isHttpOnly() returns whether the cookie is only transmitted over HTTP');
  116. }
  117. public function testCookieIsNotCleared()
  118. {
  119. $cookie = new Cookie('foo', 'bar', time() + 3600 * 24);
  120. $this->assertFalse($cookie->isCleared(), '->isCleared() returns false if the cookie did not expire yet');
  121. }
  122. public function testCookieIsCleared()
  123. {
  124. $cookie = new Cookie('foo', 'bar', time() - 20);
  125. $this->assertTrue($cookie->isCleared(), '->isCleared() returns true if the cookie has expired');
  126. $cookie = new Cookie('foo', 'bar');
  127. $this->assertFalse($cookie->isCleared());
  128. $cookie = new Cookie('foo', 'bar', 0);
  129. $this->assertFalse($cookie->isCleared());
  130. $cookie = new Cookie('foo', 'bar', -1);
  131. $this->assertFalse($cookie->isCleared());
  132. }
  133. public function testToString()
  134. {
  135. $cookie = new Cookie('foo', 'bar', $expire = strtotime('Fri, 20-May-2011 15:25:52 GMT'), '/', '.myfoodomain.com', true);
  136. $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');
  137. $cookie = new Cookie('foo', 'bar with white spaces', strtotime('Fri, 20-May-2011 15:25:52 GMT'), '/', '.myfoodomain.com', true);
  138. $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)');
  139. $cookie = new Cookie('foo', null, 1, '/admin/', '.myfoodomain.com');
  140. $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');
  141. $cookie = new Cookie('foo', 'bar', 0, '/', '');
  142. $this->assertEquals('foo=bar; path=/; httponly', (string) $cookie);
  143. }
  144. public function testRawCookie()
  145. {
  146. $cookie = new Cookie('foo', 'b a r', 0, '/', null, false, false);
  147. $this->assertFalse($cookie->isRaw());
  148. $this->assertEquals('foo=b%20a%20r; path=/', (string) $cookie);
  149. $cookie = new Cookie('foo', 'b+a+r', 0, '/', null, false, false, true);
  150. $this->assertTrue($cookie->isRaw());
  151. $this->assertEquals('foo=b+a+r; path=/', (string) $cookie);
  152. }
  153. public function testGetMaxAge()
  154. {
  155. $cookie = new Cookie('foo', 'bar');
  156. $this->assertEquals(0, $cookie->getMaxAge());
  157. $cookie = new Cookie('foo', 'bar', $expire = time() + 100);
  158. $this->assertEquals($expire - time(), $cookie->getMaxAge());
  159. $cookie = new Cookie('foo', 'bar', $expire = time() - 100);
  160. $this->assertEquals(0, $cookie->getMaxAge());
  161. }
  162. public function testFromString()
  163. {
  164. $cookie = Cookie::fromString('foo=bar; expires=Fri, 20-May-2011 15:25:52 GMT; path=/; domain=.myfoodomain.com; secure; httponly');
  165. $this->assertEquals(new Cookie('foo', 'bar', strtotime('Fri, 20-May-2011 15:25:52 GMT'), '/', '.myfoodomain.com', true, true, true), $cookie);
  166. $cookie = Cookie::fromString('foo=bar', true);
  167. $this->assertEquals(new Cookie('foo', 'bar', 0, '/', null, false, false), $cookie);
  168. }
  169. public function testFromStringWithHttpOnly()
  170. {
  171. $cookie = Cookie::fromString('foo=bar; expires=Fri, 20-May-2011 15:25:52 GMT; path=/; domain=.myfoodomain.com; secure; httponly');
  172. $this->assertTrue($cookie->isHttpOnly());
  173. $cookie = Cookie::fromString('foo=bar; expires=Fri, 20-May-2011 15:25:52 GMT; path=/; domain=.myfoodomain.com; secure');
  174. $this->assertFalse($cookie->isHttpOnly());
  175. }
  176. public function testSameSiteAttributeIsCaseInsensitive()
  177. {
  178. $cookie = new Cookie('foo', 'bar', 0, '/', null, false, true, false, 'Lax');
  179. $this->assertEquals('lax', $cookie->getSameSite());
  180. }
  181. }