ContainerBuilderTest.php 39 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917
  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\DependencyInjection\Tests;
  11. require_once __DIR__.'/Fixtures/includes/classes.php';
  12. require_once __DIR__.'/Fixtures/includes/ProjectExtension.php';
  13. use PHPUnit\Framework\TestCase;
  14. use Symfony\Component\Config\Resource\ResourceInterface;
  15. use Symfony\Component\DependencyInjection\Alias;
  16. use Symfony\Component\DependencyInjection\ContainerBuilder;
  17. use Symfony\Component\DependencyInjection\ContainerInterface;
  18. use Symfony\Component\DependencyInjection\Definition;
  19. use Symfony\Component\DependencyInjection\DefinitionDecorator;
  20. use Symfony\Component\DependencyInjection\Exception\RuntimeException;
  21. use Symfony\Component\DependencyInjection\Exception\InactiveScopeException;
  22. use Symfony\Component\DependencyInjection\Exception\ServiceCircularReferenceException;
  23. use Symfony\Component\DependencyInjection\Exception\ServiceNotFoundException;
  24. use Symfony\Component\DependencyInjection\Loader\ClosureLoader;
  25. use Symfony\Component\DependencyInjection\Reference;
  26. use Symfony\Component\DependencyInjection\ParameterBag\ParameterBag;
  27. use Symfony\Component\DependencyInjection\Scope;
  28. use Symfony\Component\Config\Resource\FileResource;
  29. use Symfony\Component\DependencyInjection\Tests\Fixtures\CustomDefinition;
  30. use Symfony\Component\ExpressionLanguage\Expression;
  31. class ContainerBuilderTest extends TestCase
  32. {
  33. public function testDefinitions()
  34. {
  35. $builder = new ContainerBuilder();
  36. $definitions = array(
  37. 'foo' => new Definition('Bar\FooClass'),
  38. 'bar' => new Definition('BarClass'),
  39. );
  40. $builder->setDefinitions($definitions);
  41. $this->assertEquals($definitions, $builder->getDefinitions(), '->setDefinitions() sets the service definitions');
  42. $this->assertTrue($builder->hasDefinition('foo'), '->hasDefinition() returns true if a service definition exists');
  43. $this->assertFalse($builder->hasDefinition('foobar'), '->hasDefinition() returns false if a service definition does not exist');
  44. $builder->setDefinition('foobar', $foo = new Definition('FooBarClass'));
  45. $this->assertEquals($foo, $builder->getDefinition('foobar'), '->getDefinition() returns a service definition if defined');
  46. $this->assertTrue($builder->setDefinition('foobar', $foo = new Definition('FooBarClass')) === $foo, '->setDefinition() implements a fluid interface by returning the service reference');
  47. $builder->addDefinitions($defs = array('foobar' => new Definition('FooBarClass')));
  48. $this->assertEquals(array_merge($definitions, $defs), $builder->getDefinitions(), '->addDefinitions() adds the service definitions');
  49. try {
  50. $builder->getDefinition('baz');
  51. $this->fail('->getDefinition() throws a ServiceNotFoundException if the service definition does not exist');
  52. } catch (ServiceNotFoundException $e) {
  53. $this->assertEquals('You have requested a non-existent service "baz".', $e->getMessage(), '->getDefinition() throws a ServiceNotFoundException if the service definition does not exist');
  54. }
  55. }
  56. /**
  57. * @group legacy
  58. * @expectedDeprecation The "deprecated_foo" service is deprecated. You should stop using it, as it will soon be removed.
  59. */
  60. public function testCreateDeprecatedService()
  61. {
  62. $definition = new Definition('stdClass');
  63. $definition->setDeprecated(true);
  64. $builder = new ContainerBuilder();
  65. $builder->createService($definition, 'deprecated_foo');
  66. }
  67. public function testRegister()
  68. {
  69. $builder = new ContainerBuilder();
  70. $builder->register('foo', 'Bar\FooClass');
  71. $this->assertTrue($builder->hasDefinition('foo'), '->register() registers a new service definition');
  72. $this->assertInstanceOf('Symfony\Component\DependencyInjection\Definition', $builder->getDefinition('foo'), '->register() returns the newly created Definition instance');
  73. }
  74. public function testHas()
  75. {
  76. $builder = new ContainerBuilder();
  77. $this->assertFalse($builder->has('foo'), '->has() returns false if the service does not exist');
  78. $builder->register('foo', 'Bar\FooClass');
  79. $this->assertTrue($builder->has('foo'), '->has() returns true if a service definition exists');
  80. $builder->set('bar', new \stdClass());
  81. $this->assertTrue($builder->has('bar'), '->has() returns true if a service exists');
  82. }
  83. public function testGet()
  84. {
  85. $builder = new ContainerBuilder();
  86. try {
  87. $builder->get('foo');
  88. $this->fail('->get() throws a ServiceNotFoundException if the service does not exist');
  89. } catch (ServiceNotFoundException $e) {
  90. $this->assertEquals('You have requested a non-existent service "foo".', $e->getMessage(), '->get() throws a ServiceNotFoundException if the service does not exist');
  91. }
  92. $this->assertNull($builder->get('foo', ContainerInterface::NULL_ON_INVALID_REFERENCE), '->get() returns null if the service does not exist and NULL_ON_INVALID_REFERENCE is passed as a second argument');
  93. $builder->register('foo', 'stdClass');
  94. $this->assertInternalType('object', $builder->get('foo'), '->get() returns the service definition associated with the id');
  95. $builder->set('bar', $bar = new \stdClass());
  96. $this->assertEquals($bar, $builder->get('bar'), '->get() returns the service associated with the id');
  97. $builder->register('bar', 'stdClass');
  98. $this->assertEquals($bar, $builder->get('bar'), '->get() returns the service associated with the id even if a definition has been defined');
  99. $builder->register('baz', 'stdClass')->setArguments(array(new Reference('baz')));
  100. try {
  101. @$builder->get('baz');
  102. $this->fail('->get() throws a ServiceCircularReferenceException if the service has a circular reference to itself');
  103. } catch (ServiceCircularReferenceException $e) {
  104. $this->assertEquals('Circular reference detected for service "baz", path: "baz".', $e->getMessage(), '->get() throws a LogicException if the service has a circular reference to itself');
  105. }
  106. $this->assertTrue($builder->get('bar') === $builder->get('bar'), '->get() always returns the same instance if the service is shared');
  107. }
  108. public function testNonSharedServicesReturnsDifferentInstances()
  109. {
  110. $builder = new ContainerBuilder();
  111. $builder->register('bar', 'stdClass')->setShared(false);
  112. $this->assertNotSame($builder->get('bar'), $builder->get('bar'));
  113. }
  114. /**
  115. * @expectedException \Symfony\Component\DependencyInjection\Exception\RuntimeException
  116. * @expectedExceptionMessage You have requested a synthetic service ("foo"). The DIC does not know how to construct this service.
  117. */
  118. public function testGetUnsetLoadingServiceWhenCreateServiceThrowsAnException()
  119. {
  120. $builder = new ContainerBuilder();
  121. $builder->register('foo', 'stdClass')->setSynthetic(true);
  122. // we expect a RuntimeException here as foo is synthetic
  123. try {
  124. $builder->get('foo');
  125. } catch (RuntimeException $e) {
  126. }
  127. // we must also have the same RuntimeException here
  128. $builder->get('foo');
  129. }
  130. /**
  131. * @group legacy
  132. */
  133. public function testGetReturnsNullOnInactiveScope()
  134. {
  135. $builder = new ContainerBuilder();
  136. $builder->register('foo', 'stdClass')->setScope('request');
  137. $this->assertNull($builder->get('foo', ContainerInterface::NULL_ON_INVALID_REFERENCE));
  138. }
  139. /**
  140. * @group legacy
  141. */
  142. public function testGetReturnsNullOnInactiveScopeWhenServiceIsCreatedByAMethod()
  143. {
  144. $builder = new ProjectContainer();
  145. $this->assertNull($builder->get('foobaz', ContainerInterface::NULL_ON_INVALID_REFERENCE));
  146. }
  147. public function testGetServiceIds()
  148. {
  149. $builder = new ContainerBuilder();
  150. $builder->register('foo', 'stdClass');
  151. $builder->bar = $bar = new \stdClass();
  152. $builder->register('bar', 'stdClass');
  153. $this->assertEquals(array('foo', 'bar', 'service_container'), $builder->getServiceIds(), '->getServiceIds() returns all defined service ids');
  154. }
  155. public function testAliases()
  156. {
  157. $builder = new ContainerBuilder();
  158. $builder->register('foo', 'stdClass');
  159. $builder->setAlias('bar', 'foo');
  160. $this->assertTrue($builder->hasAlias('bar'), '->hasAlias() returns true if the alias exists');
  161. $this->assertFalse($builder->hasAlias('foobar'), '->hasAlias() returns false if the alias does not exist');
  162. $this->assertEquals('foo', (string) $builder->getAlias('bar'), '->getAlias() returns the aliased service');
  163. $this->assertTrue($builder->has('bar'), '->setAlias() defines a new service');
  164. $this->assertTrue($builder->get('bar') === $builder->get('foo'), '->setAlias() creates a service that is an alias to another one');
  165. try {
  166. $builder->setAlias('foobar', 'foobar');
  167. $this->fail('->setAlias() throws an InvalidArgumentException if the alias references itself');
  168. } catch (\InvalidArgumentException $e) {
  169. $this->assertEquals('An alias can not reference itself, got a circular reference on "foobar".', $e->getMessage(), '->setAlias() throws an InvalidArgumentException if the alias references itself');
  170. }
  171. try {
  172. $builder->getAlias('foobar');
  173. $this->fail('->getAlias() throws an InvalidArgumentException if the alias does not exist');
  174. } catch (\InvalidArgumentException $e) {
  175. $this->assertEquals('The service alias "foobar" does not exist.', $e->getMessage(), '->getAlias() throws an InvalidArgumentException if the alias does not exist');
  176. }
  177. }
  178. public function testGetAliases()
  179. {
  180. $builder = new ContainerBuilder();
  181. $builder->setAlias('bar', 'foo');
  182. $builder->setAlias('foobar', 'foo');
  183. $builder->setAlias('moo', new Alias('foo', false));
  184. $aliases = $builder->getAliases();
  185. $this->assertEquals('foo', (string) $aliases['bar']);
  186. $this->assertTrue($aliases['bar']->isPublic());
  187. $this->assertEquals('foo', (string) $aliases['foobar']);
  188. $this->assertEquals('foo', (string) $aliases['moo']);
  189. $this->assertFalse($aliases['moo']->isPublic());
  190. $builder->register('bar', 'stdClass');
  191. $this->assertFalse($builder->hasAlias('bar'));
  192. $builder->set('foobar', 'stdClass');
  193. $builder->set('moo', 'stdClass');
  194. $this->assertCount(0, $builder->getAliases(), '->getAliases() does not return aliased services that have been overridden');
  195. }
  196. public function testSetAliases()
  197. {
  198. $builder = new ContainerBuilder();
  199. $builder->setAliases(array('bar' => 'foo', 'foobar' => 'foo'));
  200. $aliases = $builder->getAliases();
  201. $this->assertTrue(isset($aliases['bar']));
  202. $this->assertTrue(isset($aliases['foobar']));
  203. }
  204. public function testAddAliases()
  205. {
  206. $builder = new ContainerBuilder();
  207. $builder->setAliases(array('bar' => 'foo'));
  208. $builder->addAliases(array('foobar' => 'foo'));
  209. $aliases = $builder->getAliases();
  210. $this->assertTrue(isset($aliases['bar']));
  211. $this->assertTrue(isset($aliases['foobar']));
  212. }
  213. public function testSetReplacesAlias()
  214. {
  215. $builder = new ContainerBuilder();
  216. $builder->setAlias('alias', 'aliased');
  217. $builder->set('aliased', new \stdClass());
  218. $builder->set('alias', $foo = new \stdClass());
  219. $this->assertSame($foo, $builder->get('alias'), '->set() replaces an existing alias');
  220. }
  221. public function testAliasesKeepInvalidBehavior()
  222. {
  223. $builder = new ContainerBuilder();
  224. $aliased = new Definition('stdClass');
  225. $aliased->addMethodCall('setBar', array(new Reference('bar', ContainerInterface::IGNORE_ON_INVALID_REFERENCE)));
  226. $builder->setDefinition('aliased', $aliased);
  227. $builder->setAlias('alias', 'aliased');
  228. $this->assertEquals(new \stdClass(), $builder->get('alias'));
  229. }
  230. public function testAddGetCompilerPass()
  231. {
  232. $builder = new ContainerBuilder();
  233. $builder->setResourceTracking(false);
  234. $builderCompilerPasses = $builder->getCompiler()->getPassConfig()->getPasses();
  235. $builder->addCompilerPass($this->getMockBuilder('Symfony\Component\DependencyInjection\Compiler\CompilerPassInterface')->getMock());
  236. $this->assertCount(count($builder->getCompiler()->getPassConfig()->getPasses()) - 1, $builderCompilerPasses);
  237. }
  238. public function testCreateService()
  239. {
  240. $builder = new ContainerBuilder();
  241. $builder->register('foo1', 'Bar\FooClass')->setFile(__DIR__.'/Fixtures/includes/foo.php');
  242. $this->assertInstanceOf('\Bar\FooClass', $builder->get('foo1'), '->createService() requires the file defined by the service definition');
  243. $builder->register('foo2', 'Bar\FooClass')->setFile(__DIR__.'/Fixtures/includes/%file%.php');
  244. $builder->setParameter('file', 'foo');
  245. $this->assertInstanceOf('\Bar\FooClass', $builder->get('foo2'), '->createService() replaces parameters in the file provided by the service definition');
  246. }
  247. public function testCreateProxyWithRealServiceInstantiator()
  248. {
  249. $builder = new ContainerBuilder();
  250. $builder->register('foo1', 'Bar\FooClass')->setFile(__DIR__.'/Fixtures/includes/foo.php');
  251. $builder->getDefinition('foo1')->setLazy(true);
  252. $foo1 = $builder->get('foo1');
  253. $this->assertSame($foo1, $builder->get('foo1'), 'The same proxy is retrieved on multiple subsequent calls');
  254. $this->assertSame('Bar\FooClass', get_class($foo1));
  255. }
  256. public function testCreateServiceClass()
  257. {
  258. $builder = new ContainerBuilder();
  259. $builder->register('foo1', '%class%');
  260. $builder->setParameter('class', 'stdClass');
  261. $this->assertInstanceOf('\stdClass', $builder->get('foo1'), '->createService() replaces parameters in the class provided by the service definition');
  262. }
  263. public function testCreateServiceArguments()
  264. {
  265. $builder = new ContainerBuilder();
  266. $builder->register('bar', 'stdClass');
  267. $builder->register('foo1', 'Bar\FooClass')->addArgument(array('foo' => '%value%', '%value%' => 'foo', new Reference('bar'), '%%unescape_it%%'));
  268. $builder->setParameter('value', 'bar');
  269. $this->assertEquals(array('foo' => 'bar', 'bar' => 'foo', $builder->get('bar'), '%unescape_it%'), $builder->get('foo1')->arguments, '->createService() replaces parameters and service references in the arguments provided by the service definition');
  270. }
  271. public function testCreateServiceFactory()
  272. {
  273. $builder = new ContainerBuilder();
  274. $builder->register('foo', 'Bar\FooClass')->setFactory('Bar\FooClass::getInstance');
  275. $builder->register('qux', 'Bar\FooClass')->setFactory(array('Bar\FooClass', 'getInstance'));
  276. $builder->register('bar', 'Bar\FooClass')->setFactory(array(new Definition('Bar\FooClass'), 'getInstance'));
  277. $builder->register('baz', 'Bar\FooClass')->setFactory(array(new Reference('bar'), 'getInstance'));
  278. $this->assertTrue($builder->get('foo')->called, '->createService() calls the factory method to create the service instance');
  279. $this->assertTrue($builder->get('qux')->called, '->createService() calls the factory method to create the service instance');
  280. $this->assertTrue($builder->get('bar')->called, '->createService() uses anonymous service as factory');
  281. $this->assertTrue($builder->get('baz')->called, '->createService() uses another service as factory');
  282. }
  283. /**
  284. * @group legacy
  285. */
  286. public function testLegacyCreateServiceFactory()
  287. {
  288. $builder = new ContainerBuilder();
  289. $builder->register('bar', 'Bar\FooClass');
  290. $builder
  291. ->register('foo1', 'Bar\FooClass')
  292. ->setFactoryClass('%foo_class%')
  293. ->setFactoryMethod('getInstance')
  294. ->addArgument(array('foo' => '%value%', '%value%' => 'foo', new Reference('bar')))
  295. ;
  296. $builder->setParameter('value', 'bar');
  297. $builder->setParameter('foo_class', 'Bar\FooClass');
  298. $this->assertTrue($builder->get('foo1')->called, '->createService() calls the factory method to create the service instance');
  299. $this->assertEquals(array('foo' => 'bar', 'bar' => 'foo', $builder->get('bar')), $builder->get('foo1')->arguments, '->createService() passes the arguments to the factory method');
  300. }
  301. /**
  302. * @group legacy
  303. */
  304. public function testLegacyCreateServiceFactoryService()
  305. {
  306. $builder = new ContainerBuilder();
  307. $builder->register('foo_service', 'Bar\FooClass');
  308. $builder
  309. ->register('foo', 'Bar\FooClass')
  310. ->setFactoryService('%foo_service%')
  311. ->setFactoryMethod('getInstance')
  312. ;
  313. $builder->setParameter('foo_service', 'foo_service');
  314. $this->assertTrue($builder->get('foo')->called, '->createService() calls the factory method to create the service instance');
  315. }
  316. public function testCreateServiceMethodCalls()
  317. {
  318. $builder = new ContainerBuilder();
  319. $builder->register('bar', 'stdClass');
  320. $builder->register('foo1', 'Bar\FooClass')->addMethodCall('setBar', array(array('%value%', new Reference('bar'))));
  321. $builder->setParameter('value', 'bar');
  322. $this->assertEquals(array('bar', $builder->get('bar')), $builder->get('foo1')->bar, '->createService() replaces the values in the method calls arguments');
  323. }
  324. public function testCreateServiceMethodCallsWithEscapedParam()
  325. {
  326. $builder = new ContainerBuilder();
  327. $builder->register('bar', 'stdClass');
  328. $builder->register('foo1', 'Bar\FooClass')->addMethodCall('setBar', array(array('%%unescape_it%%')));
  329. $builder->setParameter('value', 'bar');
  330. $this->assertEquals(array('%unescape_it%'), $builder->get('foo1')->bar, '->createService() replaces the values in the method calls arguments');
  331. }
  332. public function testCreateServiceProperties()
  333. {
  334. $builder = new ContainerBuilder();
  335. $builder->register('bar', 'stdClass');
  336. $builder->register('foo1', 'Bar\FooClass')->setProperty('bar', array('%value%', new Reference('bar'), '%%unescape_it%%'));
  337. $builder->setParameter('value', 'bar');
  338. $this->assertEquals(array('bar', $builder->get('bar'), '%unescape_it%'), $builder->get('foo1')->bar, '->createService() replaces the values in the properties');
  339. }
  340. public function testCreateServiceConfigurator()
  341. {
  342. $builder = new ContainerBuilder();
  343. $builder->register('foo1', 'Bar\FooClass')->setConfigurator('sc_configure');
  344. $this->assertTrue($builder->get('foo1')->configured, '->createService() calls the configurator');
  345. $builder->register('foo2', 'Bar\FooClass')->setConfigurator(array('%class%', 'configureStatic'));
  346. $builder->setParameter('class', 'BazClass');
  347. $this->assertTrue($builder->get('foo2')->configured, '->createService() calls the configurator');
  348. $builder->register('baz', 'BazClass');
  349. $builder->register('foo3', 'Bar\FooClass')->setConfigurator(array(new Reference('baz'), 'configure'));
  350. $this->assertTrue($builder->get('foo3')->configured, '->createService() calls the configurator');
  351. $builder->register('foo4', 'Bar\FooClass')->setConfigurator(array($builder->getDefinition('baz'), 'configure'));
  352. $this->assertTrue($builder->get('foo4')->configured, '->createService() calls the configurator');
  353. $builder->register('foo5', 'Bar\FooClass')->setConfigurator('foo');
  354. try {
  355. $builder->get('foo5');
  356. $this->fail('->createService() throws an InvalidArgumentException if the configure callable is not a valid callable');
  357. } catch (\InvalidArgumentException $e) {
  358. $this->assertEquals('The configure callable for class "Bar\FooClass" is not a callable.', $e->getMessage(), '->createService() throws an InvalidArgumentException if the configure callable is not a valid callable');
  359. }
  360. }
  361. /**
  362. * @expectedException \RuntimeException
  363. */
  364. public function testCreateSyntheticService()
  365. {
  366. $builder = new ContainerBuilder();
  367. $builder->register('foo', 'Bar\FooClass')->setSynthetic(true);
  368. $builder->get('foo');
  369. }
  370. public function testCreateServiceWithExpression()
  371. {
  372. $builder = new ContainerBuilder();
  373. $builder->setParameter('bar', 'bar');
  374. $builder->register('bar', 'BarClass');
  375. $builder->register('foo', 'Bar\FooClass')->addArgument(array('foo' => new Expression('service("bar").foo ~ parameter("bar")')));
  376. $this->assertEquals('foobar', $builder->get('foo')->arguments['foo']);
  377. }
  378. public function testResolveServices()
  379. {
  380. $builder = new ContainerBuilder();
  381. $builder->register('foo', 'Bar\FooClass');
  382. $this->assertEquals($builder->get('foo'), $builder->resolveServices(new Reference('foo')), '->resolveServices() resolves service references to service instances');
  383. $this->assertEquals(array('foo' => array('foo', $builder->get('foo'))), $builder->resolveServices(array('foo' => array('foo', new Reference('foo')))), '->resolveServices() resolves service references to service instances in nested arrays');
  384. $this->assertEquals($builder->get('foo'), $builder->resolveServices(new Expression('service("foo")')), '->resolveServices() resolves expressions');
  385. }
  386. /**
  387. * @expectedException \Symfony\Component\DependencyInjection\Exception\RuntimeException
  388. * @expectedExceptionMessage Constructing service "foo" from a parent definition is not supported at build time.
  389. */
  390. public function testResolveServicesWithDecoratedDefinition()
  391. {
  392. $builder = new ContainerBuilder();
  393. $builder->setDefinition('grandpa', new Definition('stdClass'));
  394. $builder->setDefinition('parent', new DefinitionDecorator('grandpa'));
  395. $builder->setDefinition('foo', new DefinitionDecorator('parent'));
  396. $builder->get('foo');
  397. }
  398. public function testResolveServicesWithCustomDefinitionClass()
  399. {
  400. $builder = new ContainerBuilder();
  401. $builder->setDefinition('foo', new CustomDefinition('stdClass'));
  402. $this->assertInstanceOf('stdClass', $builder->get('foo'));
  403. }
  404. public function testMerge()
  405. {
  406. $container = new ContainerBuilder(new ParameterBag(array('bar' => 'foo')));
  407. $container->setResourceTracking(false);
  408. $config = new ContainerBuilder(new ParameterBag(array('foo' => 'bar')));
  409. $container->merge($config);
  410. $this->assertEquals(array('bar' => 'foo', 'foo' => 'bar'), $container->getParameterBag()->all(), '->merge() merges current parameters with the loaded ones');
  411. $container = new ContainerBuilder(new ParameterBag(array('bar' => 'foo')));
  412. $container->setResourceTracking(false);
  413. $config = new ContainerBuilder(new ParameterBag(array('foo' => '%bar%')));
  414. $container->merge($config);
  415. $container->compile();
  416. $this->assertEquals(array('bar' => 'foo', 'foo' => 'foo'), $container->getParameterBag()->all(), '->merge() evaluates the values of the parameters towards already defined ones');
  417. $container = new ContainerBuilder(new ParameterBag(array('bar' => 'foo')));
  418. $container->setResourceTracking(false);
  419. $config = new ContainerBuilder(new ParameterBag(array('foo' => '%bar%', 'baz' => '%foo%')));
  420. $container->merge($config);
  421. $container->compile();
  422. $this->assertEquals(array('bar' => 'foo', 'foo' => 'foo', 'baz' => 'foo'), $container->getParameterBag()->all(), '->merge() evaluates the values of the parameters towards already defined ones');
  423. $container = new ContainerBuilder();
  424. $container->setResourceTracking(false);
  425. $container->register('foo', 'Bar\FooClass');
  426. $container->register('bar', 'BarClass');
  427. $config = new ContainerBuilder();
  428. $config->setDefinition('baz', new Definition('BazClass'));
  429. $config->setAlias('alias_for_foo', 'foo');
  430. $container->merge($config);
  431. $this->assertEquals(array('foo', 'bar', 'baz'), array_keys($container->getDefinitions()), '->merge() merges definitions already defined ones');
  432. $aliases = $container->getAliases();
  433. $this->assertTrue(isset($aliases['alias_for_foo']));
  434. $this->assertEquals('foo', (string) $aliases['alias_for_foo']);
  435. $container = new ContainerBuilder();
  436. $container->setResourceTracking(false);
  437. $container->register('foo', 'Bar\FooClass');
  438. $config->setDefinition('foo', new Definition('BazClass'));
  439. $container->merge($config);
  440. $this->assertEquals('BazClass', $container->getDefinition('foo')->getClass(), '->merge() overrides already defined services');
  441. }
  442. /**
  443. * @expectedException \LogicException
  444. */
  445. public function testMergeLogicException()
  446. {
  447. $container = new ContainerBuilder();
  448. $container->setResourceTracking(false);
  449. $container->compile();
  450. $container->merge(new ContainerBuilder());
  451. }
  452. public function testfindTaggedServiceIds()
  453. {
  454. $builder = new ContainerBuilder();
  455. $builder
  456. ->register('foo', 'Bar\FooClass')
  457. ->addTag('foo', array('foo' => 'foo'))
  458. ->addTag('bar', array('bar' => 'bar'))
  459. ->addTag('foo', array('foofoo' => 'foofoo'))
  460. ;
  461. $this->assertEquals($builder->findTaggedServiceIds('foo'), array(
  462. 'foo' => array(
  463. array('foo' => 'foo'),
  464. array('foofoo' => 'foofoo'),
  465. ),
  466. ), '->findTaggedServiceIds() returns an array of service ids and its tag attributes');
  467. $this->assertEquals(array(), $builder->findTaggedServiceIds('foobar'), '->findTaggedServiceIds() returns an empty array if there is annotated services');
  468. }
  469. public function testFindUnusedTags()
  470. {
  471. $builder = new ContainerBuilder();
  472. $builder
  473. ->register('foo', 'Bar\FooClass')
  474. ->addTag('kernel.event_listener', array('foo' => 'foo'))
  475. ->addTag('kenrel.event_listener', array('bar' => 'bar'))
  476. ;
  477. $builder->findTaggedServiceIds('kernel.event_listener');
  478. $this->assertEquals(array('kenrel.event_listener'), $builder->findUnusedTags(), '->findUnusedTags() returns an array with unused tags');
  479. }
  480. public function testFindDefinition()
  481. {
  482. $container = new ContainerBuilder();
  483. $container->setDefinition('foo', $definition = new Definition('Bar\FooClass'));
  484. $container->setAlias('bar', 'foo');
  485. $container->setAlias('foobar', 'bar');
  486. $this->assertEquals($definition, $container->findDefinition('foobar'), '->findDefinition() returns a Definition');
  487. }
  488. public function testAddObjectResource()
  489. {
  490. $container = new ContainerBuilder();
  491. $container->setResourceTracking(false);
  492. $container->addObjectResource(new \BarClass());
  493. $this->assertEmpty($container->getResources(), 'No resources get registered without resource tracking');
  494. $container->setResourceTracking(true);
  495. $container->addObjectResource(new \BarClass());
  496. $resources = $container->getResources();
  497. $this->assertCount(1, $resources, '1 resource was registered');
  498. /* @var $resource \Symfony\Component\Config\Resource\FileResource */
  499. $resource = end($resources);
  500. $this->assertInstanceOf('Symfony\Component\Config\Resource\FileResource', $resource);
  501. $this->assertSame(realpath(__DIR__.'/Fixtures/includes/classes.php'), realpath($resource->getResource()));
  502. }
  503. public function testAddClassResource()
  504. {
  505. $container = new ContainerBuilder();
  506. $container->setResourceTracking(false);
  507. $container->addClassResource(new \ReflectionClass('BarClass'));
  508. $this->assertEmpty($container->getResources(), 'No resources get registered without resource tracking');
  509. $container->setResourceTracking(true);
  510. $container->addClassResource(new \ReflectionClass('BarClass'));
  511. $resources = $container->getResources();
  512. $this->assertCount(1, $resources, '1 resource was registered');
  513. /* @var $resource \Symfony\Component\Config\Resource\FileResource */
  514. $resource = end($resources);
  515. $this->assertInstanceOf('Symfony\Component\Config\Resource\FileResource', $resource);
  516. $this->assertSame(realpath(__DIR__.'/Fixtures/includes/classes.php'), realpath($resource->getResource()));
  517. }
  518. public function testCompilesClassDefinitionsOfLazyServices()
  519. {
  520. $container = new ContainerBuilder();
  521. $this->assertEmpty($container->getResources(), 'No resources get registered without resource tracking');
  522. $container->register('foo', 'BarClass');
  523. $container->getDefinition('foo')->setLazy(true);
  524. $container->compile();
  525. $classesPath = realpath(__DIR__.'/Fixtures/includes/classes.php');
  526. $matchingResources = array_filter(
  527. $container->getResources(),
  528. function (ResourceInterface $resource) use ($classesPath) {
  529. return $resource instanceof FileResource && $classesPath === realpath($resource->getResource());
  530. }
  531. );
  532. $this->assertNotEmpty($matchingResources);
  533. }
  534. public function testResources()
  535. {
  536. $container = new ContainerBuilder();
  537. $container->addResource($a = new FileResource(__DIR__.'/Fixtures/xml/services1.xml'));
  538. $container->addResource($b = new FileResource(__DIR__.'/Fixtures/xml/services2.xml'));
  539. $resources = array();
  540. foreach ($container->getResources() as $resource) {
  541. if (false === strpos($resource, '.php')) {
  542. $resources[] = $resource;
  543. }
  544. }
  545. $this->assertEquals(array($a, $b), $resources, '->getResources() returns an array of resources read for the current configuration');
  546. $this->assertSame($container, $container->setResources(array()));
  547. $this->assertEquals(array(), $container->getResources());
  548. }
  549. public function testExtension()
  550. {
  551. $container = new ContainerBuilder();
  552. $container->setResourceTracking(false);
  553. $container->registerExtension($extension = new \ProjectExtension());
  554. $this->assertTrue($container->getExtension('project') === $extension, '->registerExtension() registers an extension');
  555. $this->{method_exists($this, $_ = 'expectException') ? $_ : 'setExpectedException'}('LogicException');
  556. $container->getExtension('no_registered');
  557. }
  558. public function testRegisteredButNotLoadedExtension()
  559. {
  560. $extension = $this->getMockBuilder('Symfony\\Component\\DependencyInjection\\Extension\\ExtensionInterface')->getMock();
  561. $extension->expects($this->once())->method('getAlias')->will($this->returnValue('project'));
  562. $extension->expects($this->never())->method('load');
  563. $container = new ContainerBuilder();
  564. $container->setResourceTracking(false);
  565. $container->registerExtension($extension);
  566. $container->compile();
  567. }
  568. public function testRegisteredAndLoadedExtension()
  569. {
  570. $extension = $this->getMockBuilder('Symfony\\Component\\DependencyInjection\\Extension\\ExtensionInterface')->getMock();
  571. $extension->expects($this->exactly(2))->method('getAlias')->will($this->returnValue('project'));
  572. $extension->expects($this->once())->method('load')->with(array(array('foo' => 'bar')));
  573. $container = new ContainerBuilder();
  574. $container->setResourceTracking(false);
  575. $container->registerExtension($extension);
  576. $container->loadFromExtension('project', array('foo' => 'bar'));
  577. $container->compile();
  578. }
  579. public function testPrivateServiceUser()
  580. {
  581. $fooDefinition = new Definition('BarClass');
  582. $fooUserDefinition = new Definition('BarUserClass', array(new Reference('bar')));
  583. $container = new ContainerBuilder();
  584. $container->setResourceTracking(false);
  585. $fooDefinition->setPublic(false);
  586. $container->addDefinitions(array(
  587. 'bar' => $fooDefinition,
  588. 'bar_user' => $fooUserDefinition,
  589. ));
  590. $container->compile();
  591. $this->assertInstanceOf('BarClass', $container->get('bar_user')->bar);
  592. }
  593. /**
  594. * @expectedException \BadMethodCallException
  595. */
  596. public function testThrowsExceptionWhenSetServiceOnAFrozenContainer()
  597. {
  598. $container = new ContainerBuilder();
  599. $container->setResourceTracking(false);
  600. $container->setDefinition('a', new Definition('stdClass'));
  601. $container->compile();
  602. $container->set('a', new \stdClass());
  603. }
  604. public function testThrowsExceptionWhenAddServiceOnAFrozenContainer()
  605. {
  606. $container = new ContainerBuilder();
  607. $container->compile();
  608. $container->set('a', $foo = new \stdClass());
  609. $this->assertSame($foo, $container->get('a'));
  610. }
  611. public function testNoExceptionWhenSetSyntheticServiceOnAFrozenContainer()
  612. {
  613. $container = new ContainerBuilder();
  614. $def = new Definition('stdClass');
  615. $def->setSynthetic(true);
  616. $container->setDefinition('a', $def);
  617. $container->compile();
  618. $container->set('a', $a = new \stdClass());
  619. $this->assertEquals($a, $container->get('a'));
  620. }
  621. /**
  622. * @group legacy
  623. */
  624. public function testLegacySetOnSynchronizedService()
  625. {
  626. $container = new ContainerBuilder();
  627. $container->register('baz', 'BazClass')
  628. ->setSynchronized(true)
  629. ;
  630. $container->register('bar', 'BarClass')
  631. ->addMethodCall('setBaz', array(new Reference('baz')))
  632. ;
  633. $container->set('baz', $baz = new \BazClass());
  634. $this->assertSame($baz, $container->get('bar')->getBaz());
  635. $container->set('baz', $baz = new \BazClass());
  636. $this->assertSame($baz, $container->get('bar')->getBaz());
  637. }
  638. /**
  639. * @group legacy
  640. */
  641. public function testLegacySynchronizedServiceWithScopes()
  642. {
  643. $container = new ContainerBuilder();
  644. $container->addScope(new Scope('foo'));
  645. $container->register('baz', 'BazClass')
  646. ->setSynthetic(true)
  647. ->setSynchronized(true)
  648. ->setScope('foo')
  649. ;
  650. $container->register('bar', 'BarClass')
  651. ->addMethodCall('setBaz', array(new Reference('baz', ContainerInterface::NULL_ON_INVALID_REFERENCE, false)))
  652. ;
  653. $container->compile();
  654. $container->enterScope('foo');
  655. $container->set('baz', $outerBaz = new \BazClass(), 'foo');
  656. $this->assertSame($outerBaz, $container->get('bar')->getBaz());
  657. $container->enterScope('foo');
  658. $container->set('baz', $innerBaz = new \BazClass(), 'foo');
  659. $this->assertSame($innerBaz, $container->get('bar')->getBaz());
  660. $container->leaveScope('foo');
  661. $this->assertNotSame($innerBaz, $container->get('bar')->getBaz());
  662. $this->assertSame($outerBaz, $container->get('bar')->getBaz());
  663. $container->leaveScope('foo');
  664. }
  665. /**
  666. * @expectedException \BadMethodCallException
  667. */
  668. public function testThrowsExceptionWhenSetDefinitionOnAFrozenContainer()
  669. {
  670. $container = new ContainerBuilder();
  671. $container->setResourceTracking(false);
  672. $container->compile();
  673. $container->setDefinition('a', new Definition());
  674. }
  675. public function testExtensionConfig()
  676. {
  677. $container = new ContainerBuilder();
  678. $configs = $container->getExtensionConfig('foo');
  679. $this->assertEmpty($configs);
  680. $first = array('foo' => 'bar');
  681. $container->prependExtensionConfig('foo', $first);
  682. $configs = $container->getExtensionConfig('foo');
  683. $this->assertEquals(array($first), $configs);
  684. $second = array('ding' => 'dong');
  685. $container->prependExtensionConfig('foo', $second);
  686. $configs = $container->getExtensionConfig('foo');
  687. $this->assertEquals(array($second, $first), $configs);
  688. }
  689. public function testAbstractAlias()
  690. {
  691. $container = new ContainerBuilder();
  692. $abstract = new Definition('AbstractClass');
  693. $abstract->setAbstract(true);
  694. $container->setDefinition('abstract_service', $abstract);
  695. $container->setAlias('abstract_alias', 'abstract_service');
  696. $container->compile();
  697. $this->assertSame('abstract_service', (string) $container->getAlias('abstract_alias'));
  698. }
  699. public function testLazyLoadedService()
  700. {
  701. $loader = new ClosureLoader($container = new ContainerBuilder());
  702. $loader->load(function (ContainerBuilder $container) {
  703. $container->set('a', new \BazClass());
  704. $definition = new Definition('BazClass');
  705. $definition->setLazy(true);
  706. $container->setDefinition('a', $definition);
  707. });
  708. $container->setResourceTracking(true);
  709. $container->compile();
  710. $class = new \BazClass();
  711. $reflectionClass = new \ReflectionClass($class);
  712. $r = new \ReflectionProperty($container, 'resources');
  713. $r->setAccessible(true);
  714. $resources = $r->getValue($container);
  715. $classInList = false;
  716. foreach ($resources as $resource) {
  717. if ($resource->getResource() === $reflectionClass->getFileName()) {
  718. $classInList = true;
  719. break;
  720. }
  721. }
  722. $this->assertTrue($classInList);
  723. }
  724. public function testInitializePropertiesBeforeMethodCalls()
  725. {
  726. $container = new ContainerBuilder();
  727. $container->register('foo', 'stdClass');
  728. $container->register('bar', 'MethodCallClass')
  729. ->setProperty('simple', 'bar')
  730. ->setProperty('complex', new Reference('foo'))
  731. ->addMethodCall('callMe');
  732. $container->compile();
  733. $this->assertTrue($container->get('bar')->callPassed(), '->compile() initializes properties before method calls');
  734. }
  735. public function testAutowiring()
  736. {
  737. $container = new ContainerBuilder();
  738. $container->register('a', __NAMESPACE__.'\A');
  739. $bDefinition = $container->register('b', __NAMESPACE__.'\B');
  740. $bDefinition->setAutowired(true);
  741. $container->compile();
  742. $this->assertEquals('a', (string) $container->getDefinition('b')->getArgument(0));
  743. }
  744. }
  745. class FooClass
  746. {
  747. }
  748. class ProjectContainer extends ContainerBuilder
  749. {
  750. public function getFoobazService()
  751. {
  752. throw new InactiveScopeException('foo', 'request');
  753. }
  754. }
  755. class A
  756. {
  757. }
  758. class B
  759. {
  760. public function __construct(A $a)
  761. {
  762. }
  763. }