Fix generation of containers using a base class

Since the introduction of the container namespace, we must be explicitly set the FQCN of the base class (with its leading slash). Without that, Symfony generates a dump pointing to the wrong class. Signed-off-by: Luís Cobucci <[email protected]>
lcobucci · Apr 3, 2023 · fe6f52e · fe6f52e
1 parent c21ce06
commit fe6f52e
Show file tree

Hide file tree

Showing 5 changed files with 47 additions and 4 deletions.
diff --git a/src/Config/ContainerConfiguration.php b/src/Config/ContainerConfiguration.php
@@ -176,7 +176,7 @@ public function getBaseClass(): ?string
 
     public function setBaseClass(string $baseClass): void
     {
-        $this->baseClass = $baseClass;
+        $this->baseClass = '\\' . ltrim($baseClass, '\\');
     }
 
     public function withSubNamespace(string $namespace): self

diff --git a/test/CompilationWithBaseClassTest.php b/test/CompilationWithBaseClassTest.php
@@ -0,0 +1,33 @@
+<?php
+declare(strict_types=1);
+
+namespace Lcobucci\DependencyInjection;
+
+use PHPUnit\Framework\TestCase;
+
+/**
+ * @covers \Lcobucci\DependencyInjection\ContainerBuilder
+ * @covers \Lcobucci\DependencyInjection\Compiler
+ * @covers \Lcobucci\DependencyInjection\Compiler\ParameterBag
+ * @covers \Lcobucci\DependencyInjection\Config\ContainerConfiguration
+ * @covers \Lcobucci\DependencyInjection\Generator
+ * @covers \Lcobucci\DependencyInjection\Generators\Xml
+ * @covers \Lcobucci\DependencyInjection\Testing\MakeServicesPublic
+ */
+final class CompilationWithBaseClassTest extends TestCase
+{
+    use GeneratesDumpDirectory;
+
+    private const DI_NAMESPACE = 'Lcobucci\\DiTests\\BaseClass';
+
+    /** @test */
+    public function containerCanHaveACustomBaseClass(): void
+    {
+        $container = ContainerBuilder::default(__FILE__, self::DI_NAMESPACE)
+            ->setBaseClass(ContainerForTests::class)
+            ->setDumpDir($this->dumpDirectory)
+            ->getContainer();
+
+        self::assertInstanceOf(ContainerForTests::class, $container);
+    }
+}
diff --git a/test/Config/ContainerConfigurationTest.php b/test/Config/ContainerConfigurationTest.php
@@ -342,7 +342,7 @@ public function setBaseClassShouldChangeTheAttribute(): void
         $config = new ContainerConfiguration('Me\\MyApp');
         $config->setBaseClass('Test');
 
-        self::assertSame('Test', $config->getBaseClass());
+        self::assertSame('\\Test', $config->getBaseClass());
     }
 
     /**
@@ -427,7 +427,7 @@ public function getDumpOptionsShouldIncludeBaseWhenWasConfigured(): void
         $options = [
             'class'        => ContainerConfiguration::CLASS_NAME,
             'namespace'    => 'Me\\MyApp',
-            'base_class'   => 'Test',
+            'base_class'   => '\\Test',
             'hot_path_tag' => 'container.hot_path',
         ];
 

diff --git a/test/ContainerBuilderTest.php b/test/ContainerBuilderTest.php
@@ -208,7 +208,7 @@ public function setBaseClassShouldConfigureTheBaseClassAndReturnSelf(): void
         $builder = new ContainerBuilder($this->config, $this->generator, $this->parameterBag);
 
         self::assertSame($builder, $builder->setBaseClass('Test'));
-        self::assertEquals('Test', $this->config->getBaseClass());
+        self::assertEquals('\\Test', $this->config->getBaseClass());
     }
 
     /**

diff --git a/test/ContainerForTests.php b/test/ContainerForTests.php
@@ -0,0 +1,10 @@
+<?php
+declare(strict_types=1);
+
+namespace Lcobucci\DependencyInjection;
+
+use Symfony\Component\DependencyInjection\Container;
+
+abstract class ContainerForTests extends Container
+{
+}