Adds metadata field type and enumType validation against Entity property type

Author: yceruto

lib/Doctrine/ORM/Tools/SchemaValidator.php

@@ -4,6 +4,7 @@
 
 namespace Doctrine\ORM\Tools;
 
+use BackedEnum;
 use Doctrine\DBAL\Types\AsciiStringType;
 use Doctrine\DBAL\Types\BigIntType;
 use Doctrine\DBAL\Types\BooleanType;
@@ -35,8 +36,10 @@
 use function class_parents;
 use function count;
 use function get_class;
+use function get_debug_type;
 use function implode;
 use function in_array;
+use function is_a;
 use function sprintf;
 
 use const PHP_VERSION_ID;
@@ -386,6 +389,24 @@ function (array $fieldMapping) use ($class): ?string {
                             return null;
                         }
 
+                        if (
+                            is_a($propertyType, BackedEnum::class, true)
+                            && $metadataFieldType === get_debug_type($propertyType::cases()[0]->value)
+                        ) {
+                            if (! isset($fieldMapping['enumType']) || $propertyType === $fieldMapping['enumType']) {
+                                return null;
+                            }
+
+                            return sprintf(
+                                "The field '%s#%s' has the property type '%s' that differs from the metadata enumType '%s' returned by the '%s' DBAL type.",
+                                $class->name,
+                                $fieldName,
+                                $propertyType,
+                                $fieldMapping['enumType'],
+                                $fieldMapping['type']
+                            );
+                        }
+
                         return sprintf(
                             "The field '%s#%s' has the property type '%s' that differs from the metadata field type '%s' returned by the '%s' DBAL type.",
                             $class->name,

tests/Doctrine/Tests/ORM/Functional/Ticket/GH11037/GH11037Test.php

@@ -0,0 +1,49 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Doctrine\Tests\ORM\Functional\Ticket\GH11037;
+
+use Doctrine\ORM\EntityManagerInterface;
+use Doctrine\ORM\Tools\SchemaValidator;
+use Doctrine\Tests\OrmTestCase;
+
+/**
+ * @requires PHP >= 7.4
+ */
+final class GH11037Test extends OrmTestCase
+{
+    /** @var EntityManagerInterface */
+    private $em;
+
+    /** @var SchemaValidator */
+    private $validator;
+
+    protected function setUp(): void
+    {
+        $this->em        = $this->getTestEntityManager();
+        $this->validator = new SchemaValidator($this->em);
+    }
+
+    public function testMetadataFieldTypeCoherentWithEntityPropertyType(): void
+    {
+        $class = $this->em->getClassMetadata(ValidEntityWithTypedEnum::class);
+        $ce    = $this->validator->validateClass($class);
+
+        self::assertEquals([], $ce);
+    }
+
+    public function testMetadataFieldTypeNotCoherentWithEntityPropertyType(): void
+    {
+        $class = $this->em->getClassMetadata(InvalidEntityWithTypedEnum::class);
+        $ce    = $this->validator->validateClass($class);
+
+        self::assertEquals(
+            [
+                "The field 'Doctrine\Tests\ORM\Functional\Ticket\GH11037\InvalidEntityWithTypedEnum#status1' has the property type 'Doctrine\Tests\ORM\Functional\Ticket\GH11037\StringEntityStatus' that differs from the metadata field type 'int' returned by the 'integer' DBAL type.",
+                "The field 'Doctrine\Tests\ORM\Functional\Ticket\GH11037\InvalidEntityWithTypedEnum#status2' has the property type 'Doctrine\Tests\ORM\Functional\Ticket\GH11037\IntEntityStatus' that differs from the metadata enumType 'Doctrine\Tests\ORM\Functional\Ticket\GH11037\StringEntityStatus' returned by the 'integer' DBAL type.",
+            ],
+            $ce
+        );
+    }
+}

tests/Doctrine/Tests/ORM/Functional/Ticket/GH11037/IntEntityStatus.php

@@ -0,0 +1,11 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Doctrine\Tests\ORM\Functional\Ticket\GH11037;
+
+enum IntEntityStatus: int
+{
+    case ACTIVE   = 0;
+    case INACTIVE = 1;
+}

tests/Doctrine/Tests/ORM/Functional/Ticket/GH11037/InvalidEntityWithTypedEnum.php

@@ -0,0 +1,31 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Doctrine\Tests\ORM\Functional\Ticket\GH11037;
+
+use Doctrine\ORM\Mapping\Column;
+use Doctrine\ORM\Mapping\Entity;
+use Doctrine\ORM\Mapping\Id;
+
+/**
+ * @Entity
+ */
+class InvalidEntityWithTypedEnum
+{
+    /**
+     * @Id
+     * @Column
+     */
+    protected int $id;
+
+    /**
+     * @Column(type="integer", enumType=StringEntityStatus::class)
+     */
+    protected StringEntityStatus $status1;
+
+    /**
+     * @Column(type="integer", enumType=StringEntityStatus::class)
+     */
+    protected IntEntityStatus $status2;
+}

tests/Doctrine/Tests/ORM/Functional/Ticket/GH11037/StringEntityStatus.php

@@ -0,0 +1,11 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Doctrine\Tests\ORM\Functional\Ticket\GH11037;
+
+enum StringEntityStatus: string
+{
+    case ACTIVE   = 'active';
+    case INACTIVE = 'inactive';
+}

tests/Doctrine/Tests/ORM/Functional/Ticket/GH11037/ValidEntityWithTypedEnum.php

@@ -0,0 +1,31 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Doctrine\Tests\ORM\Functional\Ticket\GH11037;
+
+use Doctrine\ORM\Mapping\Column;
+use Doctrine\ORM\Mapping\Entity;
+use Doctrine\ORM\Mapping\Id;
+
+/**
+ * @Entity
+ */
+class ValidEntityWithTypedEnum
+{
+    /**
+     * @Id
+     * @Column
+     */
+    protected int $id;
+
+    /**
+     * @Column(type="string", enumType=StringEntityStatus::class)
+     */
+    protected StringEntityStatus $status1;
+
+    /**
+     * @Column(type="smallint", enumType=IntEntityStatus::class)
+     */
+    protected IntEntityStatus $status2;
+}