pass options to migration events

laravel · Jan 10, 2025 · 47e33a2 · 47e33a2
1 parent 4b9aeae
commit 47e33a2
Show file tree

Hide file tree

Showing 3 changed files with 69 additions and 5 deletions.
diff --git a/src/Illuminate/Database/Events/MigrationsEvent.php b/src/Illuminate/Database/Events/MigrationsEvent.php
@@ -13,14 +13,23 @@ abstract class MigrationsEvent implements MigrationEventContract
      */
     public $method;
 
+    /**
+     * The options provided when the migration method was invoked.
+     *
+     * @var array<string, mixed>
+     */
+    public $options;
+
     /**
      * Create a new event instance.
      *
      * @param  string  $method
+     * @param  array<string, mixed>  $options
      * @return void
      */
-    public function __construct($method)
+    public function __construct($method, $options)
     {
         $this->method = $method;
+        $this->options = $options;
     }
 }
diff --git a/src/Illuminate/Database/Migrations/Migrator.php b/src/Illuminate/Database/Migrations/Migrator.php
@@ -169,7 +169,7 @@ public function runPending(array $migrations, array $options = [])
 
         $step = $options['step'] ?? false;
 
-        $this->fireMigrationEvent(new MigrationsStarted('up'));
+        $this->fireMigrationEvent(new MigrationsStarted('up', $options));
 
         $this->write(Info::class, 'Running migrations.');
 
@@ -184,7 +184,7 @@ public function runPending(array $migrations, array $options = [])
             }
         }
 
-        $this->fireMigrationEvent(new MigrationsEnded('up'));
+        $this->fireMigrationEvent(new MigrationsEnded('up', $options));
 
         $this->output?->writeln('');
     }
@@ -278,7 +278,7 @@ protected function rollbackMigrations(array $migrations, $paths, array $options)
 
         $this->requireFiles($files = $this->getMigrationFiles($paths));
 
-        $this->fireMigrationEvent(new MigrationsStarted('down'));
+        $this->fireMigrationEvent(new MigrationsStarted('down', $options));
 
         $this->write(Info::class, 'Rolling back migrations.');
 
@@ -302,7 +302,7 @@ protected function rollbackMigrations(array $migrations, $paths, array $options)
             );
         }
 
-        $this->fireMigrationEvent(new MigrationsEnded('down'));
+        $this->fireMigrationEvent(new MigrationsEnded('down', $options));
 
         return $rolledBack;
     }

diff --git a/tests/Integration/Database/MigratorEventsTest.php b/tests/Integration/Database/MigratorEventsTest.php
@@ -34,6 +34,61 @@ public function testMigrationEventsAreFired()
         Event::assertDispatched(MigrationEnded::class, 2);
     }
 
+    public function testMigrationEventsContainTheOptionsAndPretendFalse()
+    {
+        Event::fake();
+
+        $this->artisan('migrate', $this->migrateOptions());
+        $this->artisan('migrate:rollback', $this->migrateOptions());
+
+        Event::assertDispatched(MigrationsStarted::class, function ($event) {
+            return $event->method === 'up'
+                && is_array($event->options)
+                && isset($event->options['pretend'])
+                && $event->options['pretend'] === false;
+        });
+        Event::assertDispatched(MigrationsStarted::class, function ($event) {
+            return $event->method === 'down'
+                && is_array($event->options)
+                && isset($event->options['pretend'])
+                && $event->options['pretend'] === false;
+        });
+        Event::assertDispatched(MigrationsEnded::class, function ($event) {
+            return $event->method === 'up'
+                && is_array($event->options)
+                && isset($event->options['pretend'])
+                && $event->options['pretend'] === false;
+        });
+        Event::assertDispatched(MigrationsEnded::class, function ($event) {
+            return $event->method === 'down'
+                && is_array($event->options)
+                && isset($event->options['pretend'])
+                && $event->options['pretend'] === false;
+        });
+    }
+
+    public function testMigrationEventsContainTheOptionsAndPretendTrue()
+    {
+        Event::fake();
+
+        $this->artisan('migrate', $this->migrateOptions() + ['--pretend' => true]);
+        $this->artisan('migrate:rollback', $this->migrateOptions()); // doesn't support pretend
+
+        Event::assertDispatched(MigrationsStarted::class, function ($event) {
+            return $event->method === 'up'
+                && is_array($event->options)
+                && isset($event->options['pretend'])
+                && $event->options['pretend'] === true;
+        });
+
+        Event::assertDispatched(MigrationsEnded::class, function ($event) {
+            return $event->method === 'up'
+                && is_array($event->options)
+                && isset($event->options['pretend'])
+                && $event->options['pretend'] === true;
+        });
+    }
+
     public function testMigrationEventsContainTheMigrationAndMethod()
     {
         Event::fake();