Make compared tables order idempotent

lib/Doctrine/Migrations/Provider/OrmSchemaProvider.php

@@ -4,11 +4,14 @@
 
 namespace Doctrine\Migrations\Provider;
 
+use Doctrine\Common\Persistence\Mapping\ClassMetadata;
 use Doctrine\DBAL\Schema\Schema;
 use Doctrine\Migrations\Provider\Exception\NoMappingFound;
 use Doctrine\ORM\EntityManagerInterface;
 use Doctrine\ORM\Tools\SchemaTool;
 use function count;
+use function method_exists;
+use function usort;
 
 /**
  * The OrmSchemaProvider class is responsible for creating a Doctrine\DBAL\Schema\Schema instance from the mapping
@@ -38,6 +41,14 @@ public function createSchema() : Schema
             throw NoMappingFound::new();
         }
 
+        usort($metadata, static function (ClassMetadata $a, ClassMetadata $b) {
+            if (method_exists($a, 'getTableName') && method_exists($b, 'getTableName')) {
+                return $a->getTableName() <=> $b->getTableName();
+            }
+
+            return $a->getName() <=> $b->getName();
+        });
+
         $tool = new SchemaTool($this->entityManager);
 
         return $tool->getSchemaFromMetadata($metadata);

tests/Doctrine/Migrations/Tests/Provider/SampleEntity.php → tests/Doctrine/Migrations/Tests/Provider/A.php

@@ -4,7 +4,7 @@
 
 namespace Doctrine\Migrations\Tests\Provider;
 
-class SampleEntity
+class A
 {
     /** @var int|null */
     private $id;

tests/Doctrine/Migrations/Tests/Provider/B.php

@@ -0,0 +1,16 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Doctrine\Migrations\Tests\Provider;
+
+class B
+{
+    /** @var int|null */
+    private $id;
+
+    public function getId() : ?int
+    {
+        return $this->id;
+    }
+}

tests/Doctrine/Migrations/Tests/Provider/C.php

@@ -0,0 +1,16 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Doctrine\Migrations\Tests\Provider;
+
+class C
+{
+    /** @var int|null */
+    private $id;
+
+    public function getId() : ?int
+    {
+        return $this->id;
+    }
+}

tests/Doctrine/Migrations/Tests/Provider/ClassMetadataFactory.php

@@ -0,0 +1,20 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Doctrine\Migrations\Tests\Provider;
+
+use Doctrine\Common\Persistence\Mapping\ClassMetadata;
+use Doctrine\ORM\Mapping\ClassMetadataFactory as BaseMetadataFactoryAlias;
+use function array_reverse;
+
+class ClassMetadataFactory extends BaseMetadataFactoryAlias
+{
+    /**
+     * @return ClassMetadata[]
+     */
+    public function getAllMetadata() : array
+    {
+        return array_reverse(parent::getAllMetadata());
+    }
+}

tests/Doctrine/Migrations/Tests/Provider/OrmSchemaProviderTest.php

@@ -34,9 +34,20 @@ class OrmSchemaProviderTest extends MigrationTestCase
     public function testCreateSchemaFetchesMetadataFromEntityManager() : void
     {
         $schema = $this->ormProvider->createSchema();
-        self::assertTrue($schema->hasTable('sample_entity'));
-        $table = $schema->getTable('sample_entity');
-        self::assertTrue($table->hasColumn('id'));
+
+        self::assertSame(
+            [
+                'public.a',
+                'public.b',
+                'public.c',
+            ],
+            $schema->getTableNames()
+        );
+
+        foreach (['a', 'b', 'c'] as $expectedTable) {
+            $table = $schema->getTable($expectedTable);
+            self::assertTrue($table->hasColumn('id'));
+        }
     }
 
     public function testEntityManagerWithoutMetadataCausesError() : void
@@ -50,8 +61,10 @@ public function testEntityManagerWithoutMetadataCausesError() : void
 
     protected function setUp() : void
     {
+        $this->config = Setup::createXMLMetadataConfiguration([__DIR__ . '/_files'], true);
+        $this->config->setClassMetadataFactoryName(ClassMetadataFactory::class);
+
         $this->conn          = $this->getSqliteConnection();
-        $this->config        = Setup::createXMLMetadataConfiguration([__DIR__ . '/_files'], true);
         $this->entityManager = EntityManager::create($this->conn, $this->config);
         $this->ormProvider   = new OrmSchemaProvider($this->entityManager);
     }

tests/Doctrine/Migrations/Tests/Provider/_files/Doctrine.Migrations.Tests.Provider.SampleEntity.dcm.xml → tests/Doctrine/Migrations/Tests/Provider/_files/Doctrine.Migrations.Tests.Provider.A.dcm.xml

@@ -3,7 +3,7 @@
       xsi:schemaLocation="http://doctrine-project.org/schemas/orm/doctrine-mapping
                    https://raw.github.com/doctrine/doctrine2/master/doctrine-mapping.xsd">
 
-   <entity name="Doctrine\Migrations\Tests\Provider\SampleEntity" table="sample_entity">
+   <entity name="Doctrine\Migrations\Tests\Provider\A" table="a">
        <id name="id" type="integer" column="id">
            <generator strategy="AUTO" />
        </id>

tests/Doctrine/Migrations/Tests/Provider/_files/Doctrine.Migrations.Tests.Provider.B.dcm.xml

@@ -0,0 +1,12 @@
+<doctrine-mapping xmlns="http://doctrine-project.org/schemas/orm/doctrine-mapping"
+      xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+      xsi:schemaLocation="http://doctrine-project.org/schemas/orm/doctrine-mapping
+                   https://raw.github.com/doctrine/doctrine2/master/doctrine-mapping.xsd">
+
+   <entity name="Doctrine\Migrations\Tests\Provider\B" table="b">
+       <id name="id" type="integer" column="id">
+           <generator strategy="AUTO" />
+       </id>
+   </entity>
+
+</doctrine-mapping>

tests/Doctrine/Migrations/Tests/Provider/_files/Doctrine.Migrations.Tests.Provider.C.dcm.xml

@@ -0,0 +1,12 @@
+<doctrine-mapping xmlns="http://doctrine-project.org/schemas/orm/doctrine-mapping"
+      xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+      xsi:schemaLocation="http://doctrine-project.org/schemas/orm/doctrine-mapping
+                   https://raw.github.com/doctrine/doctrine2/master/doctrine-mapping.xsd">
+
+   <entity name="Doctrine\Migrations\Tests\Provider\C" table="c">
+       <id name="id" type="integer" column="id">
+           <generator strategy="AUTO" />
+       </id>
+   </entity>
+
+</doctrine-mapping>