Tests does not trigger CommandFinished

[camohub]

Laravel Version

12.0

PHP Version

8.2.6

Database Driver & Version

No response

Description

I would like to use Illuminate\Console\Events\CommandFinished to handle all tests result as one bunch of data. So I decided to use CommandFinished which seems to fit perfectly my needs. BUT as I found out this event works fine with any other artisan commands but not with test command. I made some simple logs in listener handle method and as I said every artisan command works fine BUT test command does not trigger the event.

Steps To Reproduce

I have CommanfFinishedListener class which listen for CommandFinished event registered. I see the listener is registered properly. I also see the listern and event works fine with any other artisan commands but not with test command. This is my

<?php

namespace App\Listeners;


use App\Services\BaseService;
use Illuminate\Console\Events\CommandFinished;
use Illuminate\Support\Facades\DB;
use Illuminate\Support\Facades\File;
use Illuminate\Support\Facades\Log;


class CommandFinishedListener
{
    /**
     * Create the event listener.
     */
    public function __construct()
    {
        //
    }

    /**
     * Handle the event.
     */
    public function handle(CommandFinished $event)
    {
        Log::info('111111111111111');  // I see this log for any other command BUT NOT for test command
        Log::info('CommandFinishedListener: ' . $event->command);

        if ( $event->command === 'test' ) {
            Log::info('2222222222222');  // This is never logged anywhere
        }
    }
}

[crynobone]

See https://laravel.com/docs/12.x/console-tests#console-events

[camohub]

Of course I know about this BUT it also does not work. I have Illuminate\Foundation\Testing\WithConsoleEvents trait included in my test classes. You can run it?
This is parent class for every Test...

<?php

namespace Tests;


use Database\Seeders\TestsSeeders\TestDatabaseSeeder;
use Illuminate\Foundation\Testing\RefreshDatabase;
use Illuminate\Foundation\Testing\TestCase as BaseTestCase;
use Illuminate\Foundation\Testing\WithConsoleEvents;
use Illuminate\Support\Facades\Log;


abstract class TestCase extends BaseTestCase
{
    /** Clear the database */
    use RefreshDatabase;

    /** This is necessary because tests does not trigger CommandFinished event by default */
    use WithConsoleEvents;

    /**
     * Indicates whether the default seeder should run before each test.
     *
     * With ParallelTestingExtendedServiceProvider, each parallel process gets its own
     * isolated databases (resources_test_1.sqlite, resources_test_2.sqlite, etc.)
     * Laravel will automatically seed these databases using the seeder below.
     */
    protected $seed = true;

    /**
     * The seeder class to run before each test.
     */
    protected $seeder = TestDatabaseSeeder::class;

    /**
     * @return void
     */
    protected function tearDown(): void
    {
        // some custom logic....
    }

}

[ismaildasci]

Hey there!

This is actually expected behavior in Laravel - by default, CommandStarting and CommandFinished events are not dispatched during tests. Laravel does this intentionally for test isolation.

The fix is simple - just add the WithConsoleEvents trait to your test class:

For PHPUnit:

<?php

namespace Tests\Feature;

use Illuminate\Foundation\Testing\WithConsoleEvents;
use Tests\TestCase;

class YourTest extends TestCase
{
    use WithConsoleEvents;

    // your test methods...
}

For Pest:

<?php

use Illuminate\Foundation\Testing\WithConsoleEvents;

pest()->use(WithConsoleEvents::class);

Once you add this trait, your CommandFinishedListener should start receiving the events during test runs.

This is documented in the Console Tests documentation under the events section.

Hope this helps!

[camohub]

I wrote in previous comment that I have the Illuminate\Foundation\Testing\WithConsoleEvents trait included but it does not work either.

[ismaildasci]

oh my bad, didnt read your previous comment properly 🤦

so you already have WithConsoleEvents and still not working... thats weird

few things to check:

are you running tests with php artisan test or ./vendor/bin/phpunit directly? they behave differently

also when you run php artisan test, it spawns a separate process for phpunit so the main artisan app doesnt really "finish" the test command in the same way

try adding some debug in your test itself:

public function test_something()
{
    Event::fake([CommandFinished::class]);
    
    // your test logic
    
    Event::assertDispatched(CommandFinished::class);
}

this will tell you if event is even being fired

what are you actually trying to achieve btw? maybe theres another way. like if you want to run something after all tests finish, you can use phpunit hooks in phpunit.xml or create a custom test extension

[camohub]

PHPUnit hooks also do not work. I have both solution implemented now.
What i want to achieve is: Collect test data from all test as a bunch of data related to the one test run and store it to the database as a result. Every test class have tearDown() method which log data for the class separatelly. I want to see them in DB as bunch of all tests for one test run cycle.

[camohub]

Hmm this is little sad....