[10.x] Add WithConsoleEvents helper (#46694)

* [10.x] Add `WithConsoleEvents` helper

Make it easier to register console events on specific test without
adding a massive memory leak and make it easier to be documented.

fixes #46693

Signed-off-by: Mior Muhammad Zaki <[email protected]>

* wip

Signed-off-by: Mior Muhammad Zaki <[email protected]>

* wip

Signed-off-by: Mior Muhammad Zaki <[email protected]>

---------

Signed-off-by: Mior Muhammad Zaki <[email protected]>

Author: crynobone

composer.json

@@ -103,7 +103,7 @@
         "league/flysystem-read-only": "^3.3",
         "league/flysystem-sftp-v3": "^3.0",
         "mockery/mockery": "^1.5.1",
-        "orchestra/testbench-core": "^8.3",
+        "orchestra/testbench-core": "^8.4",
         "pda/pheanstalk": "^4.0",
         "phpstan/phpdoc-parser": "^1.15",
         "phpstan/phpstan": "^1.4.7",

src/Illuminate/Foundation/Console/Kernel.php

@@ -118,11 +118,11 @@ public function __construct(Application $app, Dispatcher $events)
         $this->app = $app;
         $this->events = $events;
 
-        if (! $this->app->runningUnitTests()) {
-            $this->rerouteSymfonyCommandEvents();
-        }
-
         $this->app->booted(function () {
+            if (! $this->app->runningUnitTests()) {
+                $this->rerouteSymfonyCommandEvents();
+            }
+
             $this->defineConsoleSchedule();
         });
     }

src/Illuminate/Foundation/Testing/WithConsoleEvents.php

@@ -0,0 +1,18 @@
+<?php
+
+namespace Illuminate\Foundation\Testing;
+
+use Illuminate\Contracts\Console\Kernel as ConsoleKernel;
+
+trait WithConsoleEvents
+{
+    /**
+     * Register console events.
+     *
+     * @return void
+     */
+    protected function setUpWithConsoleEvents()
+    {
+        $this->app[ConsoleKernel::class]->rerouteSymfonyCommandEvents();
+    }
+}

tests/Integration/Console/CommandEventsTest.php

@@ -7,13 +7,16 @@
 use Illuminate\Contracts\Console\Kernel as ConsoleKernel;
 use Illuminate\Events\Dispatcher;
 use Illuminate\Filesystem\Filesystem;
+use Illuminate\Foundation\Testing\WithConsoleEvents;
 use Illuminate\Support\Facades\Event;
 use Illuminate\Support\Str;
 use Orchestra\Testbench\Foundation\Application as Testbench;
 use Orchestra\Testbench\TestCase;
 
 class CommandEventsTest extends TestCase
 {
+    use WithConsoleEvents;
+
     /**
      * The path to the file that execution logs will be written to.
      *
@@ -45,17 +48,6 @@ protected function setUp(): void
         parent::setUp();
     }
 
-    /**
-     * Define environment setup.
-     *
-     * @param  \Illuminate\Foundation\Application  $app
-     * @return void
-     */
-    protected function defineEnvironment($app)
-    {
-        $app->make(ConsoleKernel::class)->rerouteSymfonyCommandEvents();
-    }
-
     /**
      * @dataProvider foregroundCommandEventsProvider
      */