[DependencyInjection] Add tests for AutowireLocator/AutowireIterator

symfony · nicolas-grekas · Oct 6, 2023 · Oct 3, 2023 · Oct 3, 2023 · Oct 6, 2023
commit a87f2e0c248e5e22c9445ba2f371ab667e49faf8
diff --git a/src/Symfony/Component/DependencyInjection/Tests/Compiler/IntegrationTest.php b/src/Symfony/Component/DependencyInjection/Tests/Compiler/IntegrationTest.php
@@ -15,6 +15,7 @@
 use Psr\Container\ContainerInterface;
 use Symfony\Component\Config\FileLocator;
 use Symfony\Component\DependencyInjection\Alias;
+use Symfony\Component\DependencyInjection\Argument\RewindableGenerator;
 use Symfony\Component\DependencyInjection\Argument\ServiceLocatorArgument;
 use Symfony\Component\DependencyInjection\Argument\TaggedIteratorArgument;
 use Symfony\Component\DependencyInjection\ChildDefinition;
@@ -32,6 +33,7 @@
 use Symfony\Component\DependencyInjection\Tests\Fixtures\AutoconfiguredInterface2;
 use Symfony\Component\DependencyInjection\Tests\Fixtures\AutoconfiguredService1;
 use Symfony\Component\DependencyInjection\Tests\Fixtures\AutoconfiguredService2;
+use Symfony\Component\DependencyInjection\Tests\Fixtures\AutowireIteratorConsumer;
 use Symfony\Component\DependencyInjection\Tests\Fixtures\AutowireLocatorConsumer;
 use Symfony\Component\DependencyInjection\Tests\Fixtures\BarTagClass;
 use Symfony\Component\DependencyInjection\Tests\Fixtures\FooBarTaggedClass;
@@ -392,6 +394,7 @@ public function testTaggedServiceWithIndexAttributeAndDefaultMethod()
     public function testLocatorConfiguredViaAttribute()
     {
         $container = new ContainerBuilder();
+        $container->setParameter('some.parameter', 'foo');
         $container->register(BarTagClass::class)
             ->setPublic(true)
         ;
@@ -411,6 +414,36 @@ public function testLocatorConfiguredViaAttribute()
         self::assertSame($container->get(BarTagClass::class), $s->locator->get(BarTagClass::class));
         self::assertSame($container->get(FooTagClass::class), $s->locator->get('with_key'));
         self::assertFalse($s->locator->has('nullable'));
+        self::assertSame('foo', $s->locator->get('subscribed'));
+    }
+
+    public function testIteratorConfiguredViaAttribute()
+    {
+        $container = new ContainerBuilder();
+        $container->setParameter('some.parameter', 'foo');
+        $container->register(BarTagClass::class)
+            ->setPublic(true)
+        ;
+        $container->register(FooTagClass::class)
+            ->setPublic(true)
+        ;
+        $container->register(AutowireIteratorConsumer::class)
+            ->setAutowired(true)
+            ->setPublic(true)
+        ;
+
+        $container->compile();
+
+        /** @var AutowireIteratorConsumer $s */
+        $s = $container->get(AutowireIteratorConsumer::class);
+
+        self::assertInstanceOf(RewindableGenerator::class, $s->iterator);
+
+        $values = iterator_to_array($s->iterator);
+        self::assertCount(3, $values);
+        self::assertSame($container->get(BarTagClass::class), $values[BarTagClass::class]);
+        self::assertSame($container->get(FooTagClass::class), $values['with_key']);
+        self::assertSame('foo', $values['subscribed']);
     }
 
     public function testTaggedServiceWithIndexAttributeAndDefaultMethodConfiguredViaAttribute()

diff --git a/src/Symfony/Component/DependencyInjection/Tests/Fixtures/AutowireIteratorConsumer.php b/src/Symfony/Component/DependencyInjection/Tests/Fixtures/AutowireIteratorConsumer.php
@@ -0,0 +1,30 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Component\DependencyInjection\Tests\Fixtures;
+
+use Symfony\Component\DependencyInjection\Attribute\Autowire;
+use Symfony\Component\DependencyInjection\Attribute\AutowireIterator;
+use Symfony\Contracts\Service\Attribute\SubscribedService;
+
+final class AutowireIteratorConsumer
+{
+    public function __construct(
+        #[AutowireIterator([
+            BarTagClass::class,
+            'with_key' => FooTagClass::class,
+            'nullable' => '?invalid',
+            'subscribed' => new SubscribedService(type: 'string', attributes: new Autowire('%some.parameter%')),
+        ])]
+        public readonly iterable $iterator,
+    ) {
+    }
+}
diff --git a/src/Symfony/Component/DependencyInjection/Tests/Fixtures/AutowireLocatorConsumer.php b/src/Symfony/Component/DependencyInjection/Tests/Fixtures/AutowireLocatorConsumer.php
@@ -12,7 +12,9 @@
 namespace Symfony\Component\DependencyInjection\Tests\Fixtures;
 
 use Psr\Container\ContainerInterface;
+use Symfony\Component\DependencyInjection\Attribute\Autowire;
 use Symfony\Component\DependencyInjection\Attribute\AutowireLocator;
+use Symfony\Contracts\Service\Attribute\SubscribedService;
 
 final class AutowireLocatorConsumer
 {
@@ -21,6 +23,7 @@ public function __construct(
             BarTagClass::class,
             'with_key' => FooTagClass::class,
             'nullable' => '?invalid',
+            'subscribed' => new SubscribedService(type: 'string', attributes: new Autowire('%some.parameter%')),
         ])]
         public readonly ContainerInterface $locator,
     ) {

diff --git a/src/Symfony/Component/DependencyInjection/Tests/Fixtures/TaggedIteratorConsumer.php b/src/Symfony/Component/DependencyInjection/Tests/Fixtures/TaggedIteratorConsumer.php
@@ -11,12 +11,12 @@
 
 namespace Symfony\Component\DependencyInjection\Tests\Fixtures;
 
-use Symfony\Component\DependencyInjection\Attribute\TaggedIterator;
+use Symfony\Component\DependencyInjection\Attribute\AutowireIterator;
 
 final class TaggedIteratorConsumer
 {
     public function __construct(
-        #[TaggedIterator('foo_bar', indexAttribute: 'foo')]
+        #[AutowireIterator('foo_bar', indexAttribute: 'foo')]
         private iterable $param,
     ) {
     }

diff --git a/src/Symfony/Component/DependencyInjection/Tests/Fixtures/TaggedLocatorConsumer.php b/src/Symfony/Component/DependencyInjection/Tests/Fixtures/TaggedLocatorConsumer.php
@@ -12,12 +12,12 @@
 namespace Symfony\Component\DependencyInjection\Tests\Fixtures;
 
 use Psr\Container\ContainerInterface;
-use Symfony\Component\DependencyInjection\Attribute\TaggedLocator;
+use Symfony\Component\DependencyInjection\Attribute\AutowireLocator;
 
 final class TaggedLocatorConsumer
 {
     public function __construct(
-        #[TaggedLocator('foo_bar', indexAttribute: 'foo')]
+        #[AutowireLocator('foo_bar', indexAttribute: 'foo')]
         private ContainerInterface $locator,
     ) {
     }

diff --git a/...onent/HttpKernel/Tests/DependencyInjection/RegisterControllerArgumentLocatorsPassTest.php b/...onent/HttpKernel/Tests/DependencyInjection/RegisterControllerArgumentLocatorsPassTest.php
@@ -17,6 +17,7 @@
 use Symfony\Component\DependencyInjection\Argument\ServiceClosureArgument;
 use Symfony\Component\DependencyInjection\Attribute\Autowire;
 use Symfony\Component\DependencyInjection\Attribute\AutowireCallable;
+use Symfony\Component\DependencyInjection\Attribute\AutowireIterator;
 use Symfony\Component\DependencyInjection\Attribute\AutowireLocator;
 use Symfony\Component\DependencyInjection\Attribute\TaggedIterator;
 use Symfony\Component\DependencyInjection\Attribute\TaggedLocator;
@@ -31,6 +32,7 @@
 use Symfony\Component\HttpFoundation\Response;
 use Symfony\Component\HttpKernel\DependencyInjection\RegisterControllerArgumentLocatorsPass;
 use Symfony\Component\HttpKernel\Tests\Fixtures\Suit;
+use Symfony\Contracts\Service\Attribute\SubscribedService;
 
 class RegisterControllerArgumentLocatorsPassTest extends TestCase
 {
@@ -499,6 +501,7 @@ public function testAutowireAttribute()
     public function testTaggedIteratorAndTaggedLocatorAttributes()
     {
         $container = new ContainerBuilder();
+        $container->setParameter('some.parameter', 'bar');
         $resolver = $container->register('argument_resolver.service', \stdClass::class)->addArgument([]);
 
         $container->register('bar', \stdClass::class)->addTag('foobar');
@@ -517,25 +520,48 @@ public function testTaggedIteratorAndTaggedLocatorAttributes()
         /** @var ServiceLocator $locator */
         $locator = $container->get($locatorId)->get('foo::fooAction');
 
-        $this->assertCount(3, $locator->getProvidedServices());
+        $this->assertCount(7, $locator->getProvidedServices());
 
-        $this->assertTrue($locator->has('iterator'));
-        $this->assertInstanceOf(RewindableGenerator::class, $argIterator = $locator->get('iterator'));
+        $this->assertTrue($locator->has('iterator1'));
+        $this->assertInstanceOf(RewindableGenerator::class, $argIterator = $locator->get('iterator1'));
         $this->assertCount(2, $argIterator);
 
-        $this->assertTrue($locator->has('locator'));
-        $this->assertInstanceOf(ServiceLocator::class, $argLocator = $locator->get('locator'));
+        $this->assertTrue($locator->has('iterator2'));
+        $this->assertInstanceOf(RewindableGenerator::class, $argIterator = $locator->get('iterator2'));
+        $this->assertCount(2, $argIterator);
+
+        $this->assertTrue($locator->has('locator1'));
+        $this->assertInstanceOf(ServiceLocator::class, $argLocator = $locator->get('locator1'));
+        $this->assertCount(2, $argLocator);
+        $this->assertTrue($argLocator->has('bar'));
+        $this->assertTrue($argLocator->has('baz'));
+
+        $this->assertSame(iterator_to_array($argIterator), [$argLocator->get('bar'), $argLocator->get('baz')]);
+
+        $this->assertTrue($locator->has('locator2'));
+        $this->assertInstanceOf(ServiceLocator::class, $argLocator = $locator->get('locator2'));
         $this->assertCount(2, $argLocator);
         $this->assertTrue($argLocator->has('bar'));
         $this->assertTrue($argLocator->has('baz'));
 
         $this->assertSame(iterator_to_array($argIterator), [$argLocator->get('bar'), $argLocator->get('baz')]);
 
-        $this->assertTrue($locator->has('container'));
-        $this->assertInstanceOf(ServiceLocator::class, $argLocator = $locator->get('container'));
+        $this->assertTrue($locator->has('container1'));
+        $this->assertInstanceOf(ServiceLocator::class, $argLocator =
F438
 $locator->get('container1'));
         $this->assertCount(2, $argLocator);
         $this->assertTrue($argLocator->has('bar'));
         $this->assertTrue($argLocator->has('baz'));
+
+        $this->assertTrue($locator->has('container2'));
+        $this->assertInstanceOf(ServiceLocator::class, $argLocator = $locator->get('container2'));
+        $this->assertCount(1, $argLocator);
+        $this->assertTrue($argLocator->has('foo'));
+        $this->assertSame('bar', $argLocator->get('foo'));
+
+        $this->assertTrue($locator->has('iterator3'));
+        $this->assertInstanceOf(RewindableGenerator::class, $argIterator = $locator->get('iterator3'));
+        $this->assertCount(1, $argIterator);
+        $this->assertSame('bar', iterator_to_array($argIterator)['foo']);
     }
 }
 
@@ -674,9 +700,13 @@ public function fooAction(
 class WithTaggedIteratorAndTaggedLocator
 {
     public function fooAction(
-        #[TaggedIterator('foobar')] iterable $iterator,
-        #[TaggedLocator('foobar')] ServiceLocator $locator,
-        #[AutowireLocator(['bar', 'baz'])] ContainerInterface $container,
+        #[TaggedIterator('foobar')] iterable $iterator1,
+        #[AutowireIterator('foobar')] iterable $iterator2,
+        #[TaggedLocator('foobar')] ServiceLocator $locator1,
+        #[AutowireLocator('foobar')] ServiceLocator $locator2,
+        #[AutowireLocator(['bar', 'baz'])] ContainerInterface $container1,
+        #[AutowireLocator(['foo' => new SubscribedService(type: 'string', attributes: new Autowire('%some.parameter%'))])] ContainerInterface $container2,
+        #[AutowireIterator(['foo' => new SubscribedService(type: 'string', attributes: new Autowire('%some.parameter%'))])] iterable $iterator3,
     ) {
     }
 }
diff --git a/src/Symfony/Component/HttpKernel/composer.json b/src/Symfony/Component/HttpKernel/composer.json
@@ -63,6 +63,7 @@
         "symfony/http-client-contracts": "<2.5",
         "symfony/mailer": "<5.4",
         "symfony/messenger": "<5.4",
+        "symfony/service-contracts": "<3.2",
         "symfony/translation": "<5.4",
         "symfony/translation-contracts": "<2.5",
         "symfony/twig-bridge": "<5.4",