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 Symfony\Component\HttpFoundation\Request;
15 use Symfony\Component\HttpFoundation\Response;
18 * @group time-sensitive
20 class ResponseTest extends ResponseTestCase
22 public function testCreate()
24 $response = Response::create('foo', 301, array('Foo' => 'bar'));
26 $this->assertInstanceOf('Symfony\Component\HttpFoundation\Response', $response);
27 $this->assertEquals(301, $response->getStatusCode());
28 $this->assertEquals('bar', $response->headers->get('foo'));
31 public function testToString()
33 $response = new Response();
34 $response = explode("\r\n", $response);
35 $this->assertEquals('HTTP/1.0 200 OK', $response[0]);
36 $this->assertEquals('Cache-Control: no-cache, private', $response[1]);
39 public function testClone()
41 $response = new Response();
42 $responseClone = clone $response;
43 $this->assertEquals($response, $responseClone);
46 public function testSendHeaders()
48 $response = new Response();
49 $headers = $response->sendHeaders();
50 $this->assertObjectHasAttribute('headers', $headers);
51 $this->assertObjectHasAttribute('content', $headers);
52 $this->assertObjectHasAttribute('version', $headers);
53 $this->assertObjectHasAttribute('statusCode', $headers);
54 $this->assertObjectHasAttribute('statusText', $headers);
55 $this->assertObjectHasAttribute('charset', $headers);
58 public function testSend()
60 $response = new Response();
61 $responseSend = $response->send();
62 $this->assertObjectHasAttribute('headers', $responseSend);
63 $this->assertObjectHasAttribute('content', $responseSend);
64 $this->assertObjectHasAttribute('version', $responseSend);
65 $this->assertObjectHasAttribute('statusCode', $responseSend);
66 $this->assertObjectHasAttribute('statusText', $responseSend);
67 $this->assertObjectHasAttribute('charset', $responseSend);
70 public function testGetCharset()
72 $response = new Response();
73 $charsetOrigin = 'UTF-8';
74 $response->setCharset($charsetOrigin);
75 $charset = $response->getCharset();
76 $this->assertEquals($charsetOrigin, $charset);
79 public function testIsCacheable()
81 $response = new Response();
82 $this->assertFalse($response->isCacheable());
85 public function testIsCacheableWithErrorCode()
87 $response = new Response('', 500);
88 $this->assertFalse($response->isCacheable());
91 public function testIsCacheableWithNoStoreDirective()
93 $response = new Response();
94 $response->headers->set('cache-control', 'private');
95 $this->assertFalse($response->isCacheable());
98 public function testIsCacheableWithSetTtl()
100 $response = new Response();
101 $response->setTtl(10);
102 $this->assertTrue($response->isCacheable());
105 public function testMustRevalidate()
107 $response = new Response();
108 $this->assertFalse($response->mustRevalidate());
111 public function testMustRevalidateWithMustRevalidateCacheControlHeader()
113 $response = new Response();
114 $response->headers->set('cache-control', 'must-revalidate');
116 $this->assertTrue($response->mustRevalidate());
119 public function testMustRevalidateWithProxyRevalidateCacheControlHeader()
121 $response = new Response();
122 $response->headers->set('cache-control', 'proxy-revalidate');
124 $this->assertTrue($response->mustRevalidate());
127 public function testSetNotModified()
129 $response = new Response();
130 $modified = $response->setNotModified();
131 $this->assertObjectHasAttribute('headers', $modified);
132 $this->assertObjectHasAttribute('content', $modified);
133 $this->assertObjectHasAttribute('version', $modified);
134 $this->assertObjectHasAttribute('statusCode', $modified);
135 $this->assertObjectHasAttribute('statusText', $modified);
136 $this->assertObjectHasAttribute('charset', $modified);
137 $this->assertEquals(304, $modified->getStatusCode());
140 public function testIsSuccessful()
142 $response = new Response();
143 $this->assertTrue($response->isSuccessful());
146 public function testIsNotModified()
148 $response = new Response();
149 $modified = $response->isNotModified(new Request());
150 $this->assertFalse($modified);
153 public function testIsNotModifiedNotSafe()
155 $request = Request::create('/homepage', 'POST');
157 $response = new Response();
158 $this->assertFalse($response->isNotModified($request));
161 public function testIsNotModifiedLastModified()
163 $before = 'Sun, 25 Aug 2013 18:32:31 GMT';
164 $modified = 'Sun, 25 Aug 2013 18:33:31 GMT';
165 $after = 'Sun, 25 Aug 2013 19:33:31 GMT';
167 $request = new Request();
168 $request->headers->set('If-Modified-Since', $modified);
170 $response = new Response();
172 $response->headers->set('Last-Modified', $modified);
173 $this->assertTrue($response->isNotModified($request));
175 $response->headers->set('Last-Modified', $before);
176 $this->assertTrue($response->isNotModified($request));
178 $response->headers->set('Last-Modified', $after);
179 $this->assertFalse($response->isNotModified($request));
181 $response->headers->set('Last-Modified', '');
182 $this->assertFalse($response->isNotModified($request));
185 public function testIsNotModifiedEtag()
187 $etagOne = 'randomly_generated_etag';
188 $etagTwo = 'randomly_generated_etag_2';
190 $request = new Request();
191 $request->headers->set('if_none_match', sprintf('%s, %s, %s', $etagOne, $etagTwo, 'etagThree'));
193 $response = new Response();
195 $response->headers->set('ETag', $etagOne);
196 $this->assertTrue($response->isNotModified($request));
198 $response->headers->set('ETag', $etagTwo);
199 $this->assertTrue($response->isNotModified($request));
201 $response->headers->set('ETag', '');
202 $this->assertFalse($response->isNotModified($request));
205 public function testIsNotModifiedLastModifiedAndEtag()
207 $before = 'Sun, 25 Aug 2013 18:32:31 GMT';
208 $modified = 'Sun, 25 Aug 2013 18:33:31 GMT';
209 $after = 'Sun, 25 Aug 2013 19:33:31 GMT';
210 $etag = 'randomly_generated_etag';
212 $request = new Request();
213 $request->headers->set('if_none_match', sprintf('%s, %s', $etag, 'etagThree'));
214 $request->headers->set('If-Modified-Since', $modified);
216 $response = new Response();
218 $response->headers->set('ETag', $etag);
219 $response->headers->set('Last-Modified', $after);
220 $this->assertFalse($response->isNotModified($request));
222 $response->headers->set('ETag', 'non-existent-etag');
223 $response->headers->set('Last-Modified', $before);
224 $this->assertFalse($response->isNotModified($request));
226 $response->headers->set('ETag', $etag);
227 $response->headers->set('Last-Modified', $modified);
228 $this->assertTrue($response->isNotModified($request));
231 public function testIsNotModifiedIfModifiedSinceAndEtagWithoutLastModified()
233 $modified = 'Sun, 25 Aug 2013 18:33:31 GMT';
234 $etag = 'randomly_generated_etag';
236 $request = new Request();
237 $request->headers->set('if_none_match', sprintf('%s, %s', $etag, 'etagThree'));
238 $request->headers->set('If-Modified-Since', $modified);
240 $response = new Response();
242 $response->headers->set('ETag', $etag);
243 $this->assertTrue($response->isNotModified($request));
245 $response->headers->set('ETag', 'non-existent-etag');
246 $this->assertFalse($response->isNotModified($request));
249 public function testIsValidateable()
251 $response = new Response('', 200, array('Last-Modified' => $this->createDateTimeOneHourAgo()->format(DATE_RFC2822)));
252 $this->assertTrue($response->isValidateable(), '->isValidateable() returns true if Last-Modified is present');
254 $response = new Response('', 200, array('ETag' => '"12345"'));
255 $this->assertTrue($response->isValidateable(), '->isValidateable() returns true if ETag is present');
257 $response = new Response();
258 $this->assertFalse($response->isValidateable(), '->isValidateable() returns false when no validator is present');
261 public function testGetDate()
263 $oneHourAgo = $this->createDateTimeOneHourAgo();
264 $response = new Response('', 200, array('Date' => $oneHourAgo->format(DATE_RFC2822)));
265 $date = $response->getDate();
266 $this->assertEquals($oneHourAgo->getTimestamp(), $date->getTimestamp(), '->getDate() returns the Date header if present');
268 $response = new Response();
269 $date = $response->getDate();
270 $this->assertEquals(time(), $date->getTimestamp(), '->getDate() returns the current Date if no Date header present');
272 $response = new Response('', 200, array('Date' => $this->createDateTimeOneHourAgo()->format(DATE_RFC2822)));
273 $now = $this->createDateTimeNow();
274 $response->headers->set('Date', $now->format(DATE_RFC2822));
275 $date = $response->getDate();
276 $this->assertEquals($now->getTimestamp(), $date->getTimestamp(), '->getDate() returns the date when the header has been modified');
278 $response = new Response('', 200);
279 $now = $this->createDateTimeNow();
280 $response->headers->remove('Date');
281 $date = $response->getDate();
282 $this->assertEquals($now->getTimestamp(), $date->getTimestamp(), '->getDate() returns the current Date when the header has previously been removed');
285 public function testGetMaxAge()
287 $response = new Response();
288 $response->headers->set('Cache-Control', 's-maxage=600, max-age=0');
289 $this->assertEquals(600, $response->getMaxAge(), '->getMaxAge() uses s-maxage cache control directive when present');
291 $response = new Response();
292 $response->headers->set('Cache-Control', 'max-age=600');
293 $this->assertEquals(600, $response->getMaxAge(), '->getMaxAge() falls back to max-age when no s-maxage directive present');
295 $response = new Response();
296 $response->headers->set('Cache-Control', 'must-revalidate');
297 $response->headers->set('Expires', $this->createDateTimeOneHourLater()->format(DATE_RFC2822));
298 $this->assertEquals(3600, $response->getMaxAge(), '->getMaxAge() falls back to Expires when no max-age or s-maxage directive present');
300 $response = new Response();
301 $response->headers->set('Cache-Control', 'must-revalidate');
302 $response->headers->set('Expires', -1);
303 $this->assertEquals('Sat, 01 Jan 00 00:00:00 +0000', $response->getExpires()->format(DATE_RFC822));
305 $response = new Response();
306 $this->assertNull($response->getMaxAge(), '->getMaxAge() returns null if no freshness information available');
309 public function testSetSharedMaxAge()
311 $response = new Response();
312 $response->setSharedMaxAge(20);
314 $cacheControl = $response->headers->get('Cache-Control');
315 $this->assertEquals('public, s-maxage=20', $cacheControl);
318 public function testIsPrivate()
320 $response = new Response();
321 $response->headers->set('Cache-Control', 'max-age=100');
322 $response->setPrivate();
323 $this->assertEquals(100, $response->headers->getCacheControlDirective('max-age'), '->isPrivate() adds the private Cache-Control directive when set to true');
324 $this->assertTrue($response->headers->getCacheControlDirective('private'), '->isPrivate() adds the private Cache-Control directive when set to true');
326 $response = new Response();
327 $response->headers->set('Cache-Control', 'public, max-age=100');
328 $response->setPrivate();
329 $this->assertEquals(100, $response->headers->getCacheControlDirective('max-age'), '->isPrivate() adds the private Cache-Control directive when set to true');
330 $this->assertTrue($response->headers->getCacheControlDirective('private'), '->isPrivate() adds the private Cache-Control directive when set to true');
331 $this->assertFalse($response->headers->hasCacheControlDirective('public'), '->isPrivate() removes the public Cache-Control directive');
334 public function testExpire()
336 $response = new Response();
337 $response->headers->set('Cache-Control', 'max-age=100');
339 $this->assertEquals(100, $response->headers->get('Age'), '->expire() sets the Age to max-age when present');
341 $response = new Response();
342 $response->headers->set('Cache-Control', 'max-age=100, s-maxage=500');
344 $this->assertEquals(500, $response->headers->get('Age'), '->expire() sets the Age to s-maxage when both max-age and s-maxage are present');
346 $response = new Response();
347 $response->headers->set('Cache-Control', 'max-age=5, s-maxage=500');
348 $response->headers->set('Age', '1000');
350 $this->assertEquals(1000, $response->headers->get('Age'), '->expire() does nothing when the response is already stale/expired');
352 $response = new Response();
354 $this->assertFalse($response->headers->has('Age'), '->expire() does nothing when the response does not include freshness information');
356 $response = new Response();
357 $response->headers->set('Expires', -1);
359 $this->assertNull($response->headers->get('Age'), '->expire() does not set the Age when the response is expired');
362 public function testGetTtl()
364 $response = new Response();
365 $this->assertNull($response->getTtl(), '->getTtl() returns null when no Expires or Cache-Control headers are present');
367 $response = new Response();
368 $response->headers->set('Expires', $this->createDateTimeOneHourLater()->format(DATE_RFC2822));
369 $this->assertEquals(3600, $response->getTtl(), '->getTtl() uses the Expires header when no max-age is present');
371 $response = new Response();
372 $response->headers->set('Expires', $this->createDateTimeOneHourAgo()->format(DATE_RFC2822));
373 $this->assertLessThan(0, $response->getTtl(), '->getTtl() returns negative values when Expires is in past');
375 $response = new Response();
376 $response->headers->set('Expires', $response->getDate()->format(DATE_RFC2822));
377 $response->headers->set('Age', 0);
378 $this->assertSame(0, $response->getTtl(), '->getTtl() correctly handles zero');
380 $response = new Response();
381 $response->headers->set('Cache-Control', 'max-age=60');
382 $this->assertEquals(60, $response->getTtl(), '->getTtl() uses Cache-Control max-age when present');
385 public function testSetClientTtl()
387 $response = new Response();
388 $response->setClientTtl(10);
390 $this->assertEquals($response->getMaxAge(), $response->getAge() + 10);
393 public function testGetSetProtocolVersion()
395 $response = new Response();
397 $this->assertEquals('1.0', $response->getProtocolVersion());
399 $response->setProtocolVersion('1.1');
401 $this->assertEquals('1.1', $response->getProtocolVersion());
404 public function testGetVary()
406 $response = new Response();
407 $this->assertEquals(array(), $response->getVary(), '->getVary() returns an empty array if no Vary header is present');
409 $response = new Response();
410 $response->headers->set('Vary', 'Accept-Language');
411 $this->assertEquals(array('Accept-Language'), $response->getVary(), '->getVary() parses a single header name value');
413 $response = new Response();
414 $response->headers->set('Vary', 'Accept-Language User-Agent X-Foo');
415 $this->assertEquals(array('Accept-Language', 'User-Agent', 'X-Foo'), $response->getVary(), '->getVary() parses multiple header name values separated by spaces');
417 $response = new Response();
418 $response->headers->set('Vary', 'Accept-Language,User-Agent, X-Foo');
419 $this->assertEquals(array('Accept-Language', 'User-Agent', 'X-Foo'), $response->getVary(), '->getVary() parses multiple header name values separated by commas');
421 $vary = array('Accept-Language', 'User-Agent', 'X-foo');
423 $response = new Response();
424 $response->headers->set('Vary', $vary);
425 $this->assertEquals($vary, $response->getVary(), '->getVary() parses multiple header name values in arrays');
427 $response = new Response();
428 $response->headers->set('Vary', 'Accept-Language, User-Agent, X-foo');
429 $this->assertEquals($vary, $response->getVary(), '->getVary() parses multiple header name values in arrays');
432 public function testSetVary()
434 $response = new Response();
435 $response->setVary('Accept-Language');
436 $this->assertEquals(array('Accept-Language'), $response->getVary());
438 $response->setVary('Accept-Language, User-Agent');
439 $this->assertEquals(array('Accept-Language', 'User-Agent'), $response->getVary(), '->setVary() replace the vary header by default');
441 $response->setVary('X-Foo', false);
442 $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');
445 public function testDefaultContentType()
447 $headerMock = $this->getMockBuilder('Symfony\Component\HttpFoundation\ResponseHeaderBag')->setMethods(array('set'))->getMock();
448 $headerMock->expects($this->at(0))
450 ->with('Content-Type', 'text/html');
451 $headerMock->expects($this->at(1))
453 ->with('Content-Type', 'text/html; charset=UTF-8');
455 $response = new Response('foo');
456 $response->headers = $headerMock;
458 $response->prepare(new Request());
461 public function testContentTypeCharset()
463 $response = new Response();
464 $response->headers->set('Content-Type', 'text/css');
466 // force fixContentType() to be called
467 $response->prepare(new Request());
469 $this->assertEquals('text/css; charset=UTF-8', $response->headers->get('Content-Type'));
472 public function testPrepareDoesNothingIfContentTypeIsSet()
474 $response = new Response('foo');
475 $response->headers->set('Content-Type', 'text/plain');
477 $response->prepare(new Request());
479 $this->assertEquals('text/plain; charset=UTF-8', $response->headers->get('content-type'));
482 public function testPrepareDoesNothingIfRequestFormatIsNotDefined()
484 $response = new Response('foo');
486 $response->prepare(new Request());
488 $this->assertEquals('text/html; charset=UTF-8', $response->headers->get('content-type'));
491 public function testPrepareSetContentType()
493 $response = new Response('foo');
494 $request = Request::create('/');
495 $request->setRequestFormat('json');
497 $response->prepare($request);
499 $this->assertEquals('application/json', $response->headers->get('content-type'));
502 public function testPrepareRemovesContentForHeadRequests()
504 $response = new Response('foo');
505 $request = Request::create('/', 'HEAD');
508 $response->headers->set('Content-Length', $length);
509 $response->prepare($request);
511 $this->assertEquals('', $response->getContent());
512 $this->assertEquals($length, $response->headers->get('Content-Length'), 'Content-Length should be as if it was GET; see RFC2616 14.13');
515 public function testPrepareRemovesContentForInformationalResponse()
517 $response = new Response('foo');
518 $request = Request::create('/');
520 $response->setContent('content');
521 $response->setStatusCode(101);
522 $response->prepare($request);
523 $this->assertEquals('', $response->getContent());
524 $this->assertFalse($response->headers->has('Content-Type'));
525 $this->assertFalse($response->headers->has('Content-Type'));
527 $response->setContent('content');
528 $response->setStatusCode(304);
529 $response->prepare($request);
530 $this->assertEquals('', $response->getContent());
531 $this->assertFalse($response->headers->has('Content-Type'));
532 $this->assertFalse($response->headers->has('Content-Length'));
535 public function testPrepareRemovesContentLength()
537 $response = new Response('foo');
538 $request = Request::create('/');
540 $response->headers->set('Content-Length', 12345);
541 $response->prepare($request);
542 $this->assertEquals(12345, $response->headers->get('Content-Length'));
544 $response->headers->set('Transfer-Encoding', 'chunked');
545 $response->prepare($request);
546 $this->assertFalse($response->headers->has('Content-Length'));
549 public function testPrepareSetsPragmaOnHttp10Only()
551 $request = Request::create('/', 'GET');
552 $request->server->set('SERVER_PROTOCOL', 'HTTP/1.0');
554 $response = new Response('foo');
555 $response->prepare($request);
556 $this->assertEquals('no-cache', $response->headers->get('pragma'));
557 $this->assertEquals('-1', $response->headers->get('expires'));
559 $request->server->set('SERVER_PROTOCOL', 'HTTP/1.1');
560 $response = new Response('foo');
561 $response->prepare($request);
562 $this->assertFalse($response->headers->has('pragma'));
563 $this->assertFalse($response->headers->has('expires'));
566 public function testSetCache()
568 $response = new Response();
569 //array('etag', 'last_modified', 'max_age', 's_maxage', 'private', 'public')
571 $response->setCache(array('wrong option' => 'value'));
572 $this->fail('->setCache() throws an InvalidArgumentException if an option is not supported');
573 } catch (\Exception $e) {
574 $this->assertInstanceOf('InvalidArgumentException', $e, '->setCache() throws an InvalidArgumentException if an option is not supported');
575 $this->assertContains('"wrong option"', $e->getMessage());
578 $options = array('etag' => '"whatever"');
579 $response->setCache($options);
580 $this->assertEquals($response->getEtag(), '"whatever"');
582 $now = $this->createDateTimeNow();
583 $options = array('last_modified' => $now);
584 $response->setCache($options);
585 $this->assertEquals($response->getLastModified()->getTimestamp(), $now->getTimestamp());
587 $options = array('max_age' => 100);
588 $response->setCache($options);
589 $this->assertEquals($response->getMaxAge(), 100);
591 $options = array('s_maxage' => 200);
592 $response->setCache($options);
593 $this->assertEquals($response->getMaxAge(), 200);
595 $this->assertTrue($response->headers->hasCacheControlDirective('public'));
596 $this->assertFalse($response->headers->hasCacheControlDirective('private'));
598 $response->setCache(array('public' => true));
599 $this->assertTrue($response->headers->hasCacheControlDirective('public'));
600 $this->assertFalse($response->headers->hasCacheControlDirective('private'));
602 $response->setCache(array('public' => false));
603 $this->assertFalse($response->headers->hasCacheControlDirective('public'));
604 $this->assertTrue($response->headers->hasCacheControlDirective('private'));
606 $response->setCache(array('private' => true));
607 $this->assertFalse($response->headers->hasCacheControlDirective('public'));
608 $this->assertTrue($response->headers->hasCacheControlDirective('private'));
610 $response->setCache(array('private' => false));
611 $this->assertTrue($response->headers->hasCacheControlDirective('public'));
612 $this->assertFalse($response->headers->hasCacheControlDirective('private'));
615 public function testSendContent()
617 $response = new Response('test response rendering', 200);
620 $response->sendContent();
621 $string = ob_get_clean();
622 $this->assertContains('test response rendering', $string);
625 public function testSetPublic()
627 $response = new Response();
628 $response->setPublic();
630 $this->assertTrue($response->headers->hasCacheControlDirective('public'));
631 $this->assertFalse($response->headers->hasCacheControlDirective('private'));
634 public function testSetExpires()
636 $response = new Response();
637 $response->setExpires(null);
639 $this->assertNull($response->getExpires(), '->setExpires() remove the header when passed null');
641 $now = $this->createDateTimeNow();
642 $response->setExpires($now);
644 $this->assertEquals($response->getExpires()->getTimestamp(), $now->getTimestamp());
647 public function testSetLastModified()
649 $response = new Response();
650 $response->setLastModified($this->createDateTimeNow());
651 $this->assertNotNull($response->getLastModified());
653 $response->setLastModified(null);
654 $this->assertNull($response->getLastModified());
657 public function testIsInvalid()
659 $response = new Response();
662 $response->setStatusCode(99);
664 } catch (\InvalidArgumentException $e) {
665 $this->assertTrue($response->isInvalid());
669 $response->setStatusCode(650);
671 } catch (\InvalidArgumentException $e) {
672 $this->assertTrue($response->isInvalid());
675 $response = new Response('', 200);
676 $this->assertFalse($response->isInvalid());
680 * @dataProvider getStatusCodeFixtures
682 public function testSetStatusCode($code, $text, $expectedText)
684 $response = new Response();
686 $response->setStatusCode($code, $text);
688 $statusText = new \ReflectionProperty($response, 'statusText');
689 $statusText->setAccessible(true);
691 $this->assertEquals($expectedText, $statusText->getValue($response));
694 public function getStatusCodeFixtures()
697 array('200', null, 'OK'),
698 array('200', false, ''),
699 array('200', 'foo', 'foo'),
700 array('199', null, 'unknown status'),
701 array('199', false, ''),
702 array('199', 'foo', 'foo'),
706 public function testIsInformational()
708 $response = new Response('', 100);
709 $this->assertTrue($response->isInformational());
711 $response = new Response('', 200);
712 $this->assertFalse($response->isInformational());
715 public function testIsRedirectRedirection()
717 foreach (array(301, 302, 303, 307) as $code) {
718 $response = new Response('', $code);
719 $this->assertTrue($response->isRedirection());
720 $this->assertTrue($response->isRedirect());
723 $response = new Response('', 304);
724 $this->assertTrue($response->isRedirection());
725 $this->assertFalse($response->isRedirect());
727 $response = new Response('', 200);
728 $this->assertFalse($response->isRedirection());
729 $this->assertFalse($response->isRedirect());
731 $response = new Response('', 404);
732 $this->assertFalse($response->isRedirection());
733 $this->assertFalse($response->isRedirect());
735 $response = new Response('', 301, array('Location' => '/good-uri'));
736 $this->assertFalse($response->isRedirect('/bad-uri'));
737 $this->assertTrue($response->isRedirect('/good-uri'));
740 public function testIsNotFound()
742 $response = new Response('', 404);
743 $this->assertTrue($response->isNotFound());
745 $response = new Response('', 200);
746 $this->assertFalse($response->isNotFound());
749 public function testIsEmpty()
751 foreach (array(204, 304) as $code) {
752 $response = new Response('', $code);
753 $this->assertTrue($response->isEmpty());
756 $response = new Response('', 200);
757 $this->assertFalse($response->isEmpty());
760 public function testIsForbidden()
762 $response = new Response('', 403);
763 $this->assertTrue($response->isForbidden());
765 $response = new Response('', 200);
766 $this->assertFalse($response->isForbidden());
769 public function testIsOk()
771 $response = new Response('', 200);
772 $this->assertTrue($response->isOk());
774 $response = new Response('', 404);
775 $this->assertFalse($response->isOk());
778 public function testIsServerOrClientError()
780 $response = new Response('', 404);
781 $this->assertTrue($response->isClientError());
782 $this->assertFalse($response->isServerError());
784 $response = new Response('', 500);
785 $this->assertFalse($response->isClientError());
786 $this->assertTrue($response->isServerError());
789 public function testHasVary()
791 $response = new Response();
792 $this->assertFalse($response->hasVary());
794 $response->setVary('User-Agent');
795 $this->assertTrue($response->hasVary());
798 public function testSetEtag()
800 $response = new Response('', 200, array('ETag' => '"12345"'));
801 $response->setEtag();
803 $this->assertNull($response->headers->get('Etag'), '->setEtag() removes Etags when call with null');
807 * @dataProvider validContentProvider
809 public function testSetContent($content)
811 $response = new Response();
812 $response->setContent($content);
813 $this->assertEquals((string) $content, $response->getContent());
817 * @expectedException \UnexpectedValueException
818 * @dataProvider invalidContentProvider
820 public function testSetContentInvalid($content)
822 $response = new Response();
823 $response->setContent($content);
826 public function testSettersAreChainable()
828 $response = new Response();
831 'setProtocolVersion' => '1.0',
832 'setCharset' => 'UTF-8',
834 'setPrivate' => null,
835 'setDate' => $this->createDateTimeNow(),
838 'setSharedMaxAge' => 1,
843 foreach ($setters as $setter => $arg) {
844 $this->assertEquals($response, $response->{$setter}($arg));
848 public function testNoDeprecationsAreTriggered()
850 new DefaultResponse();
851 $this->getMockBuilder(Response::class)->getMock();
853 // we just need to ensure that subclasses of Response can be created without any deprecations
854 // being triggered if the subclass does not override any final methods
855 $this->addToAssertionCount(1);
860 * @expectedDeprecation Extending Symfony\Component\HttpFoundation\Response::getDate() in Symfony\Component\HttpFoundation\Tests\ExtendedResponse is deprecated %s.
861 * @expectedDeprecation Extending Symfony\Component\HttpFoundation\Response::setLastModified() in Symfony\Component\HttpFoundation\Tests\ExtendedResponse is deprecated %s.
863 public function testDeprecations()
865 new ExtendedResponse();
867 // Deprecations should not be triggered twice
868 new ExtendedResponse();
871 public function validContentProvider()
874 'obj' => array(new StringableObject()),
875 'string' => array('Foo'),
880 public function invalidContentProvider()
883 'obj' => array(new \stdClass()),
884 'array' => array(array()),
885 'bool' => array(true, '1'),
889 protected function createDateTimeOneHourAgo()
891 return $this->createDateTimeNow()->sub(new \DateInterval('PT1H'));
894 protected function createDateTimeOneHourLater()
896 return $this->createDateTimeNow()->add(new \DateInterval('PT1H'));
899 protected function createDateTimeNow()
901 $date = new \DateTime();
903 return $date->setTimestamp(time());
906 protected function provideResponse()
908 return new Response();
912 * @see http://github.com/zendframework/zend-diactoros for the canonical source repository
914 * @author Fábio Pacheco
915 * @copyright Copyright (c) 2015-2016 Zend Technologies USA Inc. (http://www.zend.com)
916 * @license https://github.com/zendframework/zend-diactoros/blob/master/LICENSE.md New BSD License
918 public function ianaCodesReasonPhrasesProvider()
920 if (!in_array('https', stream_get_wrappers(), true)) {
921 $this->markTestSkipped('The "https" wrapper is not available');
924 $ianaHttpStatusCodes = new \DOMDocument();
926 libxml_set_streams_context(stream_context_create(array(
933 $ianaHttpStatusCodes->load('https://www.iana.org/assignments/http-status-codes/http-status-codes.xml');
934 if (!$ianaHttpStatusCodes->relaxNGValidate(__DIR__.'/schema/http-status-codes.rng')) {
935 self::fail('Invalid IANA\'s HTTP status code list.');
938 $ianaCodesReasonPhrases = array();
940 $xpath = new \DomXPath($ianaHttpStatusCodes);
941 $xpath->registerNamespace('ns', 'http://www.iana.org/assignments');
943 $records = $xpath->query('//ns:record');
944 foreach ($records as $record) {
945 $value = $xpath->query('.//ns:value', $record)->item(0)->nodeValue;
946 $description = $xpath->query('.//ns:description', $record)->item(0)->nodeValue;
948 if (in_array($description, array('Unassigned', '(Unused)'), true)) {
952 if (preg_match('/^([0-9]+)\s*\-\s*([0-9]+)$/', $value, $matches)) {
953 for ($value = $matches[1]; $value <= $matches[2]; ++$value) {
954 $ianaCodesReasonPhrases[] = array($value, $description);
957 $ianaCodesReasonPhrases[] = array($value, $description);
961 return $ianaCodesReasonPhrases;
965 * @dataProvider ianaCodesReasonPhrasesProvider
967 public function testReasonPhraseDefaultsAgainstIana($code, $reasonPhrase)
969 $this->assertEquals($reasonPhrase, Response::$statusTexts[$code]);
973 class StringableObject
975 public function __toString()
981 class DefaultResponse extends Response
985 class ExtendedResponse extends Response
987 public function setLastModified(\DateTime $date = null)
991 public function getDate()