Refactor the symfony integration to use one service locator per test case

Author: jakzal

depfile.yml

@@ -72,7 +72,6 @@ ruleset:
     - TestCase
     - Symfony DependencyInjection
   Symfony TestCase:
-    - Symfony Compiler
     - Psr Container
     - Symfony DependencyInjection
     - Symfony HttpKernel

src/Symfony/Compiler/ExposeServicesForTestsPass.php

@@ -12,44 +12,32 @@
 
 class ExposeServicesForTestsPass implements CompilerPassInterface
 {
-    const DEFAULT_SERVICE_LOCATOR_ID = 'app.test.service_locator';
-
-    /**
-     * @var string
-     */
-    private $serviceLocatorId;
-
     /**
      * @var PropertyDiscovery
      */
     private $propertyDiscovery;
 
-    public function __construct(string $serviceLocatorId = self::DEFAULT_SERVICE_LOCATOR_ID, ?PropertyDiscovery $propertyDiscovery = null)
+    public function __construct(?PropertyDiscovery $propertyDiscovery = null)
     {
-        $this->serviceLocatorId = $serviceLocatorId;
         $this->propertyDiscovery = $propertyDiscovery ?? new PropertyDiscovery();
     }
 
     public function process(ContainerBuilder $container): void
     {
-        $container->register($this->serviceLocatorId, ServiceLocator::class)
-            ->setPublic(true)
-            ->addTag('container.service_locator')
-            ->addArgument($this->discoverServices());
+        foreach ($this->discoverServices() as $testClass => $references) {
+            $container->register($testClass, ServiceLocator::class)
+                ->setPublic(true)
+                ->addTag('container.service_locator')
+                ->addArgument($references);
+        }
     }
 
     private function discoverServices(): array
     {
-        return $this->flatMap(
-            function (Property $property) {
-                return [$property->getServiceId() => new Reference($property->getServiceId())];
-            },
-            $this->propertyDiscovery->run()
-        );
-    }
+        return \array_reduce($this->propertyDiscovery->run(), function (array $services, Property $property) {
+            $services[$property->getClassName()][$property->getServiceId()] = new Reference($property->getServiceId());
 
-    private function flatMap(callable $callback, array $collection): array
-    {
-        return \array_merge([], ...\array_map($callback, $collection));
+            return $services;
+        }, []);
     }
 }

src/Symfony/TestCase/SymfonyContainer.php

@@ -4,7 +4,6 @@
 namespace Zalas\Injector\PHPUnit\Symfony\TestCase;
 
 use Psr\Container\ContainerInterface;
-use Zalas\Injector\PHPUnit\Symfony\Compiler\ExposeServicesForTestsPass;
 
 /**
  * Provides a `ServiceContainerTestCase` implementation with the container created by the Symfony Kernel.
@@ -15,11 +14,6 @@ trait SymfonyContainer
 
     public function createContainer(): ContainerInterface
     {
-        return static::bootKernel()->getContainer()->get($this->getTestServiceLocatorId());
-    }
-
-    protected function getTestServiceLocatorId(): string
-    {
-        return ExposeServicesForTestsPass::DEFAULT_SERVICE_LOCATOR_ID;
+        return static::bootKernel()->getContainer()->get(__CLASS__);
     }
 }

tests/Symfony/Compiler/ExposeServicesForTestsPassTest.php

@@ -14,12 +14,11 @@
 use Zalas\Injector\PHPUnit\Tests\Symfony\Compiler\Fixtures\Service1;
 use Zalas\Injector\PHPUnit\Tests\Symfony\Compiler\Fixtures\Service2;
 use Zalas\Injector\PHPUnit\Tests\Symfony\Compiler\Fixtures\TestCase1;
+use Zalas\Injector\PHPUnit\Tests\Symfony\Compiler\Fixtures\TestCase2;
 use Zalas\Injector\Service\Property;
 
 class ExposeServicesForTestsPassTest extends TestCase
 {
-    const SERVICE_LOCATOR_ID = 'app.test.service_locator';
-
     /**
      * @var ExposeServicesForTestsPass
      */
@@ -33,42 +32,49 @@ class ExposeServicesForTestsPassTest extends TestCase
     protected function setUp()
     {
         $this->discovery = $this->prophesize(PropertyDiscovery::class);
-        $this->pass = new ExposeServicesForTestsPass(self::SERVICE_LOCATOR_ID, $this->discovery->reveal());
+        $this->pass = new ExposeServicesForTestsPass($this->discovery->reveal());
     }
 
     public function test_it_is_a_compiler_pass()
     {
         $this->assertInstanceOf(CompilerPassInterface::class, $this->pass);
     }
 
-    public function test_it_registers_a_service_locator_for_services_used_in_tests()
+    public function test_it_registers_a_service_locator_for_each_test_case_requiring_service_injection()
     {
         $this->discovery->run()->willReturn([
             new Property(TestCase1::class, 'service1', Service1::class),
             new Property(TestCase1::class, 'service2', Service2::class),
+            new Property(TestCase2::class, 'service2', Service2::class),
         ]);
 
         $container = new ContainerBuilder();
 
         $this->pass->process($container);
 
-        $this->assertTrue($container->hasDefinition(self::SERVICE_LOCATOR_ID), 'The service locator is registered as a service.');
-        $this->assertSame(ServiceLocator::class, $container->getDefinition(self::SERVICE_LOCATOR_ID)->getClass());
-        $this->assertFalse($container->getDefinition(self::SERVICE_LOCATOR_ID)->isPrivate(), 'The service locator is registered as a public service.');
-        $this->assertTrue($container->getDefinition(self::SERVICE_LOCATOR_ID)->isPublic(), 'The service locator is registered as a public service.');
-        $this->assertTrue($container->getDefinition(self::SERVICE_LOCATOR_ID)->hasTag('container.service_locator'), 'The service locator is tagged.');
-        $this->assertEquals([Service1::class => new Reference(Service1::class), Service2::class => new Reference(Service2::class)], $container->getDefinition(self::SERVICE_LOCATOR_ID)->getArgument(0));
+        $this->assertTrue($container->hasDefinition(TestCase1::class), 'The first test case service locator is registered as a service.');
+        $this->assertSame(ServiceLocator::class, $container->getDefinition(TestCase1::class)->getClass());
+        $this->assertSame(ServiceLocator::class, $container->getDefinition(TestCase2::class)->getClass());
+        $this->assertFalse($container->getDefinition(TestCase1::class)->isPrivate(), 'The first test case service locator is registered as a public service.');
+        $this->assertTrue($container->getDefinition(TestCase1::class)->isPublic(), 'The first test case service locator is registered as a public service.');
+        $this->assertTrue($container->getDefinition(TestCase1::class)->hasTag('container.service_locator'), 'The first case service locator is tagged.');
+        $this->assertEquals([Service1::class => new Reference(Service1::class), Service2::class => new Reference(Service2::class)], $container->getDefinition(TestCase1::class)->getArgument(0));
+        $this->assertTrue($container->hasDefinition(TestCase2::class), 'The second test case service locator is registered as a service.');
+        $this->assertFalse($container->getDefinition(TestCase2::class)->isPrivate(), 'The second test case service locator is registered as a public service.');
+        $this->assertTrue($container->getDefinition(TestCase2::class)->isPublic(), 'The second test case service locator is registered as a public service.');
+        $this->assertTrue($container->getDefinition(TestCase2::class)->hasTag('container.service_locator'), 'The second test case service locator is tagged.');
+        $this->assertEquals([Service2::class => new Reference(Service2::class)], $container->getDefinition(TestCase2::class)->getArgument(0));
     }
 
-    public function test_it_registers_an_empty_service_locator_if_no_services_were_discovered()
+    public function test_it_only_registers_a_service_locator_if_any_services_were_discovered()
     {
         $this->discovery->run()->willReturn([]);
 
         $container = new ContainerBuilder();
 
         $this->pass->process($container);
 
-        $this->assertTrue($container->hasDefinition(self::SERVICE_LOCATOR_ID), 'The service locator is registered as a service.');
-        $this->assertEquals([], $container->getDefinition(self::SERVICE_LOCATOR_ID)->getArgument(0), 'No services were registered on the service locator.');
+        $this->assertfalse($container->hasDefinition(TestCase1::class), 'The first test case service locator is not registered as a service.');
+        $this->assertfalse($container->hasDefinition(TestCase2::class), 'The second test case service locator is not registered as a service.');
     }
 }

tests/Symfony/TestCase/Fixtures/TestKernel.php

@@ -43,7 +43,6 @@ protected function build(ContainerBuilder $container)
         if ('test' === $this->getEnvironment()) {
             $container->addCompilerPass(
                 new ExposeServicesForTestsPass(
-                    ExposeServicesForTestsPass::DEFAULT_SERVICE_LOCATOR_ID,
                     new PropertyDiscovery(new ClassFinder(__DIR__ . '/../'))
                 )
             );