Create migration repository table automatically

Author: stevebauman

README.md

@@ -22,12 +22,6 @@ Publish the migration configuration:
 php artisan vendor:publish --provider="DirectoryTree\OpenSearchMigrations\OpenSearchMigrationsServiceProvider"
 ```
 
-Run Laravel migrations to create the OpenSearch migrations table:
-
-```bash
-php artisan migrate
-```
-
 ## Configuration
 
 The migration configuration is published to `config/opensearch-migrations.php`:

database/migrations/2019_15_12_112000_create_opensearch_migrations_table.php

@@ -78,8 +78,6 @@ public function boot(): void
             __DIR__.'/../config/opensearch-migrations.php' => config_path('opensearch-migrations.php'),
         ]);
 
-        $this->loadMigrationsFrom(__DIR__.'/../database/migrations');
-
         $this->commands($this->commands);
     }
 }

src/OpenSearchMigrationsServiceProvider.php

@@ -4,6 +4,7 @@
 
 use DirectoryTree\OpenSearchMigrations\ReadinessInterface;
 use Illuminate\Database\Query\Builder;
+use Illuminate\Database\Schema\Blueprint;
 use Illuminate\Support\Collection;
 use Illuminate\Support\Facades\DB;
 use Illuminate\Support\Facades\Schema;
@@ -71,6 +72,18 @@ public function truncate(): void
         $this->table()->truncate();
     }
 
+    /**
+     * Create the migration repository table.
+     */
+    public function create(): void
+    {
+        Schema::connection($this->connection)->create($this->table, function (Blueprint $table) {
+            $table->increments('id');
+            $table->string('migration');
+            $table->integer('batch');
+        });
+    }
+
     /**
      * Get the latest migration batch number.
      */
@@ -123,6 +136,10 @@ protected function table(): Builder
      */
     public function isReady(): bool
     {
+        if (! Schema::connection($this->connection)->hasTable($this->table)) {
+            $this->create();
+        }
+
         return Schema::connection($this->connection)->hasTable($this->table);
     }
 }

src/Repositories/MigrationRepository.php

@@ -2,6 +2,7 @@
 
 use DirectoryTree\OpenSearchMigrations\Facades\Index;
 use DirectoryTree\OpenSearchMigrations\Migrator;
+use DirectoryTree\OpenSearchMigrations\Repositories\MigrationRepository;
 use Illuminate\Console\OutputStyle;
 use Illuminate\Foundation\Testing\RefreshDatabase;
 use Illuminate\Support\Facades\DB;
@@ -13,6 +14,8 @@ function seededMigrator(OutputStyle $output): array
 {
     $table = config('opensearch-migrations.table');
 
+    app(MigrationRepository::class)->isReady();
+
     DB::table($table)->insert([
         ['migration' => '2018_12_01_081000_create_test_index', 'batch' => 1],
     ]);
@@ -223,13 +226,14 @@ function outputExpectingLines(array $lines): OutputStyle
     expect($migrator->isReady())->toBeTrue();
 });
 
-it('is not ready when the repository is not ready', function (): void {
-    $output = outputExpectingLines(['<error>Migration table is not yet created</error>']);
+it('creates the repository table when checking readiness', function (): void {
+    $output = Mockery::mock(OutputStyle::class);
     [$table, $migrator] = seededMigrator($output);
 
     Schema::drop($table);
 
-    expect($migrator->isReady())->toBeFalse();
+    expect($migrator->isReady())->toBeTrue();
+    expect(Schema::hasTable($table))->toBeTrue();
 });
 
 it('is not ready when the storage is not ready', function (): void {

tests/Integration/MigratorTest.php

@@ -10,6 +10,9 @@
 function seedMigrationRepositoryTable(): string
 {
     $table = config('opensearch-migrations.table');
+    $repository = app(MigrationRepository::class);
+
+    $repository->isReady();
 
     DB::table($table)->insert([
         ['migration' => '2019_08_10_142230_update_test_index_mapping', 'batch' => 2],
@@ -19,6 +22,16 @@ function seedMigrationRepositoryTable(): string
     return $table;
 }
 
+it('creates the repository table when it is missing', function (): void {
+    $table = config('opensearch-migrations.table');
+
+    expect(Schema::hasTable($table))->toBeFalse();
+
+    expect(app(MigrationRepository::class)->isReady())->toBeTrue();
+
+    expect(Schema::hasTable($table))->toBeTrue();
+});
+
 it('inserts records', function (): void {
     $table = seedMigrationRepositoryTable();
     $repository = app(MigrationRepository::class);
@@ -42,7 +55,7 @@ function seedMigrationRepositoryTable(): string
     expect(DB::table($table)->max('id'))->toBe(3);
 });
 
-it('uses the configured database connection for the table migration', function (): void {
+it('uses the configured database connection for the repository table', function (): void {
     seedMigrationRepositoryTable();
 
     config()->set('database.connections.opensearch_migrations', [
@@ -53,16 +66,12 @@ function seedMigrationRepositoryTable(): string
     config()->set('opensearch-migrations.connection', 'opensearch_migrations');
     config()->set('opensearch-migrations.table', 'custom_opensearch_migrations');
 
-    $migration = require dirname(__DIR__, 3).'/database/migrations/2019_15_12_112000_create_opensearch_migrations_table.php';
+    $repository = app(MigrationRepository::class);
 
-    $migration->up();
+    $repository->isReady();
 
     expect(Schema::hasTable('custom_opensearch_migrations'))->toBeFalse();
     expect(Schema::connection('opensearch_migrations')->hasTable('custom_opensearch_migrations'))->toBeTrue();
-
-    $migration->down();
-
-    expect(Schema::connection('opensearch_migrations')->hasTable('custom_opensearch_migrations'))->toBeFalse();
 });
 
 it('checks whether records exist', function (): void {
@@ -120,12 +129,13 @@ function seedMigrationRepositoryTable(): string
     expect(app(MigrationRepository::class)->isReady())->toBeTrue();
 });
 
-it('is not ready when the table does not exist', function (): void {
+it('is ready after creating a missing table', function (): void {
     $table = seedMigrationRepositoryTable();
 
     Schema::drop($table);
 
-    expect(app(MigrationRepository::class)->isReady())->toBeFalse();
+    expect(app(MigrationRepository::class)->isReady())->toBeTrue();
+    expect(Schema::hasTable($table))->toBeTrue();
 });
 
 it('deletes all records', function (): void {