Use provided length for enum type if given for non-mysql platform (#7034)

Author: VincentLanglet

docs/en/reference/types.rst

@@ -210,8 +210,8 @@ Maps and converts a string which is one of a set of predefined values. This
 type is specifically designed for MySQL and MariaDB, where it is mapped to
 the native ``ENUM`` type. For other database vendors, this type is mapped to
 a string field (``VARCHAR``) with the maximum length being the length of the
-longest value in the set. Values retrieved from the database are always
-converted to PHP's ``string`` type or ``null`` if no data is present.
+longest value in the set if none was configured. Values retrieved from the database
+are always converted to PHP's ``string`` type or ``null`` if no data is present.
 
 Binary string types
 ^^^^^^^^^^^^^^^^^^^

src/Platforms/AbstractPlatform.php

@@ -248,6 +248,18 @@ public function getEnumDeclarationSQL(array $column): string
             ? max(...array_map(mb_strlen(...), $column['values']))
             : mb_strlen($column['values'][key($column['values'])]);
 
+        if (isset($column['length'])) {
+            if ($length > $column['length']) {
+                throw new InvalidArgumentException(sprintf(
+                    'Specified column length (%d) is less than the maximum length of provided values (%d).',
+                    $column['length'],
+                    $length,
+                ));
+            }
+
+            $length = $column['length'];
+        }
+
         return $this->getStringTypeDeclarationSQL(['length' => $length]);
     }
 

tests/Platforms/AbstractMySQLPlatformTestCase.php

@@ -20,6 +20,7 @@
 use Doctrine\DBAL\Schema\Table;
 use Doctrine\DBAL\TransactionIsolationLevel;
 use Doctrine\DBAL\Types\Types;
+use PHPUnit\Framework\Attributes\DataProvider;
 
 use function array_shift;
 
@@ -622,6 +623,13 @@ protected function createComparator(): Comparator
         );
     }
 
+    /** @param array<string> $values */
+    #[DataProvider('getEnumDeclarationExceptionWithLengthSQLProvider')]
+    public function testGetEnumDeclarationExceptionWithLengthSQL(array $values, int $length): void
+    {
+        self::markTestSkipped('There is no exception thrown on MySQL.');
+    }
+
     /** @return array<string, array{array<string>, string}> */
     public static function getEnumDeclarationSQLProvider(): array
     {
@@ -630,4 +638,15 @@ public static function getEnumDeclarationSQLProvider(): array
             'multiple values' => [['foo', 'bar1'], "ENUM('foo', 'bar1')"],
         ];
     }
+
+    /** @return array<string, array{array<string>, int, string}> */
+    public static function getEnumDeclarationWithLengthSQLProvider(): array
+    {
+        return [
+            'single value and bigger length' => [['foo'], 42, "ENUM('foo')"],
+            'single value and lower length' => [['foo'], 1, "ENUM('foo')"],
+            'multiple values and bigger length' => [['foo', 'bar1'], 42, "ENUM('foo', 'bar1')"],
+            'multiple values and lower length' => [['foo', 'bar1'], 2, "ENUM('foo', 'bar1')"],
+        ];
+    }
 }

tests/Platforms/AbstractPlatformTestCase.php

@@ -1218,6 +1218,48 @@ public static function getEnumDeclarationSQLProvider(): array
         ];
     }
 
+    /** @param array<string> $values */
+    #[DataProvider('getEnumDeclarationWithLengthSQLProvider')]
+    public function testGetEnumDeclarationWithLengthSQL(array $values, int $length, string $expectedSQL): void
+    {
+        $result = $this->platform->getEnumDeclarationSQL([
+            'values' => $values,
+            'length' => $length,
+        ]);
+
+        self::assertSame($expectedSQL, $result);
+    }
+
+    /** @param array<string> $values */
+    #[DataProvider('getEnumDeclarationExceptionWithLengthSQLProvider')]
+    public function testGetEnumDeclarationExceptionWithLengthSQL(array $values, int $length): void
+    {
+        $this->expectException(InvalidArgumentException::class);
+
+        $this->platform->getEnumDeclarationSQL([
+            'values' => $values,
+            'length' => $length,
+        ]);
+    }
+
+    /** @return array<string, array{array<string>, int, string}> */
+    public static function getEnumDeclarationWithLengthSQLProvider(): array
+    {
+        return [
+            'single value and bigger length' => [['foo'], 42, 'VARCHAR(42)'],
+            'multiple values and bigger length' => [['foo', 'bar1'], 42, 'VARCHAR(42)'],
+        ];
+    }
+
+    /** @return array<string, array{array<string>, int}> */
+    public static function getEnumDeclarationExceptionWithLengthSQLProvider(): array
+    {
+        return [
+            'single value and lower length' => [['foo'], 1],
+            'multiple values and lower length' => [['foo', 'bar1'], 2],
+        ];
+    }
+
     /** @param array<mixed> $column */
     #[DataProvider('getEnumDeclarationSQLWithInvalidValuesProvider')]
     public function testGetEnumDeclarationSQLWithInvalidValues(array $column): void

tests/Platforms/OraclePlatformTest.php

@@ -651,4 +651,13 @@ public static function getEnumDeclarationSQLProvider(): array
             'multiple values' => [['foo', 'bar1'], 'VARCHAR2(4)'],
         ];
     }
+
+    /** @return array<string, array{array<string>, int, string}> */
+    public static function getEnumDeclarationWithLengthSQLProvider(): array
+    {
+        return [
+            'single value and bigger length' => [['foo'], 42, 'VARCHAR2(42)'],
+            'multiple values and bigger length' => [['foo', 'bar1'], 42, 'VARCHAR2(42)'],
+        ];
+    }
 }

tests/Platforms/SQLServerPlatformTest.php

@@ -1225,4 +1225,13 @@ public static function getEnumDeclarationSQLProvider(): array
             'multiple values' => [['foo', 'bar1'], 'NVARCHAR(4)'],
         ];
     }
+
+    /** @return array<string, array{array<string>, int, string}> */
+    public static function getEnumDeclarationWithLengthSQLProvider(): array
+    {
+        return [
+            'single value and bigger length' => [['foo'], 42, 'NVARCHAR(42)'],
+            'multiple values and bigger length' => [['foo', 'bar1'], 42, 'NVARCHAR(42)'],
+        ];
+    }
 }