[12.x] add 'dry-run' option for schedule:run

src/Illuminate/Console/Scheduling/ScheduleRunCommand.php

@@ -26,7 +26,9 @@ class ScheduleRunCommand extends Command
      *
      * @var string
      */
-    protected $signature = 'schedule:run {--whisper : Do not output message indicating that no jobs were ready to run}';
+    protected $signature = 'schedule:run
+        {--whisper : Do not output message indicating that no jobs were ready to run}
+        {--dry-run : Display scheduled commands without executing them}';
 
     /**
      * The console command description.
@@ -56,6 +58,13 @@ class ScheduleRunCommand extends Command
      */
     protected $eventsRan = false;
 
+    /**
+     * Print commands without executing them.
+     *
+     * @var bool
+     */
+    protected $dryRun = false;
+
     /**
      * The event dispatcher.
      *
@@ -110,13 +119,15 @@ public function handle(Schedule $schedule, Dispatcher $dispatcher, Cache $cache,
         $this->cache = $cache;
         $this->handler = $handler;
         $this->phpBinary = Application::phpBinary();
+        $this->dryRun = $this->option('dry-run');
 
         $events = $this->schedule->dueEvents($this->laravel);
 
         if ($events->contains->isRepeatable()) {
             $this->clearInterruptSignal();
         }
 
+        /* @var  Event $event */
         foreach ($events as $event) {
             if (! $event->filtersPass($this->laravel)) {
                 $this->dispatcher->dispatch(new ScheduledTaskSkipped($event));
@@ -128,7 +139,9 @@ public function handle(Schedule $schedule, Dispatcher $dispatcher, Cache $cache,
                 $this->newLine();
             }
 
-            if ($event->onOneServer) {
+            if ($this->dryRun) {
+                $this->outputDryRunMessage($event);
+            } elseif ($event->onOneServer) {
                 $this->runSingleServerEvent($event);
             } else {
                 $this->runEvent($event);
@@ -254,7 +267,9 @@ protected function repeatEvents($events)
                     continue;
                 }
 
-                if ($event->onOneServer) {
+                if ($this->dryRun) {
+                    $this->outputDryRunMessage($event);
+                } elseif ($event->onOneServer) {
                     $this->runSingleServerEvent($event);
                 } else {
                     $this->runEvent($event);
@@ -286,4 +301,25 @@ protected function clearInterruptSignal()
     {
         $this->cache->forget('illuminate:schedule:interrupt');
     }
+
+    /**
+     * Output a formatted message indicating a scheduled task is skipped in dry-run mode.
+     *
+     * @param  \Illuminate\Console\Scheduling\Event  $event
+     * @return void
+     */
+    private function outputDryRunMessage(Event $event)
+    {
+        $summary = $event->getSummaryForDisplay();
+
+        $command = $event instanceof CallbackEvent
+            ? $summary
+            : trim(str_replace($this->phpBinary, '', $event->command));
+
+        $this->components->info(sprintf(
+            '<fg=gray>%s</> Skipping [%s], because the scheduler is started with the dry-run option.',
+            Carbon::now()->format('Y-m-d H:i:s'),
+            $command
+        ));
+    }
 }