ControllerResolverTest.php 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276
  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\HttpKernel\Tests\Controller;
  11. use Psr\Log\LoggerInterface;
  12. use Symfony\Component\HttpKernel\Controller\ControllerResolver;
  13. use Symfony\Component\HttpKernel\Tests\Fixtures\Controller\VariadicController;
  14. use Symfony\Component\HttpFoundation\Request;
  15. class ControllerResolverTest extends \PHPUnit_Framework_TestCase
  16. {
  17. public function testGetControllerWithoutControllerParameter()
  18. {
  19. $logger = $this->getMock('Psr\Log\LoggerInterface');
  20. $logger->expects($this->once())->method('warning')->with('Unable to look for the controller as the "_controller" parameter is missing.');
  21. $resolver = $this->createControllerResolver($logger);
  22. $request = Request::create('/');
  23. $this->assertFalse($resolver->getController($request), '->getController() returns false when the request has no _controller attribute');
  24. }
  25. public function testGetControllerWithLambda()
  26. {
  27. $resolver = $this->createControllerResolver();
  28. $request = Request::create('/');
  29. $request->attributes->set('_controller', $lambda = function () {});
  30. $controller = $resolver->getController($request);
  31. $this->assertSame($lambda, $controller);
  32. }
  33. public function testGetControllerWithObjectAndInvokeMethod()
  34. {
  35. $resolver = $this->createControllerResolver();
  36. $request = Request::create('/');
  37. $request->attributes->set('_controller', $this);
  38. $controller = $resolver->getController($request);
  39. $this->assertSame($this, $controller);
  40. }
  41. public function testGetControllerWithObjectAndMethod()
  42. {
  43. $resolver = $this->createControllerResolver();
  44. $request = Request::create('/');
  45. $request->attributes->set('_controller', array($this, 'controllerMethod1'));
  46. $controller = $resolver->getController($request);
  47. $this->assertSame(array($this, 'controllerMethod1'), $controller);
  48. }
  49. public function testGetControllerWithClassAndMethod()
  50. {
  51. $resolver = $this->createControllerResolver();
  52. $request = Request::create('/');
  53. $request->attributes->set('_controller', array('Symfony\Component\HttpKernel\Tests\Controller\ControllerResolverTest', 'controllerMethod4'));
  54. $controller = $resolver->getController($request);
  55. $this->assertSame(array('Symfony\Component\HttpKernel\Tests\Controller\ControllerResolverTest', 'controllerMethod4'), $controller);
  56. }
  57. public function testGetControllerWithObjectAndMethodAsString()
  58. {
  59. $resolver = $this->createControllerResolver();
  60. $request = Request::create('/');
  61. $request->attributes->set('_controller', 'Symfony\Component\HttpKernel\Tests\Controller\ControllerResolverTest::controllerMethod1');
  62. $controller = $resolver->getController($request);
  63. $this->assertInstanceOf('Symfony\Component\HttpKernel\Tests\Controller\ControllerResolverTest', $controller[0], '->getController() returns a PHP callable');
  64. }
  65. public function testGetControllerWithClassAndInvokeMethod()
  66. {
  67. $resolver = $this->createControllerResolver();
  68. $request = Request::create('/');
  69. $request->attributes->set('_controller', 'Symfony\Component\HttpKernel\Tests\Controller\ControllerResolverTest');
  70. $controller = $resolver->getController($request);
  71. $this->assertInstanceOf('Symfony\Component\HttpKernel\Tests\Controller\ControllerResolverTest', $controller);
  72. }
  73. /**
  74. * @expectedException \InvalidArgumentException
  75. */
  76. public function testGetControllerOnObjectWithoutInvokeMethod()
  77. {
  78. $resolver = $this->createControllerResolver();
  79. $request = Request::create('/');
  80. $request->attributes->set('_controller', new \stdClass());
  81. $resolver->getController($request);
  82. }
  83. public function testGetControllerWithFunction()
  84. {
  85. $resolver = $this->createControllerResolver();
  86. $request = Request::create('/');
  87. $request->attributes->set('_controller', 'Symfony\Component\HttpKernel\Tests\Controller\some_controller_function');
  88. $controller = $resolver->getController($request);
  89. $this->assertSame('Symfony\Component\HttpKernel\Tests\Controller\some_controller_function', $controller);
  90. }
  91. /**
  92. * @dataProvider getUndefinedControllers
  93. */
  94. public function testGetControllerOnNonUndefinedFunction($controller, $exceptionName = null, $exceptionMessage = null)
  95. {
  96. $resolver = $this->createControllerResolver();
  97. $this->setExpectedException($exceptionName, $exceptionMessage);
  98. $request = Request::create('/');
  99. $request->attributes->set('_controller', $controller);
  100. $resolver->getController($request);
  101. }
  102. public function getUndefinedControllers()
  103. {
  104. return array(
  105. array(1, 'InvalidArgumentException', 'Unable to find controller "1".'),
  106. array('foo', 'InvalidArgumentException', 'Unable to find controller "foo".'),
  107. array('oof::bar', 'InvalidArgumentException', 'Class "oof" does not exist.'),
  108. array('stdClass', 'InvalidArgumentException', 'Unable to find controller "stdClass".'),
  109. array('Symfony\Component\HttpKernel\Tests\Controller\ControllerTest::staticsAction', 'InvalidArgumentException', 'The controller for URI "/" is not callable. Expected method "staticsAction" on class "Symfony\Component\HttpKernel\Tests\Controller\ControllerTest", did you mean "staticAction"?'),
  110. array('Symfony\Component\HttpKernel\Tests\Controller\ControllerTest::privateAction', 'InvalidArgumentException', 'The controller for URI "/" is not callable. Method "privateAction" on class "Symfony\Component\HttpKernel\Tests\Controller\ControllerTest" should be public and non-abstract'),
  111. array('Symfony\Component\HttpKernel\Tests\Controller\ControllerTest::protectedAction', 'InvalidArgumentException', 'The controller for URI "/" is not callable. Method "protectedAction" on class "Symfony\Component\HttpKernel\Tests\Controller\ControllerTest" should be public and non-abstract'),
  112. array('Symfony\Component\HttpKernel\Tests\Controller\ControllerTest::undefinedAction', 'InvalidArgumentException', 'The controller for URI "/" is not callable. Expected method "undefinedAction" on class "Symfony\Component\HttpKernel\Tests\Controller\ControllerTest". Available methods: "publicAction", "staticAction"'),
  113. );
  114. }
  115. public function testGetArguments()
  116. {
  117. $resolver = $this->createControllerResolver();
  118. $request = Request::create('/');
  119. $controller = array(new self(), 'testGetArguments');
  120. $this->assertEquals(array(), $resolver->getArguments($request, $controller), '->getArguments() returns an empty array if the method takes no arguments');
  121. $request = Request::create('/');
  122. $request->attributes->set('foo', 'foo');
  123. $controller = array(new self(), 'controllerMethod1');
  124. $this->assertEquals(array('foo'), $resolver->getArguments($request, $controller), '->getArguments() returns an array of arguments for the controller method');
  125. $request = Request::create('/');
  126. $request->attributes->set('foo', 'foo');
  127. $controller = array(new self(), 'controllerMethod2');
  128. $this->assertEquals(array('foo', null), $resolver->getArguments($request, $controller), '->getArguments() uses default values if present');
  129. $request->attributes->set('bar', 'bar');
  130. $this->assertEquals(array('foo', 'bar'), $resolver->getArguments($request, $controller), '->getArguments() overrides default values if provided in the request attributes');
  131. $request = Request::create('/');
  132. $request->attributes->set('foo', 'foo');
  133. $controller = function ($foo) {};
  134. $this->assertEquals(array('foo'), $resolver->getArguments($request, $controller));
  135. $request = Request::create('/');
  136. $request->attributes->set('foo', 'foo');
  137. $controller = function ($foo, $bar = 'bar') {};
  138. $this->assertEquals(array('foo', 'bar'), $resolver->getArguments($request, $controller));
  139. $request = Request::create('/');
  140. $request->attributes->set('foo', 'foo');
  141. $controller = new self();
  142. $this->assertEquals(array('foo', null), $resolver->getArguments($request, $controller));
  143. $request->attributes->set('bar', 'bar');
  144. $this->assertEquals(array('foo', 'bar'), $resolver->getArguments($request, $controller));
  145. $request = Request::create('/');
  146. $request->attributes->set('foo', 'foo');
  147. $request->attributes->set('foobar', 'foobar');
  148. $controller = 'Symfony\Component\HttpKernel\Tests\Controller\some_controller_function';
  149. $this->assertEquals(array('foo', 'foobar'), $resolver->getArguments($request, $controller));
  150. $request = Request::create('/');
  151. $request->attributes->set('foo', 'foo');
  152. $request->attributes->set('foobar', 'foobar');
  153. $controller = array(new self(), 'controllerMethod3');
  154. try {
  155. $resolver->getArguments($request, $controller);
  156. $this->fail('->getArguments() throws a \RuntimeException exception if it cannot determine the argument value');
  157. } catch (\Exception $e) {
  158. $this->assertInstanceOf('\RuntimeException', $e, '->getArguments() throws a \RuntimeException exception if it cannot determine the argument value');
  159. }
  160. $request = Request::create('/');
  161. $controller = array(new self(), 'controllerMethod5');
  162. $this->assertEquals(array($request), $resolver->getArguments($request, $controller), '->getArguments() injects the request');
  163. }
  164. /**
  165. * @requires PHP 5.6
  166. */
  167. public function testGetVariadicArguments()
  168. {
  169. $resolver = new ControllerResolver();
  170. $request = Request::create('/');
  171. $request->attributes->set('foo', 'foo');
  172. $request->attributes->set('bar', array('foo', 'bar'));
  173. $controller = array(new VariadicController(), 'action');
  174. $this->assertEquals(array('foo', 'foo', 'bar'), $resolver->getArguments($request, $controller));
  175. }
  176. public function testCreateControllerCanReturnAnyCallable()
  177. {
  178. $mock = $this->getMock('Symfony\Component\HttpKernel\Controller\ControllerResolver', array('createController'));
  179. $mock->expects($this->once())->method('createController')->will($this->returnValue('Symfony\Component\HttpKernel\Tests\Controller\some_controller_function'));
  180. $request = Request::create('/');
  181. $request->attributes->set('_controller', 'foobar');
  182. $mock->getController($request);
  183. }
  184. protected function createControllerResolver(LoggerInterface $logger = null)
  185. {
  186. return new ControllerResolver($logger);
  187. }
  188. public function __invoke($foo, $bar = null)
  189. {
  190. }
  191. public function controllerMethod1($foo)
  192. {
  193. }
  194. protected function controllerMethod2($foo, $bar = null)
  195. {
  196. }
  197. protected function controllerMethod3($foo, $bar, $foobar)
  198. {
  199. }
  200. protected static function controllerMethod4()
  201. {
  202. }
  203. protected function controllerMethod5(Request $request)
  204. {
  205. }
  206. }
  207. function some_controller_function($foo, $foobar)
  208. {
  209. }
  210. class ControllerTest
  211. {
  212. public function publicAction()
  213. {
  214. }
  215. private function privateAction()
  216. {
  217. }
  218. protected function protectedAction()
  219. {
  220. }
  221. public static function staticAction()
  222. {
  223. }
  224. }