bug #44987 [DoctrineBridge] [5.4] Fix automapping (mbabker)

This PR was merged into the 5.4 branch.

Discussion
----------

[DoctrineBridge] [5.4] Fix automapping

| Q             | A
| ------------- | ---
| Branch?       | 5.4
| Bug fix?      | yes
| New feature?  | no
| Deprecations? | no
| Tickets       | Fix #44355
| License       | MIT
| Doc PR        | N/A

This should fix the broken automapping configuration for bundles that use annotations and attributes, see #44355 for additional details.

When using the newer bundle directory structure conventions, especially with the `Bundle::getPath()` method overridden to point the bundle root path to the Bundle class' parent directory, the issue comes up because the bundle filesystem root path does not match the root path for the actual bundle code (effectively the PSR-4 root path).

To fix automapping, the `AbstractDoctrineExtension::detectMetadataDriver()` method will be called a second time with the Bundle classpath if the first call (which is effectively the same as `Bundle::getPath()`)  can't resolve the appropriate mapping type.  This will also update setting `$bundleConfig['dir']` for drivers that are based on PHP classes so that the root path is based on the bundle classpath (AKA the PSR-4 root path) instead of the bundle path.

The bulk of this patch is mainly from adding test fixture bundles to be able to test the `AbstractDoctrineExtension::getMappingDriverBundleConfigDefaults()` method in this repo and ensuring that the metadata driver detection works right for all of the supported drivers.

Commits
-------

0aaa2fdca7 Fix bundle automapping detection for annotations and attributes

Author: nicolas-grekas

DependencyInjection/AbstractDoctrineExtension.php

@@ -148,10 +148,15 @@ protected function getMappingDriverBundleConfigDefaults(array $bundleConfig, \Re
             $bundleDir = func_get_arg(3);
         }
 
-        $bundleDir ?? $bundleDir = \dirname($bundle->getFileName());
+        $bundleClassDir = \dirname($bundle->getFileName());
+        $bundleDir ?? $bundleDir = $bundleClassDir;
 
         if (!$bundleConfig['type']) {
             $bundleConfig['type'] = $this->detectMetadataDriver($bundleDir, $container);
+
+            if (!$bundleConfig['type'] && $bundleDir !== $bundleClassDir) {
+                $bundleConfig['type'] = $this->detectMetadataDriver($bundleClassDir, $container);
+            }
         }
 
         if (!$bundleConfig['type']) {
@@ -161,7 +166,7 @@ protected function getMappingDriverBundleConfigDefaults(array $bundleConfig, \Re
 
         if (!$bundleConfig['dir']) {
             if (\in_array($bundleConfig['type'], ['annotation', 'staticphp', 'attribute'])) {
-                $bundleConfig['dir'] = $bundleDir.'/'.$this->getMappingObjectDefaultName();
+                $bundleConfig['dir'] = $bundleClassDir.'/'.$this->getMappingObjectDefaultName();
             } else {
                 $bundleConfig['dir'] = $bundleDir.'/'.$this->getMappingResourceConfigDirectory($bundleDir);
             }

Tests/DependencyInjection/DoctrineExtensionTest.php

@@ -16,6 +16,7 @@
 use Symfony\Component\DependencyInjection\ContainerBuilder;
 use Symfony\Component\DependencyInjection\Definition;
 use Symfony\Component\DependencyInjection\ParameterBag\ParameterBag;
+use Symfony\Component\HttpKernel\Bundle\BundleInterface;
 
 /**
  * @author  Fabio B. Silva <[email protected]>
@@ -53,6 +54,10 @@ protected function setUp(): void
         $this->extension
             ->method('getMappingObjectDefaultName')
             ->willReturn('Entity');
+
+        $this->extension
+            ->method('getMappingResourceExtension')
+            ->willReturn('orm');
     }
 
     public function testFixManagersAutoMappingsWithTwoAutomappings()
@@ -271,6 +276,75 @@ public function testUnrecognizedCacheDriverException()
         $this->invokeLoadCacheDriver($objectManager, $container, $cacheName);
     }
 
+    public function providerBundles()
+    {
+        yield ['AnnotationsBundle', 'annotation', '/Entity'];
+        if (\PHP_VERSION_ID >= 80000) {
+            yield ['AttributesBundle', 'attribute', '/Entity'];
+        }
+        yield ['XmlBundle', 'xml', '/Resources/config/doctrine'];
+        yield ['PhpBundle', 'php', '/Resources/config/doctrine'];
+        yield ['YamlBundle', 'yml', '/Resources/config/doctrine'];
+
+        yield ['SrcXmlBundle', 'xml', '/Resources/config/doctrine'];
+
+        yield ['NewAnnotationsBundle', 'annotation', '/src/Entity'];
+        yield ['NewXmlBundle', 'xml', '/config/doctrine'];
+    }
+
+    /**
+     * @dataProvider providerBundles
+     */
+    public function testBundleAutoMapping(string $bundle, string $expectedType, string $dirSuffix)
+    {
+        $bundleDir = __DIR__.'/../Fixtures/Bundles/'.$bundle;
+        $bundleClassName = 'Fixtures\\Bundles\\'.$bundle.'\\'.$bundle;
+
+        if (is_dir($bundleDir.'/src')) {
+            require_once $bundleDir.'/src/'.$bundle.'.php';
+        } else {
+            require_once $bundleDir.'/'.$bundle.'.php';
+        }
+
+        /** @var BundleInterface $bundleClass */
+        $bundleClass = new $bundleClassName();
+
+        $mappingConfig = [
+            'dir' => false,
+            'type' => false,
+            'prefix' => false,
+            'mapping' => true,
+            'is_bundle' => true,
+        ];
+
+        $this->extension
+            ->method('getMappingResourceConfigDirectory')
+            ->willReturnCallback(function ($bundleDir) {
+                if (null !== $bundleDir && is_dir($bundleDir.'/config/doctrine')) {
+                    return 'config/doctrine';
+                }
+
+                return 'Resources/config/doctrine';
+            });
+
+        $container = $this->createContainer([], [$bundle => $bundleClassName]);
+
+        $reflection = new \ReflectionClass(\get_class($this->extension));
+        $method = $reflection->getMethod('getMappingDriverBundleConfigDefaults');
+        $method->setAccessible(true);
+
+        $this->assertSame(
+            [
+                'dir' => $bundleClass->getPath().$dirSuffix,
+                'type' => $expectedType,
+                'prefix' => $bundleClass->getNamespace().'\\Entity',
+                'mapping' => true,
+                'is_bundle' => true,
+            ],
+            $method->invoke($this->extension, $mappingConfig, new \ReflectionClass($bundleClass), $container, $bundleClass->getPath())
+        );
+    }
+
     protected function invokeLoadCacheDriver(array $objectManager, ContainerBuilder $container, $cacheName)
     {
         $method = new \ReflectionMethod($this->extension, 'loadObjectManagerCacheDriver');
@@ -280,10 +354,10 @@ protected function invokeLoadCacheDriver(array $objectManager, ContainerBuilder
         $method->invokeArgs($this->extension, [$objectManager, $container, $cacheName]);
     }
 
-    protected function createContainer(array $data = []): ContainerBuilder
+    protected function createContainer(array $data = [], array $extraBundles = []): ContainerBuilder
     {
         return new ContainerBuilder(new ParameterBag(array_merge([
-            'kernel.bundles' => ['FrameworkBundle' => 'Symfony\\Bundle\\FrameworkBundle\\FrameworkBundle'],
+            'kernel.bundles' => array_merge(['FrameworkBundle' => 'Symfony\\Bundle\\FrameworkBundle\\FrameworkBundle'], $extraBundles),
             'kernel.cache_dir' => __DIR__,
             'kernel.build_dir' => __DIR__,
             'kernel.container_class' => 'kernel',

Tests/Fixtures/Bundles/AnnotationsBundle/AnnotationsBundle.php

@@ -0,0 +1,18 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Fixtures\Bundles\AnnotationsBundle;
+
+use Symfony\Component\HttpKernel\Bundle\Bundle;
+
+class AnnotationsBundle extends Bundle
+{
+}

Tests/Fixtures/Bundles/AnnotationsBundle/Entity/Person.php

@@ -0,0 +1,39 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Fixtures\Bundles\AnnotationsBundle\Entity;
+
+use Doctrine\ORM\Mapping\Column;
+use Doctrine\ORM\Mapping\Entity;
+use Doctrine\ORM\Mapping\Id;
+
+/**
+ * @Entity
+ */
+class Person
+{
+    /** @Id @Column(type="integer") */
+    protected $id;
+
+    /** @Column(type="string") */
+    public $name;
+
+    public function __construct($id, $name)
+    {
+        $this->id = $id;
+        $this->name = $name;
+    }
+
+    public function __toString(): string
+    {
+        return (string) $this->name;
+    }
+}

Tests/Fixtures/Bundles/AttributesBundle/AttributesBundle.php

@@ -0,0 +1,18 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Fixtures\Bundles\AttributesBundle;
+
+use Symfony\Component\HttpKernel\Bundle\Bundle;
+
+class AttributesBundle extends Bundle
+{
+}

Tests/Fixtures/Bundles/AttributesBundle/Entity/Person.php

@@ -0,0 +1,37 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Fixtures\Bundles\AttributesBundle\Entity;
+
+use Doctrine\ORM\Mapping\Column;
+use Doctrine\ORM\Mapping\Entity;
+use Doctrine\ORM\Mapping\Id;
+
+#[Entity]
+class Person
+{
+    #[Id, Column(type: 'integer')]
+    protected $id;
+
+    #[Column(type: 'string')]
+    public $name;
+
+    public function __construct($id, $name)
+    {
+        $this->id = $id;
+        $this->name = $name;
+    }
+
+    public function __toString(): string
+    {
+        return (string) $this->name;
+    }
+}

Tests/Fixtures/Bundles/NewAnnotationsBundle/src/Entity/Person.php

@@ -0,0 +1,39 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Fixtures\Bundles\NewAnnotationsBundle\Entity;
+
+use Doctrine\ORM\Mapping\Column;
+use Doctrine\ORM\Mapping\Entity;
+use Doctrine\ORM\Mapping\Id;
+
+/**
+ * @Entity
+ */
+class Person
+{
+    /** @Id @Column(type="integer") */
+    protected $id;
+
+    /** @Column(type="string") */
+    public $name;
+
+    public function __construct($id, $name)
+    {
+        $this->id = $id;
+        $this->name = $name;
+    }
+
+    public function __toString(): string
+    {
+        return (string) $this->name;
+    }
+}

Tests/Fixtures/Bundles/NewAnnotationsBundle/src/NewAnnotationsBundle.php

@@ -0,0 +1,22 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Fixtures\Bundles\NewAnnotationsBundle;
+
+use Symfony\Component\HttpKernel\Bundle\Bundle;
+
+class NewAnnotationsBundle extends Bundle
+{
+    public function getPath(): string
+    {
+        return \dirname(__DIR__);
+    }
+}

Tests/Fixtures/Bundles/NewXmlBundle/config/doctrine/Person.orm.xml

@@ -0,0 +1,30 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Fixtures\Bundles\NewXmlBundle\Entity;
+
+class Person
+{
+    protected $id;
+
+    public $name;
+
+    public function __construct($id, $name)
+    {
+        $this->id = $id;
+        $this->name = $name;
+    }
+
+    public function __toString(): string
+    {
+        return (string) $this->name;
+    }
+}