Fix schema comparison on tables with multiple foreign keys referencing the same tables and columns #7131
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,183 @@ | ||
| <?php | ||
|
|
||
| declare(strict_types=1); | ||
|
|
||
| namespace Doctrine\DBAL\Tests\Functional\Schema; | ||
|
|
||
| use Doctrine\DBAL\Platforms\DB2Platform; | ||
| use Doctrine\DBAL\Platforms\OraclePlatform; | ||
| use Doctrine\DBAL\Schema\AbstractSchemaManager; | ||
| use Doctrine\DBAL\Schema\Column; | ||
| use Doctrine\DBAL\Schema\ForeignKeyConstraint; | ||
| use Doctrine\DBAL\Schema\PrimaryKeyConstraint; | ||
| use Doctrine\DBAL\Schema\Table; | ||
| use Doctrine\DBAL\Tests\FunctionalTestCase; | ||
| use Doctrine\DBAL\Types\Types; | ||
|
|
||
| class DoubleForeignKeyConstraintTest extends FunctionalTestCase | ||
| { | ||
| private AbstractSchemaManager $schemaManager; | ||
|
|
||
| protected function setUp(): void | ||
| { | ||
| $this->schemaManager = $this->connection->createSchemaManager(); | ||
| } | ||
|
|
||
| public function testDoubleForeignKeyConstraint(): void | ||
| { | ||
| $platform = $this->connection->getDatabasePlatform(); | ||
| if ($platform instanceof DB2Platform || $platform instanceof OraclePlatform) { | ||
| self::markTestSkipped('DB2 and Oracle do not allow multiple FKs with the same columns.'); | ||
| } | ||
|
|
||
| $articles = Table::editor() | ||
| ->setUnquotedName('articles') | ||
| ->setColumns( | ||
| Column::editor() | ||
| ->setUnquotedName('id') | ||
| ->setTypeName(Types::INTEGER) | ||
| ->create(), | ||
| ) | ||
| ->setPrimaryKeyConstraint( | ||
| PrimaryKeyConstraint::editor() | ||
| ->setUnquotedColumnNames('id') | ||
| ->create(), | ||
| ) | ||
| ->create(); | ||
|
|
||
| $orders = Table::editor() | ||
| ->setUnquotedName('orders') | ||
| ->setColumns( | ||
| Column::editor() | ||
| ->setUnquotedName('id') | ||
| ->setTypeName(Types::INTEGER) | ||
| ->create(), | ||
| Column::editor() | ||
| ->setUnquotedName('article_id') | ||
| ->setTypeName(Types::INTEGER) | ||
| ->create(), | ||
| ) | ||
| ->setForeignKeyConstraints( | ||
| ForeignKeyConstraint::editor() | ||
| ->setUnquotedName('articles_fk') | ||
|
There was a problem hiding this comment. Should this be named "articles_fk_1" for consistency? |
||
| ->setUnquotedReferencingColumnNames('article_id') | ||
| ->setUnquotedReferencedTableName('articles') | ||
| ->setUnquotedReferencedColumnNames('id') | ||
| ->create(), | ||
| ForeignKeyConstraint::editor() | ||
| ->setUnquotedName('articles_fk_2') | ||
| ->setUnquotedReferencingColumnNames('article_id') | ||
| ->setUnquotedReferencedTableName('articles') | ||
| ->setUnquotedReferencedColumnNames('id') | ||
| ->create(), | ||
| ) | ||
| ->create(); | ||
|
|
||
| $this->dropTableIfExists('orders'); | ||
| $this->dropTableIfExists('articles'); | ||
|
|
||
| $this->connection->createSchemaManager() | ||
| ->createTable($articles); | ||
| $this->connection->createSchemaManager() | ||
| ->createTable($orders); | ||
|
|
||
| $ordersActual = $this->schemaManager->introspectTable('orders'); | ||
|
|
||
| self::assertTrue( | ||
| $this->schemaManager->createComparator() | ||
| ->compareTables($ordersActual, $orders) | ||
| ->isEmpty(), | ||
| ); | ||
| } | ||
|
|
||
| public function testDoubleForeignKeyConstraintComparedToSingle(): void | ||
|
There was a problem hiding this comment. It looks like this test passes even without the fix. There was a problem hiding this comment. This is the regression test @derrabus asked for. |
||
| { | ||
| $platform = $this->connection->getDatabasePlatform(); | ||
| if ($platform instanceof DB2Platform || $platform instanceof OraclePlatform) { | ||
| self::markTestSkipped('DB2 and Oracle do not allow multiple FKs with the same columns.'); | ||
| } | ||
|
|
||
| $articles = Table::editor() | ||
| ->setUnquotedName('articles') | ||
| ->setColumns( | ||
| Column::editor() | ||
| ->setUnquotedName('id') | ||
| ->setTypeName(Types::INTEGER) | ||
| ->create(), | ||
| ) | ||
| ->setPrimaryKeyConstraint( | ||
| PrimaryKeyConstraint::editor() | ||
| ->setUnquotedColumnNames('id') | ||
| ->create(), | ||
| ) | ||
| ->create(); | ||
|
|
||
| $orders = Table::editor() | ||
| ->setUnquotedName('orders') | ||
| ->setColumns( | ||
| Column::editor() | ||
| ->setUnquotedName('id') | ||
| ->setTypeName(Types::INTEGER) | ||
| ->create(), | ||
| Column::editor() | ||
| ->setUnquotedName('article_id') | ||
| ->setTypeName(Types::INTEGER) | ||
| ->create(), | ||
| ) | ||
| ->setForeignKeyConstraints( | ||
| ForeignKeyConstraint::editor() | ||
| ->setUnquotedName('articles_fk') | ||
| ->setUnquotedReferencingColumnNames('article_id') | ||
| ->setUnquotedReferencedTableName('articles') | ||
| ->setUnquotedReferencedColumnNames('id') | ||
| ->create(), | ||
| ForeignKeyConstraint::editor() | ||
| ->setUnquotedName('articles_fk_2') | ||
| ->setUnquotedReferencingColumnNames('article_id') | ||
| ->setUnquotedReferencedTableName('articles') | ||
| ->setUnquotedReferencedColumnNames('id') | ||
| ->create(), | ||
| ) | ||
| ->create(); | ||
|
|
||
| $ordersCompare = Table::editor() | ||
| ->setUnquotedName('orders') | ||
| ->setColumns( | ||
| Column::editor() | ||
| ->setUnquotedName('id') | ||
| ->setTypeName(Types::INTEGER) | ||
| ->create(), | ||
| Column::editor() | ||
| ->setUnquotedName('article_id') | ||
| ->setTypeName(Types::INTEGER) | ||
| ->create(), | ||
| ) | ||
| ->setForeignKeyConstraints( | ||
| ForeignKeyConstraint::editor() | ||
| ->setUnquotedName('articles_fk') | ||
| ->setUnquotedReferencingColumnNames('article_id') | ||
| ->setUnquotedReferencedTableName('articles') | ||
| ->setUnquotedReferencedColumnNames('id') | ||
| ->create(), | ||
| ) | ||
| ->create(); | ||
|
|
||
| $this->dropTableIfExists('orders'); | ||
| $this->dropTableIfExists('articles'); | ||
|
|
||
| $this->connection->createSchemaManager() | ||
| ->createTable($articles); | ||
| $this->connection->createSchemaManager() | ||
| ->createTable($orders); | ||
|
|
||
| $ordersActual = $this->schemaManager->introspectTable('orders'); | ||
|
|
||
| $diff = $this->schemaManager->createComparator() | ||
| ->compareTables($ordersActual, $ordersCompare); | ||
|
|
||
| self::assertFalse($diff->isEmpty()); | ||
| self::assertCount(0, $diff->getAddedForeignKeys()); | ||
| self::assertCount(1, $diff->getDroppedForeignKeys()); | ||
| self::assertSame('articles_fk_2', $diff->getDroppedForeignKeys()[0]->getName()); | ||
| } | ||
| } | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
As I understand, this is the fix. The rest of the lines have been mostly affected to satisfy the coding standard.
The essence of the fix is that once we have found a matching pair of new key / old key, we not only continue the inner loop, we continue the outer one as well. Otherwise, the other equal key will also match.
Is that correct?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes, the
continue 2;is the actual change. It stops comparing the new key when a matching old key has been found.