8000 [DependencyInjection] Add tests for `AutowireLocator`/`AutowireIterator` · symfony/symfony@fe8d9dc · GitHub
[go: up one dir, main page]
Skip to content

Commit fe8d9dc

Browse files
kbondnicolas-grekas
kbond
authored and
nicolas-grekas
committed
[DependencyInjection] Add tests for AutowireLocator/AutowireIterator 
1 parent 8ef38b3 commit fe8d9dc

File tree

10 files changed

+129
-22
lines changed

10 files changed

+129
-22
lines changed

‎src/Symfony/Component/DependencyInjection/Attribute/AutowireIterator.php

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -19,16 +19,20 @@
1919
use Symfony\Contracts\Service\Attribute\SubscribedService;
2020
use Symfony\Contracts\Service\ServiceSubscriberInterface;
2121

22+
/**
23+
* Autowires an iterator of services based on a tag name or an explicit list of key => service-type pairs.
24+
*/
2225
#[\Attribute(\Attribute::TARGET_PARAMETER)]
2326
class AutowireIterator extends Autowire
2427
{
2528
/**
2629
* @see ServiceSubscriberInterface::getSubscribedServices()
2730
*
28-
* @param array<string|SubscribedService>|string $services An explicit list of services or a tag name
31+
* @param string|array<string|SubscribedService> $services A tag name or an explicit list of services
32+
* @param string|string[] $exclude A service or a list of services to exclude
2933
*/
3034
public function __construct(
31-
array|string $services,
35+
string|array $services,
3236
string $indexAttribute = null,
3337
string $defaultIndexMethod = null,
3438
string $defaultPriorityMethod = null,
@@ -55,7 +59,8 @@ public function __construct(
5559
if (!\is_string($type) || !preg_match('/(?(DEFINE)(?<cn>[a-zA-Z_\x7f-\xff][a-zA-Z0-9_\x7f-\xff]*+))(?(DEFINE)(?<fqcn>(?&cn)(?:\\\\(?&cn))*+))^\??(?&fqcn)(?:(?:\|(?&fqcn))*+|(?:&(?&fqcn))*+)$/', $type)) {
5660
throw new InvalidArgumentException(sprintf('"%s" is not a PHP type for key "%s".', \is_string($type) ? $type : get_debug_type($type), $key));
5761
}
58-
if ($optionalBehavior = '?' === $type[0]) {
62+
$optionalBehavior = ContainerInterface::EXCEPTION_ON_INVALID_REFERENCE;
63+
if ('?' === $type[0]) {
5964
$type = substr($type, 1);
6065
$optionalBehavior = ContainerInterface::IGNORE_ON_INVALID_REFERENCE;
6166
}
@@ -64,7 +69,7 @@ public function __construct(
6469
$name = null;
6570
}
6671

67-
$references[$key] = new TypedReference($type, $type, $optionalBehavior ?: ContainerInterface::EXCEPTION_ON_INVALID_REFERENCE, $name, $attributes);
72+
$references[$key] = new TypedReference($type, $type, $optionalBehavior, $name, $attributes);
6873
}
6974

7075
parent::__construct(new IteratorArgument($references));

‎src/Symfony/Component/DependencyInjection/Attribute/AutowireLocator.php

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,16 +17,20 @@
1717
use Symfony\Contracts\Service\Attribute\SubscribedService;
1818
use Symfony\Contracts\Service\ServiceSubscriberInterface;
1919

20+
/**
21+
* Autowires a service locator based on a tag name or an explicit list of key => service-type pairs.
22+
*/
2023
#[\Attribute(\Attribute::TARGET_PARAMETER)]
2124
class AutowireLocator extends Autowire
2225
{
2326
/**
2427
* @see ServiceSubscriberInterface::getSubscribedServices()
2528
*
26-
* @param array<string|SubscribedService>|string $services An explicit list of services or a tag name
29+
* @param string|array<string|SubscribedService> $services An explicit list of services or a tag name
30+
* @param string|string[] $exclude A service or a list of services to exclude
2731
*/
2832
public function __construct(
29-
array|string $services,
33+
string|array $services,
3034
string $indexAttribute = null,
3135
string $defaultIndexMethod = null,
3236
string $defaultPriorityMethod = null,

‎src/Symfony/Component/DependencyInjection/Compiler/RegisterServiceSubscribersPass.php

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -87,7 +87,8 @@ protected function processValue(mixed $value, bool $isRoot = false): mixed
8787
if (!\is_string($type) || !preg_match('/(?(DEFINE)(?<cn>[a-zA-Z_\x7f-\xff][a-zA-Z0-9_\x7f-\xff]*+))(?(DEFINE)(?<fqcn>(?&cn)(?:\\\\(?&cn))*+))^\??(?&fqcn)(?:(?:\|(?&fqcn))*+|(?:&(?&fqcn))*+)$/', $type)) {
8888
throw new InvalidArgumentException(sprintf('"%s::getSubscribedServices()" must return valid PHP types for service "%s" key "%s", "%s" returned.', $class, $this->currentId, $key, \is_string($type) ? $type : get_debug_type($type)));
8989
}
90-
if ($optionalBehavior = '?' === $type[0]) {
90+
$optionalBehavior = ContainerInterface::EXCEPTION_ON_INVALID_REFERENCE;
91+
if ('?' === $type[0]) {
9192
$type = substr($type, 1);
9293
$optionalBehavior = ContainerInterface::IGNORE_ON_INVALID_REFERENCE;
9394
}
@@ -120,7 +121,7 @@ protected function processValue(mixed $value, bool $isRoot = false): mixed
120121
$name = $this->container->has($type.' $'.$camelCaseName) ? $camelCaseName : $name;
121122
}
122123

123-
$subscriberMap[$key] = new TypedReference((string) $serviceMap[$key], $type, $optionalBehavior ?: ContainerInterface::EXCEPTION_ON_INVALID_REFERENCE, $name, $attributes);
124+
$subscriberMap[$key] = new TypedReference((string) $serviceMap[$key], $type, $optionalBehavior, $name, $attributes);
124125
unset($serviceMap[$key]);
125126
}
126127

‎src/Symfony/Component/DependencyInjection/Tests/Compiler/IntegrationTest.php

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@
1515
use Psr\Container\ContainerInterface;
1616
use Symfony\Component\Config\FileLocator;
1717
use Symfony\Component\DependencyInjection\Alias;
18+
use Symfony\Component\DependencyInjection\Argument\RewindableGenerator;
1819
use Symfony\Component\DependencyInjection\Argument\ServiceLocatorArgument;
1920
use Symfony\Component\DependencyInjection\Argument\TaggedIteratorArgument;
2021
use Symfony\Component\DependencyInjection\ChildDefinition;
@@ -32,6 +33,7 @@
3233
use Symfony\Component\DependencyInjection\Tests\Fixtures\AutoconfiguredInterface2;
3334
use Symfony\Component\DependencyInjection\Tests\Fixtures\AutoconfiguredService1;
3435
use Symfony\Component\DependencyInjection\Tests\Fixtures\AutoconfiguredService2;
36+
use Symfony\Component\DependencyInjection\Tests\Fixtures\AutowireIteratorConsumer;
3537
use Symfony\Component\DependencyInjection\Tests\Fixtures\AutowireLocatorConsumer;
3638
use Symfony\Component\DependencyInjection\Tests\Fixtures\BarTagClass;
3739
use Symfony\Component\DependencyInjection\Tests\Fixtures\FooBarTaggedClass;
@@ -392,6 +394,7 @@ public function testTaggedServiceWithIndexAttributeAndDefaultMethod()
392394
public function testLocatorConfiguredViaAttribute()
393395
{
394396
$container = new ContainerBuilder();
397+
$container->setParameter('some.parameter', 'foo');
395398
$container->register(BarTagClass::class)
396399
->setPublic(true)
397400
;
@@ -411,6 +414,36 @@ public function testLocatorConfiguredViaAttribute()
411414
self::assertSame($container->get(BarTagClass::class), $s->locator->get(BarTagClass::class));
412415
self::assertSame($container->get(FooTagClass::class), $s->locator->get('with_key'));
413416
self::assertFalse($s->locator->has('nullable'));
417+
self::assertSame('foo', $s->locator->get('subscribed'));
418+
}
419+
420+
public function testIteratorConfiguredViaAttribute()
421+
{
422+
$container = new ContainerBuilder();
423+
$container->setParameter('some.parameter', 'foo');
424+
$container->register(BarTagClass::class)
425+
->setPublic(true)
426+
;
427+
$container->register(FooTagClass::class)
428+
->setPublic(true)
429+
;
430+
$container->register(AutowireIteratorConsumer::class)
431+
->setAutowired(true)
432+
->setPublic(true)
433+
;
434+
435+
$container->compile();
436+
437+
/** @var AutowireIteratorConsumer $s */
438+
$s = $container->get(AutowireIteratorConsumer::class);
439+
440+
self::assertInstanceOf(RewindableGenerator::class, $s->iterator);
441+
442+
$values = iterator_to_array($s->iterator);
443+
self::assertCount(3, $values);
444+
self::assertSame($container->get(BarTagClass::class), $values[BarTagClass::class]);
445+
self::assertSame($container->get(FooTagClass::class), $values['with_key']);
446+
self::assertSame('foo', $values['subscribed']);
414447
}
415448

416449
public function testTaggedServiceWithIndexAttributeAndDefaultMethodConfiguredViaAttribute()

‎src/Symfony/Component/DependencyInjection/Tests/Fixtures/AutowireIteratorConsumer.php

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
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\DependencyInjection\Tests\Fixtures;
13+
14+
use Symfony\Component\DependencyInjection\Attribute\Autowire;
15+
use Symfony\Component\DependencyInjection\Attribute\AutowireIterator;
16+
use Symfony\Contracts\Service\Attribute\SubscribedService;
17+
18+
final class AutowireIteratorConsumer
19+
{
20+
public function __construct(
21+
#[AutowireIterator([
22+
BarTagClass::class,
23+
'with_key' => FooTagClass::class,
24+
'nullable' => '?invalid',
25+
'subscribed' => new SubscribedService(type: 'string', attributes: new Autowire('%some.parameter%')),
26+
])]
27+
public readonly iterable $iterator,
28+
) {
29+
}
30+
}

‎src/Symfony/Component/DependencyInjection/Tests/Fixtures/AutowireLocatorConsumer.php

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,9 @@
1212
namespace Symfony\Component\DependencyInjection\Tests\Fixtures;
1313

1414
use Psr\Container\ContainerInterface;
15+
use Symfony\Component\DependencyInjection\Attribute\Autowire;
1516
use Symfony\Component\DependencyInjection\Attribute\AutowireLocator;
17+
use Symfony\Contracts\Service\Attribute\SubscribedService;
1618

1719
final class AutowireLocatorConsumer
1820
{
@@ -21,6 +23,7 @@ public function __construct(
2123
BarTagClass::class,
2224
'with_key' => FooTagClass::class,
2325
'nullable' => '?invalid',
26+
'subscribed' => new SubscribedService(type: 'string', attributes: new Autowire('%some.parameter%')),
2427
])]
2528
public readonly ContainerInterface $locator,
2629
) {

‎src/Symfony/Component/DependencyInjection/Tests/Fixtures/TaggedIteratorConsumer.php

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,12 +11,12 @@
1111

1212
namespace Symfony\Component\DependencyInjection\Tests\Fixtures;
1313

14-
use Symfony\Component\DependencyInjection\Attribute\TaggedIterator;
14+
use Symfony\Component\DependencyInjection\Attribute\AutowireIterator;
1515

1616
final class TaggedIteratorConsumer
1717
{
1818
public function __construct(
19-
#[TaggedIterator('foo_bar', indexAttribute: 'foo')]
19+
#[AutowireIterator('foo_bar', indexAttribute: 'foo')]
2020
private iterable $param,
2121
) {
2222
}

‎src/Symfony/Component/DependencyInjection/Tests/Fixtures/TaggedLocatorConsumer.php

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,12 +12,12 @@
1212
namespace Symfony\Component\DependencyInjection\Tests\Fixtures;
1313

1414
use Psr\Container\ContainerInterface;
15-
use Symfony\Component\DependencyInjection\Attribute\TaggedLocator;
15+
use Symfony\Component\DependencyInjection\Attribute\AutowireLocator;
1616

1717
final class TaggedLocatorConsumer
1818
{
1919
public function __construct(
20-
#[TaggedLocator('foo_bar', indexAttribute: 'foo')]
20+
#[AutowireLocator('foo_bar', indexAttribute: 'foo')]
2121
private ContainerInterface $locator,
2222
) {
2323
}

‎src/Symfony/Component/HttpKernel/Tests/DependencyInjection/RegisterControllerArgumentLocatorsPassTest.php

Lines changed: 40 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@
1717
use Symfony\Component\DependencyInjection\Argument\ServiceClosureArgument;
1818
use Symfony\Component\DependencyInjection\Attribute\Autowire;
1919
use Symfony\Component\DependencyInjection\Attribute\AutowireCallable;
20+
use Symfony\Component\DependencyInjection\Attribute\AutowireIterator;
2021
use Symfony\Component\DependencyInjection\Attribute\AutowireLocator;
2122
use Symfony\Component\DependencyInjection\Attribute\TaggedIterator;
2223
use Symfony\Component\DependencyInjection\Attribute\TaggedLocator;
@@ -31,6 +32,7 @@
3132
use Symfony\Component\HttpFoundation\Response;
3233
use Symfony\Component\HttpKernel\DependencyInjection\RegisterControllerArgumentLocatorsPass;
3334
use Symfony\Component\HttpKernel\Tests\Fixtures\Suit;
35+
use Symfony\Contracts\Service\Attribute\SubscribedService;
3436

3537
class RegisterControllerArgumentLocatorsPassTest extends TestCase
3638
{
@@ -499,6 +501,7 @@ public function testAutowireAttribute()
499501
public function testTaggedIteratorAndTaggedLocatorAttributes()
500502
{
501503
$container = new ContainerBuilder();
504+
$container->setParameter('some.parameter', 'bar');
502505
$resolver = $container->register('argument_resolver.service', \stdClass::class)->addArgument([]);
503506

504507
$container->register('bar', \stdClass::class)->addTag('foobar');
@@ -517,25 +520,48 @@ public function testTaggedIteratorAndTaggedLocatorAttributes()
517520
/** @var ServiceLocator $locator */
518521
$locator = $container->get($locatorId)->get('foo::fooAction');
519522

520-
$this->assertCount(3, $locator->getProvidedServices());
523+
$this->assertCount(7, $locator->getProvidedServices());
521524

522-
$this->assertTrue($locator->has('iterator'));
523-
$this->assertInstanceOf(RewindableGenerator::class, $argIterator = $locator->get('iterator'));
525+
$this->assertTrue($locator->has('iterator1'));
526+
$this->assertInstanceOf(RewindableGenerator::class, $argIterator = $locator->get('iterator1'));
524527
$this->assertCount(2, $argIterator);
525528

526-
$this->assertTrue($locator->has('locator'));
527-
$this->assertInstanceOf(ServiceLocator::class, $argLocator = $locator->get('locator'));
529+
$this->assertTrue($locator->has('iterator2'));
530+
$this->assertInstanceOf(RewindableGenerator::class, $argIterator = $locator->get('iterator2'));
531+
$this->assertCount(2, $argIterator);
532+
533+
$this->assertTrue($locator->has('locator1'));
534+
$this->assertInstanceOf(ServiceLocator::class, $argLocator = $locator->get('locator1'));
535+
$this->assertCount(2, $argLocator);
536+
$this->assertTrue($argLocator->has('bar'));
537+
$this->assertTrue($argLocator->has('baz'));
538+
539+
$this->assertSame(iterator_to_array($argIterator), [$argLocator->get('bar'), $argLocator->get('baz')]);
540+
541+
$this->assertTrue($locator->has('locator2'));
542+
$this->assertInstanceOf(ServiceLocator::class, $argLocator = $locator->get('locator2'));
528543
$this->assertCount(2, $argLocator);
529544
$this->assertTrue($argLocator->has('bar'));
530545
$this->assertTrue($argLocator->has('baz'));
531546

532547
$this->assertSame(iterator_to_array($argIterator), [$argLocator->get('bar'), $argLocator->get('baz')]);
533548

534-
$this->assertTrue($locator->has('container'));
535-
$this->assertInstanceOf(ServiceLocator::class, $argLocator = $locator->get('container'));
549+
$this->assertTrue($locator->has('container1'));
550+
$this->assertInstanceOf(ServiceLocator::class, $argLocator = $locator->get('container1'));
536551
$this->assertCount(2, $argLocator);
537552
$this->assertTrue($argLocator->has('bar'));
538553
$this->assertTrue($argLocator->has('baz'));
554+
555+
$this->assertTrue($locator->has('container2'));
556+
$this->assertInstanceOf(ServiceLocator::class, $argLocator = $locator->get('container2'));
557+
$this->assertCount(1, $argLocator);
558+
$this->assertTrue($argLocator->has('foo'));
559+
$this->assertSame('bar', $argLocator->get('foo'));
560+
561+
$this->assertTrue($locator->has('iterator3'));
562+
$this->assertInstanceOf(RewindableGenerator::class, $argIterator = $locator->get('iterator3'));
563+
$this->assertCount(1, $argIterator);
564+
$this->assertSame('bar', iterator_to_array($argIterator)['foo']);
539565
}
540566
}
541567

@@ -674,9 +700,13 @@ public function fooAction(
674700
class WithTaggedIteratorAndTaggedLocator
675701
{
676702
public function fooAction(
677-
#[TaggedIterator('foobar')] iterable $iterator,
678-
#[TaggedLocator('foobar')] ServiceLocator $locator,
679-
#[AutowireLocator(['bar', 'baz'])] ContainerInterface $container,
703+
#[TaggedIterator('foobar')] iterable $iterator1,
704+
#[AutowireIterator('foobar')] iterable $iterator2,
705+
#[TaggedLocator('foobar')] ServiceLocator $locator1,
706+
#[AutowireLocator('foobar')] ServiceLocator $locator2,
707+
#[AutowireLocator(['bar', 'baz'])] ContainerInterface $container1,
708+
#[AutowireLocator(['foo' => new SubscribedService(type: 'string', attributes: new Autowire('%some.parameter%'))])] ContainerInterface $container2,
709+
#[AutowireIterator(['foo' => new SubscribedService(type: 'string', attributes: new Autowire('%some.parameter%'))])] iterable $iterator3,
680710
) {
681711
}
682712
}

‎src/Symfony/Component/HttpKernel/composer.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -63,6 +63,7 @@
6363
"symfony/http-client-contracts": "<2.5",
6464
"symfony/mailer": "<5.4",
6565
"symfony/messenger": "<5.4",
66+
"symfony/service-contracts": "<3.2",
6667
"symfony/translation": "<5.4",
6768
"symfony/translation-contracts": "<2.5",
6869
"symfony/twig-bridge": "<5.4",

0 commit comments

Comments
 (0)
0