Prevent destructive commands from running

Author: jasonmccreary

src/Illuminate/Console/Preventable.php

@@ -0,0 +1,38 @@
+<?php
+
+namespace Illuminate\Console;
+
+use function Laravel\Prompts\confirm;
+
+trait Preventable
+{
+    protected static $preventFromRunning = false;
+
+    /**
+     * Whether to prevent command from running.
+     *
+     * @param  bool  $prevent
+     * @return bool
+     */
+    public static function preventFromRunning($prevent = true)
+    {
+        static::$preventFromRunning = $prevent;
+    }
+
+    /**
+     * Determine if the command is prevented from
+     * running and display a warning if so.
+     *
+     * @return bool
+     */
+    protected function preventedFromRunning()
+    {
+        if (! static::$preventFromRunning) {
+            return false;
+        }
+
+        $this->components->warn('Command has been prevented from running in this environment.');
+
+        return true;
+    }
+}

src/Illuminate/Database/Console/Migrations/FreshCommand.php

@@ -4,6 +4,7 @@
 
 use Illuminate\Console\Command;
 use Illuminate\Console\ConfirmableTrait;
+use Illuminate\Console\Preventable;
 use Illuminate\Contracts\Events\Dispatcher;
 use Illuminate\Database\Events\DatabaseRefreshed;
 use Illuminate\Database\Migrations\Migrator;
@@ -13,7 +14,7 @@
 #[AsCommand(name: 'migrate:fresh')]
 class FreshCommand extends Command
 {
-    use ConfirmableTrait;
+    use ConfirmableTrait, Preventable;
 
     /**
      * The console command name.
@@ -56,6 +57,10 @@ public function __construct(Migrator $migrator)
      */
     public function handle()
     {
+        if ($this->preventedFromRunning()) {
+            return 1;
+        }
+
         if (! $this->confirmToProceed()) {
             return 1;
         }

src/Illuminate/Database/Console/Migrations/RefreshCommand.php

@@ -4,6 +4,7 @@
 
 use Illuminate\Console\Command;
 use Illuminate\Console\ConfirmableTrait;
+use Illuminate\Console\Preventable;
 use Illuminate\Contracts\Events\Dispatcher;
 use Illuminate\Database\Events\DatabaseRefreshed;
 use Symfony\Component\Console\Attribute\AsCommand;
@@ -12,7 +13,7 @@
 #[AsCommand(name: 'migrate:refresh')]
 class RefreshCommand extends Command
 {
-    use ConfirmableTrait;
+    use ConfirmableTrait, Preventable;
 
     /**
      * The console command name.
@@ -35,6 +36,10 @@ class RefreshCommand extends Command
      */
     public function handle()
     {
+        if ($this->preventedFromRunning()) {
+            return 1;
+        }
+
         if (! $this->confirmToProceed()) {
             return 1;
         }

src/Illuminate/Database/Console/Migrations/ResetCommand.php

@@ -3,14 +3,15 @@
 namespace Illuminate\Database\Console\Migrations;
 
 use Illuminate\Console\ConfirmableTrait;
+use Illuminate\Console\Preventable;
 use Illuminate\Database\Migrations\Migrator;
 use Symfony\Component\Console\Attribute\AsCommand;
 use Symfony\Component\Console\Input\InputOption;
 
 #[AsCommand(name: 'migrate:reset')]
 class ResetCommand extends BaseCommand
 {
-    use ConfirmableTrait;
+    use ConfirmableTrait, Preventable;
 
     /**
      * The console command name.
@@ -53,6 +54,10 @@ public function __construct(Migrator $migrator)
      */
     public function handle()
     {
+        if ($this->preventedFromRunning()) {
+            return 1;
+        }
+
         if (! $this->confirmToProceed()) {
             return 1;
         }

src/Illuminate/Database/Console/WipeCommand.php

@@ -4,13 +4,14 @@
 
 use Illuminate\Console\Command;
 use Illuminate\Console\ConfirmableTrait;
+use Illuminate\Console\Preventable;
 use Symfony\Component\Console\Attribute\AsCommand;
 use Symfony\Component\Console\Input\InputOption;
 
 #[AsCommand(name: 'db:wipe')]
 class WipeCommand extends Command
 {
-    use ConfirmableTrait;
+    use ConfirmableTrait, Preventable;
 
     /**
      * The console command name.
@@ -33,6 +34,10 @@ class WipeCommand extends Command
      */
     public function handle()
     {
+        if ($this->preventedFromRunning()) {
+            return 1;
+        }
+
         if (! $this->confirmToProceed()) {
             return 1;
         }

tests/Database/DatabaseMigrationRefreshCommandTest.php

@@ -72,6 +72,27 @@ public function testRefreshCommandCallsCommandsWithStep()
         $this->runCommand($command, ['--step' => 2]);
     }
 
+    public function testRefreshCommandExitsWhenPrevented()
+    {
+        $command = new RefreshCommand;
+
+        $app = new ApplicationDatabaseRefreshStub(['path.database' => __DIR__]);
+        $dispatcher = $app->instance(Dispatcher::class, $events = m::mock());
+        $console = m::mock(ConsoleApplication::class)->makePartial();
+        $console->__construct();
+        $command->setLaravel($app);
+        $command->setApplication($console);
+
+        RefreshCommand::preventFromRunning();
+
+        $code = $this->runCommand($command);
+
+        $this->assertSame(1, $code);
+
+        $console->shouldNotHaveBeenCalled();
+        $dispatcher->shouldNotReceive('dispatch');
+    }
+
     protected function runCommand($command, $input = [])
     {
         return $command->run(new ArrayInput($input), new NullOutput);

tests/Database/DatabaseMigrationResetCommandTest.php

@@ -52,6 +52,23 @@ public function testResetCommandCanBePretended()
         $this->runCommand($command, ['--pretend' => true, '--database' => 'foo']);
     }
 
+    public function testRefreshCommandExitsWhenPrevented()
+    {
+        $command = new ResetCommand($migrator = m::mock(Migrator::class));
+
+        $app = new ApplicationDatabaseResetStub(['path.database' => __DIR__]);
+        $app->useDatabasePath(__DIR__);
+        $command->setLaravel($app);
+
+        ResetCommand::preventFromRunning();
+
+        $code = $this->runCommand($command);
+
+        $this->assertSame(1, $code);
+
+        $migrator->shouldNotHaveBeenCalled();
+    }
+
     protected function runCommand($command, $input = [])
     {
         return $command->run(new ArrayInput($input), new NullOutput);