Updating Media dependent modules to versions compatible with core Media.
[yaffs-website] / vendor / symfony / http-kernel / Tests / Fragment / InlineFragmentRendererTest.php
1 <?php
2
3 /*
4  * This file is part of the Symfony package.
5  *
6  * (c) Fabien Potencier <fabien@symfony.com>
7  *
8  * For the full copyright and license information, please view the LICENSE
9  * file that was distributed with this source code.
10  */
11
12 namespace Symfony\Component\HttpKernel\Tests\Fragment;
13
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;
25
26 class InlineFragmentRendererTest extends TestCase
27 {
28     public function testRender()
29     {
30         $strategy = new InlineFragmentRenderer($this->getKernel($this->returnValue(new Response('foo'))));
31
32         $this->assertEquals('foo', $strategy->render('/', Request::create('/'))->getContent());
33     }
34
35     public function testRenderWithControllerReference()
36     {
37         $strategy = new InlineFragmentRenderer($this->getKernel($this->returnValue(new Response('foo'))));
38
39         $this->assertEquals('foo', $strategy->render(new ControllerReference('main_controller', array(), array()), Request::create('/'))->getContent());
40     }
41
42     public function testRenderWithObjectsAsAttributes()
43     {
44         $object = new \stdClass();
45
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');
50
51         $strategy = new InlineFragmentRenderer($this->getKernelExpectingRequest($subRequest));
52
53         $this->assertSame('foo', $strategy->render(new ControllerReference('main_controller', array('object' => $object), array()), Request::create('/'))->getContent());
54     }
55
56     /**
57      * @group legacy
58      */
59     public function testRenderWithObjectsAsAttributesPassedAsObjectsInTheControllerLegacy()
60     {
61         $resolver = $this->getMockBuilder('Symfony\\Component\\HttpKernel\\Controller\\ControllerResolver')->setMethods(array('getController'))->getMock();
62         $resolver
63             ->expects($this->once())
64             ->method('getController')
65             ->will($this->returnValue(function (\stdClass $object, Bar $object1) {
66                 return new Response($object1->getBar());
67             }))
68         ;
69
70         $kernel = new HttpKernel(new EventDispatcher(), $resolver, new RequestStack());
71         $renderer = new InlineFragmentRenderer($kernel);
72
73         $response = $renderer->render(new ControllerReference('main_controller', array('object' => new \stdClass(), 'object1' => new Bar()), array()), Request::create('/'));
74         $this->assertEquals('bar', $response->getContent());
75     }
76
77     /**
78      * @group legacy
79      */
80     public function testRenderWithObjectsAsAttributesPassedAsObjectsInTheController()
81     {
82         $resolver = $this->getMockBuilder(ControllerResolverInterface::class)->getMock();
83         $resolver
84             ->expects($this->once())
85             ->method('getController')
86             ->will($this->returnValue(function (\stdClass $object, Bar $object1) {
87                 return new Response($object1->getBar());
88             }))
89         ;
90
91         $kernel = new HttpKernel(new EventDispatcher(), $resolver, new RequestStack(), new ArgumentResolver());
92         $renderer = new InlineFragmentRenderer($kernel);
93
94         $response = $renderer->render(new ControllerReference('main_controller', array('object' => new \stdClass(), 'object1' => new Bar()), array()), Request::create('/'));
95         $this->assertEquals('bar', $response->getContent());
96     }
97
98     public function testRenderWithTrustedHeaderDisabled()
99     {
100         Request::setTrustedProxies(array(), 0);
101
102         $strategy = new InlineFragmentRenderer($this->getKernelExpectingRequest(Request::create('/')));
103         $this->assertSame('foo', $strategy->render('/', Request::create('/'))->getContent());
104
105         Request::setTrustedProxies(array(), -1);
106     }
107
108     /**
109      * @expectedException \RuntimeException
110      */
111     public function testRenderExceptionNoIgnoreErrors()
112     {
113         $dispatcher = $this->getMockBuilder('Symfony\Component\EventDispatcher\EventDispatcherInterface')->getMock();
114         $dispatcher->expects($this->never())->method('dispatch');
115
116         $strategy = new InlineFragmentRenderer($this->getKernel($this->throwException(new \RuntimeException('foo'))), $dispatcher);
117
118         $this->assertEquals('foo', $strategy->render('/', Request::create('/'))->getContent());
119     }
120
121     public function testRenderExceptionIgnoreErrors()
122     {
123         $dispatcher = $this->getMockBuilder('Symfony\Component\EventDispatcher\EventDispatcherInterface')->getMock();
124         $dispatcher->expects($this->once())->method('dispatch')->with(KernelEvents::EXCEPTION);
125
126         $strategy = new InlineFragmentRenderer($this->getKernel($this->throwException(new \RuntimeException('foo'))), $dispatcher);
127
128         $this->assertEmpty($strategy->render('/', Request::create('/'), array('ignore_errors' => true))->getContent());
129     }
130
131     public function testRenderExceptionIgnoreErrorsWithAlt()
132     {
133         $strategy = new InlineFragmentRenderer($this->getKernel($this->onConsecutiveCalls(
134             $this->throwException(new \RuntimeException('foo')),
135             $this->returnValue(new Response('bar'))
136         )));
137
138         $this->assertEquals('bar', $strategy->render('/', Request::create('/'), array('ignore_errors' => true, 'alt' => '/foo'))->getContent());
139     }
140
141     private function getKernel($returnValue)
142     {
143         $kernel = $this->getMockBuilder('Symfony\Component\HttpKernel\HttpKernelInterface')->getMock();
144         $kernel
145             ->expects($this->any())
146             ->method('handle')
147             ->will($returnValue)
148         ;
149
150         return $kernel;
151     }
152
153     public function testExceptionInSubRequestsDoesNotMangleOutputBuffers()
154     {
155         $controllerResolver = $this->getMockBuilder('Symfony\\Component\\HttpKernel\\Controller\\ControllerResolverInterface')->getMock();
156         $controllerResolver
157             ->expects($this->once())
158             ->method('getController')
159             ->will($this->returnValue(function () {
160                 ob_start();
161                 echo 'bar';
162                 throw new \RuntimeException();
163             }))
164         ;
165
166         $argumentResolver = $this->getMockBuilder('Symfony\\Component\\HttpKernel\\Controller\\ArgumentResolverInterface')->getMock();
167         $argumentResolver
168             ->expects($this->once())
169             ->method('getArguments')
170             ->will($this->returnValue(array()))
171         ;
172
173         $kernel = new HttpKernel(new EventDispatcher(), $controllerResolver, new RequestStack(), $argumentResolver);
174         $renderer = new InlineFragmentRenderer($kernel);
175
176         // simulate a main request with output buffering
177         ob_start();
178         echo 'Foo';
179
180         // simulate a sub-request with output buffering and an exception
181         $renderer->render('/', Request::create('/'), array('ignore_errors' => true));
182
183         $this->assertEquals('Foo', ob_get_clean());
184     }
185
186     public function testESIHeaderIsKeptInSubrequest()
187     {
188         $expectedSubRequest = Request::create('/');
189         $expectedSubRequest->headers->set('Surrogate-Capability', 'abc="ESI/1.0"');
190
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');
194         }
195
196         $strategy = new InlineFragmentRenderer($this->getKernelExpectingRequest($expectedSubRequest));
197
198         $request = Request::create('/');
199         $request->headers->set('Surrogate-Capability', 'abc="ESI/1.0"');
200         $strategy->render('/', $request);
201     }
202
203     public function testESIHeaderIsKeptInSubrequestWithTrustedHeaderDisabled()
204     {
205         Request::setTrustedProxies(array(), 0);
206
207         $this->testESIHeaderIsKeptInSubrequest();
208
209         Request::setTrustedProxies(array(), -1);
210     }
211
212     public function testHeadersPossiblyResultingIn304AreNotAssignedToSubrequest()
213     {
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');
218         }
219
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);
223     }
224
225     /**
226      * Creates a Kernel expecting a request equals to $request
227      * Allows delta in comparison in case REQUEST_TIME changed by 1 second.
228      */
229     private function getKernelExpectingRequest(Request $request, $strict = false)
230     {
231         $kernel = $this->getMockBuilder('Symfony\Component\HttpKernel\HttpKernelInterface')->getMock();
232         $kernel
233             ->expects($this->once())
234             ->method('handle')
235             ->with($this->equalTo($request, 1))
236             ->willReturn(new Response('foo'));
237
238         return $kernel;
239     }
240 }
241
242 class Bar
243 {
244     public $bar = 'bar';
245
246     public function getBar()
247     {
248         return $this->bar;
249     }
250 }