Added migration status events.

triadev · Oct 14, 2018 · 0024d5c · 0024d5c
1 parent 4d20000
commit 0024d5c
Show file tree

Hide file tree

Showing 6 changed files with 128 additions and 20 deletions.
diff --git a/README.md b/README.md
@@ -64,16 +64,29 @@ The package is registered through the package discovery of laravel and Composer.
 - deleteByQuery
 - updateByQuery
 
-### Start migration
+### Commands
+
+#### Start migration
 Orchestra migrations
 >php artisan triadev:elasticsearch:migrate:start VERSIONS
 
 Example:
 >php artisan triadev:elasticsearch:migrate:start migration1,migration2,migration3
 
-### Show migrations
+#### Show migrations
 >php artisan triadev:elasticsearch:migration:show
 
+### Events
+[Documentation: Laravel Events](https://laravel.com/docs/5.7/events)
+
+Namespace: Triadev\EsMigration\Business\Events
+
+| Event        | Status  |
+|:-------------:|:-----:|
+| MigrationRunning | Migration is running |
+| MigrationError | Migration is failed |
+| MigrationDone | Migration is done |
+
 ## Roadmap
 - create/delete templates
 - shrink index

diff --git a/src/Business/Events/MigrationDone.php b/src/Business/Events/MigrationDone.php
@@ -1,10 +1,30 @@
 <?php
 namespace Triadev\EsMigration\Business\Events;
 
+use Illuminate\Queue\SerializesModels;
+use Triadev\EsMigration\Models\Entity\ElasticsearchMigration;
+
 class MigrationDone
 {
-    public function __construct()
+    use SerializesModels;
+
+    /** @var ElasticsearchMigration */
+    private $migration;
+
+    /**
+     * MigrationDone constructor.
+     * @param ElasticsearchMigration $migration
+     */
+    public function __construct(ElasticsearchMigration $migration)
     {
+        $this->migration = $migration;
+    }
 
+    /**
+     * @return ElasticsearchMigration
+     */
+    public function getMigration(): ElasticsearchMigration
+    {
+        return $this->migration;
     }
 }
diff --git a/src/Business/Events/MigrationError.php b/src/Business/Events/MigrationError.php
@@ -1,10 +1,30 @@
 <?php
 namespace Triadev\EsMigration\Business\Events;
 
+use Illuminate\Queue\SerializesModels;
+use Triadev\EsMigration\Models\Entity\ElasticsearchMigration;
+
 class MigrationError
 {
-    public function __construct()
+    use SerializesModels;
+
+    /** @var ElasticsearchMigration */
+    private $migration;
+
+    /**
+     * MigrationError constructor.
+     * @param ElasticsearchMigration $migration
+     */
+    public function __construct(ElasticsearchMigration $migration)
     {
+        $this->migration = $migration;
+    }
 
+    /**
+     * @return ElasticsearchMigration
+     */
+    public function getMigration(): ElasticsearchMigration
+    {
+        return $this->migration;
     }
 }
diff --git a/src/Business/Events/MigrationRunning.php b/src/Business/Events/MigrationRunning.php
@@ -1,10 +1,30 @@
 <?php
 namespace Triadev\EsMigration\Business\Events;
 
+use Illuminate\Queue\SerializesModels;
+use Triadev\EsMigration\Models\Entity\ElasticsearchMigration;
+
 class MigrationRunning
 {
-    public function __construct()
+    use SerializesModels;
+
+    /** @var ElasticsearchMigration */
+    private $migration;
+
+    /**
+     * MigrationRunning constructor.
+     * @param ElasticsearchMigration $migration
+     */
+    public function __construct(ElasticsearchMigration $migration)
     {
+        $this->migration = $migration;
+    }
 
+    /**
+     * @return ElasticsearchMigration
+     */
+    public function getMigration(): ElasticsearchMigration
+    {
+        return $this->migration;
     }
 }
diff --git a/src/Business/Repository/ElasticsearchMigration.php b/src/Business/Repository/ElasticsearchMigration.php
@@ -2,6 +2,9 @@
 namespace Triadev\EsMigration\Business\Repository;
 
 use Illuminate\Database\Eloquent\Collection;
+use Triadev\EsMigration\Business\Events\MigrationDone;
+use Triadev\EsMigration\Business\Events\MigrationError;
+use Triadev\EsMigration\Business\Events\MigrationRunning;
 use Triadev\EsMigration\Contract\Repository\ElasticsearchMigrationContract;
 
 class ElasticsearchMigration implements ElasticsearchMigrationContract
@@ -26,6 +29,8 @@ public function createOrUpdate(
 
         $dbMigration->saveOrFail();
 
+        $this->dispatchStatus($dbMigration);
+
         return $dbMigration;
     }
 
@@ -72,4 +77,26 @@ private function isStatusValid(int $status) : bool
 
         return false;
     }
+
+    private function dispatchStatus(\Triadev\EsMigration\Models\Entity\ElasticsearchMigration $migration)
+    {
+        switch ($migration->status) {
+            case self::ELASTICSEARCH_MIGRATION_STATUS_RUNNING:
+                $event = new MigrationRunning($migration);
+                break;
+            case self::ELASTICSEARCH_MIGRATION_STATUS_DONE:
+                $event = new MigrationDone($migration);
+                break;
+            case self::ELASTICSEARCH_MIGRATION_STATUS_ERROR:
+                $event = new MigrationError($migration);
+                break;
+            default:
+                $event = null;
+                break;
+        }
+
+        if ($event) {
+            event($event);
+        }
+    }
 }
diff --git a/tests/integration/Business/Repository/ElasticsearchMigrationTest.php b/tests/integration/Business/Repository/ElasticsearchMigrationTest.php
@@ -2,6 +2,9 @@
 namespace Tests\Integration\Business\Repository;
 
 use Tests\TestCase;
+use Triadev\EsMigration\Business\Events\MigrationDone;
+use Triadev\EsMigration\Business\Events\MigrationError;
+use Triadev\EsMigration\Business\Events\MigrationRunning;
 use Triadev\EsMigration\Contract\Repository\ElasticsearchMigrationContract;
 use Triadev\EsMigration\Contract\Repository\ElasticsearchMigrationsContract;
 use Triadev\EsMigration\Models\Entity\ElasticsearchMigration;
@@ -42,26 +45,31 @@ public function it_creates_a_migration()
      */
     public function it_updates_a_migration()
     {
-        $this->repository->createOrUpdate('1.0.0');
+        $this->expectsEvents([
+            MigrationRunning::class,
+            MigrationError::class,
+            MigrationDone::class
+        ]);
 
-        $this->assertEquals(
-            ElasticsearchMigrationContract::ELASTICSEARCH_MIGRATION_STATUS_WAIT,
-            $this->repository->find('1.0.0')->status
-        );
+        // WAIT
+        $this->repository->createOrUpdate('1.0.0');
+        $this->assertEquals(ElasticsearchMigrationContract::ELASTICSEARCH_MIGRATION_STATUS_WAIT, $this->repository->find('1.0.0')->status);
 
+        // ERROR
+        $this->repository->createOrUpdate('1.0.0', ElasticsearchMigrationContract::ELASTICSEARCH_MIGRATION_STATUS_ERROR);
+        $this->assertEquals(ElasticsearchMigrationContract::ELASTICSEARCH_MIGRATION_STATUS_ERROR, $this->repository->find('1.0.0')->status);
+
+        // RUNNING
+        $this->repository->createOrUpdate('1.0.0', ElasticsearchMigrationContract::ELASTICSEARCH_MIGRATION_STATUS_RUNNING);
+        $this->assertEquals(ElasticsearchMigrationContract::ELASTICSEARCH_MIGRATION_STATUS_RUNNING, $this->repository->find('1.0.0')->status);
+
+        // DONE
         $this->repository->createOrUpdate('1.0.0', ElasticsearchMigrationContract::ELASTICSEARCH_MIGRATION_STATUS_DONE);
+        $this->assertEquals(ElasticsearchMigrationContract::ELASTICSEARCH_MIGRATION_STATUS_DONE, $this->repository->find('1.0.0')->status);
 
-        $this->assertEquals(
-            ElasticsearchMigrationContract::ELASTICSEARCH_MIGRATION_STATUS_DONE,
-            $this->repository->find('1.0.0')->status
-        );
-
+        // DONE => invalid status id
         $this->repository->createOrUpdate('1.0.0', 999);
-
-        $this->assertEquals(
-            ElasticsearchMigrationContract::ELASTICSEARCH_MIGRATION_STATUS_DONE,
-            $this->repository->find('1.0.0')->status
-        );
+        $this->assertEquals(ElasticsearchMigrationContract::ELASTICSEARCH_MIGRATION_STATUS_DONE, $this->repository->find('1.0.0')->status);
     }
 
     /**