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\HttpKernel\Tests\Fragment;
14 use PHPUnit\Framework\TestCase;
15 use Symfony\Component\HttpFoundation\RequestStack;
16 use Symfony\Component\HttpKernel\Controller\ArgumentResolver;
17 use Symfony\Component\HttpKernel\Controller\ControllerResolverInterface;
18 use Symfony\Component\HttpKernel\Controller\ControllerReference;
19 use Symfony\Component\HttpKernel\HttpKernel;
20 use Symfony\Component\HttpKernel\Fragment\InlineFragmentRenderer;
21 use Symfony\Component\HttpKernel\KernelEvents;
22 use Symfony\Component\HttpFoundation\Request;
23 use Symfony\Component\HttpFoundation\Response;
24 use Symfony\Component\EventDispatcher\EventDispatcher;
26 class InlineFragmentRendererTest extends TestCase
28 public function testRender()
30 $strategy = new InlineFragmentRenderer($this->getKernel($this->returnValue(new Response('foo'))));
32 $this->assertEquals('foo', $strategy->render('/', Request::create('/'))->getContent());
35 public function testRenderWithControllerReference()
37 $strategy = new InlineFragmentRenderer($this->getKernel($this->returnValue(new Response('foo'))));
39 $this->assertEquals('foo', $strategy->render(new ControllerReference('main_controller', array(), array()), Request::create('/'))->getContent());
42 public function testRenderWithObjectsAsAttributes()
44 $object = new \stdClass();
46 $subRequest = Request::create('/_fragment?_path=_format%3Dhtml%26_locale%3Den%26_controller%3Dmain_controller');
47 $subRequest->attributes->replace(array('object' => $object, '_format' => 'html', '_controller' => 'main_controller', '_locale' => 'en'));
48 $subRequest->headers->set('x-forwarded-for', array('127.0.0.1'));
49 $subRequest->server->set('HTTP_X_FORWARDED_FOR', '127.0.0.1');
51 $strategy = new InlineFragmentRenderer($this->getKernelExpectingRequest($subRequest));
53 $this->assertSame('foo', $strategy->render(new ControllerReference('main_controller', array('object' => $object), array()), Request::create('/'))->getContent());
59 public function testRenderWithObjectsAsAttributesPassedAsObjectsInTheControllerLegacy()
61 $resolver = $this->getMockBuilder('Symfony\\Component\\HttpKernel\\Controller\\ControllerResolver')->setMethods(array('getController'))->getMock();
63 ->expects($this->once())
64 ->method('getController')
65 ->will($this->returnValue(function (\stdClass $object, Bar $object1) {
66 return new Response($object1->getBar());
70 $kernel = new HttpKernel(new EventDispatcher(), $resolver, new RequestStack());
71 $renderer = new InlineFragmentRenderer($kernel);
73 $response = $renderer->render(new ControllerReference('main_controller', array('object' => new \stdClass(), 'object1' => new Bar()), array()), Request::create('/'));
74 $this->assertEquals('bar', $response->getContent());
80 public function testRenderWithObjectsAsAttributesPassedAsObjectsInTheController()
82 $resolver = $this->getMockBuilder(ControllerResolverInterface::class)->getMock();
84 ->expects($this->once())
85 ->method('getController')
86 ->will($this->returnValue(function (\stdClass $object, Bar $object1) {
87 return new Response($object1->getBar());
91 $kernel = new HttpKernel(new EventDispatcher(), $resolver, new RequestStack(), new ArgumentResolver());
92 $renderer = new InlineFragmentRenderer($kernel);
94 $response = $renderer->render(new ControllerReference('main_controller', array('object' => new \stdClass(), 'object1' => new Bar()), array()), Request::create('/'));
95 $this->assertEquals('bar', $response->getContent());
98 public function testRenderWithTrustedHeaderDisabled()
100 Request::setTrustedProxies(array(), 0);
102 $strategy = new InlineFragmentRenderer($this->getKernelExpectingRequest(Request::create('/')));
103 $this->assertSame('foo', $strategy->render('/', Request::create('/'))->getContent());
105 Request::setTrustedProxies(array(), -1);
109 * @expectedException \RuntimeException
111 public function testRenderExceptionNoIgnoreErrors()
113 $dispatcher = $this->getMockBuilder('Symfony\Component\EventDispatcher\EventDispatcherInterface')->getMock();
114 $dispatcher->expects($this->never())->method('dispatch');
116 $strategy = new InlineFragmentRenderer($this->getKernel($this->throwException(new \RuntimeException('foo'))), $dispatcher);
118 $this->assertEquals('foo', $strategy->render('/', Request::create('/'))->getContent());
121 public function testRenderExceptionIgnoreErrors()
123 $dispatcher = $this->getMockBuilder('Symfony\Component\EventDispatcher\EventDispatcherInterface')->getMock();
124 $dispatcher->expects($this->once())->method('dispatch')->with(KernelEvents::EXCEPTION);
126 $strategy = new InlineFragmentRenderer($this->getKernel($this->throwException(new \RuntimeException('foo'))), $dispatcher);
128 $this->assertEmpty($strategy->render('/', Request::create('/'), array('ignore_errors' => true))->getContent());
131 public function testRenderExceptionIgnoreErrorsWithAlt()
133 $strategy = new InlineFragmentRenderer($this->getKernel($this->onConsecutiveCalls(
134 $this->throwException(new \RuntimeException('foo')),
135 $this->returnValue(new Response('bar'))
138 $this->assertEquals('bar', $strategy->render('/', Request::create('/'), array('ignore_errors' => true, 'alt' => '/foo'))->getContent());
141 private function getKernel($returnValue)
143 $kernel = $this->getMockBuilder('Symfony\Component\HttpKernel\HttpKernelInterface')->getMock();
145 ->expects($this->any())
153 public function testExceptionInSubRequestsDoesNotMangleOutputBuffers()
155 $controllerResolver = $this->getMockBuilder('Symfony\\Component\\HttpKernel\\Controller\\ControllerResolverInterface')->getMock();
157 ->expects($this->once())
158 ->method('getController')
159 ->will($this->returnValue(function () {
162 throw new \RuntimeException();
166 $argumentResolver = $this->getMockBuilder('Symfony\\Component\\HttpKernel\\Controller\\ArgumentResolverInterface')->getMock();
168 ->expects($this->once())
169 ->method('getArguments')
170 ->will($this->returnValue(array()))
173 $kernel = new HttpKernel(new EventDispatcher(), $controllerResolver, new RequestStack(), $argumentResolver);
174 $renderer = new InlineFragmentRenderer($kernel);
176 // simulate a main request with output buffering
180 // simulate a sub-request with output buffering and an exception
181 $renderer->render('/', Request::create('/'), array('ignore_errors' => true));
183 $this->assertEquals('Foo', ob_get_clean());
186 public function testESIHeaderIsKeptInSubrequest()
188 $expectedSubRequest = Request::create('/');
189 $expectedSubRequest->headers->set('Surrogate-Capability', 'abc="ESI/1.0"');
191 if (Request::HEADER_X_FORWARDED_FOR & Request::getTrustedHeaderSet()) {
192 $expectedSubRequest->headers->set('x-forwarded-for', array('127.0.0.1'));
193 $expectedSubRequest->server->set('HTTP_X_FORWARDED_FOR', '127.0.0.1');
196 $strategy = new InlineFragmentRenderer($this->getKernelExpectingRequest($expectedSubRequest));
198 $request = Request::create('/');
199 $request->headers->set('Surrogate-Capability', 'abc="ESI/1.0"');
200 $strategy->render('/', $request);
203 public function testESIHeaderIsKeptInSubrequestWithTrustedHeaderDisabled()
205 Request::setTrustedProxies(array(), 0);
207 $this->testESIHeaderIsKeptInSubrequest();
209 Request::setTrustedProxies(array(), -1);
212 public function testHeadersPossiblyResultingIn304AreNotAssignedToSubrequest()
214 $expectedSubRequest = Request::create('/');
215 if (Request::HEADER_X_FORWARDED_FOR & Request::getTrustedHeaderSet()) {
216 $expectedSubRequest->headers->set('x-forwarded-for', array('127.0.0.1'));
217 $expectedSubRequest->server->set('HTTP_X_FORWARDED_FOR', '127.0.0.1');
220 $strategy = new InlineFragmentRenderer($this->getKernelExpectingRequest($expectedSubRequest));
221 $request = Request::create('/', 'GET', array(), array(), array(), array('HTTP_IF_MODIFIED_SINCE' => 'Fri, 01 Jan 2016 00:00:00 GMT', 'HTTP_IF_NONE_MATCH' => '*'));
222 $strategy->render('/', $request);
226 * Creates a Kernel expecting a request equals to $request
227 * Allows delta in comparison in case REQUEST_TIME changed by 1 second.
229 private function getKernelExpectingRequest(Request $request, $strict = false)
231 $kernel = $this->getMockBuilder('Symfony\Component\HttpKernel\HttpKernelInterface')->getMock();
233 ->expects($this->once())
235 ->with($this->equalTo($request, 1))
236 ->willReturn(new Response('foo'));
246 public function getBar()