AbstractPlatformTestCase.php 50.9 KB
Newer Older
1 2 3 4
<?php

namespace Doctrine\Tests\DBAL\Platforms;

5
use Doctrine\Common\EventManager;
Sergei Morozov's avatar
Sergei Morozov committed
6
use Doctrine\DBAL\DBALException;
7
use Doctrine\DBAL\Events;
8
use Doctrine\DBAL\Platforms\AbstractPlatform;
Sergei Morozov's avatar
Sergei Morozov committed
9
use Doctrine\DBAL\Platforms\Keywords\KeywordList;
10
use Doctrine\DBAL\Schema\Column;
11
use Doctrine\DBAL\Schema\ColumnDiff;
12
use Doctrine\DBAL\Schema\Comparator;
13
use Doctrine\DBAL\Schema\ForeignKeyConstraint;
14
use Doctrine\DBAL\Schema\Index;
15
use Doctrine\DBAL\Schema\Table;
16
use Doctrine\DBAL\Schema\TableDiff;
17
use Doctrine\DBAL\Types\Type;
Sergei Morozov's avatar
Sergei Morozov committed
18
use Doctrine\Tests\DbalTestCase;
19
use Doctrine\Tests\Types\CommentedType;
20 21 22 23
use function get_class;
use function implode;
use function sprintf;
use function str_repeat;
24

Sergei Morozov's avatar
Sergei Morozov committed
25
abstract class AbstractPlatformTestCase extends DbalTestCase
26
{
Sergei Morozov's avatar
Sergei Morozov committed
27
    /** @var AbstractPlatform */
Sergei Morozov's avatar
Sergei Morozov committed
28
    protected $platform;
29

30
    abstract public function createPlatform() : AbstractPlatform;
31

32
    protected function setUp() : void
33
    {
Sergei Morozov's avatar
Sergei Morozov committed
34
        $this->platform = $this->createPlatform();
35 36
    }

37 38 39
    /**
     * @group DDC-1360
     */
40
    public function testQuoteIdentifier() : void
41
    {
Sergei Morozov's avatar
Sergei Morozov committed
42
        if ($this->platform->getName() === 'mssql') {
43 44 45
            $this->markTestSkipped('Not working this way on mssql.');
        }

Sergei Morozov's avatar
Sergei Morozov committed
46 47 48 49
        $c = $this->platform->getIdentifierQuoteCharacter();
        self::assertEquals($c . 'test' . $c, $this->platform->quoteIdentifier('test'));
        self::assertEquals($c . 'test' . $c . '.' . $c . 'test' . $c, $this->platform->quoteIdentifier('test.test'));
        self::assertEquals(str_repeat($c, 4), $this->platform->quoteIdentifier($c));
50 51
    }

52 53 54
    /**
     * @group DDC-1360
     */
55
    public function testQuoteSingleIdentifier() : void
56
    {
Sergei Morozov's avatar
Sergei Morozov committed
57
        if ($this->platform->getName() === 'mssql') {
58 59 60
            $this->markTestSkipped('Not working this way on mssql.');
        }

Sergei Morozov's avatar
Sergei Morozov committed
61 62 63 64
        $c = $this->platform->getIdentifierQuoteCharacter();
        self::assertEquals($c . 'test' . $c, $this->platform->quoteSingleIdentifier('test'));
        self::assertEquals($c . 'test.test' . $c, $this->platform->quoteSingleIdentifier('test.test'));
        self::assertEquals(str_repeat($c, 4), $this->platform->quoteSingleIdentifier($c));
65 66
    }

67 68 69 70
    /**
     * @group DBAL-1029
     * @dataProvider getReturnsForeignKeyReferentialActionSQL
     */
71
    public function testReturnsForeignKeyReferentialActionSQL(string $action, string $expectedSQL) : void
72
    {
Sergei Morozov's avatar
Sergei Morozov committed
73
        self::assertSame($expectedSQL, $this->platform->getForeignKeyReferentialActionSQL($action));
74 75 76
    }

    /**
77
     * @return mixed[][]
78
     */
79
    public static function getReturnsForeignKeyReferentialActionSQL() : iterable
80
    {
Sergei Morozov's avatar
Sergei Morozov committed
81 82 83 84 85 86 87 88
        return [
            ['CASCADE', 'CASCADE'],
            ['SET NULL', 'SET NULL'],
            ['NO ACTION', 'NO ACTION'],
            ['RESTRICT', 'RESTRICT'],
            ['SET DEFAULT', 'SET DEFAULT'],
            ['CaScAdE', 'CASCADE'],
        ];
89 90
    }

91
    public function testGetInvalidForeignKeyReferentialActionSQL() : void
92
    {
Luís Cobucci's avatar
Luís Cobucci committed
93
        $this->expectException('InvalidArgumentException');
Sergei Morozov's avatar
Sergei Morozov committed
94
        $this->platform->getForeignKeyReferentialActionSQL('unknown');
95 96
    }

97
    public function testGetUnknownDoctrineMappingType() : void
98
    {
Sergei Morozov's avatar
Sergei Morozov committed
99 100
        $this->expectException(DBALException::class);
        $this->platform->getDoctrineTypeMapping('foobar');
101 102
    }

103
    public function testRegisterDoctrineMappingType() : void
104
    {
Sergei Morozov's avatar
Sergei Morozov committed
105 106
        $this->platform->registerDoctrineTypeMapping('foo', 'integer');
        self::assertEquals('integer', $this->platform->getDoctrineTypeMapping('foo'));
107 108
    }

109
    public function testRegisterUnknownDoctrineMappingType() : void
110
    {
Sergei Morozov's avatar
Sergei Morozov committed
111 112
        $this->expectException(DBALException::class);
        $this->platform->registerDoctrineTypeMapping('foo', 'bar');
113 114
    }

115 116 117
    /**
     * @group DBAL-2594
     */
118
    public function testRegistersCommentedDoctrineMappingTypeImplicitly() : void
119
    {
Sergei Morozov's avatar
Sergei Morozov committed
120
        if (! Type::hasType('my_commented')) {
121 122 123 124
            Type::addType('my_commented', CommentedType::class);
        }

        $type = Type::getType('my_commented');
Sergei Morozov's avatar
Sergei Morozov committed
125
        $this->platform->registerDoctrineTypeMapping('foo', 'my_commented');
126

Sergei Morozov's avatar
Sergei Morozov committed
127
        self::assertTrue($this->platform->isCommentedDoctrineType($type));
128 129
    }

130 131 132 133
    /**
     * @group DBAL-939
     * @dataProvider getIsCommentedDoctrineType
     */
134
    public function testIsCommentedDoctrineType(Type $type, bool $commented) : void
135
    {
Sergei Morozov's avatar
Sergei Morozov committed
136
        self::assertSame($commented, $this->platform->isCommentedDoctrineType($type));
137 138
    }

139 140 141 142
    /**
     * @return mixed[]
     */
    public function getIsCommentedDoctrineType() : iterable
143 144 145
    {
        $this->setUp();

Sergei Morozov's avatar
Sergei Morozov committed
146
        $data = [];
147 148 149 150

        foreach (Type::getTypesMap() as $typeName => $className) {
            $type = Type::getType($typeName);

Sergei Morozov's avatar
Sergei Morozov committed
151
            $data[$typeName] = [
152
                $type,
Sergei Morozov's avatar
Sergei Morozov committed
153
                $type->requiresSQLCommentHint($this->platform),
Sergei Morozov's avatar
Sergei Morozov committed
154
            ];
155 156 157 158 159
        }

        return $data;
    }

160
    public function testCreateWithNoColumns() : void
161
    {
162
        $table = new Table('test');
163

Sergei Morozov's avatar
Sergei Morozov committed
164 165
        $this->expectException(DBALException::class);
        $sql = $this->platform->getCreateTableSQL($table);
166 167
    }

168
    public function testGeneratesTableCreationSql() : void
169
    {
170
        $table = new Table('test');
Sergei Morozov's avatar
Sergei Morozov committed
171 172 173
        $table->addColumn('id', 'integer', ['notnull' => true, 'autoincrement' => true]);
        $table->addColumn('test', 'string', ['notnull' => false, 'length' => 255]);
        $table->setPrimaryKey(['id']);
174

Sergei Morozov's avatar
Sergei Morozov committed
175
        $sql = $this->platform->getCreateTableSQL($table);
176
        self::assertEquals($this->getGenerateTableSql(), $sql[0]);
177 178
    }

179
    abstract public function getGenerateTableSql() : string;
180

181
    public function testGenerateTableWithMultiColumnUniqueIndex() : void
182
    {
183
        $table = new Table('test');
Sergei Morozov's avatar
Sergei Morozov committed
184 185 186
        $table->addColumn('foo', 'string', ['notnull' => false, 'length' => 255]);
        $table->addColumn('bar', 'string', ['notnull' => false, 'length' => 255]);
        $table->addUniqueIndex(['foo', 'bar']);
187

Sergei Morozov's avatar
Sergei Morozov committed
188
        $sql = $this->platform->getCreateTableSQL($table);
189
        self::assertEquals($this->getGenerateTableWithMultiColumnUniqueIndexSql(), $sql);
190 191
    }

192 193 194 195
    /**
     * @return string[]
     */
    abstract public function getGenerateTableWithMultiColumnUniqueIndexSql() : array;
196

197
    public function testGeneratesIndexCreationSql() : void
198
    {
Sergei Morozov's avatar
Sergei Morozov committed
199
        $indexDef = new Index('my_idx', ['user_name', 'last_login']);
200

201
        self::assertEquals(
202
            $this->getGenerateIndexSql(),
Sergei Morozov's avatar
Sergei Morozov committed
203
            $this->platform->getCreateIndexSQL($indexDef, 'mytable')
204 205 206
        );
    }

207
    abstract public function getGenerateIndexSql() : string;
208

209
    public function testGeneratesUniqueIndexCreationSql() : void
210
    {
Sergei Morozov's avatar
Sergei Morozov committed
211
        $indexDef = new Index('index_name', ['test', 'test2'], true);
212

Sergei Morozov's avatar
Sergei Morozov committed
213
        $sql = $this->platform->getCreateIndexSQL($indexDef, 'test');
214
        self::assertEquals($this->getGenerateUniqueIndexSql(), $sql);
215 216
    }

217
    abstract public function getGenerateUniqueIndexSql() : string;
218

219
    public function testGeneratesPartialIndexesSqlOnlyWhenSupportingPartialIndexes() : void
220
    {
Sergei Morozov's avatar
Sergei Morozov committed
221 222 223
        $where       = 'test IS NULL AND test2 IS NOT NULL';
        $indexDef    = new Index('name', ['test', 'test2'], false, false, [], ['where' => $where]);
        $uniqueIndex = new Index('name', ['test', 'test2'], true, false, [], ['where' => $where]);
224 225 226

        $expected = ' WHERE ' . $where;

Sergei Morozov's avatar
Sergei Morozov committed
227
        $actuals = [];
228 229

        if ($this->supportsInlineIndexDeclaration()) {
Sergei Morozov's avatar
Sergei Morozov committed
230
            $actuals[] = $this->platform->getIndexDeclarationSQL('name', $indexDef);
231 232
        }

Sergei Morozov's avatar
Sergei Morozov committed
233 234
        $actuals[] = $this->platform->getUniqueConstraintDeclarationSQL('name', $uniqueIndex);
        $actuals[] = $this->platform->getCreateIndexSQL($indexDef, 'table');
235 236

        foreach ($actuals as $actual) {
Sergei Morozov's avatar
Sergei Morozov committed
237
            if ($this->platform->supportsPartialIndexes()) {
238
                self::assertStringEndsWith($expected, $actual, 'WHERE clause should be present');
239
            } else {
240
                self::assertStringEndsNotWith($expected, $actual, 'WHERE clause should NOT be present');
241 242 243 244
            }
        }
    }

245
    public function testGeneratesForeignKeyCreationSql() : void
246
    {
Sergei Morozov's avatar
Sergei Morozov committed
247
        $fk = new ForeignKeyConstraint(['fk_name_id'], 'other_table', ['id'], '');
248

Sergei Morozov's avatar
Sergei Morozov committed
249
        $sql = $this->platform->getCreateForeignKeySQL($fk, 'test');
250
        self::assertEquals($sql, $this->getGenerateForeignKeySql());
251 252
    }

253
    abstract public function getGenerateForeignKeySql() : string;
254

255
    public function testGeneratesConstraintCreationSql() : void
256
    {
257 258 259 260
        if (! $this->platform->supportsCreateDropForeignKeyConstraints()) {
            $this->markTestSkipped('Platform does not support creating or dropping foreign key constraints.');
        }

Sergei Morozov's avatar
Sergei Morozov committed
261
        $idx = new Index('constraint_name', ['test'], true, false);
Sergei Morozov's avatar
Sergei Morozov committed
262
        $sql = $this->platform->getCreateConstraintSQL($idx, 'test');
263
        self::assertEquals($this->getGenerateConstraintUniqueIndexSql(), $sql);
264

Sergei Morozov's avatar
Sergei Morozov committed
265
        $pk  = new Index('constraint_name', ['test'], true, true);
Sergei Morozov's avatar
Sergei Morozov committed
266
        $sql = $this->platform->getCreateConstraintSQL($pk, 'test');
267
        self::assertEquals($this->getGenerateConstraintPrimaryIndexSql(), $sql);
268

Sergei Morozov's avatar
Sergei Morozov committed
269
        $fk  = new ForeignKeyConstraint(['fk_name'], 'foreign', ['id'], 'constraint_fk');
Sergei Morozov's avatar
Sergei Morozov committed
270
        $sql = $this->platform->getCreateConstraintSQL($fk, 'test');
271
        self::assertEquals($this->getGenerateConstraintForeignKeySql($fk), $sql);
272
    }
Fabio B. Silva's avatar
Fabio B. Silva committed
273

274
    protected function getBitAndComparisonExpressionSql(string $value1, string $value2) : string
275 276 277 278 279 280 281
    {
        return '(' . $value1 . ' & ' . $value2 . ')';
    }

    /**
     * @group DDC-1213
     */
282
    public function testGeneratesBitAndComparisonExpressionSql() : void
283
    {
Sergei Morozov's avatar
Sergei Morozov committed
284
        $sql = $this->platform->getBitAndComparisonExpression(2, 4);
285
        self::assertEquals($this->getBitAndComparisonExpressionSql(2, 4), $sql);
286 287
    }

288
    protected function getBitOrComparisonExpressionSql(string $value1, string $value2) : string
289 290 291 292 293 294 295
    {
        return '(' . $value1 . ' | ' . $value2 . ')';
    }

    /**
     * @group DDC-1213
     */
296
    public function testGeneratesBitOrComparisonExpressionSql() : void
297
    {
Sergei Morozov's avatar
Sergei Morozov committed
298
        $sql = $this->platform->getBitOrComparisonExpression(2, 4);
299
        self::assertEquals($this->getBitOrComparisonExpressionSql(2, 4), $sql);
300
    }
301

302
    public function getGenerateConstraintUniqueIndexSql() : string
303 304 305 306
    {
        return 'ALTER TABLE test ADD CONSTRAINT constraint_name UNIQUE (test)';
    }

307
    public function getGenerateConstraintPrimaryIndexSql() : string
308 309 310 311
    {
        return 'ALTER TABLE test ADD CONSTRAINT constraint_name PRIMARY KEY (test)';
    }

312
    public function getGenerateConstraintForeignKeySql(ForeignKeyConstraint $fk) : string
313
    {
Sergei Morozov's avatar
Sergei Morozov committed
314
        $quotedForeignTable = $fk->getQuotedForeignTableName($this->platform);
315

Sergei Morozov's avatar
Sergei Morozov committed
316 317 318 319
        return sprintf(
            'ALTER TABLE test ADD CONSTRAINT constraint_fk FOREIGN KEY (fk_name) REFERENCES %s (id)',
            $quotedForeignTable
        );
320
    }
321

322 323 324 325
    /**
     * @return string[]
     */
    abstract public function getGenerateAlterTableSql() : array;
326

327
    public function testGeneratesTableAlterationSql() : void
328 329 330
    {
        $expectedSql = $this->getGenerateAlterTableSql();

331
        $table = new Table('mytable');
Sergei Morozov's avatar
Sergei Morozov committed
332
        $table->addColumn('id', 'integer', ['autoincrement' => true]);
333 334 335
        $table->addColumn('foo', 'integer');
        $table->addColumn('bar', 'string');
        $table->addColumn('bloo', 'boolean');
Sergei Morozov's avatar
Sergei Morozov committed
336 337 338 339 340 341 342 343 344 345 346 347 348
        $table->setPrimaryKey(['id']);

        $tableDiff                         = new TableDiff('mytable');
        $tableDiff->fromTable              = $table;
        $tableDiff->newName                = 'userlist';
        $tableDiff->addedColumns['quota']  = new Column('quota', Type::getType('integer'), ['notnull' => false]);
        $tableDiff->removedColumns['foo']  = new Column('foo', Type::getType('integer'));
        $tableDiff->changedColumns['bar']  = new ColumnDiff(
            'bar',
            new Column(
                'baz',
                Type::getType('string'),
                ['default' => 'def']
349
            ),
Sergei Morozov's avatar
Sergei Morozov committed
350
            ['type', 'notnull', 'default']
351
        );
Sergei Morozov's avatar
Sergei Morozov committed
352 353 354 355 356 357
        $tableDiff->changedColumns['bloo'] = new ColumnDiff(
            'bloo',
            new Column(
                'bloo',
                Type::getType('boolean'),
                ['default' => false]
358
            ),
Sergei Morozov's avatar
Sergei Morozov committed
359
            ['type', 'notnull', 'default']
360
        );
361

Sergei Morozov's avatar
Sergei Morozov committed
362
        $sql = $this->platform->getAlterTableSQL($tableDiff);
363

364
        self::assertEquals($expectedSql, $sql);
365
    }
366

367
    public function testGetCustomColumnDeclarationSql() : void
368
    {
Sergei Morozov's avatar
Sergei Morozov committed
369
        $field = ['columnDefinition' => 'MEDIUMINT(6) UNSIGNED'];
Sergei Morozov's avatar
Sergei Morozov committed
370
        self::assertEquals('foo MEDIUMINT(6) UNSIGNED', $this->platform->getColumnDeclarationSQL('foo', $field));
371
    }
372

373
    public function testGetCreateTableSqlDispatchEvent() : void
374
    {
375 376
        $listenerMock = $this->getMockBuilder($this->getMockClass('GetCreateTableSqlDispatchEvenListener'))
            ->addMethods(['onSchemaCreateTable', 'onSchemaCreateTableColumn'])
377
            ->getMock();
378 379
        $listenerMock
            ->expects($this->once())
380
            ->method('onSchemaCreateTable');
381 382 383 384 385
        $listenerMock
            ->expects($this->exactly(2))
            ->method('onSchemaCreateTableColumn');

        $eventManager = new EventManager();
Sergei Morozov's avatar
Sergei Morozov committed
386
        $eventManager->addEventListener([Events::onSchemaCreateTable, Events::onSchemaCreateTableColumn], $listenerMock);
387

Sergei Morozov's avatar
Sergei Morozov committed
388
        $this->platform->setEventManager($eventManager);
389

390
        $table = new Table('test');
Sergei Morozov's avatar
Sergei Morozov committed
391 392
        $table->addColumn('foo', 'string', ['notnull' => false, 'length' => 255]);
        $table->addColumn('bar', 'string', ['notnull' => false, 'length' => 255]);
393

Sergei Morozov's avatar
Sergei Morozov committed
394
        $this->platform->getCreateTableSQL($table);
395 396
    }

397
    public function testGetDropTableSqlDispatchEvent() : void
398
    {
399 400
        $listenerMock = $this->getMockBuilder($this->getMockClass('GetDropTableSqlDispatchEventListener'))
            ->addMethods(['onSchemaDropTable'])
401
            ->getMock();
402 403 404 405 406
        $listenerMock
            ->expects($this->once())
            ->method('onSchemaDropTable');

        $eventManager = new EventManager();
Sergei Morozov's avatar
Sergei Morozov committed
407
        $eventManager->addEventListener([Events::onSchemaDropTable], $listenerMock);
408

Sergei Morozov's avatar
Sergei Morozov committed
409
        $this->platform->setEventManager($eventManager);
410

Sergei Morozov's avatar
Sergei Morozov committed
411
        $this->platform->getDropTableSQL('TABLE');
412
    }
413

414
    public function testGetAlterTableSqlDispatchEvent() : void
415
    {
Sergei Morozov's avatar
Sergei Morozov committed
416
        $events = [
417
            'onSchemaAlterTable',
jsor's avatar
jsor committed
418 419 420
            'onSchemaAlterTableAddColumn',
            'onSchemaAlterTableRemoveColumn',
            'onSchemaAlterTableChangeColumn',
Sergei Morozov's avatar
Sergei Morozov committed
421 422
            'onSchemaAlterTableRenameColumn',
        ];
423

424 425
        $listenerMock = $this->getMockBuilder($this->getMockClass('GetAlterTableSqlDispatchEvenListener'))
            ->addMethods($events)
426
            ->getMock();
427 428 429
        $listenerMock
            ->expects($this->once())
            ->method('onSchemaAlterTable');
430 431
        $listenerMock
            ->expects($this->once())
jsor's avatar
jsor committed
432
            ->method('onSchemaAlterTableAddColumn');
433 434
        $listenerMock
            ->expects($this->once())
jsor's avatar
jsor committed
435
            ->method('onSchemaAlterTableRemoveColumn');
436 437
        $listenerMock
            ->expects($this->once())
jsor's avatar
jsor committed
438
            ->method('onSchemaAlterTableChangeColumn');
439 440
        $listenerMock
            ->expects($this->once())
jsor's avatar
jsor committed
441
            ->method('onSchemaAlterTableRenameColumn');
442 443

        $eventManager = new EventManager();
Sergei Morozov's avatar
Sergei Morozov committed
444
        $events       = [
445
            Events::onSchemaAlterTable,
jsor's avatar
jsor committed
446 447 448
            Events::onSchemaAlterTableAddColumn,
            Events::onSchemaAlterTableRemoveColumn,
            Events::onSchemaAlterTableChangeColumn,
Sergei Morozov's avatar
Sergei Morozov committed
449 450
            Events::onSchemaAlterTableRenameColumn,
        ];
451 452
        $eventManager->addEventListener($events, $listenerMock);

Sergei Morozov's avatar
Sergei Morozov committed
453
        $this->platform->setEventManager($eventManager);
454

455 456 457 458 459
        $table = new Table('mytable');
        $table->addColumn('removed', 'integer');
        $table->addColumn('changed', 'integer');
        $table->addColumn('renamed', 'integer');

Sergei Morozov's avatar
Sergei Morozov committed
460 461 462 463 464 465 466 467 468 469
        $tableDiff                            = new TableDiff('mytable');
        $tableDiff->fromTable                 = $table;
        $tableDiff->addedColumns['added']     = new Column('added', Type::getType('integer'), []);
        $tableDiff->removedColumns['removed'] = new Column('removed', Type::getType('integer'), []);
        $tableDiff->changedColumns['changed'] = new ColumnDiff(
            'changed',
            new Column(
                'changed2',
                Type::getType('string'),
                []
470
            ),
Sergei Morozov's avatar
Sergei Morozov committed
471
            []
472
        );
Sergei Morozov's avatar
Sergei Morozov committed
473
        $tableDiff->renamedColumns['renamed'] = new Column('renamed2', Type::getType('integer'), []);
474

Sergei Morozov's avatar
Sergei Morozov committed
475
        $this->platform->getAlterTableSQL($tableDiff);
476
    }
477

478 479 480
    /**
     * @group DBAL-42
     */
481
    public function testCreateTableColumnComments() : void
482
    {
483
        $table = new Table('test');
Sergei Morozov's avatar
Sergei Morozov committed
484 485
        $table->addColumn('id', 'integer', ['comment' => 'This is a comment']);
        $table->setPrimaryKey(['id']);
486

Sergei Morozov's avatar
Sergei Morozov committed
487
        self::assertEquals($this->getCreateTableColumnCommentsSQL(), $this->platform->getCreateTableSQL($table));
488 489 490 491 492
    }

    /**
     * @group DBAL-42
     */
493
    public function testAlterTableColumnComments() : void
494
    {
Sergei Morozov's avatar
Sergei Morozov committed
495 496 497 498 499 500 501
        $tableDiff                        = new TableDiff('mytable');
        $tableDiff->addedColumns['quota'] = new Column('quota', Type::getType('integer'), ['comment' => 'A comment']);
        $tableDiff->changedColumns['foo'] = new ColumnDiff(
            'foo',
            new Column(
                'foo',
                Type::getType('string')
502
            ),
Sergei Morozov's avatar
Sergei Morozov committed
503
            ['comment']
504
        );
Sergei Morozov's avatar
Sergei Morozov committed
505 506 507 508 509 510
        $tableDiff->changedColumns['bar'] = new ColumnDiff(
            'bar',
            new Column(
                'baz',
                Type::getType('string'),
                ['comment' => 'B comment']
511
            ),
Sergei Morozov's avatar
Sergei Morozov committed
512
            ['comment']
513 514
        );

Sergei Morozov's avatar
Sergei Morozov committed
515
        self::assertEquals($this->getAlterTableColumnCommentsSQL(), $this->platform->getAlterTableSQL($tableDiff));
516 517
    }

518
    public function testCreateTableColumnTypeComments() : void
519
    {
520
        $table = new Table('test');
521 522
        $table->addColumn('id', 'integer');
        $table->addColumn('data', 'array');
Sergei Morozov's avatar
Sergei Morozov committed
523
        $table->setPrimaryKey(['id']);
524

Sergei Morozov's avatar
Sergei Morozov committed
525
        self::assertEquals($this->getCreateTableColumnTypeCommentsSQL(), $this->platform->getCreateTableSQL($table));
526 527
    }

528 529 530 531
    /**
     * @return string[]
     */
    public function getCreateTableColumnCommentsSQL() : array
532 533 534 535
    {
        $this->markTestSkipped('Platform does not support Column comments.');
    }

536 537 538 539
    /**
     * @return string[]
     */
    public function getAlterTableColumnCommentsSQL() : array
540 541 542
    {
        $this->markTestSkipped('Platform does not support Column comments.');
    }
543

544 545 546 547
    /**
     * @return string[]
     */
    public function getCreateTableColumnTypeCommentsSQL() : array
548 549 550 551
    {
        $this->markTestSkipped('Platform does not support Column comments.');
    }

552
    public function testGetDefaultValueDeclarationSQL() : void
553 554
    {
        // non-timestamp value will get single quotes
Sergei Morozov's avatar
Sergei Morozov committed
555
        $field = [
556
            'type' => Type::getType('string'),
Sergei Morozov's avatar
Sergei Morozov committed
557 558
            'default' => 'non_timestamp',
        ];
559

Sergei Morozov's avatar
Sergei Morozov committed
560
        self::assertEquals(" DEFAULT 'non_timestamp'", $this->platform->getDefaultValueDeclarationSQL($field));
561 562
    }

563 564 565 566
    /**
     * @group 2859
     */
    public function testGetDefaultValueDeclarationSQLDateTime() : void
567 568
    {
        // timestamps on datetime types should not be quoted
569 570 571
        foreach (['datetime', 'datetimetz', 'datetime_immutable', 'datetimetz_immutable'] as $type) {
            $field = [
                'type'    => Type::getType($type),
Sergei Morozov's avatar
Sergei Morozov committed
572
                'default' => $this->platform->getCurrentTimestampSQL(),
573
            ];
574

575
            self::assertSame(
Sergei Morozov's avatar
Sergei Morozov committed
576 577
                ' DEFAULT ' . $this->platform->getCurrentTimestampSQL(),
                $this->platform->getDefaultValueDeclarationSQL($field)
578 579 580 581
            );
        }
    }

582
    public function testGetDefaultValueDeclarationSQLForIntegerTypes() : void
583
    {
Sergei Morozov's avatar
Sergei Morozov committed
584 585
        foreach (['bigint', 'integer', 'smallint'] as $type) {
            $field = [
586
                'type'    => Type::getType($type),
Sergei Morozov's avatar
Sergei Morozov committed
587 588
                'default' => 1,
            ];
589

590
            self::assertEquals(
591
                ' DEFAULT 1',
Sergei Morozov's avatar
Sergei Morozov committed
592
                $this->platform->getDefaultValueDeclarationSQL($field)
593 594 595 596
            );
        }
    }

597 598 599
    /**
     * @group 2859
     */
600
    public function testGetDefaultValueDeclarationSQLForDateType() : void
601
    {
Sergei Morozov's avatar
Sergei Morozov committed
602
        $currentDateSql = $this->platform->getCurrentDateSQL();
603 604 605 606 607 608 609 610
        foreach (['date', 'date_immutable'] as $type) {
            $field = [
                'type'    => Type::getType($type),
                'default' => $currentDateSql,
            ];

            self::assertSame(
                ' DEFAULT ' . $currentDateSql,
Sergei Morozov's avatar
Sergei Morozov committed
611
                $this->platform->getDefaultValueDeclarationSQL($field)
612 613
            );
        }
614 615
    }

616 617 618
    /**
     * @group DBAL-45
     */
619
    public function testKeywordList() : void
620
    {
Sergei Morozov's avatar
Sergei Morozov committed
621 622
        $keywordList = $this->platform->getReservedKeywordsList();
        self::assertInstanceOf(KeywordList::class, $keywordList);
623

624
        self::assertTrue($keywordList->isKeyword('table'));
625
    }
626 627 628 629

    /**
     * @group DBAL-374
     */
630
    public function testQuotedColumnInPrimaryKeyPropagation() : void
631 632
    {
        $table = new Table('`quoted`');
633
        $table->addColumn('create', 'string');
Sergei Morozov's avatar
Sergei Morozov committed
634
        $table->setPrimaryKey(['create']);
635

Sergei Morozov's avatar
Sergei Morozov committed
636
        $sql = $this->platform->getCreateTableSQL($table);
637
        self::assertEquals($this->getQuotedColumnInPrimaryKeySQL(), $sql);
638 639
    }

640 641 642 643
    /**
     * @return string[]
     */
    abstract protected function getQuotedColumnInPrimaryKeySQL() : array;
644

645 646 647 648
    /**
     * @return string[]
     */
    abstract protected function getQuotedColumnInIndexSQL() : array;
649

650 651 652 653
    /**
     * @return string[]
     */
    abstract protected function getQuotedNameInIndexSQL() : array;
654

655 656 657 658
    /**
     * @return string[]
     */
    abstract protected function getQuotedColumnInForeignKeySQL() : array;
659 660 661 662

    /**
     * @group DBAL-374
     */
663
    public function testQuotedColumnInIndexPropagation() : void
664 665
    {
        $table = new Table('`quoted`');
666
        $table->addColumn('create', 'string');
Sergei Morozov's avatar
Sergei Morozov committed
667
        $table->addIndex(['create']);
668

Sergei Morozov's avatar
Sergei Morozov committed
669
        $sql = $this->platform->getCreateTableSQL($table);
670
        self::assertEquals($this->getQuotedColumnInIndexSQL(), $sql);
671
    }
672

673
    public function testQuotedNameInIndexSQL() : void
Markus Fasselt's avatar
Markus Fasselt committed
674 675 676
    {
        $table = new Table('test');
        $table->addColumn('column1', 'string');
Sergei Morozov's avatar
Sergei Morozov committed
677
        $table->addIndex(['column1'], '`key`');
Markus Fasselt's avatar
Markus Fasselt committed
678

Sergei Morozov's avatar
Sergei Morozov committed
679
        $sql = $this->platform->getCreateTableSQL($table);
680
        self::assertEquals($this->getQuotedNameInIndexSQL(), $sql);
Markus Fasselt's avatar
Markus Fasselt committed
681 682
    }

683 684 685
    /**
     * @group DBAL-374
     */
686
    public function testQuotedColumnInForeignKeyPropagation() : void
687 688 689 690
    {
        $table = new Table('`quoted`');
        $table->addColumn('create', 'string');
        $table->addColumn('foo', 'string');
691
        $table->addColumn('`bar`', 'string');
692

693
        // Foreign table with reserved keyword as name (needs quotation).
694
        $foreignTable = new Table('foreign');
695 696 697
        $foreignTable->addColumn('create', 'string');    // Foreign column with reserved keyword as name (needs quotation).
        $foreignTable->addColumn('bar', 'string');       // Foreign column with non-reserved keyword as name (does not need quotation).
        $foreignTable->addColumn('`foo-bar`', 'string'); // Foreign table with special character in name (needs quotation on some platforms, e.g. Sqlite).
698

Sergei Morozov's avatar
Sergei Morozov committed
699
        $table->addForeignKeyConstraint($foreignTable, ['create', 'foo', '`bar`'], ['create', 'bar', '`foo-bar`'], [], 'FK_WITH_RESERVED_KEYWORD');
700 701 702 703 704 705 706

        // Foreign table with non-reserved keyword as name (does not need quotation).
        $foreignTable = new Table('foo');
        $foreignTable->addColumn('create', 'string');    // Foreign column with reserved keyword as name (needs quotation).
        $foreignTable->addColumn('bar', 'string');       // Foreign column with non-reserved keyword as name (does not need quotation).
        $foreignTable->addColumn('`foo-bar`', 'string'); // Foreign table with special character in name (needs quotation on some platforms, e.g. Sqlite).

Sergei Morozov's avatar
Sergei Morozov committed
707
        $table->addForeignKeyConstraint($foreignTable, ['create', 'foo', '`bar`'], ['create', 'bar', '`foo-bar`'], [], 'FK_WITH_NON_RESERVED_KEYWORD');
708 709 710 711 712 713 714

        // Foreign table with special character in name (needs quotation on some platforms, e.g. Sqlite).
        $foreignTable = new Table('`foo-bar`');
        $foreignTable->addColumn('create', 'string');    // Foreign column with reserved keyword as name (needs quotation).
        $foreignTable->addColumn('bar', 'string');       // Foreign column with non-reserved keyword as name (does not need quotation).
        $foreignTable->addColumn('`foo-bar`', 'string'); // Foreign table with special character in name (needs quotation on some platforms, e.g. Sqlite).

Sergei Morozov's avatar
Sergei Morozov committed
715
        $table->addForeignKeyConstraint($foreignTable, ['create', 'foo', '`bar`'], ['create', 'bar', '`foo-bar`'], [], 'FK_WITH_INTENDED_QUOTATION');
716

Sergei Morozov's avatar
Sergei Morozov committed
717
        $sql = $this->platform->getCreateTableSQL($table, AbstractPlatform::CREATE_FOREIGNKEYS);
718
        self::assertEquals($this->getQuotedColumnInForeignKeySQL(), $sql);
719
    }
720

721 722 723
    /**
     * @group DBAL-1051
     */
724
    public function testQuotesReservedKeywordInUniqueConstraintDeclarationSQL() : void
725
    {
Sergei Morozov's avatar
Sergei Morozov committed
726
        $index = new Index('select', ['foo'], true);
727

728
        self::assertSame(
729
            $this->getQuotesReservedKeywordInUniqueConstraintDeclarationSQL(),
Sergei Morozov's avatar
Sergei Morozov committed
730
            $this->platform->getUniqueConstraintDeclarationSQL('select', $index)
731 732 733
        );
    }

734
    abstract protected function getQuotesReservedKeywordInUniqueConstraintDeclarationSQL() : string;
735

736 737 738
    /**
     * @group DBAL-2270
     */
739
    public function testQuotesReservedKeywordInTruncateTableSQL() : void
740
    {
741
        self::assertSame(
742
            $this->getQuotesReservedKeywordInTruncateTableSQL(),
Sergei Morozov's avatar
Sergei Morozov committed
743
            $this->platform->getTruncateTableSQL('select')
744 745 746
        );
    }

747
    abstract protected function getQuotesReservedKeywordInTruncateTableSQL() : string;
748

749 750 751
    /**
     * @group DBAL-1051
     */
752
    public function testQuotesReservedKeywordInIndexDeclarationSQL() : void
753
    {
Sergei Morozov's avatar
Sergei Morozov committed
754
        $index = new Index('select', ['foo']);
755 756

        if (! $this->supportsInlineIndexDeclaration()) {
Sergei Morozov's avatar
Sergei Morozov committed
757
            $this->expectException(DBALException::class);
758 759
        }

760
        self::assertSame(
761
            $this->getQuotesReservedKeywordInIndexDeclarationSQL(),
Sergei Morozov's avatar
Sergei Morozov committed
762
            $this->platform->getIndexDeclarationSQL('select', $index)
763 764 765
        );
    }

766
    abstract protected function getQuotesReservedKeywordInIndexDeclarationSQL() : string;
767

768
    protected function supportsInlineIndexDeclaration() : bool
769 770 771 772
    {
        return true;
    }

773
    public function testSupportsCommentOnStatement() : void
774
    {
Sergei Morozov's avatar
Sergei Morozov committed
775
        self::assertSame($this->supportsCommentOnStatement(), $this->platform->supportsCommentOnStatement());
776 777
    }

778
    protected function supportsCommentOnStatement() : bool
779 780 781 782
    {
        return false;
    }

783
    public function testGetCreateSchemaSQL() : void
784
    {
785 786
        $this->expectException(DBALException::class);

Sergei Morozov's avatar
Sergei Morozov committed
787
        $this->platform->getCreateSchemaSQL('schema');
788 789
    }

790 791 792
    /**
     * @group DBAL-585
     */
793
    public function testAlterTableChangeQuotedColumn() : void
794
    {
Sergei Morozov's avatar
Sergei Morozov committed
795 796 797 798 799 800 801
        $tableDiff                        = new TableDiff('mytable');
        $tableDiff->fromTable             = new Table('mytable');
        $tableDiff->changedColumns['foo'] = new ColumnDiff(
            'select',
            new Column(
                'select',
                Type::getType('string')
802
            ),
Sergei Morozov's avatar
Sergei Morozov committed
803
            ['type']
804 805
        );

806
        self::assertStringContainsString(
Sergei Morozov's avatar
Sergei Morozov committed
807 808
            $this->platform->quoteIdentifier('select'),
            implode(';', $this->platform->getAlterTableSQL($tableDiff))
809 810
        );
    }
Benjamin Eberlei's avatar
Benjamin Eberlei committed
811

812 813 814
    /**
     * @group DBAL-563
     */
815
    public function testUsesSequenceEmulatedIdentityColumns() : void
816
    {
Sergei Morozov's avatar
Sergei Morozov committed
817
        self::assertFalse($this->platform->usesSequenceEmulatedIdentityColumns());
818 819 820 821 822
    }

    /**
     * @group DBAL-563
     */
823
    public function testReturnsIdentitySequenceName() : void
824
    {
825 826
        $this->expectException(DBALException::class);

Sergei Morozov's avatar
Sergei Morozov committed
827
        $this->platform->getIdentitySequenceName('mytable', 'mycolumn');
828
    }
Steve Müller's avatar
Steve Müller committed
829

830
    public function testReturnsBinaryDefaultLength() : void
Steve Müller's avatar
Steve Müller committed
831
    {
Sergei Morozov's avatar
Sergei Morozov committed
832
        self::assertSame($this->getBinaryDefaultLength(), $this->platform->getBinaryDefaultLength());
Steve Müller's avatar
Steve Müller committed
833 834
    }

835
    protected function getBinaryDefaultLength() : int
Steve Müller's avatar
Steve Müller committed
836 837 838 839
    {
        return 255;
    }

840
    public function testReturnsBinaryMaxLength() : void
Steve Müller's avatar
Steve Müller committed
841
    {
Sergei Morozov's avatar
Sergei Morozov committed
842
        self::assertSame($this->getBinaryMaxLength(), $this->platform->getBinaryMaxLength());
Steve Müller's avatar
Steve Müller committed
843 844
    }

845
    protected function getBinaryMaxLength() : int
Steve Müller's avatar
Steve Müller committed
846 847 848 849
    {
        return 4000;
    }

850
    public function testReturnsBinaryTypeDeclarationSQL() : void
Steve Müller's avatar
Steve Müller committed
851
    {
852 853
        $this->expectException(DBALException::class);

Sergei Morozov's avatar
Sergei Morozov committed
854
        $this->platform->getBinaryTypeDeclarationSQL([]);
Steve Müller's avatar
Steve Müller committed
855
    }
856

857
    public function testReturnsBinaryTypeLongerThanMaxDeclarationSQL() : void
858 859 860 861
    {
        $this->markTestSkipped('Not applicable to the platform');
    }

862 863 864
    /**
     * @group DBAL-553
     */
865
    public function hasNativeJsonType() : void
866
    {
Sergei Morozov's avatar
Sergei Morozov committed
867
        self::assertFalse($this->platform->hasNativeJsonType());
868 869 870 871 872
    }

    /**
     * @group DBAL-553
     */
873
    public function testReturnsJsonTypeDeclarationSQL() : void
874
    {
Sergei Morozov's avatar
Sergei Morozov committed
875
        $column = [
876 877 878
            'length'  => 666,
            'notnull' => true,
            'type'    => Type::getType('json_array'),
Sergei Morozov's avatar
Sergei Morozov committed
879
        ];
880

881
        self::assertSame(
Sergei Morozov's avatar
Sergei Morozov committed
882 883
            $this->platform->getClobTypeDeclarationSQL($column),
            $this->platform->getJsonTypeDeclarationSQL($column)
884 885
        );
    }
886 887 888 889

    /**
     * @group DBAL-234
     */
890
    public function testAlterTableRenameIndex() : void
891
    {
Sergei Morozov's avatar
Sergei Morozov committed
892
        $tableDiff            = new TableDiff('mytable');
893 894
        $tableDiff->fromTable = new Table('mytable');
        $tableDiff->fromTable->addColumn('id', 'integer');
Sergei Morozov's avatar
Sergei Morozov committed
895 896 897 898
        $tableDiff->fromTable->setPrimaryKey(['id']);
        $tableDiff->renamedIndexes = [
            'idx_foo' => new Index('idx_bar', ['id']),
        ];
899

900
        self::assertSame(
901
            $this->getAlterTableRenameIndexSQL(),
Sergei Morozov's avatar
Sergei Morozov committed
902
            $this->platform->getAlterTableSQL($tableDiff)
903 904 905 906
        );
    }

    /**
907 908
     * @return string[]
     *
909 910
     * @group DBAL-234
     */
911
    protected function getAlterTableRenameIndexSQL() : array
912
    {
Sergei Morozov's avatar
Sergei Morozov committed
913
        return [
914 915
            'DROP INDEX idx_foo',
            'CREATE INDEX idx_bar ON mytable (id)',
Sergei Morozov's avatar
Sergei Morozov committed
916
        ];
917 918 919 920 921
    }

    /**
     * @group DBAL-234
     */
922
    public function testQuotesAlterTableRenameIndex() : void
923
    {
Sergei Morozov's avatar
Sergei Morozov committed
924
        $tableDiff            = new TableDiff('table');
925 926
        $tableDiff->fromTable = new Table('table');
        $tableDiff->fromTable->addColumn('id', 'integer');
Sergei Morozov's avatar
Sergei Morozov committed
927 928 929 930 931
        $tableDiff->fromTable->setPrimaryKey(['id']);
        $tableDiff->renamedIndexes = [
            'create' => new Index('select', ['id']),
            '`foo`'  => new Index('`bar`', ['id']),
        ];
932

933
        self::assertSame(
934
            $this->getQuotedAlterTableRenameIndexSQL(),
Sergei Morozov's avatar
Sergei Morozov committed
935
            $this->platform->getAlterTableSQL($tableDiff)
936 937 938 939
        );
    }

    /**
940 941
     * @return string[]
     *
942 943
     * @group DBAL-234
     */
944
    protected function getQuotedAlterTableRenameIndexSQL() : array
945
    {
Sergei Morozov's avatar
Sergei Morozov committed
946
        return [
947 948 949 950
            'DROP INDEX "create"',
            'CREATE INDEX "select" ON "table" (id)',
            'DROP INDEX "foo"',
            'CREATE INDEX "bar" ON "table" (id)',
Sergei Morozov's avatar
Sergei Morozov committed
951
        ];
952
    }
953 954 955 956

    /**
     * @group DBAL-835
     */
957
    public function testQuotesAlterTableRenameColumn() : void
958 959 960
    {
        $fromTable = new Table('mytable');

Sergei Morozov's avatar
Sergei Morozov committed
961 962 963
        $fromTable->addColumn('unquoted1', 'integer', ['comment' => 'Unquoted 1']);
        $fromTable->addColumn('unquoted2', 'integer', ['comment' => 'Unquoted 2']);
        $fromTable->addColumn('unquoted3', 'integer', ['comment' => 'Unquoted 3']);
964

Sergei Morozov's avatar
Sergei Morozov committed
965 966 967
        $fromTable->addColumn('create', 'integer', ['comment' => 'Reserved keyword 1']);
        $fromTable->addColumn('table', 'integer', ['comment' => 'Reserved keyword 2']);
        $fromTable->addColumn('select', 'integer', ['comment' => 'Reserved keyword 3']);
968

Sergei Morozov's avatar
Sergei Morozov committed
969 970 971
        $fromTable->addColumn('`quoted1`', 'integer', ['comment' => 'Quoted 1']);
        $fromTable->addColumn('`quoted2`', 'integer', ['comment' => 'Quoted 2']);
        $fromTable->addColumn('`quoted3`', 'integer', ['comment' => 'Quoted 3']);
972 973 974

        $toTable = new Table('mytable');

Sergei Morozov's avatar
Sergei Morozov committed
975 976 977
        $toTable->addColumn('unquoted', 'integer', ['comment' => 'Unquoted 1']); // unquoted -> unquoted
        $toTable->addColumn('where', 'integer', ['comment' => 'Unquoted 2']); // unquoted -> reserved keyword
        $toTable->addColumn('`foo`', 'integer', ['comment' => 'Unquoted 3']); // unquoted -> quoted
978

Sergei Morozov's avatar
Sergei Morozov committed
979 980 981
        $toTable->addColumn('reserved_keyword', 'integer', ['comment' => 'Reserved keyword 1']); // reserved keyword -> unquoted
        $toTable->addColumn('from', 'integer', ['comment' => 'Reserved keyword 2']); // reserved keyword -> reserved keyword
        $toTable->addColumn('`bar`', 'integer', ['comment' => 'Reserved keyword 3']); // reserved keyword -> quoted
982

Sergei Morozov's avatar
Sergei Morozov committed
983 984 985
        $toTable->addColumn('quoted', 'integer', ['comment' => 'Quoted 1']); // quoted -> unquoted
        $toTable->addColumn('and', 'integer', ['comment' => 'Quoted 2']); // quoted -> reserved keyword
        $toTable->addColumn('`baz`', 'integer', ['comment' => 'Quoted 3']); // quoted -> quoted
986 987 988

        $comparator = new Comparator();

989
        self::assertEquals(
990
            $this->getQuotedAlterTableRenameColumnSQL(),
Sergei Morozov's avatar
Sergei Morozov committed
991
            $this->platform->getAlterTableSQL($comparator->diffTable($fromTable, $toTable))
992 993 994 995 996 997
        );
    }

    /**
     * Returns SQL statements for {@link testQuotesAlterTableRenameColumn}.
     *
Sergei Morozov's avatar
Sergei Morozov committed
998
     * @return string[]
999 1000 1001
     *
     * @group DBAL-835
     */
1002
    abstract protected function getQuotedAlterTableRenameColumnSQL() : array;
1003

1004 1005 1006
    /**
     * @group DBAL-835
     */
1007
    public function testQuotesAlterTableChangeColumnLength() : void
1008 1009 1010
    {
        $fromTable = new Table('mytable');

Sergei Morozov's avatar
Sergei Morozov committed
1011 1012 1013
        $fromTable->addColumn('unquoted1', 'string', ['comment' => 'Unquoted 1', 'length' => 10]);
        $fromTable->addColumn('unquoted2', 'string', ['comment' => 'Unquoted 2', 'length' => 10]);
        $fromTable->addColumn('unquoted3', 'string', ['comment' => 'Unquoted 3', 'length' => 10]);
1014

Sergei Morozov's avatar
Sergei Morozov committed
1015 1016 1017
        $fromTable->addColumn('create', 'string', ['comment' => 'Reserved keyword 1', 'length' => 10]);
        $fromTable->addColumn('table', 'string', ['comment' => 'Reserved keyword 2', 'length' => 10]);
        $fromTable->addColumn('select', 'string', ['comment' => 'Reserved keyword 3', 'length' => 10]);
1018 1019 1020

        $toTable = new Table('mytable');

Sergei Morozov's avatar
Sergei Morozov committed
1021 1022 1023
        $toTable->addColumn('unquoted1', 'string', ['comment' => 'Unquoted 1', 'length' => 255]);
        $toTable->addColumn('unquoted2', 'string', ['comment' => 'Unquoted 2', 'length' => 255]);
        $toTable->addColumn('unquoted3', 'string', ['comment' => 'Unquoted 3', 'length' => 255]);
1024

Sergei Morozov's avatar
Sergei Morozov committed
1025 1026 1027
        $toTable->addColumn('create', 'string', ['comment' => 'Reserved keyword 1', 'length' => 255]);
        $toTable->addColumn('table', 'string', ['comment' => 'Reserved keyword 2', 'length' => 255]);
        $toTable->addColumn('select', 'string', ['comment' => 'Reserved keyword 3', 'length' => 255]);
1028 1029 1030

        $comparator = new Comparator();

1031
        self::assertEquals(
1032
            $this->getQuotedAlterTableChangeColumnLengthSQL(),
Sergei Morozov's avatar
Sergei Morozov committed
1033
            $this->platform->getAlterTableSQL($comparator->diffTable($fromTable, $toTable))
1034 1035 1036 1037 1038 1039
        );
    }

    /**
     * Returns SQL statements for {@link testQuotesAlterTableChangeColumnLength}.
     *
Sergei Morozov's avatar
Sergei Morozov committed
1040
     * @return string[]
1041 1042 1043
     *
     * @group DBAL-835
     */
1044
    abstract protected function getQuotedAlterTableChangeColumnLengthSQL() : array;
1045

1046 1047 1048
    /**
     * @group DBAL-807
     */
1049
    public function testAlterTableRenameIndexInSchema() : void
1050
    {
Sergei Morozov's avatar
Sergei Morozov committed
1051
        $tableDiff            = new TableDiff('myschema.mytable');
1052 1053
        $tableDiff->fromTable = new Table('myschema.mytable');
        $tableDiff->fromTable->addColumn('id', 'integer');
Sergei Morozov's avatar
Sergei Morozov committed
1054 1055 1056 1057
        $tableDiff->fromTable->setPrimaryKey(['id']);
        $tableDiff->renamedIndexes = [
            'idx_foo' => new Index('idx_bar', ['id']),
        ];
1058

1059
        self::assertSame(
1060
            $this->getAlterTableRenameIndexInSchemaSQL(),
Sergei Morozov's avatar
Sergei Morozov committed
1061
            $this->platform->getAlterTableSQL($tableDiff)
1062 1063 1064 1065
        );
    }

    /**
1066 1067
     * @return string[]
     *
1068 1069
     * @group DBAL-807
     */
1070
    protected function getAlterTableRenameIndexInSchemaSQL() : array
1071
    {
Sergei Morozov's avatar
Sergei Morozov committed
1072
        return [
1073 1074
            'DROP INDEX idx_foo',
            'CREATE INDEX idx_bar ON myschema.mytable (id)',
Sergei Morozov's avatar
Sergei Morozov committed
1075
        ];
1076 1077 1078 1079 1080
    }

    /**
     * @group DBAL-807
     */
1081
    public function testQuotesAlterTableRenameIndexInSchema() : void
1082
    {
Sergei Morozov's avatar
Sergei Morozov committed
1083
        $tableDiff            = new TableDiff('`schema`.table');
1084 1085
        $tableDiff->fromTable = new Table('`schema`.table');
        $tableDiff->fromTable->addColumn('id', 'integer');
Sergei Morozov's avatar
Sergei Morozov committed
1086 1087 1088 1089 1090
        $tableDiff->fromTable->setPrimaryKey(['id']);
        $tableDiff->renamedIndexes = [
            'create' => new Index('select', ['id']),
            '`foo`'  => new Index('`bar`', ['id']),
        ];
1091

1092
        self::assertSame(
1093
            $this->getQuotedAlterTableRenameIndexInSchemaSQL(),
Sergei Morozov's avatar
Sergei Morozov committed
1094
            $this->platform->getAlterTableSQL($tableDiff)
1095 1096 1097 1098
        );
    }

    /**
1099 1100
     * @return string[]
     *
1101 1102
     * @group DBAL-234
     */
1103
    protected function getQuotedAlterTableRenameIndexInSchemaSQL() : array
1104
    {
Sergei Morozov's avatar
Sergei Morozov committed
1105
        return [
1106 1107 1108 1109
            'DROP INDEX "schema"."create"',
            'CREATE INDEX "select" ON "schema"."table" (id)',
            'DROP INDEX "schema"."foo"',
            'CREATE INDEX "bar" ON "schema"."table" (id)',
Sergei Morozov's avatar
Sergei Morozov committed
1110
        ];
1111
    }
1112

1113 1114 1115
    /**
     * @group DBAL-1237
     */
1116
    public function testQuotesDropForeignKeySQL() : void
1117
    {
1118
        if (! $this->platform->supportsCreateDropForeignKeyConstraints()) {
1119
            $this->markTestSkipped(
1120
                sprintf('%s does not support modifying foreign key constraints.', get_class($this->platform))
1121 1122 1123
            );
        }

Sergei Morozov's avatar
Sergei Morozov committed
1124 1125
        $tableName      = 'table';
        $table          = new Table($tableName);
1126
        $foreignKeyName = 'select';
Sergei Morozov's avatar
Sergei Morozov committed
1127 1128
        $foreignKey     = new ForeignKeyConstraint([], 'foo', [], 'select');
        $expectedSql    = $this->getQuotesDropForeignKeySQL();
1129

Sergei Morozov's avatar
Sergei Morozov committed
1130 1131
        self::assertSame($expectedSql, $this->platform->getDropForeignKeySQL($foreignKeyName, $tableName));
        self::assertSame($expectedSql, $this->platform->getDropForeignKeySQL($foreignKey, $table));
1132 1133
    }

1134
    protected function getQuotesDropForeignKeySQL() : string
1135 1136 1137 1138 1139 1140 1141
    {
        return 'ALTER TABLE "table" DROP FOREIGN KEY "select"';
    }

    /**
     * @group DBAL-1237
     */
1142
    public function testQuotesDropConstraintSQL() : void
1143
    {
Sergei Morozov's avatar
Sergei Morozov committed
1144 1145
        $tableName      = 'table';
        $table          = new Table($tableName);
1146
        $constraintName = 'select';
Sergei Morozov's avatar
Sergei Morozov committed
1147 1148
        $constraint     = new ForeignKeyConstraint([], 'foo', [], 'select');
        $expectedSql    = $this->getQuotesDropConstraintSQL();
1149

Sergei Morozov's avatar
Sergei Morozov committed
1150 1151
        self::assertSame($expectedSql, $this->platform->getDropConstraintSQL($constraintName, $tableName));
        self::assertSame($expectedSql, $this->platform->getDropConstraintSQL($constraint, $table));
1152 1153
    }

1154
    protected function getQuotesDropConstraintSQL() : string
1155 1156 1157 1158
    {
        return 'ALTER TABLE "table" DROP CONSTRAINT "select"';
    }

1159
    protected function getStringLiteralQuoteCharacter() : string
1160 1161 1162 1163
    {
        return "'";
    }

1164
    public function testGetStringLiteralQuoteCharacter() : void
1165
    {
Sergei Morozov's avatar
Sergei Morozov committed
1166
        self::assertSame($this->getStringLiteralQuoteCharacter(), $this->platform->getStringLiteralQuoteCharacter());
1167 1168
    }

1169
    protected function getQuotedCommentOnColumnSQLWithoutQuoteCharacter() : string
1170 1171 1172 1173
    {
        return "COMMENT ON COLUMN mytable.id IS 'This is a comment'";
    }

1174
    public function testGetCommentOnColumnSQLWithoutQuoteCharacter() : void
1175
    {
1176
        self::assertEquals(
1177
            $this->getQuotedCommentOnColumnSQLWithoutQuoteCharacter(),
Sergei Morozov's avatar
Sergei Morozov committed
1178
            $this->platform->getCommentOnColumnSQL('mytable', 'id', 'This is a comment')
1179
        );
1180 1181
    }

1182
    protected function getQuotedCommentOnColumnSQLWithQuoteCharacter() : string
1183 1184 1185 1186
    {
        return "COMMENT ON COLUMN mytable.id IS 'It''s a quote !'";
    }

1187
    public function testGetCommentOnColumnSQLWithQuoteCharacter() : void
1188 1189
    {
        $c = $this->getStringLiteralQuoteCharacter();
1190

1191
        self::assertEquals(
1192
            $this->getQuotedCommentOnColumnSQLWithQuoteCharacter(),
Sergei Morozov's avatar
Sergei Morozov committed
1193
            $this->platform->getCommentOnColumnSQL('mytable', 'id', 'It' . $c . 's a quote !')
1194 1195 1196
        );
    }

1197 1198
    /**
     * @see testGetCommentOnColumnSQL
Sergei Morozov's avatar
Sergei Morozov committed
1199
     *
Sergei Morozov's avatar
Sergei Morozov committed
1200
     * @return string[]
1201
     */
1202
    abstract protected function getCommentOnColumnSQL() : array;
1203 1204 1205 1206

    /**
     * @group DBAL-1004
     */
1207
    public function testGetCommentOnColumnSQL() : void
1208
    {
1209
        self::assertSame(
1210
            $this->getCommentOnColumnSQL(),
Sergei Morozov's avatar
Sergei Morozov committed
1211
            [
Sergei Morozov's avatar
Sergei Morozov committed
1212 1213 1214
                $this->platform->getCommentOnColumnSQL('foo', 'bar', 'comment'), // regular identifiers
                $this->platform->getCommentOnColumnSQL('`Foo`', '`BAR`', 'comment'), // explicitly quoted identifiers
                $this->platform->getCommentOnColumnSQL('select', 'from', 'comment'), // reserved keyword identifiers
Sergei Morozov's avatar
Sergei Morozov committed
1215
            ]
1216 1217 1218
        );
    }

1219 1220 1221 1222
    /**
     * @group DBAL-1176
     * @dataProvider getGeneratesInlineColumnCommentSQL
     */
1223
    public function testGeneratesInlineColumnCommentSQL(?string $comment, string $expectedSql) : void
1224
    {
Sergei Morozov's avatar
Sergei Morozov committed
1225 1226
        if (! $this->platform->supportsInlineColumnComments()) {
            $this->markTestSkipped(sprintf('%s does not support inline column comments.', get_class($this->platform)));
1227 1228
        }

Sergei Morozov's avatar
Sergei Morozov committed
1229
        self::assertSame($expectedSql, $this->platform->getInlineColumnCommentSQL($comment));
1230 1231
    }

1232 1233 1234 1235
    /**
     * @return mixed[][]
     */
    public static function getGeneratesInlineColumnCommentSQL() : iterable
1236
    {
Sergei Morozov's avatar
Sergei Morozov committed
1237
        return [
1238
            'regular comment' => ['Regular comment', static::getInlineColumnRegularCommentSQL()],
Sergei Morozov's avatar
Sergei Morozov committed
1239
            'comment requiring escaping' => [
1240 1241
                sprintf(
                    'Using inline comment delimiter %s works',
1242
                    static::getInlineColumnCommentDelimiter()
1243
                ),
1244
                static::getInlineColumnCommentRequiringEscapingSQL(),
Sergei Morozov's avatar
Sergei Morozov committed
1245
            ],
1246
            'empty comment' => ['', static::getInlineColumnEmptyCommentSQL()],
Sergei Morozov's avatar
Sergei Morozov committed
1247
        ];
1248 1249
    }

1250
    protected static function getInlineColumnCommentDelimiter() : string
1251 1252 1253 1254
    {
        return "'";
    }

1255
    protected static function getInlineColumnRegularCommentSQL() : string
1256 1257 1258 1259
    {
        return "COMMENT 'Regular comment'";
    }

1260
    protected static function getInlineColumnCommentRequiringEscapingSQL() : string
1261 1262 1263 1264
    {
        return "COMMENT 'Using inline comment delimiter '' works'";
    }

1265
    protected static function getInlineColumnEmptyCommentSQL() : string
1266 1267 1268 1269
    {
        return "COMMENT ''";
    }

1270
    protected function getQuotedStringLiteralWithoutQuoteCharacter() : string
1271 1272 1273 1274
    {
        return "'No quote'";
    }

1275
    protected function getQuotedStringLiteralWithQuoteCharacter() : string
1276 1277 1278 1279
    {
        return "'It''s a quote'";
    }

1280
    protected function getQuotedStringLiteralQuoteCharacter() : string
1281 1282 1283 1284
    {
        return "''''";
    }

1285 1286 1287
    /**
     * @group DBAL-1176
     */
1288
    public function testThrowsExceptionOnGeneratingInlineColumnCommentSQLIfUnsupported() : void
1289
    {
Sergei Morozov's avatar
Sergei Morozov committed
1290 1291
        if ($this->platform->supportsInlineColumnComments()) {
            $this->markTestSkipped(sprintf('%s supports inline column comments.', get_class($this->platform)));
1292 1293
        }

Sergei Morozov's avatar
Sergei Morozov committed
1294
        $this->expectException(DBALException::class);
1295 1296
        $this->expectExceptionMessage("Operation 'Doctrine\\DBAL\\Platforms\\AbstractPlatform::getInlineColumnCommentSQL' is not supported by platform.");
        $this->expectExceptionCode(0);
1297

Sergei Morozov's avatar
Sergei Morozov committed
1298
        $this->platform->getInlineColumnCommentSQL('unsupported');
1299 1300
    }

1301
    public function testQuoteStringLiteral() : void
1302
    {
1303 1304
        $c = $this->getStringLiteralQuoteCharacter();

1305
        self::assertEquals(
1306
            $this->getQuotedStringLiteralWithoutQuoteCharacter(),
Sergei Morozov's avatar
Sergei Morozov committed
1307
            $this->platform->quoteStringLiteral('No quote')
1308
        );
1309
        self::assertEquals(
1310
            $this->getQuotedStringLiteralWithQuoteCharacter(),
Sergei Morozov's avatar
Sergei Morozov committed
1311
            $this->platform->quoteStringLiteral('It' . $c . 's a quote')
1312
        );
1313
        self::assertEquals(
1314
            $this->getQuotedStringLiteralQuoteCharacter(),
Sergei Morozov's avatar
Sergei Morozov committed
1315
            $this->platform->quoteStringLiteral($c)
1316
        );
1317
    }
1318 1319 1320 1321

    /**
     * @group DBAL-423
     */
1322
    public function testReturnsGuidTypeDeclarationSQL() : void
1323
    {
1324 1325
        $this->expectException(DBALException::class);

Sergei Morozov's avatar
Sergei Morozov committed
1326
        $this->platform->getGuidTypeDeclarationSQL([]);
1327
    }
1328 1329 1330 1331

    /**
     * @group DBAL-1010
     */
1332
    public function testGeneratesAlterTableRenameColumnSQL() : void
1333 1334 1335 1336 1337
    {
        $table = new Table('foo');
        $table->addColumn(
            'bar',
            'integer',
Sergei Morozov's avatar
Sergei Morozov committed
1338
            ['notnull' => true, 'default' => 666, 'comment' => 'rename test']
1339 1340
        );

Sergei Morozov's avatar
Sergei Morozov committed
1341 1342
        $tableDiff                        = new TableDiff('foo');
        $tableDiff->fromTable             = $table;
1343 1344 1345
        $tableDiff->renamedColumns['bar'] = new Column(
            'baz',
            Type::getType('integer'),
Sergei Morozov's avatar
Sergei Morozov committed
1346
            ['notnull' => true, 'default' => 666, 'comment' => 'rename test']
1347 1348
        );

Sergei Morozov's avatar
Sergei Morozov committed
1349
        self::assertSame($this->getAlterTableRenameColumnSQL(), $this->platform->getAlterTableSQL($tableDiff));
1350 1351 1352
    }

    /**
Sergei Morozov's avatar
Sergei Morozov committed
1353
     * @return string[]
1354
     */
1355
    abstract public function getAlterTableRenameColumnSQL() : array;
1356 1357 1358 1359

    /**
     * @group DBAL-1016
     */
1360
    public function testQuotesTableIdentifiersInAlterTableSQL() : void
1361 1362 1363 1364 1365 1366 1367 1368
    {
        $table = new Table('"foo"');
        $table->addColumn('id', 'integer');
        $table->addColumn('fk', 'integer');
        $table->addColumn('fk2', 'integer');
        $table->addColumn('fk3', 'integer');
        $table->addColumn('bar', 'integer');
        $table->addColumn('baz', 'integer');
Sergei Morozov's avatar
Sergei Morozov committed
1369 1370
        $table->addForeignKeyConstraint('fk_table', ['fk'], ['id'], [], 'fk1');
        $table->addForeignKeyConstraint('fk_table', ['fk2'], ['id'], [], 'fk2');
1371

Sergei Morozov's avatar
Sergei Morozov committed
1372 1373 1374 1375
        $tableDiff                        = new TableDiff('"foo"');
        $tableDiff->fromTable             = $table;
        $tableDiff->newName               = 'table';
        $tableDiff->addedColumns['bloo']  = new Column('bloo', Type::getType('integer'));
1376 1377
        $tableDiff->changedColumns['bar'] = new ColumnDiff(
            'bar',
Sergei Morozov's avatar
Sergei Morozov committed
1378 1379
            new Column('bar', Type::getType('integer'), ['notnull' => false]),
            ['notnull'],
1380 1381
            $table->getColumn('bar')
        );
Sergei Morozov's avatar
Sergei Morozov committed
1382
        $tableDiff->renamedColumns['id']  = new Column('war', Type::getType('integer'));
1383
        $tableDiff->removedColumns['baz'] = new Column('baz', Type::getType('integer'));
Sergei Morozov's avatar
Sergei Morozov committed
1384 1385 1386
        $tableDiff->addedForeignKeys[]    = new ForeignKeyConstraint(['fk3'], 'fk_table', ['id'], 'fk_add');
        $tableDiff->changedForeignKeys[]  = new ForeignKeyConstraint(['fk2'], 'fk_table2', ['id'], 'fk2');
        $tableDiff->removedForeignKeys[]  = new ForeignKeyConstraint(['fk'], 'fk_table', ['id'], 'fk1');
1387

1388
        self::assertSame(
1389
            $this->getQuotesTableIdentifiersInAlterTableSQL(),
Sergei Morozov's avatar
Sergei Morozov committed
1390
            $this->platform->getAlterTableSQL($tableDiff)
1391 1392 1393 1394
        );
    }

    /**
Sergei Morozov's avatar
Sergei Morozov committed
1395
     * @return string[]
1396
     */
1397
    abstract protected function getQuotesTableIdentifiersInAlterTableSQL() : array;
1398 1399 1400 1401

    /**
     * @group DBAL-1090
     */
1402
    public function testAlterStringToFixedString() : void
1403 1404
    {
        $table = new Table('mytable');
Sergei Morozov's avatar
Sergei Morozov committed
1405
        $table->addColumn('name', 'string', ['length' => 2]);
1406

Sergei Morozov's avatar
Sergei Morozov committed
1407
        $tableDiff            = new TableDiff('mytable');
1408 1409
        $tableDiff->fromTable = $table;

Sergei Morozov's avatar
Sergei Morozov committed
1410 1411 1412 1413 1414 1415
        $tableDiff->changedColumns['name'] = new ColumnDiff(
            'name',
            new Column(
                'name',
                Type::getType('string'),
                ['fixed' => true, 'length' => 2]
1416
            ),
Sergei Morozov's avatar
Sergei Morozov committed
1417
            ['fixed']
1418 1419
        );

Sergei Morozov's avatar
Sergei Morozov committed
1420
        $sql = $this->platform->getAlterTableSQL($tableDiff);
1421 1422 1423

        $expectedSql = $this->getAlterStringToFixedStringSQL();

1424
        self::assertEquals($expectedSql, $sql);
1425 1426 1427
    }

    /**
Sergei Morozov's avatar
Sergei Morozov committed
1428
     * @return string[]
1429
     */
1430
    abstract protected function getAlterStringToFixedStringSQL() : array;
1431 1432 1433 1434

    /**
     * @group DBAL-1062
     */
1435
    public function testGeneratesAlterTableRenameIndexUsedByForeignKeySQL() : void
1436 1437 1438
    {
        $foreignTable = new Table('foreign_table');
        $foreignTable->addColumn('id', 'integer');
Sergei Morozov's avatar
Sergei Morozov committed
1439
        $foreignTable->setPrimaryKey(['id']);
1440 1441 1442 1443 1444

        $primaryTable = new Table('mytable');
        $primaryTable->addColumn('foo', 'integer');
        $primaryTable->addColumn('bar', 'integer');
        $primaryTable->addColumn('baz', 'integer');
Sergei Morozov's avatar
Sergei Morozov committed
1445 1446 1447 1448
        $primaryTable->addIndex(['foo'], 'idx_foo');
        $primaryTable->addIndex(['bar'], 'idx_bar');
        $primaryTable->addForeignKeyConstraint($foreignTable, ['foo'], ['id'], [], 'fk_foo');
        $primaryTable->addForeignKeyConstraint($foreignTable, ['bar'], ['id'], [], 'fk_bar');
1449

Sergei Morozov's avatar
Sergei Morozov committed
1450 1451 1452
        $tableDiff                            = new TableDiff('mytable');
        $tableDiff->fromTable                 = $primaryTable;
        $tableDiff->renamedIndexes['idx_foo'] = new Index('idx_foo_renamed', ['foo']);
1453

1454
        self::assertSame(
1455
            $this->getGeneratesAlterTableRenameIndexUsedByForeignKeySQL(),
Sergei Morozov's avatar
Sergei Morozov committed
1456
            $this->platform->getAlterTableSQL($tableDiff)
1457 1458 1459 1460
        );
    }

    /**
Sergei Morozov's avatar
Sergei Morozov committed
1461
     * @return string[]
1462
     */
1463
    abstract protected function getGeneratesAlterTableRenameIndexUsedByForeignKeySQL() : array;
1464 1465

    /**
Sergei Morozov's avatar
Sergei Morozov committed
1466 1467
     * @param mixed[] $column
     *
1468 1469 1470
     * @group DBAL-1082
     * @dataProvider getGeneratesDecimalTypeDeclarationSQL
     */
1471
    public function testGeneratesDecimalTypeDeclarationSQL(array $column, string $expectedSql) : void
1472
    {
Sergei Morozov's avatar
Sergei Morozov committed
1473
        self::assertSame($expectedSql, $this->platform->getDecimalTypeDeclarationSQL($column));
1474 1475 1476
    }

    /**
1477
     * @return mixed[][]
1478
     */
1479
    public static function getGeneratesDecimalTypeDeclarationSQL() : iterable
1480
    {
Sergei Morozov's avatar
Sergei Morozov committed
1481 1482 1483 1484 1485 1486 1487 1488
        return [
            [[], 'NUMERIC(10, 0)'],
            [['unsigned' => true], 'NUMERIC(10, 0)'],
            [['unsigned' => false], 'NUMERIC(10, 0)'],
            [['precision' => 5], 'NUMERIC(5, 0)'],
            [['scale' => 5], 'NUMERIC(10, 5)'],
            [['precision' => 8, 'scale' => 2], 'NUMERIC(8, 2)'],
        ];
1489 1490 1491
    }

    /**
Sergei Morozov's avatar
Sergei Morozov committed
1492 1493
     * @param mixed[] $column
     *
1494 1495 1496
     * @group DBAL-1082
     * @dataProvider getGeneratesFloatDeclarationSQL
     */
1497
    public function testGeneratesFloatDeclarationSQL(array $column, string $expectedSql) : void
1498
    {
Sergei Morozov's avatar
Sergei Morozov committed
1499
        self::assertSame($expectedSql, $this->platform->getFloatDeclarationSQL($column));
1500 1501 1502
    }

    /**
1503
     * @return mixed[][]
1504
     */
1505
    public static function getGeneratesFloatDeclarationSQL() : iterable
1506
    {
Sergei Morozov's avatar
Sergei Morozov committed
1507 1508 1509 1510 1511 1512 1513 1514
        return [
            [[], 'DOUBLE PRECISION'],
            [['unsigned' => true], 'DOUBLE PRECISION'],
            [['unsigned' => false], 'DOUBLE PRECISION'],
            [['precision' => 5], 'DOUBLE PRECISION'],
            [['scale' => 5], 'DOUBLE PRECISION'],
            [['precision' => 8, 'scale' => 2], 'DOUBLE PRECISION'],
        ];
1515
    }
1516 1517 1518 1519 1520

    public function testItEscapesStringsForLike() : void
    {
        self::assertSame(
            '\_25\% off\_ your next purchase \\\\o/',
Sergei Morozov's avatar
Sergei Morozov committed
1521
            $this->platform->escapeStringForLike('_25% off_ your next purchase \o/', '\\')
1522 1523
        );
    }
1524 1525 1526 1527 1528 1529 1530

    public function testZeroOffsetWithoutLimitIsIgnored() : void
    {
        $query = 'SELECT * FROM user';

        self::assertSame(
            $query,
Sergei Morozov's avatar
Sergei Morozov committed
1531
            $this->platform->modifyLimitQuery($query, null, 0)
1532 1533
        );
    }
1534
}