ResponseTest.php 34 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966
  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 Symfony\Component\HttpFoundation\Request;
  12. use Symfony\Component\HttpFoundation\Response;
  13. /**
  14. * @group time-sensitive
  15. */
  16. class ResponseTest extends ResponseTestCase
  17. {
  18. public function testCreate()
  19. {
  20. $response = Response::create('foo', 301, array('Foo' => 'bar'));
  21. $this->assertInstanceOf('Symfony\Component\HttpFoundation\Response', $response);
  22. $this->assertEquals(301, $response->getStatusCode());
  23. $this->assertEquals('bar', $response->headers->get('foo'));
  24. }
  25. public function testToString()
  26. {
  27. $response = new Response();
  28. $response = explode("\r\n", $response);
  29. $this->assertEquals('HTTP/1.0 200 OK', $response[0]);
  30. $this->assertEquals('Cache-Control: no-cache', $response[1]);
  31. }
  32. public function testClone()
  33. {
  34. $response = new Response();
  35. $responseClone = clone $response;
  36. $this->assertEquals($response, $responseClone);
  37. }
  38. public function testSendHeaders()
  39. {
  40. $response = new Response();
  41. $headers = $response->sendHeaders();
  42. $this->assertObjectHasAttribute('headers', $headers);
  43. $this->assertObjectHasAttribute('content', $headers);
  44. $this->assertObjectHasAttribute('version', $headers);
  45. $this->assertObjectHasAttribute('statusCode', $headers);
  46. $this->assertObjectHasAttribute('statusText', $headers);
  47. $this->assertObjectHasAttribute('charset', $headers);
  48. }
  49. public function testSend()
  50. {
  51. $response = new Response();
  52. $responseSend = $response->send();
  53. $this->assertObjectHasAttribute('headers', $responseSend);
  54. $this->assertObjectHasAttribute('content', $responseSend);
  55. $this->assertObjectHasAttribute('version', $responseSend);
  56. $this->assertObjectHasAttribute('statusCode', $responseSend);
  57. $this->assertObjectHasAttribute('statusText', $responseSend);
  58. $this->assertObjectHasAttribute('charset', $responseSend);
  59. }
  60. public function testGetCharset()
  61. {
  62. $response = new Response();
  63. $charsetOrigin = 'UTF-8';
  64. $response->setCharset($charsetOrigin);
  65. $charset = $response->getCharset();
  66. $this->assertEquals($charsetOrigin, $charset);
  67. }
  68. public function testIsCacheable()
  69. {
  70. $response = new Response();
  71. $this->assertFalse($response->isCacheable());
  72. }
  73. public function testIsCacheableWithErrorCode()
  74. {
  75. $response = new Response('', 500);
  76. $this->assertFalse($response->isCacheable());
  77. }
  78. public function testIsCacheableWithNoStoreDirective()
  79. {
  80. $response = new Response();
  81. $response->headers->set('cache-control', 'private');
  82. $this->assertFalse($response->isCacheable());
  83. }
  84. public function testIsCacheableWithSetTtl()
  85. {
  86. $response = new Response();
  87. $response->setTtl(10);
  88. $this->assertTrue($response->isCacheable());
  89. }
  90. public function testMustRevalidate()
  91. {
  92. $response = new Response();
  93. $this->assertFalse($response->mustRevalidate());
  94. }
  95. public function testMustRevalidateWithMustRevalidateCacheControlHeader()
  96. {
  97. $response = new Response();
  98. $response->headers->set('cache-control', 'must-revalidate');
  99. $this->assertTrue($response->mustRevalidate());
  100. }
  101. public function testMustRevalidateWithProxyRevalidateCacheControlHeader()
  102. {
  103. $response = new Response();
  104. $response->headers->set('cache-control', 'proxy-revalidate');
  105. $this->assertTrue($response->mustRevalidate());
  106. }
  107. public function testSetNotModified()
  108. {
  109. $response = new Response('foo');
  110. $modified = $response->setNotModified();
  111. $this->assertObjectHasAttribute('headers', $modified);
  112. $this->assertObjectHasAttribute('content', $modified);
  113. $this->assertObjectHasAttribute('version', $modified);
  114. $this->assertObjectHasAttribute('statusCode', $modified);
  115. $this->assertObjectHasAttribute('statusText', $modified);
  116. $this->assertObjectHasAttribute('charset', $modified);
  117. $this->assertEquals(304, $modified->getStatusCode());
  118. ob_start();
  119. $modified->sendContent();
  120. $string = ob_get_clean();
  121. $this->assertEmpty($string);
  122. }
  123. public function testIsSuccessful()
  124. {
  125. $response = new Response();
  126. $this->assertTrue($response->isSuccessful());
  127. }
  128. public function testIsNotModified()
  129. {
  130. $response = new Response();
  131. $modified = $response->isNotModified(new Request());
  132. $this->assertFalse($modified);
  133. }
  134. public function testIsNotModifiedNotSafe()
  135. {
  136. $request = Request::create('/homepage', 'POST');
  137. $response = new Response();
  138. $this->assertFalse($response->isNotModified($request));
  139. }
  140. public function testIsNotModifiedLastModified()
  141. {
  142. $before = 'Sun, 25 Aug 2013 18:32:31 GMT';
  143. $modified = 'Sun, 25 Aug 2013 18:33:31 GMT';
  144. $after = 'Sun, 25 Aug 2013 19:33:31 GMT';
  145. $request = new Request();
  146. $request->headers->set('If-Modified-Since', $modified);
  147. $response = new Response();
  148. $response->headers->set('Last-Modified', $modified);
  149. $this->assertTrue($response->isNotModified($request));
  150. $response->headers->set('Last-Modified', $before);
  151. $this->assertTrue($response->isNotModified($request));
  152. $response->headers->set('Last-Modified', $after);
  153. $this->assertFalse($response->isNotModified($request));
  154. $response->headers->set('Last-Modified', '');
  155. $this->assertFalse($response->isNotModified($request));
  156. }
  157. public function testIsNotModifiedEtag()
  158. {
  159. $etagOne = 'randomly_generated_etag';
  160. $etagTwo = 'randomly_generated_etag_2';
  161. $request = new Request();
  162. $request->headers->set('if_none_match', sprintf('%s, %s, %s', $etagOne, $etagTwo, 'etagThree'));
  163. $response = new Response();
  164. $response->headers->set('ETag', $etagOne);
  165. $this->assertTrue($response->isNotModified($request));
  166. $response->headers->set('ETag', $etagTwo);
  167. $this->assertTrue($response->isNotModified($request));
  168. $response->headers->set('ETag', '');
  169. $this->assertFalse($response->isNotModified($request));
  170. }
  171. public function testIsNotModifiedLastModifiedAndEtag()
  172. {
  173. $before = 'Sun, 25 Aug 2013 18:32:31 GMT';
  174. $modified = 'Sun, 25 Aug 2013 18:33:31 GMT';
  175. $after = 'Sun, 25 Aug 2013 19:33:31 GMT';
  176. $etag = 'randomly_generated_etag';
  177. $request = new Request();
  178. $request->headers->set('if_none_match', sprintf('%s, %s', $etag, 'etagThree'));
  179. $request->headers->set('If-Modified-Since', $modified);
  180. $response = new Response();
  181. $response->headers->set('ETag', $etag);
  182. $response->headers->set('Last-Modified', $after);
  183. $this->assertFalse($response->isNotModified($request));
  184. $response->headers->set('ETag', 'non-existent-etag');
  185. $response->headers->set('Last-Modified', $before);
  186. $this->assertFalse($response->isNotModified($request));
  187. $response->headers->set('ETag', $etag);
  188. $response->headers->set('Last-Modified', $modified);
  189. $this->assertTrue($response->isNotModified($request));
  190. }
  191. public function testIsNotModifiedIfModifiedSinceAndEtagWithoutLastModified()
  192. {
  193. $modified = 'Sun, 25 Aug 2013 18:33:31 GMT';
  194. $etag = 'randomly_generated_etag';
  195. $request = new Request();
  196. $request->headers->set('if_none_match', sprintf('%s, %s', $etag, 'etagThree'));
  197. $request->headers->set('If-Modified-Since', $modified);
  198. $response = new Response();
  199. $response->headers->set('ETag', $etag);
  200. $this->assertTrue($response->isNotModified($request));
  201. $response->headers->set('ETag', 'non-existent-etag');
  202. $this->assertFalse($response->isNotModified($request));
  203. }
  204. public function testIsValidateable()
  205. {
  206. $response = new Response('', 200, array('Last-Modified' => $this->createDateTimeOneHourAgo()->format(DATE_RFC2822)));
  207. $this->assertTrue($response->isValidateable(), '->isValidateable() returns true if Last-Modified is present');
  208. $response = new Response('', 200, array('ETag' => '"12345"'));
  209. $this->assertTrue($response->isValidateable(), '->isValidateable() returns true if ETag is present');
  210. $response = new Response();
  211. $this->assertFalse($response->isValidateable(), '->isValidateable() returns false when no validator is present');
  212. }
  213. public function testGetDate()
  214. {
  215. $oneHourAgo = $this->createDateTimeOneHourAgo();
  216. $response = new Response('', 200, array('Date' => $oneHourAgo->format(DATE_RFC2822)));
  217. $date = $response->getDate();
  218. $this->assertEquals($oneHourAgo->getTimestamp(), $date->getTimestamp(), '->getDate() returns the Date header if present');
  219. $response = new Response();
  220. $date = $response->getDate();
  221. $this->assertEquals(time(), $date->getTimestamp(), '->getDate() returns the current Date if no Date header present');
  222. $response = new Response('', 200, array('Date' => $this->createDateTimeOneHourAgo()->format(DATE_RFC2822)));
  223. $now = $this->createDateTimeNow();
  224. $response->headers->set('Date', $now->format(DATE_RFC2822));
  225. $date = $response->getDate();
  226. $this->assertEquals($now->getTimestamp(), $date->getTimestamp(), '->getDate() returns the date when the header has been modified');
  227. $response = new Response('', 200);
  228. $now = $this->createDateTimeNow();
  229. $response->headers->remove('Date');
  230. $date = $response->getDate();
  231. $this->assertEquals($now->getTimestamp(), $date->getTimestamp(), '->getDate() returns the current Date when the header has previously been removed');
  232. }
  233. public function testGetMaxAge()
  234. {
  235. $response = new Response();
  236. $response->headers->set('Cache-Control', 's-maxage=600, max-age=0');
  237. $this->assertEquals(600, $response->getMaxAge(), '->getMaxAge() uses s-maxage cache control directive when present');
  238. $response = new Response();
  239. $response->headers->set('Cache-Control', 'max-age=600');
  240. $this->assertEquals(600, $response->getMaxAge(), '->getMaxAge() falls back to max-age when no s-maxage directive present');
  241. $response = new Response();
  242. $response->headers->set('Cache-Control', 'must-revalidate');
  243. $response->headers->set('Expires', $this->createDateTimeOneHourLater()->format(DATE_RFC2822));
  244. $this->assertEquals(3600, $response->getMaxAge(), '->getMaxAge() falls back to Expires when no max-age or s-maxage directive present');
  245. $response = new Response();
  246. $response->headers->set('Cache-Control', 'must-revalidate');
  247. $response->headers->set('Expires', -1);
  248. $this->assertEquals('Sat, 01 Jan 00 00:00:00 +0000', $response->getExpires()->format(DATE_RFC822));
  249. $response = new Response();
  250. $this->assertNull($response->getMaxAge(), '->getMaxAge() returns null if no freshness information available');
  251. }
  252. public function testSetSharedMaxAge()
  253. {
  254. $response = new Response();
  255. $response->setSharedMaxAge(20);
  256. $cacheControl = $response->headers->get('Cache-Control');
  257. $this->assertEquals('public, s-maxage=20', $cacheControl);
  258. }
  259. public function testIsPrivate()
  260. {
  261. $response = new Response();
  262. $response->headers->set('Cache-Control', 'max-age=100');
  263. $response->setPrivate();
  264. $this->assertEquals(100, $response->headers->getCacheControlDirective('max-age'), '->isPrivate() adds the private Cache-Control directive when set to true');
  265. $this->assertTrue($response->headers->getCacheControlDirective('private'), '->isPrivate() adds the private Cache-Control directive when set to true');
  266. $response = new Response();
  267. $response->headers->set('Cache-Control', 'public, max-age=100');
  268. $response->setPrivate();
  269. $this->assertEquals(100, $response->headers->getCacheControlDirective('max-age'), '->isPrivate() adds the private Cache-Control directive when set to true');
  270. $this->assertTrue($response->headers->getCacheControlDirective('private'), '->isPrivate() adds the private Cache-Control directive when set to true');
  271. $this->assertFalse($response->headers->hasCacheControlDirective('public'), '->isPrivate() removes the public Cache-Control directive');
  272. }
  273. public function testExpire()
  274. {
  275. $response = new Response();
  276. $response->headers->set('Cache-Control', 'max-age=100');
  277. $response->expire();
  278. $this->assertEquals(100, $response->headers->get('Age'), '->expire() sets the Age to max-age when present');
  279. $response = new Response();
  280. $response->headers->set('Cache-Control', 'max-age=100, s-maxage=500');
  281. $response->expire();
  282. $this->assertEquals(500, $response->headers->get('Age'), '->expire() sets the Age to s-maxage when both max-age and s-maxage are present');
  283. $response = new Response();
  284. $response->headers->set('Cache-Control', 'max-age=5, s-maxage=500');
  285. $response->headers->set('Age', '1000');
  286. $response->expire();
  287. $this->assertEquals(1000, $response->headers->get('Age'), '->expire() does nothing when the response is already stale/expired');
  288. $response = new Response();
  289. $response->expire();
  290. $this->assertFalse($response->headers->has('Age'), '->expire() does nothing when the response does not include freshness information');
  291. $response = new Response();
  292. $response->headers->set('Expires', -1);
  293. $response->expire();
  294. $this->assertNull($response->headers->get('Age'), '->expire() does not set the Age when the response is expired');
  295. $response = new Response();
  296. $response->headers->set('Expires', date(DATE_RFC2822, time() + 600));
  297. $response->expire();
  298. $this->assertNull($response->headers->get('Expires'), '->expire() removes the Expires header when the response is fresh');
  299. }
  300. public function testGetTtl()
  301. {
  302. $response = new Response();
  303. $this->assertNull($response->getTtl(), '->getTtl() returns null when no Expires or Cache-Control headers are present');
  304. $response = new Response();
  305. $response->headers->set('Expires', $this->createDateTimeOneHourLater()->format(DATE_RFC2822));
  306. $this->assertEquals(3600, $response->getTtl(), '->getTtl() uses the Expires header when no max-age is present');
  307. $response = new Response();
  308. $response->headers->set('Expires', $this->createDateTimeOneHourAgo()->format(DATE_RFC2822));
  309. $this->assertLessThan(0, $response->getTtl(), '->getTtl() returns negative values when Expires is in past');
  310. $response = new Response();
  311. $response->headers->set('Expires', $response->getDate()->format(DATE_RFC2822));
  312. $response->headers->set('Age', 0);
  313. $this->assertSame(0, $response->getTtl(), '->getTtl() correctly handles zero');
  314. $response = new Response();
  315. $response->headers->set('Cache-Control', 'max-age=60');
  316. $this->assertEquals(60, $response->getTtl(), '->getTtl() uses Cache-Control max-age when present');
  317. }
  318. public function testSetClientTtl()
  319. {
  320. $response = new Response();
  321. $response->setClientTtl(10);
  322. $this->assertEquals($response->getMaxAge(), $response->getAge() + 10);
  323. }
  324. public function testGetSetProtocolVersion()
  325. {
  326. $response = new Response();
  327. $this->assertEquals('1.0', $response->getProtocolVersion());
  328. $response->setProtocolVersion('1.1');
  329. $this->assertEquals('1.1', $response->getProtocolVersion());
  330. }
  331. public function testGetVary()
  332. {
  333. $response = new Response();
  334. $this->assertEquals(array(), $response->getVary(), '->getVary() returns an empty array if no Vary header is present');
  335. $response = new Response();
  336. $response->headers->set('Vary', 'Accept-Language');
  337. $this->assertEquals(array('Accept-Language'), $response->getVary(), '->getVary() parses a single header name value');
  338. $response = new Response();
  339. $response->headers->set('Vary', 'Accept-Language User-Agent X-Foo');
  340. $this->assertEquals(array('Accept-Language', 'User-Agent', 'X-Foo'), $response->getVary(), '->getVary() parses multiple header name values separated by spaces');
  341. $response = new Response();
  342. $response->headers->set('Vary', 'Accept-Language,User-Agent, X-Foo');
  343. $this->assertEquals(array('Accept-Language', 'User-Agent', 'X-Foo'), $response->getVary(), '->getVary() parses multiple header name values separated by commas');
  344. $vary = array('Accept-Language', 'User-Agent', 'X-foo');
  345. $response = new Response();
  346. $response->headers->set('Vary', $vary);
  347. $this->assertEquals($vary, $response->getVary(), '->getVary() parses multiple header name values in arrays');
  348. $response = new Response();
  349. $response->headers->set('Vary', 'Accept-Language, User-Agent, X-foo');
  350. $this->assertEquals($vary, $response->getVary(), '->getVary() parses multiple header name values in arrays');
  351. }
  352. public function testSetVary()
  353. {
  354. $response = new Response();
  355. $response->setVary('Accept-Language');
  356. $this->assertEquals(array('Accept-Language'), $response->getVary());
  357. $response->setVary('Accept-Language, User-Agent');
  358. $this->assertEquals(array('Accept-Language', 'User-Agent'), $response->getVary(), '->setVary() replace the vary header by default');
  359. $response->setVary('X-Foo', false);
  360. $this->assertEquals(array('Accept-Language', 'User-Agent', 'X-Foo'), $response->getVary(), '->setVary() doesn\'t wipe out earlier Vary headers if replace is set to false');
  361. }
  362. public function testDefaultContentType()
  363. {
  364. $headerMock = $this->getMockBuilder('Symfony\Component\HttpFoundation\ResponseHeaderBag')->setMethods(array('set'))->getMock();
  365. $headerMock->expects($this->at(0))
  366. ->method('set')
  367. ->with('Content-Type', 'text/html');
  368. $headerMock->expects($this->at(1))
  369. ->method('set')
  370. ->with('Content-Type', 'text/html; charset=UTF-8');
  371. $response = new Response('foo');
  372. $response->headers = $headerMock;
  373. $response->prepare(new Request());
  374. }
  375. public function testContentTypeCharset()
  376. {
  377. $response = new Response();
  378. $response->headers->set('Content-Type', 'text/css');
  379. // force fixContentType() to be called
  380. $response->prepare(new Request());
  381. $this->assertEquals('text/css; charset=UTF-8', $response->headers->get('Content-Type'));
  382. }
  383. public function testPrepareDoesNothingIfContentTypeIsSet()
  384. {
  385. $response = new Response('foo');
  386. $response->headers->set('Content-Type', 'text/plain');
  387. $response->prepare(new Request());
  388. $this->assertEquals('text/plain; charset=UTF-8', $response->headers->get('content-type'));
  389. }
  390. public function testPrepareDoesNothingIfRequestFormatIsNotDefined()
  391. {
  392. $response = new Response('foo');
  393. $response->prepare(new Request());
  394. $this->assertEquals('text/html; charset=UTF-8', $response->headers->get('content-type'));
  395. }
  396. public function testPrepareSetContentType()
  397. {
  398. $response = new Response('foo');
  399. $request = Request::create('/');
  400. $request->setRequestFormat('json');
  401. $response->prepare($request);
  402. $this->assertEquals('application/json', $response->headers->get('content-type'));
  403. }
  404. public function testPrepareRemovesContentForHeadRequests()
  405. {
  406. $response = new Response('foo');
  407. $request = Request::create('/', 'HEAD');
  408. $length = 12345;
  409. $response->headers->set('Content-Length', $length);
  410. $response->prepare($request);
  411. $this->assertEquals('', $response->getContent());
  412. $this->assertEquals($length, $response->headers->get('Content-Length'), 'Content-Length should be as if it was GET; see RFC2616 14.13');
  413. }
  414. public function testPrepareRemovesContentForInformationalResponse()
  415. {
  416. $response = new Response('foo');
  417. $request = Request::create('/');
  418. $response->setContent('content');
  419. $response->setStatusCode(101);
  420. $response->prepare($request);
  421. $this->assertEquals('', $response->getContent());
  422. $this->assertFalse($response->headers->has('Content-Type'));
  423. $this->assertFalse($response->headers->has('Content-Type'));
  424. $response->setContent('content');
  425. $response->setStatusCode(304);
  426. $response->prepare($request);
  427. $this->assertEquals('', $response->getContent());
  428. $this->assertFalse($response->headers->has('Content-Type'));
  429. $this->assertFalse($response->headers->has('Content-Length'));
  430. }
  431. public function testPrepareRemovesContentLength()
  432. {
  433. $response = new Response('foo');
  434. $request = Request::create('/');
  435. $response->headers->set('Content-Length', 12345);
  436. $response->prepare($request);
  437. $this->assertEquals(12345, $response->headers->get('Content-Length'));
  438. $response->headers->set('Transfer-Encoding', 'chunked');
  439. $response->prepare($request);
  440. $this->assertFalse($response->headers->has('Content-Length'));
  441. }
  442. public function testPrepareSetsPragmaOnHttp10Only()
  443. {
  444. $request = Request::create('/', 'GET');
  445. $request->server->set('SERVER_PROTOCOL', 'HTTP/1.0');
  446. $response = new Response('foo');
  447. $response->prepare($request);
  448. $this->assertEquals('no-cache', $response->headers->get('pragma'));
  449. $this->assertEquals('-1', $response->headers->get('expires'));
  450. $request->server->set('SERVER_PROTOCOL', 'HTTP/1.1');
  451. $response = new Response('foo');
  452. $response->prepare($request);
  453. $this->assertFalse($response->headers->has('pragma'));
  454. $this->assertFalse($response->headers->has('expires'));
  455. }
  456. public function testSetCache()
  457. {
  458. $response = new Response();
  459. //array('etag', 'last_modified', 'max_age', 's_maxage', 'private', 'public')
  460. try {
  461. $response->setCache(array('wrong option' => 'value'));
  462. $this->fail('->setCache() throws an InvalidArgumentException if an option is not supported');
  463. } catch (\Exception $e) {
  464. $this->assertInstanceOf('InvalidArgumentException', $e, '->setCache() throws an InvalidArgumentException if an option is not supported');
  465. $this->assertContains('"wrong option"', $e->getMessage());
  466. }
  467. $options = array('etag' => '"whatever"');
  468. $response->setCache($options);
  469. $this->assertEquals($response->getEtag(), '"whatever"');
  470. $now = $this->createDateTimeNow();
  471. $options = array('last_modified' => $now);
  472. $response->setCache($options);
  473. $this->assertEquals($response->getLastModified()->getTimestamp(), $now->getTimestamp());
  474. $options = array('max_age' => 100);
  475. $response->setCache($options);
  476. $this->assertEquals($response->getMaxAge(), 100);
  477. $options = array('s_maxage' => 200);
  478. $response->setCache($options);
  479. $this->assertEquals($response->getMaxAge(), 200);
  480. $this->assertTrue($response->headers->hasCacheControlDirective('public'));
  481. $this->assertFalse($response->headers->hasCacheControlDirective('private'));
  482. $response->setCache(array('public' => true));
  483. $this->assertTrue($response->headers->hasCacheControlDirective('public'));
  484. $this->assertFalse($response->headers->hasCacheControlDirective('private'));
  485. $response->setCache(array('public' => false));
  486. $this->assertFalse($response->headers->hasCacheControlDirective('public'));
  487. $this->assertTrue($response->headers->hasCacheControlDirective('private'));
  488. $response->setCache(array('private' => true));
  489. $this->assertFalse($response->headers->hasCacheControlDirective('public'));
  490. $this->assertTrue($response->headers->hasCacheControlDirective('private'));
  491. $response->setCache(array('private' => false));
  492. $this->assertTrue($response->headers->hasCacheControlDirective('public'));
  493. $this->assertFalse($response->headers->hasCacheControlDirective('private'));
  494. }
  495. public function testSendContent()
  496. {
  497. $response = new Response('test response rendering', 200);
  498. ob_start();
  499. $response->sendContent();
  500. $string = ob_get_clean();
  501. $this->assertContains('test response rendering', $string);
  502. }
  503. public function testSetPublic()
  504. {
  505. $response = new Response();
  506. $response->setPublic();
  507. $this->assertTrue($response->headers->hasCacheControlDirective('public'));
  508. $this->assertFalse($response->headers->hasCacheControlDirective('private'));
  509. }
  510. public function testSetExpires()
  511. {
  512. $response = new Response();
  513. $response->setExpires(null);
  514. $this->assertNull($response->getExpires(), '->setExpires() remove the header when passed null');
  515. $now = $this->createDateTimeNow();
  516. $response->setExpires($now);
  517. $this->assertEquals($response->getExpires()->getTimestamp(), $now->getTimestamp());
  518. }
  519. public function testSetLastModified()
  520. {
  521. $response = new Response();
  522. $response->setLastModified($this->createDateTimeNow());
  523. $this->assertNotNull($response->getLastModified());
  524. $response->setLastModified(null);
  525. $this->assertNull($response->getLastModified());
  526. }
  527. public function testIsInvalid()
  528. {
  529. $response = new Response();
  530. try {
  531. $response->setStatusCode(99);
  532. $this->fail();
  533. } catch (\InvalidArgumentException $e) {
  534. $this->assertTrue($response->isInvalid());
  535. }
  536. try {
  537. $response->setStatusCode(650);
  538. $this->fail();
  539. } catch (\InvalidArgumentException $e) {
  540. $this->assertTrue($response->isInvalid());
  541. }
  542. $response = new Response('', 200);
  543. $this->assertFalse($response->isInvalid());
  544. }
  545. /**
  546. * @dataProvider getStatusCodeFixtures
  547. */
  548. public function testSetStatusCode($code, $text, $expectedText)
  549. {
  550. $response = new Response();
  551. $response->setStatusCode($code, $text);
  552. $statusText = new \ReflectionProperty($response, 'statusText');
  553. $statusText->setAccessible(true);
  554. $this->assertEquals($expectedText, $statusText->getValue($response));
  555. }
  556. public function getStatusCodeFixtures()
  557. {
  558. return array(
  559. array('200', null, 'OK'),
  560. array('200', false, ''),
  561. array('200', 'foo', 'foo'),
  562. array('199', null, 'unknown status'),
  563. array('199', false, ''),
  564. array('199', 'foo', 'foo'),
  565. );
  566. }
  567. public function testIsInformational()
  568. {
  569. $response = new Response('', 100);
  570. $this->assertTrue($response->isInformational());
  571. $response = new Response('', 200);
  572. $this->assertFalse($response->isInformational());
  573. }
  574. public function testIsRedirectRedirection()
  575. {
  576. foreach (array(301, 302, 303, 307) as $code) {
  577. $response = new Response('', $code);
  578. $this->assertTrue($response->isRedirection());
  579. $this->assertTrue($response->isRedirect());
  580. }
  581. $response = new Response('', 304);
  582. $this->assertTrue($response->isRedirection());
  583. $this->assertFalse($response->isRedirect());
  584. $response = new Response('', 200);
  585. $this->assertFalse($response->isRedirection());
  586. $this->assertFalse($response->isRedirect());
  587. $response = new Response('', 404);
  588. $this->assertFalse($response->isRedirection());
  589. $this->assertFalse($response->isRedirect());
  590. $response = new Response('', 301, array('Location' => '/good-uri'));
  591. $this->assertFalse($response->isRedirect('/bad-uri'));
  592. $this->assertTrue($response->isRedirect('/good-uri'));
  593. }
  594. public function testIsNotFound()
  595. {
  596. $response = new Response('', 404);
  597. $this->assertTrue($response->isNotFound());
  598. $response = new Response('', 200);
  599. $this->assertFalse($response->isNotFound());
  600. }
  601. public function testIsEmpty()
  602. {
  603. foreach (array(204, 304) as $code) {
  604. $response = new Response('', $code);
  605. $this->assertTrue($response->isEmpty());
  606. }
  607. $response = new Response('', 200);
  608. $this->assertFalse($response->isEmpty());
  609. }
  610. public function testIsForbidden()
  611. {
  612. $response = new Response('', 403);
  613. $this->assertTrue($response->isForbidden());
  614. $response = new Response('', 200);
  615. $this->assertFalse($response->isForbidden());
  616. }
  617. public function testIsOk()
  618. {
  619. $response = new Response('', 200);
  620. $this->assertTrue($response->isOk());
  621. $response = new Response('', 404);
  622. $this->assertFalse($response->isOk());
  623. }
  624. public function testIsServerOrClientError()
  625. {
  626. $response = new Response('', 404);
  627. $this->assertTrue($response->isClientError());
  628. $this->assertFalse($response->isServerError());
  629. $response = new Response('', 500);
  630. $this->assertFalse($response->isClientError());
  631. $this->assertTrue($response->isServerError());
  632. }
  633. public function testHasVary()
  634. {
  635. $response = new Response();
  636. $this->assertFalse($response->hasVary());
  637. $response->setVary('User-Agent');
  638. $this->assertTrue($response->hasVary());
  639. }
  640. public function testSetEtag()
  641. {
  642. $response = new Response('', 200, array('ETag' => '"12345"'));
  643. $response->setEtag();
  644. $this->assertNull($response->headers->get('Etag'), '->setEtag() removes Etags when call with null');
  645. }
  646. /**
  647. * @dataProvider validContentProvider
  648. */
  649. public function testSetContent($content)
  650. {
  651. $response = new Response();
  652. $response->setContent($content);
  653. $this->assertEquals((string) $content, $response->getContent());
  654. }
  655. /**
  656. * @expectedException \UnexpectedValueException
  657. * @dataProvider invalidContentProvider
  658. */
  659. public function testSetContentInvalid($content)
  660. {
  661. $response = new Response();
  662. $response->setContent($content);
  663. }
  664. public function testSettersAreChainable()
  665. {
  666. $response = new Response();
  667. $setters = array(
  668. 'setProtocolVersion' => '1.0',
  669. 'setCharset' => 'UTF-8',
  670. 'setPublic' => null,
  671. 'setPrivate' => null,
  672. 'setDate' => $this->createDateTimeNow(),
  673. 'expire' => null,
  674. 'setMaxAge' => 1,
  675. 'setSharedMaxAge' => 1,
  676. 'setTtl' => 1,
  677. 'setClientTtl' => 1,
  678. );
  679. foreach ($setters as $setter => $arg) {
  680. $this->assertEquals($response, $response->{$setter}($arg));
  681. }
  682. }
  683. public function validContentProvider()
  684. {
  685. return array(
  686. 'obj' => array(new StringableObject()),
  687. 'string' => array('Foo'),
  688. 'int' => array(2),
  689. );
  690. }
  691. public function invalidContentProvider()
  692. {
  693. return array(
  694. 'obj' => array(new \stdClass()),
  695. 'array' => array(array()),
  696. 'bool' => array(true, '1'),
  697. );
  698. }
  699. protected function createDateTimeOneHourAgo()
  700. {
  701. return $this->createDateTimeNow()->sub(new \DateInterval('PT1H'));
  702. }
  703. protected function createDateTimeOneHourLater()
  704. {
  705. return $this->createDateTimeNow()->add(new \DateInterval('PT1H'));
  706. }
  707. protected function createDateTimeNow()
  708. {
  709. $date = new \DateTime();
  710. return $date->setTimestamp(time());
  711. }
  712. protected function provideResponse()
  713. {
  714. return new Response();
  715. }
  716. /**
  717. * @see http://github.com/zendframework/zend-diactoros for the canonical source repository
  718. *
  719. * @author Fábio Pacheco
  720. * @copyright Copyright (c) 2015-2016 Zend Technologies USA Inc. (http://www.zend.com)
  721. * @license https://github.com/zendframework/zend-diactoros/blob/master/LICENSE.md New BSD License
  722. */
  723. public function ianaCodesReasonPhrasesProvider()
  724. {
  725. if (!\in_array('https', stream_get_wrappers(), true)) {
  726. $this->markTestSkipped('The "https" wrapper is not available');
  727. }
  728. $ianaHttpStatusCodes = new \DOMDocument();
  729. libxml_set_streams_context(stream_context_create(array(
  730. 'http' => array(
  731. 'method' => 'GET',
  732. 'timeout' => 30,
  733. ),
  734. )));
  735. $ianaHttpStatusCodes->load('https://www.iana.org/assignments/http-status-codes/http-status-codes.xml');
  736. if (!$ianaHttpStatusCodes->relaxNGValidate(__DIR__.'/schema/http-status-codes.rng')) {
  737. self::fail('Invalid IANA\'s HTTP status code list.');
  738. }
  739. $ianaCodesReasonPhrases = array();
  740. $xpath = new \DOMXPath($ianaHttpStatusCodes);
  741. $xpath->registerNamespace('ns', 'http://www.iana.org/assignments');
  742. $records = $xpath->query('//ns:record');
  743. foreach ($records as $record) {
  744. $value = $xpath->query('.//ns:value', $record)->item(0)->nodeValue;
  745. $description = $xpath->query('.//ns:description', $record)->item(0)->nodeValue;
  746. if (\in_array($description, array('Unassigned', '(Unused)'), true)) {
  747. continue;
  748. }
  749. if (preg_match('/^([0-9]+)\s*\-\s*([0-9]+)$/', $value, $matches)) {
  750. for ($value = $matches[1]; $value <= $matches[2]; ++$value) {
  751. $ianaCodesReasonPhrases[] = array($value, $description);
  752. }
  753. } else {
  754. $ianaCodesReasonPhrases[] = array($value, $description);
  755. }
  756. }
  757. return $ianaCodesReasonPhrases;
  758. }
  759. /**
  760. * @dataProvider ianaCodesReasonPhrasesProvider
  761. */
  762. public function testReasonPhraseDefaultsAgainstIana($code, $reasonPhrase)
  763. {
  764. $this->assertEquals($reasonPhrase, Response::$statusTexts[$code]);
  765. }
  766. }
  767. class StringableObject
  768. {
  769. public function __toString()
  770. {
  771. return 'Foo';
  772. }
  773. }