File: AlterTableTest.php

package info (click to toggle)
php-doctrine-dbal 4.2.3%2Bdfsg-4
  • links: PTS, VCS
  • area: main
  • in suites: forky, trixie
  • size: 4,644 kB
  • sloc: php: 46,471; xml: 460; makefile: 22
file content (256 lines) | stat: -rw-r--r-- 8,800 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
<?php

declare(strict_types=1);

namespace Doctrine\DBAL\Tests\Functional\Schema;

use Doctrine\DBAL\Platforms\AbstractMySQLPlatform;
use Doctrine\DBAL\Platforms\DB2Platform;
use Doctrine\DBAL\Platforms\OraclePlatform;
use Doctrine\DBAL\Platforms\SQLitePlatform;
use Doctrine\DBAL\Platforms\SQLServerPlatform;
use Doctrine\DBAL\Schema\Table;
use Doctrine\DBAL\Tests\FunctionalTestCase;
use Doctrine\DBAL\Types\Types;

class AlterTableTest extends FunctionalTestCase
{
    public function testAddPrimaryKeyOnExistingColumn(): void
    {
        if ($this->connection->getDatabasePlatform() instanceof SQLitePlatform) {
            self::markTestSkipped(
                'SQLite will automatically set up auto-increment behavior on the primary key column, which this test'
                    . ' does not expect.',
            );
        }

        $table = new Table('alter_pk');
        $table->addColumn('id', Types::INTEGER);
        $table->addColumn('val', Types::INTEGER);

        $this->testMigration($table, static function (Table $table): void {
            $table->setPrimaryKey(['id']);
        });
    }

    public function testAddPrimaryKeyOnNewAutoIncrementColumn(): void
    {
        if ($this->connection->getDatabasePlatform() instanceof DB2Platform) {
            self::markTestSkipped(
                'IBM DB2 LUW does not support adding identity columns to an existing table.',
            );
        }

        $table = new Table('alter_pk');
        $table->addColumn('val', Types::INTEGER);

        $this->testMigration($table, static function (Table $table): void {
            $table->addColumn('id', Types::INTEGER, ['autoincrement' => true]);
            $table->setPrimaryKey(['id']);
        });
    }

    public function testAlterPrimaryKeyFromAutoincrementToNonAutoincrementColumn(): void
    {
        $platform = $this->connection->getDatabasePlatform();

        if ($platform instanceof AbstractMySQLPlatform) {
            self::markTestIncomplete(
                'DBAL should not allow this migration on MySQL because an auto-increment column must be part of the'
                    . ' primary key constraint.',
            );
        }

        if ($platform instanceof SQLitePlatform) {
            self::markTestSkipped(
                'SQLite does not support auto-increment columns that are not part the primary key constraint',
            );
        }

        $this->ensureDroppingPrimaryKeyConstraintIsSupported();

        $table = new Table('alter_pk');
        $table->addColumn('id1', Types::INTEGER, ['autoincrement' => true]);
        $table->addColumn('id2', Types::INTEGER);
        $table->setPrimaryKey(['id1']);

        $this->testMigration($table, static function (Table $table): void {
            $table->dropPrimaryKey();
            $table->setPrimaryKey(['id2']);
        });
    }

    public function testDropPrimaryKeyWithAutoincrementColumn(): void
    {
        $platform = $this->connection->getDatabasePlatform();

        if ($platform instanceof AbstractMySQLPlatform) {
            self::markTestIncomplete(
                'DBAL should not allow this migration on MySQL because an auto-increment column must be part of the'
                    . ' primary key constraint.',
            );
        }

        if ($platform instanceof SQLitePlatform) {
            self::markTestSkipped(
                'SQLite does not support auto-increment columns as part of composite primary key constraint',
            );
        }

        $this->ensureDroppingPrimaryKeyConstraintIsSupported();

        $table = new Table('alter_pk');
        $table->addColumn('id1', Types::INTEGER, ['autoincrement' => true]);
        $table->addColumn('id2', Types::INTEGER);
        $table->setPrimaryKey(['id1', 'id2']);

        $this->testMigration($table, static function (Table $table): void {
            $table->dropPrimaryKey();
        });
    }

    public function testDropNonAutoincrementColumnFromCompositePrimaryKeyWithAutoincrementColumn(): void
    {
        if ($this->connection->getDatabasePlatform() instanceof AbstractMySQLPlatform) {
            self::markTestIncomplete(
                'DBAL does not restore the auto-increment attribute after dropping and adding the constraint,'
                    . ' which is a bug.',
            );
        }

        $this->ensureDroppingPrimaryKeyConstraintIsSupported();

        $table = new Table('alter_pk');
        $table->addColumn('id1', Types::INTEGER, ['autoincrement' => true]);
        $table->addColumn('id2', Types::INTEGER);
        $table->setPrimaryKey(['id1', 'id2']);

        $this->testMigration($table, static function (Table $table): void {
            $table->dropPrimaryKey();
            $table->setPrimaryKey(['id1']);
        });
    }

    public function testAddNonAutoincrementColumnToPrimaryKeyWithAutoincrementColumn(): void
    {
        $platform = $this->connection->getDatabasePlatform();

        if ($platform instanceof AbstractMySQLPlatform) {
            self::markTestIncomplete(
                'DBAL does not restore the auto-increment attribute after dropping and adding the constraint,'
                    . ' which is a bug.',
            );
        }

        if ($platform instanceof SQLitePlatform) {
            self::markTestSkipped(
                'SQLite does not support auto-increment columns as part of composite primary key constraint',
            );
        }

        $this->ensureDroppingPrimaryKeyConstraintIsSupported();

        $table = new Table('alter_pk');
        $table->addColumn('id1', Types::INTEGER, ['autoincrement' => true]);
        $table->addColumn('id2', Types::INTEGER);
        $table->setPrimaryKey(['id1']);

        $this->testMigration($table, static function (Table $table): void {
            $table->dropPrimaryKey();
            $table->setPrimaryKey(['id1', 'id2']);
        });
    }

    public function testAddNewColumnToPrimaryKey(): void
    {
        $this->ensureDroppingPrimaryKeyConstraintIsSupported();

        $table = new Table('alter_pk');
        $table->addColumn('id1', Types::INTEGER);
        $table->setPrimaryKey(['id1']);

        $this->testMigration($table, static function (Table $table): void {
            $table->addColumn('id2', Types::INTEGER);
            $table->dropPrimaryKey();
            $table->setPrimaryKey(['id1', 'id2']);
        });
    }

    public function testReplaceForeignKeyConstraint(): void
    {
        $articles = new Table('articles');
        $articles->addColumn('id', Types::INTEGER);
        $articles->addColumn('sku', Types::INTEGER);
        $articles->setPrimaryKey(['id']);
        $articles->addUniqueConstraint(['sku']);

        $orders = new Table('orders');
        $orders->addColumn('id', Types::INTEGER);
        $orders->addColumn('article_id', Types::INTEGER);
        $orders->addColumn('article_sku', Types::INTEGER);
        $orders->addForeignKeyConstraint(
            'articles',
            ['article_id'],
            ['id'],
            [],
            'articles_fk',
        );

        $this->dropTableIfExists('orders');
        $this->dropTableIfExists('articles');

        $this->connection->createSchemaManager()
            ->createTable($articles);

        $this->testMigration($orders, static function (Table $table): void {
            $table->removeForeignKey('articles_fk');
            $table->addForeignKeyConstraint(
                'articles',
                ['article_sku'],
                ['sku'],
                [],
                'articles_fk',
            );
        });
    }

    private function ensureDroppingPrimaryKeyConstraintIsSupported(): void
    {
        $platform = $this->connection->getDatabasePlatform();

        if (
            ! ($platform instanceof DB2Platform)
            && ! ($platform instanceof OraclePlatform)
            && ! ($platform instanceof SQLServerPlatform)
        ) {
            return;
        }

        self::markTestIncomplete(
            'Dropping primary key constraint on the currently used database platform is not implemented.',
        );
    }

    private function testMigration(Table $oldTable, callable $migration): void
    {
        $this->dropAndCreateTable($oldTable);

        $newTable = clone $oldTable;

        $migration($newTable);

        $schemaManager = $this->connection->createSchemaManager();

        $diff = $schemaManager->createComparator()
            ->compareTables($oldTable, $newTable);

        $schemaManager->alterTable($diff);

        $introspectedTable = $schemaManager->introspectTable($newTable->getName());

        $diff = $schemaManager->createComparator()
            ->compareTables($newTable, $introspectedTable);

        self::assertTrue($diff->isEmpty());
    }
}