Automatically add event description when scheduling a command (#40286)

laravel · Jan 7, 2022 · 0fb801a · 0fb801a
1 parent bed54df
commit 0fb801a
Show file tree

Hide file tree

Showing 2 changed files with 22 additions and 1 deletion.
diff --git a/src/Illuminate/Console/Scheduling/Schedule.php b/src/Illuminate/Console/Scheduling/Schedule.php
@@ -120,7 +120,11 @@ public function call($callback, array $parameters = [])
     public function command($command, array $parameters = [])
     {
         if (class_exists($command)) {
-            $command = Container::getInstance()->make($command)->getName();
+            $command = Container::getInstance()->make($command);
+
+            return $this->exec(
+                Application::formatCommandString($command->getName()), $parameters,
+            )->description($command->getDescription());
         }
 
         return $this->exec(

diff --git a/tests/Console/ConsoleEventSchedulerTest.php b/tests/Console/ConsoleEventSchedulerTest.php
@@ -120,6 +120,21 @@ public function testCreateNewArtisanCommandUsingCommandClass()
         $this->assertEquals($binary.' '.$artisan.' foo:bar --force', $events[0]->command);
     }
 
+    public function testItUsesCommandDescriptionAsEventDescription()
+    {
+        $schedule = $this->schedule;
+        $event = $schedule->command(ConsoleCommandStub::class);
+        $this->assertEquals('This is a description about the command', $event->description);
+    }
+
+    public function testItShouldBePossibleToOverwriteTheDescription()
+    {
+        $schedule = $this->schedule;
+        $event = $schedule->command(ConsoleCommandStub::class)
+            ->description('This is an alternative description');
+        $this->assertEquals('This is an alternative description', $event->description);
+    }
+
     public function testCallCreatesNewJobWithTimezone()
     {
         $schedule = new Schedule('UTC');
@@ -148,6 +163,8 @@ class ConsoleCommandStub extends Command
 {
     protected $signature = 'foo:bar';
 
+    protected $description = 'This is a description about the command';
+
     protected $foo;
 
     public function __construct(FooClassStub $foo)