Merge pull request #16 from EvgenyBarinov/feature/issue15

[feature]:issue15 - add try-catch for run migrations

Author: wolfy-j

src/Migrator.php

@@ -18,6 +18,8 @@
 
 final class Migrator
 {
+    private const DB_DATE_FORMAT = 'Y-m-d H:i:s';
+
     /** @var MigrationConfig */
     private $config;
 
@@ -116,9 +118,10 @@ public function getMigrations(): array
      * Execute one migration and return it's instance.
      *
      * @param CapsuleInterface $capsule
+     *
      * @return null|MigrationInterface
      *
-     * @throws \Throwable
+     * @throws MigrationException
      */
     public function run(CapsuleInterface $capsule = null): ?MigrationInterface
     {
@@ -131,21 +134,37 @@ public function run(CapsuleInterface $capsule = null): ?MigrationInterface
                 continue;
             }
 
-            $capsule = $capsule ?? new Capsule($this->dbal->database($migration->getDatabase()));
-            $capsule->getDatabase($migration->getDatabase())->transaction(
-                static function () use ($migration, $capsule): void {
-                    $migration->withCapsule($capsule)->up();
-                }
-            );
-
-            $this->migrationTable($migration->getDatabase())->insertOne(
-                [
-                    'migration'     => $migration->getState()->getName(),
-                    'time_executed' => new \DateTime('now')
-                ]
-            );
-
-            return $migration->withState($this->resolveState($migration));
+            try {
+                $capsule = $capsule ?? new Capsule($this->dbal->database($migration->getDatabase()));
+                $capsule->getDatabase($migration->getDatabase())->transaction(
+                    static function () use ($migration, $capsule): void {
+                        $migration->withCapsule($capsule)->up();
+                    }
+                );
+
+                $this->migrationTable($migration->getDatabase())->insertOne(
+                    [
+                        'migration' => $migration->getState()->getName(),
+                        'time_executed' => new \DateTime('now')
+                    ]
+                );
+
+                return $migration->withState($this->resolveState($migration));
+            } catch (\Throwable $exception) {
+                throw new MigrationException(
+                    \sprintf(
+                        'Error in the migration (%s) occurred: %s',
+                        \sprintf(
+                            '%s (%s)',
+                            $migration->getState()->getName(),
+                            $migration->getState()->getTimeCreated()->format(self::DB_DATE_FORMAT)
+                        ),
+                        $exception->getMessage()
+                    ),
+                    $exception->getCode(),
+                    $exception
+                );
+            }
         }
 
         return null;

tests/Migrations/AtomizerTest.php

@@ -303,9 +303,6 @@ public function testSetPrimaryKeys(): void
         $this->assertFalse($this->db->hasTable('sample'));
     }
 
-    /**
-     * @expectedException \Spiral\Migrations\Exception\Operation\TableException
-     */
     public function testChangePrimaryKeys(): void
     {
         //Create thought migration
@@ -327,6 +324,13 @@ public function testChangePrimaryKeys(): void
         $schema->setPrimaryKeys(['id']);
 
         $this->atomize('migration2', [$schema]);
+
+        $this->expectException(\Spiral\Migrations\Exception\MigrationException::class);
+        $this->expectExceptionMessageMatches(
+            "/Error in the migration \([0-9a-z_\-]+ \(\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}\)\) occurred: "
+            . "Unable to set primary keys for table \'.+\'\.\'.+\', table already exists/"
+        );
+
         $this->migrator->run();
     }