yaffs.net Git - yaffs-website/blob - 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\EventDispatcher\EventDispatcher;
  16 use Symfony\Component\HttpFoundation\Request;
  17 use Symfony\Component\HttpFoundation\RequestStack;
  18 use Symfony\Component\HttpFoundation\Response;
  19 use Symfony\Component\HttpKernel\Controller\ArgumentResolver;
  20 use Symfony\Component\HttpKernel\Controller\ControllerReference;
  21 use Symfony\Component\HttpKernel\Controller\ControllerResolverInterface;
  22 use Symfony\Component\HttpKernel\Fragment\InlineFragmentRenderer;
  23 use Symfony\Component\HttpKernel\HttpKernel;
  24 use Symfony\Component\HttpKernel\KernelEvents;
  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->headers->set('forwarded', array('for="127.0.0.1";host="localhost";proto=http'));
  50         $subRequest->server->set('HTTP_X_FORWARDED_FOR', '127.0.0.1');
  51         $subRequest->server->set('HTTP_FORWARDED', 'for="127.0.0.1";host="localhost";proto=http');
  52
  53         $strategy = new InlineFragmentRenderer($this->getKernelExpectingRequest($subRequest));
  54
  55         $this->assertSame('foo', $strategy->render(new ControllerReference('main_controller', array('object' => $object), array()), Request::create('/'))->getContent());
  56     }
  57
  58     /**
  59      * @group legacy
  60      */
  61     public function testRenderWithObjectsAsAttributesPassedAsObjectsInTheControllerLegacy()
  62     {
  63         $resolver = $this->getMockBuilder('Symfony\\Component\\HttpKernel\\Controller\\ControllerResolver')->setMethods(array('getController'))->getMock();
  64         $resolver
  65             ->expects($this->once())
  66             ->method('getController')
  67             ->will($this->returnValue(function (\stdClass $object, Bar $object1) {
  68                 return new Response($object1->getBar());
  69             }))
  70         ;
  71
  72         $kernel = new HttpKernel(new EventDispatcher(), $resolver, new RequestStack());
  73         $renderer = new InlineFragmentRenderer($kernel);
  74
  75         $response = $renderer->render(new ControllerReference('main_controller', array('object' => new \stdClass(), 'object1' => new Bar()), array()), Request::create('/'));
  76         $this->assertEquals('bar', $response->getContent());
  77     }
  78
  79     /**
  80      * @group legacy
  81      */
  82     public function testRenderWithObjectsAsAttributesPassedAsObjectsInTheController()
  83     {
  84         $resolver = $this->getMockBuilder(ControllerResolverInterface::class)->getMock();
  85         $resolver
  86             ->expects($this->once())
  87             ->method('getController')
  88             ->will($this->returnValue(function (\stdClass $object, Bar $object1) {
  89                 return new Response($object1->getBar());
  90             }))
  91         ;
  92
  93         $kernel = new HttpKernel(new EventDispatcher(), $resolver, new RequestStack(), new ArgumentResolver());
  94         $renderer = new InlineFragmentRenderer($kernel);
  95
  96         $response = $renderer->render(new ControllerReference('main_controller', array('object' => new \stdClass(), 'object1' => new Bar()), array()), Request::create('/'));
  97         $this->assertEquals('bar', $response->getContent());
  98     }
  99
 100     public function testRenderWithTrustedHeaderDisabled()
 101     {
 102         Request::setTrustedProxies(array(), 0);
 103
 104         $expectedSubRequest = Request::create('/');
 105         $expectedSubRequest->headers->set('x-forwarded-for', array('127.0.0.1'));
 106         $expectedSubRequest->server->set('HTTP_X_FORWARDED_FOR', '127.0.0.1');
 107
 108         $strategy = new InlineFragmentRenderer($this->getKernelExpectingRequest($expectedSubRequest));
 109         $this->assertSame('foo', $strategy->render('/', Request::create('/'))->getContent());
 110
 111         Request::setTrustedProxies(array(), -1);
 112     }
 113
 114     /**
 115      * @expectedException \RuntimeException
 116      */
 117     public function testRenderExceptionNoIgnoreErrors()
 118     {
 119         $dispatcher = $this->getMockBuilder('Symfony\Component\EventDispatcher\EventDispatcherInterface')->getMock();
 120         $dispatcher->expects($this->never())->method('dispatch');
 121
 122         $strategy = new InlineFragmentRenderer($this->getKernel($this->throwException(new \RuntimeException('foo'))), $dispatcher);
 123
 124         $this->assertEquals('foo', $strategy->render('/', Request::create('/'))->getContent());
 125     }
 126
 127     public function testRenderExceptionIgnoreErrors()
 128     {
 129         $dispatcher = $this->getMockBuilder('Symfony\Component\EventDispatcher\EventDispatcherInterface')->getMock();
 130         $dispatcher->expects($this->once())->method('dispatch')->with(KernelEvents::EXCEPTION);
 131
 132         $strategy = new InlineFragmentRenderer($this->getKernel($this->throwException(new \RuntimeException('foo'))), $dispatcher);
 133
 134         $this->assertEmpty($strategy->render('/', Request::create('/'), array('ignore_errors' => true))->getContent());
 135     }
 136
 137     public function testRenderExceptionIgnoreErrorsWithAlt()
 138     {
 139         $strategy = new InlineFragmentRenderer($this->getKernel($this->onConsecutiveCalls(
 140             $this->throwException(new \RuntimeException('foo')),
 141             $this->returnValue(new Response('bar'))
 142         )));
 143
 144         $this->assertEquals('bar', $strategy->render('/', Request::create('/'), array('ignore_errors' => true, 'alt' => '/foo'))->getContent());
 145     }
 146
 147     private function getKernel($returnValue)
 148     {
 149         $kernel = $this->getMockBuilder('Symfony\Component\HttpKernel\HttpKernelInterface')->getMock();
 150         $kernel
 151             ->expects($this->any())
 152             ->method('handle')
 153             ->will($returnValue)
 154         ;
 155
 156         return $kernel;
 157     }
 158
 159     public function testExceptionInSubRequestsDoesNotMangleOutputBuffers()
 160     {
 161         $controllerResolver = $this->getMockBuilder('Symfony\\Component\\HttpKernel\\Controller\\ControllerResolverInterface')->getMock();
 162         $controllerResolver
 163             ->expects($this->once())
 164             ->method('getController')
 165             ->will($this->returnValue(function () {
 166                 ob_start();
 167                 echo 'bar';
 168                 throw new \RuntimeException();
 169             }))
 170         ;
 171
 172         $argumentResolver = $this->getMockBuilder('Symfony\\Component\\HttpKernel\\Controller\\ArgumentResolverInterface')->getMock();
 173         $argumentResolver
 174             ->expects($this->once())
 175             ->method('getArguments')
 176             ->will($this->returnValue(array()))
 177         ;
 178
 179         $kernel = new HttpKernel(new EventDispatcher(), $controllerResolver, new RequestStack(), $argumentResolver);
 180         $renderer = new InlineFragmentRenderer($kernel);
 181
 182         // simulate a main request with output buffering
 183         ob_start();
 184         echo 'Foo';
 185
 186         // simulate a sub-request with output buffering and an exception
 187         $renderer->render('/', Request::create('/'), array('ignore_errors' => true));
 188
 189         $this->assertEquals('Foo', ob_get_clean());
 190     }
 191
 192     public function testLocaleAndFormatAreIsKeptInSubrequest()
 193     {
 194         $expectedSubRequest = Request::create('/');
 195         $expectedSubRequest->attributes->set('_format', 'foo');
 196         $expectedSubRequest->setLocale('fr');
 197         if (Request::HEADER_X_FORWARDED_FOR & Request::getTrustedHeaderSet()) {
 198             $expectedSubRequest->headers->set('x-forwarded-for', array('127.0.0.1'));
 199             $expectedSubRequest->server->set('HTTP_X_FORWARDED_FOR', '127.0.0.1');
 200         }
 201         $expectedSubRequest->headers->set('forwarded', array('for="127.0.0.1";host="localhost";proto=http'));
 202         $expectedSubRequest->server->set('HTTP_FORWARDED', 'for="127.0.0.1";host="localhost";proto=http');
 203
 204         $strategy = new InlineFragmentRenderer($this->getKernelExpectingRequest($expectedSubRequest));
 205
 206         $request = Request::create('/');
 207         $request->attributes->set('_format', 'foo');
 208         $request->setLocale('fr');
 209         $strategy->render('/', $request);
 210     }
 211
 212     public function testESIHeaderIsKeptInSubrequest()
 213     {
 214         $expectedSubRequest = Request::create('/');
 215         $expectedSubRequest->headers->set('Surrogate-Capability', 'abc="ESI/1.0"');
 216
 217         if (Request::HEADER_X_FORWARDED_FOR & Request::getTrustedHeaderSet()) {
 218             $expectedSubRequest->headers->set('x-forwarded-for', array('127.0.0.1'));
 219             $expectedSubRequest->server->set('HTTP_X_FORWARDED_FOR', '127.0.0.1');
 220         }
 221         $expectedSubRequest->headers->set('forwarded', array('for="127.0.0.1";host="localhost";proto=http'));
 222         $expectedSubRequest->server->set('HTTP_FORWARDED', 'for="127.0.0.1";host="localhost";proto=http');
 223
 224         $strategy = new InlineFragmentRenderer($this->getKernelExpectingRequest($expectedSubRequest));
 225
 226         $request = Request::create('/');
 227         $request->headers->set('Surrogate-Capability', 'abc="ESI/1.0"');
 228         $strategy->render('/', $request);
 229     }
 230
 231     public function testESIHeaderIsKeptInSubrequestWithTrustedHeaderDisabled()
 232     {
 233         Request::setTrustedProxies(array(), Request::HEADER_FORWARDED);
 234
 235         $this->testESIHeaderIsKeptInSubrequest();
 236
 237         Request::setTrustedProxies(array(), -1);
 238     }
 239
 240     public function testHeadersPossiblyResultingIn304AreNotAssignedToSubrequest()
 241     {
 242         $expectedSubRequest = Request::create('/');
 243         $expectedSubRequest->headers->set('x-forwarded-for', array('127.0.0.1'));
 244         $expectedSubRequest->headers->set('forwarded', array('for="127.0.0.1";host="localhost";proto=http'));
 245         $expectedSubRequest->server->set('HTTP_X_FORWARDED_FOR', '127.0.0.1');
 246         $expectedSubRequest->server->set('HTTP_FORWARDED', 'for="127.0.0.1";host="localhost";proto=http');
 247
 248         $strategy = new InlineFragmentRenderer($this->getKernelExpectingRequest($expectedSubRequest));
 249         $request = Request::create('/', 'GET', array(), array(), array(), array('HTTP_IF_MODIFIED_SINCE' => 'Fri, 01 Jan 2016 00:00:00 GMT', 'HTTP_IF_NONE_MATCH' => '*'));
 250         $strategy->render('/', $request);
 251     }
 252
 253     public function testFirstTrustedProxyIsSetAsRemote()
 254     {
 255         Request::setTrustedProxies(array('1.1.1.1'), -1);
 256
 257         $expectedSubRequest = Request::create('/');
 258         $expectedSubRequest->headers->set('Surrogate-Capability', 'abc="ESI/1.0"');
 259         $expectedSubRequest->server->set('REMOTE_ADDR', '127.0.0.1');
 260         $expectedSubRequest->headers->set('x-forwarded-for', array('127.0.0.1'));
 261         $expectedSubRequest->headers->set('forwarded', array('for="127.0.0.1";host="localhost";proto=http'));
 262         $expectedSubRequest->server->set('HTTP_X_FORWARDED_FOR', '127.0.0.1');
 263         $expectedSubRequest->server->set('HTTP_FORWARDED', 'for="127.0.0.1";host="localhost";proto=http');
 264
 265         $strategy = new InlineFragmentRenderer($this->getKernelExpectingRequest($expectedSubRequest));
 266
 267         $request = Request::create('/');
 268         $request->headers->set('Surrogate-Capability', 'abc="ESI/1.0"');
 269         $strategy->render('/', $request);
 270
 271         Request::setTrustedProxies(array(), -1);
 272     }
 273
 274     public function testIpAddressOfRangedTrustedProxyIsSetAsRemote()
 275     {
 276         $expectedSubRequest = Request::create('/');
 277         $expectedSubRequest->headers->set('Surrogate-Capability', 'abc="ESI/1.0"');
 278         $expectedSubRequest->server->set('REMOTE_ADDR', '127.0.0.1');
 279         $expectedSubRequest->headers->set('x-forwarded-for', array('127.0.0.1'));
 280         $expectedSubRequest->headers->set('forwarded', array('for="127.0.0.1";host="localhost";proto=http'));
 281         $expectedSubRequest->server->set('HTTP_X_FORWARDED_FOR', '127.0.0.1');
 282         $expectedSubRequest->server->set('HTTP_FORWARDED', 'for="127.0.0.1";host="localhost";proto=http');
 283
 284         Request::setTrustedProxies(array('1.1.1.1/24'), -1);
 285
 286         $strategy = new InlineFragmentRenderer($this->getKernelExpectingRequest($expectedSubRequest));
 287
 288         $request = Request::create('/');
 289         $request->headers->set('Surrogate-Capability', 'abc="ESI/1.0"');
 290         $strategy->render('/', $request);
 291
 292         Request::setTrustedProxies(array(), -1);
 293     }
 294
 295     /**
 296      * Creates a Kernel expecting a request equals to $request
 297      * Allows delta in comparison in case REQUEST_TIME changed by 1 second.
 298      */
 299     private function getKernelExpectingRequest(Request $request, $strict = false)
 300     {
 301         $kernel = $this->getMockBuilder('Symfony\Component\HttpKernel\HttpKernelInterface')->getMock();
 302         $kernel
 303             ->expects($this->once())
 304             ->method('handle')
 305             ->with($this->equalTo($request, 1))
 306             ->willReturn(new Response('foo'));
 307
 308         return $kernel;
 309     }
 310 }
 311
 312 class Bar
 313 {
 314     public $bar = 'bar';
 315
 316     public function getBar()
 317     {
 318         return $this->bar;
 319     }
 320 }