5.x - Simpler check constraints (#932)

markstory · web-flow · commit 69729a3d7fd0 · 2025-10-30T22:59:12.000-04:00
- With CheckConstraint in cakephp/database we don't need as much code in
  migrations.
- Fix SQLite implementation.
- Add test coverage for sqlite + postgres.
- Remove reflection logic and use cakephp/database
- Fix test for mariadb
diff --git a/src/Db/Adapter/MysqlAdapter.php b/src/Db/Adapter/MysqlAdapter.php
@@ -915,34 +915,9 @@ protected function getDropForeignKeyByColumnsInstructions(string $tableName, arr
      */
     protected function getCheckConstraints(string $tableName): array
     {
-        $database = (string)$this->getOption('database');
-        $query = $this->getSelectBuilder()
-            ->select(['cc.CONSTRAINT_NAME', 'cc.CHECK_CLAUSE'])
-            ->from(['cc' => 'INFORMATION_SCHEMA.CHECK_CONSTRAINTS'])
-            ->innerJoin(
-                ['tc' => 'INFORMATION_SCHEMA.TABLE_CONSTRAINTS'],
-                [
-                    'tc.CONSTRAINT_SCHEMA = cc.CONSTRAINT_SCHEMA',
-                    'tc.CONSTRAINT_NAME = cc.CONSTRAINT_NAME',
-                ],
-            )
-            ->where([
-                'tc.CONSTRAINT_SCHEMA' => $database,
-                'tc.TABLE_NAME' => $tableName,
-                'tc.CONSTRAINT_TYPE' => 'CHECK',
-            ]);
-
-        $rows = $query->execute()->fetchAll('assoc');
-        $constraints = [];
-
-        foreach ($rows as $row) {
-            $constraints[] = [
-                'name' => $row['CONSTRAINT_NAME'],
-                'expression' => $row['CHECK_CLAUSE'],
-            ];
-        }
+        $dialect = $this->getSchemaDialect();
 
-        return $constraints;
+        return $dialect->describeCheckConstraints($tableName);
     }
 
     /**
diff --git a/src/Db/Adapter/PostgresAdapter.php b/src/Db/Adapter/PostgresAdapter.php
@@ -755,35 +755,8 @@ protected function getDropForeignKeyByColumnsInstructions(string $tableName, arr
      */
     protected function getCheckConstraints(string $tableName): array
     {
-        $parts = $this->getSchemaName($tableName);
-        $query = $this->getSelectBuilder()
-            ->select(['con.conname', 'pg_get_constraintdef(con.oid)'])
-            ->from(['con' => 'pg_constraint'])
-            ->innerJoin(['ns' => 'pg_namespace'], ['ns.oid = con.connamespace'])
-            ->innerJoin(['cls' => 'pg_class'], ['cls.oid = con.conrelid'])
-            ->where([
-                'ns.nspname' => $parts['schema'],
-                'cls.relname' => $parts['table'],
-                'con.contype' => 'c',
-            ]);
-
-        $rows = $query->execute()->fetchAll('assoc');
-        $constraints = [];
-
-        foreach ($rows as $row) {
-            // Extract the expression from the constraint definition (remove "CHECK (" and trailing ")")
-            $definition = $row['pg_get_constraintdef'];
-            if (preg_match('/^CHECK \((.+)\)$/s', $definition, $matches)) {
-                $expression = $matches[1];
-            } else {
-                $expression = $definition;
-            }
-
-            $constraints[] = [
-                'name' => $row['conname'],
-                'expression' => $expression,
-            ];
-        }
+        $dialect = $this->getSchemaDialect();
+        $constraints = $dialect->describeCheckConstraints($tableName);
 
         return $constraints;
     }
diff --git a/src/Db/Adapter/SqliteAdapter.php b/src/Db/Adapter/SqliteAdapter.php
@@ -1517,28 +1517,9 @@ protected function getDropForeignKeyByColumnsInstructions(string $tableName, arr
      */
     protected function getCheckConstraints(string $tableName): array
     {
-        $constraints = [];
-        $createSql = $this->getDeclaringSql($tableName);
-
-        // Parse CHECK constraints from CREATE TABLE statement
-        // Match CONSTRAINT name CHECK (expression) or just CHECK (expression)
-        $pattern = '/(?:CONSTRAINT\s+([^\s]+)\s+)?CHECK\s*\(([^)]+(?:\([^)]*\)[^)]*)*)\)/is';
-
-        if (preg_match_all($pattern, $createSql, $matches, PREG_SET_ORDER)) {
-            foreach ($matches as $index => $match) {
-                $name = !empty($match[1])
-                    ? trim($match[1], '"`[]')
-                    : 'check_' . $index;
-                $expression = trim($match[2]);
-
-                $constraints[] = [
-                    'name' => $name,
-                    'expression' => $expression,
-                ];
-            }
-        }
+        $dialect = $this->getSchemaDialect();
 
-        return $constraints;
+        return $dialect->describeCheckConstraints($tableName);
     }
 
     /**
@@ -1588,11 +1569,10 @@ protected function getDropCheckConstraintInstructions(string $tableName, string
         $instructions->addPostStep(function ($state) use ($constraintName) {
             // Remove the check constraint from the CREATE TABLE statement
             // Match CONSTRAINT name CHECK (expression) or just CHECK (expression)
-            $quotedName = preg_quote($this->possiblyQuotedIdentifierRegex($constraintName, false), '/');
+            $quotedName = $this->possiblyQuotedIdentifierRegex($constraintName, false);
             $pattern = "/,?\s*CONSTRAINT\s+{$quotedName}\s+CHECK\s*\([^)]+(?:\([^)]*\)[^)]*)*\)/is";
 
             $sql = preg_replace($pattern, '', (string)$state['createSQL'], 1);
-
             if ($sql) {
                 $this->execute($sql);
             }
diff --git a/src/Db/Table/CheckConstraint.php b/src/Db/Table/CheckConstraint.php
@@ -8,89 +8,13 @@
 
 namespace Migrations\Db\Table;
 
-use InvalidArgumentException;
+use Cake\Database\Schema\CheckConstraint as DatabaseCheckConstraint;
 
 /**
  * Check constraint value object
  *
  * Used to define check constraints that are added to tables as part of migrations.
  */
-class CheckConstraint
+class CheckConstraint extends DatabaseCheckConstraint
 {
-    /**
-     * @var string|null
-     */
-    protected ?string $name = null;
-
-    /**
-     * @var string
-     */
-    protected string $expression;
-
-    /**
-     * Constructor
-     *
-     * @param string|null $name Constraint name (optional, will be auto-generated if null)
-     * @param string $expression The check constraint expression (e.g., "age >= 18")
-     */
-    public function __construct(?string $name = null, string $expression = '')
-    {
-        if ($name !== null) {
-            $this->name = $name;
-        }
-        if ($expression !== '') {
-            $this->expression = $expression;
-        }
-    }
-
-    /**
-     * Set the constraint name.
-     *
-     * @param string $name Constraint name
-     * @return $this
-     */
-    public function setName(string $name)
-    {
-        $this->name = $name;
-
-        return $this;
-    }
-
-    /**
-     * Get the constraint name.
-     *
-     * @return string|null
-     */
-    public function getName(): ?string
-    {
-        return $this->name;
-    }
-
-    /**
-     * Set the check constraint expression.
-     *
-     * @param string $expression The SQL expression for the check constraint
-     * @return $this
-     * @throws \InvalidArgumentException
-     */
-    public function setExpression(string $expression)
-    {
-        if (trim($expression) === '') {
-            throw new InvalidArgumentException('Check constraint expression cannot be empty');
-        }
-
-        $this->expression = $expression;
-
-        return $this;
-    }
-
-    /**
-     * Get the check constraint expression.
-     *
-     * @return string
-     */
-    public function getExpression(): string
-    {
-        return $this->expression;
-    }
 }
diff --git a/tests/TestCase/Db/Adapter/MysqlAdapterTest.php b/tests/TestCase/Db/Adapter/MysqlAdapterTest.php
@@ -8,6 +8,7 @@
 use Cake\Console\TestSuite\StubConsoleOutput;
 use Cake\Core\Configure;
 use Cake\Database\Connection;
+use Cake\Database\Driver\Mysql;
 use Cake\Datasource\ConnectionManager;
 use InvalidArgumentException;
 use Migrations\Db\Adapter\MysqlAdapter;
@@ -2327,10 +2328,7 @@ public function testAddCheckConstraint()
         $table->addColumn('price', 'decimal', ['precision' => 10, 'scale' => 2])
               ->create();
 
-        $checkConstraint = new CheckConstraint();
-        $checkConstraint->setName('price_positive')
-                       ->setExpression('price > 0');
-
+        $checkConstraint = new CheckConstraint('price_positive', 'price > 0');
         $this->adapter->addCheckConstraint($table->getTable(), $checkConstraint);
 
         $this->assertTrue($this->adapter->hasCheckConstraint('check_table', 'price_positive'));
@@ -2342,19 +2340,18 @@ public function testAddCheckConstraintWithAutoGeneratedName()
         $table->addColumn('age', 'integer')
               ->create();
 
-        $checkConstraint = new CheckConstraint();
-        $checkConstraint->setExpression('age >= 18');
+        $checkConstraint = new CheckConstraint('', 'age >= 18');
 
         $this->adapter->addCheckConstraint($table->getTable(), $checkConstraint);
 
-        // The constraint should exist with an auto-generated name
-        $constraints = $this->adapter->fetchAll(sprintf(
-            "SELECT cc.CONSTRAINT_NAME FROM INFORMATION_SCHEMA.CHECK_CONSTRAINTS cc INNER JOIN INFORMATION_SCHEMA.TABLE_CONSTRAINTS tc ON cc.CONSTRAINT_SCHEMA = tc.CONSTRAINT_SCHEMA AND cc.CONSTRAINT_NAME = tc.CONSTRAINT_NAME WHERE tc.CONSTRAINT_SCHEMA = '%s' AND tc.TABLE_NAME = 'check_table2'",
-            $this->config['database'],
-        ));
+        $driver = $this->adapter->getConnection()->getDriver();
+        assert($driver instanceof Mysql);
 
+        $dialect = $driver->schemaDialect();
+        $constraints = $dialect->describeCheckConstraints('check_table2');
         $this->assertCount(1, $constraints);
-        $this->assertStringContainsString('check_table2_chk_', $constraints[0]['CONSTRAINT_NAME']);
+        $expected = $driver->isMariaDb() ? 'CONSTRAINT_1' : 'check_table2_chk_';
+        $this->assertStringContainsString($expected, $constraints[0]['name']);
     }
 
     public function testHasCheckConstraint()
@@ -2363,10 +2360,7 @@ public function testHasCheckConstraint()
         $table->addColumn('quantity', 'integer')
               ->create();
 
-        $checkConstraint = new CheckConstraint();
-        $checkConstraint->setName('quantity_positive')
-                       ->setExpression('quantity > 0');
-
+        $checkConstraint = new CheckConstraint('quantity_positive', 'quantity > 0');
         $this->assertFalse($this->adapter->hasCheckConstraint('check_table3', 'quantity_positive'));
 
         $this->adapter->addCheckConstraint($table->getTable(), $checkConstraint);
@@ -2380,10 +2374,7 @@ public function testDropCheckConstraint()
         $table->addColumn('price', 'decimal', ['precision' => 10, 'scale' => 2])
               ->create();
 
-        $checkConstraint = new CheckConstraint();
-        $checkConstraint->setName('price_check')
-                       ->setExpression('price BETWEEN 0 AND 1000');
-
+        $checkConstraint = new CheckConstraint('price_check', 'price BETWEEN 0 AND 1000');
         $this->adapter->addCheckConstraint($table->getTable(), $checkConstraint);
         $this->assertTrue($this->adapter->hasCheckConstraint('check_table4', 'price_check'));
 
@@ -2398,10 +2389,10 @@ public function testCheckConstraintWithComplexExpression()
               ->addColumn('status', 'string', ['limit' => 20])
               ->create();
 
-        $checkConstraint = new CheckConstraint();
-        $checkConstraint->setName('status_valid')
-                       ->setExpression("status IN ('active', 'inactive', 'pending')");
-
+        $checkConstraint = new CheckConstraint(
+            'status_valid',
+            "status IN ('active', 'inactive', 'pending')",
+        );
         $this->adapter->addCheckConstraint($table->getTable(), $checkConstraint);
         $this->assertTrue($this->adapter->hasCheckConstraint('check_table5', 'status_valid'));
 
diff --git a/tests/TestCase/Db/Adapter/PostgresAdapterTest.php b/tests/TestCase/Db/Adapter/PostgresAdapterTest.php
@@ -13,10 +13,12 @@
 use Migrations\Db\Adapter\PostgresAdapter;
 use Migrations\Db\Literal;
 use Migrations\Db\Table;
+use Migrations\Db\Table\CheckConstraint;
 use Migrations\Db\Table\Column;
 use Migrations\Db\Table\ForeignKey;
 use Migrations\Db\Table\Index;
 use PDO;
+use PDOException;
 use PHPUnit\Framework\Attributes\DataProvider;
 use PHPUnit\Framework\Attributes\Depends;
 use PHPUnit\Framework\TestCase;
@@ -2757,4 +2759,64 @@ public function testSerialAliases(string $columnType): void
         $this->assertTrue($column->isIdentity());
         $this->assertFalse($column->isNull());
     }
+
+    public function testAddCheckConstraint()
+    {
+        $table = new Table('check_table', [], $this->adapter);
+        $table->addColumn('price', 'decimal', ['precision' => 10, 'scale' => 2])
+              ->create();
+
+        $checkConstraint = new CheckConstraint('price_positive', 'price > 0');
+        $this->adapter->addCheckConstraint($table->getTable(), $checkConstraint);
+
+        $this->assertTrue($this->adapter->hasCheckConstraint('check_table', 'price_positive'));
+    }
+
+    public function testHasCheckConstraint()
+    {
+        $table = new Table('check_table3', [], $this->adapter);
+        $table->addColumn('quantity', 'integer')
+              ->create();
+
+        $checkConstraint = new CheckConstraint('quantity_positive', 'quantity > 0');
+        $this->assertFalse($this->adapter->hasCheckConstraint('check_table3', 'quantity_positive'));
+
+        $this->adapter->addCheckConstraint($table->getTable(), $checkConstraint);
+
+        $this->assertTrue($this->adapter->hasCheckConstraint('check_table3', 'quantity_positive'));
+    }
+
+    public function testDropCheckConstraint()
+    {
+        $table = new Table('check_table4', [], $this->adapter);
+        $table->addColumn('price', 'decimal', ['precision' => 10, 'scale' => 2])
+              ->create();
+
+        $checkConstraint = new CheckConstraint('price_check', 'price BETWEEN 0 AND 1000');
+        $this->adapter->addCheckConstraint($table->getTable(), $checkConstraint);
+        $this->assertTrue($this->adapter->hasCheckConstraint('check_table4', 'price_check'));
+
+        $this->adapter->dropCheckConstraint('check_table4', 'price_check');
+        $this->assertFalse($this->adapter->hasCheckConstraint('check_table4', 'price_check'));
+    }
+
+    public function testCheckConstraintWithComplexExpression()
+    {
+        $table = new Table('check_table5', [], $this->adapter);
+        $table->addColumn('email', 'string', ['limit' => 255])
+              ->addColumn('status', 'string', ['limit' => 20])
+              ->create();
+
+        $checkConstraint = new CheckConstraint(
+            'status_valid',
+            "status IN ('active', 'inactive', 'pending')",
+        );
+        $this->adapter->addCheckConstraint($table->getTable(), $checkConstraint);
+        $this->assertTrue($this->adapter->hasCheckConstraint('check_table5', 'status_valid'));
+
+        // Verify the constraint is actually enforced
+        $quotedTableName = $this->adapter->getConnection()->getDriver()->quoteIdentifier('check_table5');
+        $this->expectException(PDOException::class);
+        $this->adapter->execute("INSERT INTO {$quotedTableName} (email, status) VALUES ('test@example.com', 'invalid')");
+    }
 }
diff --git a/tests/TestCase/Db/Adapter/SqliteAdapterTest.php b/tests/TestCase/Db/Adapter/SqliteAdapterTest.php
