AddDependencyCallsCompilerPassTest.php 16 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382
  1. <?php
  2. /*
  3. * This file is part of the Sonata package.
  4. *
  5. * (c) Thomas Rabaix <thomas.rabaix@sonata-project.org>
  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 Sonata\AdminBundle\Tests\DependencyInjection;
  11. use Sonata\AdminBundle\DependencyInjection\SonataAdminExtension;
  12. use Sonata\AdminBundle\DependencyInjection\Compiler\AddDependencyCallsCompilerPass;
  13. use Symfony\Component\DependencyInjection\ContainerBuilder;
  14. /**
  15. * @author Tiago Garcia
  16. */
  17. class AddDependencyCallsCompilerPassTest extends \PHPUnit_Framework_TestCase
  18. {
  19. /** @var SonataAdminExtension $extension */
  20. private $extension;
  21. /** @var array $config */
  22. private $config;
  23. public function setUp()
  24. {
  25. parent::setUp();
  26. $this->extension = new SonataAdminExtension();
  27. $this->config = $this->getConfig();
  28. }
  29. public function testTranslatorDisabled()
  30. {
  31. $this->setExpectedException(
  32. 'RuntimeException', 'The "translator" service is not yet enabled.
  33. It\'s required by SonataAdmin to display all labels properly.
  34. To learn how to enable the translator service please visit:
  35. http://symfony.com/doc/current/book/translation.html#book-translation-configuration
  36. '
  37. );
  38. $container = $this->getContainer();
  39. $container->removeAlias('translator');
  40. $this->extension->load(array($this->config), $container);
  41. $compilerPass = new AddDependencyCallsCompilerPass();
  42. $compilerPass->process($container);
  43. $container->compile();
  44. }
  45. /**
  46. * @covers Sonata\AdminBundle\DependencyInjection\Compiler\AddDependencyCallsCompilerPass::process
  47. */
  48. public function testProcessParsingFullValidConfig()
  49. {
  50. $container = $this->getContainer();
  51. $this->extension->load(array($this->config), $container);
  52. $compilerPass = new AddDependencyCallsCompilerPass();
  53. $compilerPass->process($container);
  54. $container->compile();
  55. $this->assertTrue($container->hasParameter('sonata.admin.configuration.dashboard_groups'));
  56. $dashboardGroupsSettings = $container->getParameter('sonata.admin.configuration.dashboard_groups');
  57. $this->assertArrayHasKey('sonata_group_one', $dashboardGroupsSettings);
  58. $this->assertArrayHasKey('label', $dashboardGroupsSettings['sonata_group_one']);
  59. $this->assertArrayHasKey('label_catalogue', $dashboardGroupsSettings['sonata_group_one']);
  60. $this->assertArrayHasKey('items', $dashboardGroupsSettings['sonata_group_one']);
  61. $this->assertArrayHasKey('item_adds', $dashboardGroupsSettings['sonata_group_one']);
  62. $this->assertArrayHasKey('roles', $dashboardGroupsSettings['sonata_group_one']);
  63. $this->assertEquals('Group One Label', $dashboardGroupsSettings['sonata_group_one']['label']);
  64. $this->assertEquals('SonataAdminBundle', $dashboardGroupsSettings['sonata_group_one']['label_catalogue']);
  65. $this->assertContains('sonata_post_admin', $dashboardGroupsSettings['sonata_group_one']['items']);
  66. $this->assertContains('sonata_news_admin', $dashboardGroupsSettings['sonata_group_one']['item_adds']);
  67. $this->assertContains('ROLE_ONE', $dashboardGroupsSettings['sonata_group_one']['roles']);
  68. }
  69. /**
  70. * @covers Sonata\AdminBundle\DependencyInjection\Compiler\AddDependencyCallsCompilerPass::process
  71. */
  72. public function testProcessResultingConfig()
  73. {
  74. $container = $this->getContainer();
  75. $this->extension->load(array($this->config), $container);
  76. $compilerPass = new AddDependencyCallsCompilerPass();
  77. $compilerPass->process($container);
  78. $container->compile();
  79. $this->assertTrue($container->hasDefinition('sonata.admin.pool'));
  80. $this->assertTrue($container->hasDefinition('sonata_post_admin'));
  81. $this->assertTrue($container->hasDefinition('sonata_article_admin'));
  82. $this->assertTrue($container->hasDefinition('sonata_news_admin'));
  83. $pool = $container->get('sonata.admin.pool');
  84. $adminServiceIds = $pool->getAdminServiceIds();
  85. $adminGroups = $pool->getAdminGroups();
  86. $adminClasses = $pool->getAdminClasses();
  87. $this->assertContains('sonata_post_admin', $adminServiceIds);
  88. $this->assertContains('sonata_article_admin', $adminServiceIds);
  89. $this->assertContains('sonata_news_admin', $adminServiceIds);
  90. $this->assertArrayHasKey('sonata_group_one', $adminGroups);
  91. $this->assertArrayHasKey('label', $adminGroups['sonata_group_one']);
  92. $this->assertArrayHasKey('label_catalogue', $adminGroups['sonata_group_one']);
  93. $this->assertArrayHasKey('items', $adminGroups['sonata_group_one']);
  94. $this->assertArrayHasKey('item_adds', $adminGroups['sonata_group_one']);
  95. $this->assertArrayHasKey('roles', $adminGroups['sonata_group_one']);
  96. $this->assertEquals('Group One Label', $adminGroups['sonata_group_one']['label']);
  97. $this->assertEquals('SonataAdminBundle', $adminGroups['sonata_group_one']['label_catalogue']);
  98. $this->assertContains('sonata_post_admin', $adminGroups['sonata_group_one']['items']);
  99. $this->assertContains('sonata_news_admin', $adminGroups['sonata_group_one']['items']);
  100. $this->assertContains('sonata_news_admin', $adminGroups['sonata_group_one']['item_adds']);
  101. $this->assertFalse(in_array('sonata_article_admin', $adminGroups['sonata_group_one']['items']));
  102. $this->assertContains('ROLE_ONE', $adminGroups['sonata_group_one']['roles']);
  103. $this->assertArrayHasKey('Sonata\AdminBundle\Tests\DependencyInjection\Post', $adminClasses);
  104. $this->assertContains('sonata_post_admin', $adminClasses['Sonata\AdminBundle\Tests\DependencyInjection\Post']);
  105. $this->assertArrayHasKey('Sonata\AdminBundle\Tests\DependencyInjection\Article', $adminClasses);
  106. $this->assertContains('sonata_article_admin', $adminClasses['Sonata\AdminBundle\Tests\DependencyInjection\Article']);
  107. $this->assertArrayHasKey('Sonata\AdminBundle\Tests\DependencyInjection\News', $adminClasses);
  108. $this->assertContains('sonata_news_admin', $adminClasses['Sonata\AdminBundle\Tests\DependencyInjection\News']);
  109. $newsRouteBuilderMethodCall = current(array_filter(
  110. $container->getDefinition('sonata_news_admin')->getMethodCalls(),
  111. function ($element) {
  112. return $element[0] == 'setRouteBuilder';
  113. }
  114. ));
  115. $this->assertSame(
  116. 'sonata.admin.route.path_info',
  117. (string) $newsRouteBuilderMethodCall[1][0],
  118. 'The news admin uses the orm, and should therefore use the path_info router.'
  119. );
  120. $articleRouteBuilderMethodCall = current(array_filter(
  121. $container->getDefinition('sonata_article_admin')->getMethodCalls(),
  122. function ($element) {
  123. return $element[0] == 'setRouteBuilder';
  124. }
  125. ));
  126. $this->assertSame(
  127. 'sonata.admin.route.path_info_slashes',
  128. (string) $articleRouteBuilderMethodCall[1][0],
  129. 'The article admin uses the odm, and should therefore use the path_info_slashes router.'
  130. );
  131. }
  132. /**
  133. * @covers Sonata\AdminBundle\DependencyInjection\Compiler\AddDependencyCallsCompilerPass::process
  134. */
  135. public function testProcessGroupNameAsParameter()
  136. {
  137. $config = array(
  138. 'dashboard' => array(
  139. 'groups' => array(
  140. '%sonata.admin.parameter.groupname%' => array(),
  141. )
  142. )
  143. );
  144. $container = $this->getContainer();
  145. $container->setParameter('sonata.admin.parameter.groupname', 'resolved_group_name');
  146. $this->extension->load(array($config), $container);
  147. $compilerPass = new AddDependencyCallsCompilerPass();
  148. $compilerPass->process($container);
  149. $container->compile();
  150. $adminGroups = $container->get('sonata.admin.pool')->getAdminGroups();
  151. $this->assertArrayHasKey('resolved_group_name', $adminGroups);
  152. $this->assertFalse(array_key_exists('%sonata.admin.parameter.groupname%', $adminGroups));
  153. }
  154. public function testApplyTemplatesConfiguration()
  155. {
  156. $container = $this->getContainer();
  157. $this->extension->load(array($this->getConfig()), $container);
  158. $compilerPass = new AddDependencyCallsCompilerPass();
  159. $compilerPass->process($container);
  160. $callsPostAdmin = $container->getDefinition('sonata_post_admin')->getMethodCalls();
  161. foreach ($callsPostAdmin as $call) {
  162. list($name, $parameters) = $call;
  163. switch ($name) {
  164. case 'setTemplates':
  165. $this->assertEquals('foobar.twig.html', $parameters[0]['user_block']);
  166. $this->assertEquals('SonataAdminBundle:Pager:results.html.twig', $parameters[0]['pager_results']);
  167. break;
  168. case 'setLabel':
  169. $this->assertEquals('-', $parameters[0]);
  170. break;
  171. case 'setPagerType':
  172. $this->assertEquals('default', $parameters[0]);
  173. break;
  174. }
  175. }
  176. $callsNewsAdmin = $container->getDefinition('sonata_news_admin')->getMethodCalls();
  177. foreach ($callsNewsAdmin as $call) {
  178. list($name, $parameters) = $call;
  179. switch ($name) {
  180. case 'setTemplates':
  181. $this->assertEquals('foo.twig.html', $parameters[0]['user_block']);
  182. $this->assertEquals('SonataAdminBundle:Pager:simple_pager_results.html.twig', $parameters[0]['pager_results']);
  183. break;
  184. case 'setLabel':
  185. $this->assertEquals('Foo', $parameters[0]);
  186. break;
  187. case 'setPagerType':
  188. $this->assertEquals('simple', $parameters[0]);
  189. break;
  190. }
  191. }
  192. }
  193. /**
  194. * @return array
  195. */
  196. protected function getConfig()
  197. {
  198. $config = array(
  199. 'dashboard' => array(
  200. 'groups' => array(
  201. 'sonata_group_one' => array(
  202. 'label' => 'Group One Label',
  203. 'label_catalogue' => 'SonataAdminBundle',
  204. 'items' => array(
  205. 'sonata_post_admin'
  206. ),
  207. 'item_adds' => array(
  208. 'sonata_news_admin'
  209. ),
  210. 'roles' => array('ROLE_ONE'),
  211. ),
  212. )
  213. ),
  214. 'admin_services' => array(
  215. 'sonata_post_admin' => array(
  216. 'templates' => array(
  217. 'view' => array('user_block' => 'foobar.twig.html')
  218. )
  219. ),
  220. 'sonata_news_admin' => array(
  221. 'label' => 'Foo',
  222. 'pager_type' => 'simple',
  223. 'templates' => array(
  224. 'view' => array('user_block' => 'foo.twig.html')
  225. )
  226. )
  227. )
  228. );
  229. return $config;
  230. }
  231. private function getContainer()
  232. {
  233. $container = new ContainerBuilder();
  234. $container->setParameter('kernel.bundles', array(
  235. 'SonataCoreBundle' => true,
  236. 'KnpMenuBundle' => true
  237. ));
  238. $container->setParameter('kernel.cache_dir', '/tmp');
  239. $container->setParameter('kernel.debug', true);
  240. // Add dependencies for SonataAdminBundle (these services will never get called so dummy classes will do)
  241. $container
  242. ->register('twig')
  243. ->setClass('Symfony\Bundle\FrameworkBundle\Templating\EngineInterface');
  244. $container
  245. ->register('templating')
  246. ->setClass('Symfony\Bundle\FrameworkBundle\Templating\EngineInterface');
  247. $container
  248. ->register('translator')
  249. ->setClass('Symfony\Bundle\FrameworkBundle\Translation\TranslatorInterface');
  250. $container
  251. ->register('validator')
  252. ->setClass('Symfony\Bundle\FrameworkBundle\Validator\Validator');
  253. $container
  254. ->register('validator.validator_factory')
  255. ->setClass('Symfony\Bundle\FrameworkBundle\Validator\ConstraintValidatorFactory');
  256. $container
  257. ->register('router')
  258. ->setClass('Symfony\Component\Routing\RouterInterface');
  259. $container
  260. ->register('form.factory')
  261. ->setClass('Symfony\Component\Form\FormFactoryInterface');
  262. foreach (array(
  263. 'doctrine_phpcr' => 'PHPCR',
  264. 'orm' => 'ORM') as $key => $bundleSubstring) {
  265. $container
  266. ->register(sprintf('sonata.admin.manager.%s', $key))
  267. ->setClass(sprintf(
  268. 'Sonata\Doctrine%sAdminBundle\Model\ModelManager',
  269. $bundleSubstring
  270. ));
  271. $container
  272. ->register(sprintf('sonata.admin.builder.%s_form', $key))
  273. ->setClass(sprintf(
  274. 'Sonata\Doctrine%sAdminBundle\Builder\FormContractor',
  275. $bundleSubstring
  276. ));
  277. $container
  278. ->register(sprintf('sonata.admin.builder.%s_show', $key))
  279. ->setClass(sprintf(
  280. 'Sonata\Doctrine%sAdminBundle\Builder\ShowBuilder',
  281. $bundleSubstring
  282. ));
  283. $container
  284. ->register(sprintf('sonata.admin.builder.%s_list', $key))
  285. ->setClass(sprintf(
  286. 'Sonata\Doctrine%sAdminBundle\Builder\ListBuilder',
  287. $bundleSubstring
  288. ));
  289. $container
  290. ->register(sprintf('sonata.admin.builder.%s_datagrid', $key))
  291. ->setClass(sprintf(
  292. 'Sonata\Doctrine%sAdminBundle\Builder\DatagridBuilder',
  293. $bundleSubstring
  294. ));
  295. }
  296. $container
  297. ->register('sonata.admin.route.path_info_slashes')
  298. ->setClass('Sonata\DoctrinePHPCRAdminBundle\Route\PathInfoBuilderSlashes');
  299. $container
  300. ->register('sonata.admin.route.cache')
  301. ->setClass('Sonata\AdminBundle\Route\RoutesCache');
  302. $container
  303. ->register('knp_menu.factory')
  304. ->setClass('Knp\Menu\Silex\RouterAwareFactory');
  305. $container
  306. ->register('event_dispatcher')
  307. ->setClass('Symfony\Component\EventDispatcher\EventDispatcherInterface');
  308. // Add admin definition's
  309. $container
  310. ->register('sonata_post_admin')
  311. ->setClass('Sonata\AdminBundle\Tests\DependencyInjection\MockAdmin')
  312. ->setArguments(array('', 'Sonata\AdminBundle\Tests\DependencyInjection\Post', 'SonataAdminBundle:CRUD'))
  313. ->addTag('sonata.admin', array('group' => 'sonata_group_one', 'manager_type' => 'orm'));
  314. $container
  315. ->register('sonata_news_admin')
  316. ->setClass('Sonata\AdminBundle\Tests\DependencyInjection\MockAdmin')
  317. ->setArguments(array('', 'Sonata\AdminBundle\Tests\DependencyInjection\News', 'SonataAdminBundle:CRUD'))
  318. ->addTag('sonata.admin', array('group' => 'sonata_group_two', 'manager_type' => 'orm'));
  319. $container
  320. ->register('sonata_article_admin')
  321. ->setClass('Sonata\AdminBundle\Tests\DependencyInjection\MockAdmin')
  322. ->setArguments(array('', 'Sonata\AdminBundle\Tests\DependencyInjection\Article', 'SonataAdminBundle:CRUD'))
  323. ->addTag('sonata.admin', array('group' => 'sonata_group_one', 'manager_type' => 'doctrine_phpcr'));
  324. // translator
  325. $container
  326. ->register('translator.default')
  327. ->setClass('Symfony\Bundle\FrameworkBundle\Translation\Translator');
  328. $container->setAlias('translator', 'translator.default');
  329. return $container;
  330. }
  331. }