Allow different set of services per test case

This fixes an edge case problem when using multiple kernels to create containers with different sets of services per test case. The current limitation is it only works per test case class. It does not work per test case test method (all services in test case class have to come from the same service locator).

Author: jakzal

Makefile

@@ -34,7 +34,7 @@ deptrac: vendor/bin/deptrac
 .PHONY: deptrac
 
 infection: vendor/bin/infection vendor/bin/infection.pubkey
-	phpdbg -qrr ./vendor/bin/infection --no-interaction --formatter=progress --min-msi=87 --min-covered-msi=89 --ansi
+	phpdbg -qrr ./vendor/bin/infection --no-interaction --formatter=progress --min-msi=89 --min-covered-msi=91 --ansi
 .PHONY: infection
 
 phpunit: vendor/bin/phpunit

src/Symfony/Compiler/ExposeServicesForTestsPass.php

@@ -5,6 +5,7 @@
 
 use Symfony\Component\DependencyInjection\Compiler\CompilerPassInterface;
 use Symfony\Component\DependencyInjection\ContainerBuilder;
+use Symfony\Component\DependencyInjection\ContainerInterface;
 use Symfony\Component\DependencyInjection\Reference;
 use Symfony\Component\DependencyInjection\ServiceLocator;
 use Zalas\Injector\PHPUnit\Symfony\Compiler\Discovery\PropertyDiscovery;
@@ -35,7 +36,7 @@ public function process(ContainerBuilder $container): void
     private function discoverServices(): array
     {
         return \array_reduce($this->propertyDiscovery->run(), function (array $services, Property $property) {
-            $services[$property->getClassName()][$property->getServiceId()] = new Reference($property->getServiceId());
+            $services[$property->getClassName()][$property->getServiceId()] = new Reference($property->getServiceId(), ContainerInterface::IGNORE_ON_INVALID_REFERENCE);
 
             return $services;
         }, []);

tests/Symfony/Compiler/ExposeServicesForTestsPassTest.php

@@ -7,6 +7,7 @@
 use Prophecy\Prophecy\ObjectProphecy;
 use Symfony\Component\DependencyInjection\Compiler\CompilerPassInterface;
 use Symfony\Component\DependencyInjection\ContainerBuilder;
+use Symfony\Component\DependencyInjection\ContainerInterface;
 use Symfony\Component\DependencyInjection\Reference;
 use Symfony\Component\DependencyInjection\ServiceLocator;
 use Zalas\Injector\PHPUnit\Symfony\Compiler\Discovery\PropertyDiscovery;
@@ -58,12 +59,12 @@ public function test_it_registers_a_service_locator_for_each_test_case_requiring
         $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->assertEquals([Service1::class => new Reference(Service1::class, ContainerInterface::IGNORE_ON_INVALID_REFERENCE), Service2::class => new Reference(Service2::class, ContainerInterface::IGNORE_ON_INVALID_REFERENCE)], $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));
+        $this->assertEquals([Service2::class => new Reference(Service2::class, ContainerInterface::IGNORE_ON_INVALID_REFERENCE)], $container->getDefinition(TestCase2::class, ContainerInterface::IGNORE_ON_INVALID_REFERENCE)->getArgument(0));
     }
 
     public function test_it_only_registers_a_service_locator_if_any_services_were_discovered()

tests/Symfony/TestCase/Fixtures/AnotherTestKernel.php

@@ -0,0 +1,50 @@
+<?php
+declare(strict_types=1);
+
+namespace Zalas\Injector\PHPUnit\Tests\Symfony\TestCase\Fixtures;
+
+use Symfony\Component\Config\Loader\LoaderInterface;
+use Symfony\Component\DependencyInjection\ContainerBuilder;
+use Symfony\Component\HttpKernel\Kernel;
+use Zalas\Injector\PHPUnit\Symfony\Compiler\Discovery\ClassFinder;
+use Zalas\Injector\PHPUnit\Symfony\Compiler\Discovery\PropertyDiscovery;
+use Zalas\Injector\PHPUnit\Symfony\Compiler\ExposeServicesForTestsPass;
+
+class AnotherTestKernel extends Kernel
+{
+    public function registerBundles()
+    {
+        return [];
+    }
+
+    public function getCacheDir()
+    {
+        return \sys_get_temp_dir().'/ZalasPHPUnitInjector2/cache/'.$this->environment;
+    }
+
+    public function getLogDir()
+    {
+        return \sys_get_temp_dir().'/ZalasPHPUnitInjector2/logs';
+    }
+
+    /**
+     * Loads the container configuration.
+     */
+    public function registerContainerConfiguration(LoaderInterface $loader)
+    {
+        $loader->load(function (ContainerBuilder $container) use ($loader) {
+            $container->register(Service1::class, Service1::class);
+        });
+    }
+
+    protected function build(ContainerBuilder $container)
+    {
+        if ('test' === $this->getEnvironment()) {
+            $container->addCompilerPass(
+                new ExposeServicesForTestsPass(
+                    new PropertyDiscovery(new ClassFinder(__DIR__ . '/../'))
+                )
+            );
+        }
+    }
+}

tests/Symfony/TestCase/SymfonyContainerTest.php

@@ -9,7 +9,6 @@
 use Zalas\Injector\PHPUnit\TestCase\ServiceContainerTestCase;
 use Zalas\Injector\PHPUnit\Tests\Symfony\TestCase\Fixtures\Service1;
 use Zalas\Injector\PHPUnit\Tests\Symfony\TestCase\Fixtures\Service2;
-use Zalas\Injector\PHPUnit\Tests\Symfony\TestCase\Fixtures\TestKernel;
 
 class SymfonyContainerTest extends TestCase implements ServiceContainerTestCase
 {
@@ -27,6 +26,9 @@ class SymfonyContainerTest extends TestCase implements ServiceContainerTestCase
      */
     private $service2;
 
+    /**
+     * @env KERNEL_CLASS=Zalas\Injector\PHPUnit\Tests\Symfony\TestCase\Fixtures\TestKernel
+     */
     public function test_it_initializes_the_container_by_booting_the_symfony_kernel()
     {
         $container = $this->createContainer();
@@ -38,8 +40,16 @@ public function test_it_initializes_the_container_by_booting_the_symfony_kernel(
         $this->assertInstanceOf(Service2::class, $container->get('foo.service2'));
     }
 
-    protected static function getKernelClass()
+    /**
+     * @env KERNEL_CLASS=Zalas\Injector\PHPUnit\Tests\Symfony\TestCase\Fixtures\AnotherTestKernel
+     */
+    public function test_it_ignores_missing_services_when_registering_the_service_locator()
     {
-        return TestKernel::class;
+        $container = $this->createContainer();
+
+        $this->assertInstanceOf(ServiceLocator::class, $container, 'Full container is not exposed.');
+        $this->assertTrue($container->has(Service1::class), 'The private service is available in tests.');
+        $this->assertFalse($container->has('foo.service2'), 'The private service is available in tests.');
+        $this->assertInstanceOf(Service1::class, $container->get(Service1::class));
     }
 }