Allow to set type and priority for addTestCompilerPass (#88)

Author: chapterjason

CHANGELOG.md

@@ -8,6 +8,7 @@ The change log describes what is "Added", "Removed", "Changed" or "Fixed" betwee
 
 - Support for Symfony 6.2, 6.3 and 6.4
 - Support for PHP 8.2 and 8.3
+- Allow to set type and priority for compiler passes in `TestKernel::addTestCompilerPass`
 
 ## 2.0.0
 

src/TestKernel.php

@@ -7,6 +7,7 @@
 use Symfony\Bundle\FrameworkBundle\Kernel\MicroKernelTrait;
 use Symfony\Component\Config\Loader\LoaderInterface;
 use Symfony\Component\DependencyInjection\Compiler\CompilerPassInterface;
+use Symfony\Component\DependencyInjection\Compiler\PassConfig;
 use Symfony\Component\DependencyInjection\ContainerBuilder;
 use Symfony\Component\Filesystem\Filesystem;
 use Symfony\Component\HttpKernel\Bundle\BundleInterface;
@@ -42,7 +43,7 @@ class TestKernel extends Kernel
     private $testProjectDir;
 
     /**
-     * @var CompilerPassInterface[]
+     * @var array{CompilerPassInterface, string, int}[]
      */
     private $testCompilerPasses = [];
 
@@ -131,19 +132,23 @@ protected function buildContainer(): ContainerBuilder
     {
         $container = parent::buildContainer();
 
-        foreach ($this->testCompilerPasses as $pass) {
-            $container->addCompilerPass($pass);
+        foreach ($this->testCompilerPasses as $compilerPass) {
+            $container->addCompilerPass($compilerPass[0], $compilerPass[1], $compilerPass[2]);
         }
 
         return $container;
     }
 
     /**
-     * @param CompilerPassInterface $compilerPasses
+     * @param CompilerPassInterface $compilerPass
+     * @param string                $type
+     * @param int                   $priority
+     *
+     * @psalm-param PassConfig::TYPE_* $type
      */
-    public function addTestCompilerPass($compilerPasses): void
+    public function addTestCompilerPass($compilerPass, $type = PassConfig::TYPE_BEFORE_OPTIMIZATION, $priority = 0): void
     {
-        $this->testCompilerPasses[] = $compilerPasses;
+        $this->testCompilerPasses[] = [$compilerPass, $type, $priority];
     }
 
     /**

tests/Fixtures/ConfigurationBundle/DependencyInjection/Compiler/DeRegisterSomethingPass.php

@@ -0,0 +1,16 @@
+<?php
+
+namespace Nyholm\BundleTest\Tests\Fixtures\ConfigurationBundle\DependencyInjection\Compiler;
+
+use Symfony\Component\DependencyInjection\Compiler\CompilerPassInterface;
+use Symfony\Component\DependencyInjection\ContainerBuilder;
+
+class DeRegisterSomethingPass implements CompilerPassInterface
+{
+    public function process(ContainerBuilder $container)
+    {
+        if ($container->hasDefinition('something')) {
+            $container->removeDefinition('something');
+        }
+    }
+}

tests/Fixtures/ConfigurationBundle/DependencyInjection/Compiler/RegisterSomethingPass.php

@@ -0,0 +1,23 @@
+<?php
+
+namespace Nyholm\BundleTest\Tests\Fixtures\ConfigurationBundle\DependencyInjection\Compiler;
+
+use Symfony\Component\DependencyInjection\Compiler\CompilerPassInterface;
+use Symfony\Component\DependencyInjection\ContainerBuilder;
+use Symfony\Component\DependencyInjection\Definition;
+
+class RegisterSomethingPass implements CompilerPassInterface
+{
+    public function process(ContainerBuilder $container)
+    {
+        if ($container->hasDefinition('something')) {
+            return;
+        }
+
+        $definition = new Definition();
+        $definition->setClass(\stdClass::class);
+        $definition->setPublic(true);
+
+        $container->setDefinition('something', $definition);
+    }
+}

tests/Functional/BundleConfigurationTest.php

@@ -4,7 +4,10 @@
 
 use Nyholm\BundleTest\TestKernel;
 use Nyholm\BundleTest\Tests\Fixtures\ConfigurationBundle\ConfigurationBundle;
+use Nyholm\BundleTest\Tests\Fixtures\ConfigurationBundle\DependencyInjection\Compiler\DeRegisterSomethingPass;
+use Nyholm\BundleTest\Tests\Fixtures\ConfigurationBundle\DependencyInjection\Compiler\RegisterSomethingPass;
 use Symfony\Bundle\FrameworkBundle\Test\KernelTestCase;
+use Symfony\Component\DependencyInjection\Compiler\PassConfig;
 use Symfony\Component\DependencyInjection\ContainerBuilder;
 use Symfony\Component\HttpKernel\KernelInterface;
 
@@ -61,4 +64,41 @@ public function testBundleWithDifferentConfigurationFormats($config): void
         $this->assertEquals('val1', $container->getParameter('app.foo'));
         $this->assertEquals(['val2', 'val3'], $container->getParameter('app.bar'));
     }
+
+    public function testAddCompilerPassPriority(): void
+    {
+        // CASE 1: Compiler pass without priority, should be prioritized by order of addition
+        $kernel = self::bootKernel(['config' => function (TestKernel $kernel) {
+            $kernel->addTestConfig(__DIR__.'/../Fixtures/Resources/ConfigurationBundle/config.php');
+            $kernel->addTestCompilerPass(new DeRegisterSomethingPass());
+            $kernel->addTestCompilerPass(new RegisterSomethingPass());
+        }]);
+
+        $container = $kernel->getContainer();
+
+        $this->assertTrue($container->has('something'));
+
+        // CASE 2: Compiler pass with priority, should be prioritized by priority
+        $kernel = self::bootKernel(['config' => function (TestKernel $kernel) {
+            $kernel->addTestConfig(__DIR__.'/../Fixtures/Resources/ConfigurationBundle/config.php');
+            $kernel->addTestCompilerPass(new DeRegisterSomethingPass(), PassConfig::TYPE_BEFORE_OPTIMIZATION, -5);
+            $kernel->addTestCompilerPass(new RegisterSomethingPass());
+        }]);
+
+        $container = $kernel->getContainer();
+
+        $this->assertFalse($container->has('something'));
+
+        // CASE 3: Compiler pass without priority, should be prioritized by order of addition
+        $kernel = self::bootKernel(['config' => function (TestKernel $kernel) {
+            $kernel->addTestConfig(__DIR__.'/../Fixtures/Resources/ConfigurationBundle/config.php');
+            // DeRegisterSomethingPass is now added as second compiler pass
+            $kernel->addTestCompilerPass(new RegisterSomethingPass());
+            $kernel->addTestCompilerPass(new DeRegisterSomethingPass());
+        }]);
+
+        $container = $kernel->getContainer();
+
+        $this->assertFalse($container->has('something'));
+    }
 }