README

This package lets you test if Laravel events has been broadcasted. This is useful for TDD and End-to-end testing.

Installation

Install the package via composer:

composer require GENL/laravel-broadcast-testing

Add the test broadcaster to the connections array in app/config/broadcasting.php.

'connections' => [
    ...
    'test' => [
        'driver' => 'test'
    ],
],

Set the default broadcaster for testing in the php element of phpunit.xml.

<php>
    ...
    <env name="BROADCAST_DRIVER" value="test"/>
</php>

Finally add the Genl\TestBroadcaster\CanTestBroadcasting trait to tests/TestCase.php.

use Genl\TestBroadcaster\CanTestBroadcasting;
abstract class TestCase extends BaseTestCase
{
    use CanTestBroadcasting;
}

Usage

This package adds the assertEventBroadcasted method to your testing.

/**
 * @test
 */
public function it_can_assert_when_an_event_is_broadcasted()
{
    event(new TestEvent());
    $this->assertEventWasBroadcast(TestEvent::class);
}

Futhermore it is also possible to test for how many times an even is broadcasted

/**
 * @test
 */
public function it_can_assert_if_an_event_was_broadcasted_a_given_amount_of_times()
{
    event(new TestEvent());
    $this->assertEventWasBroadcast(TestEvent::class, 1);

    event(new TestEvent());
    $this->assertEventWasBroadcast(TestEvent::class, 2);
}

/**
 * @test
 */
public function it_can_assert_if_an_event_was_broadcasted_a_given_amount_of_times()
{
    event(new TestEvent());
    $this->assertEventWasBroadcast(TestEvent::class, 1);

    event(new TestEvent());
    $this->assertEventWasBroadcast(TestEvent::class, 2);
}

The assertEventWasBroadcast method can also assert on which channels the event is broadcasted to. It can either take a single string, for a single channel, or an array of channel names.

/**
 * @test
 */
public function it_can_assert_if_an_event_was_broadcasted_on_multiple_channels()
{
    event(new TestEvent());

    // 
    $this->assertEventWasBroadcast(TestEvent::class, ['private-channel-name', 'private-another-channel-name']);

    try {
        $this->assertEventWasBroadcast(TestEvent::class, [
            'private-channel-name',
            'somethingelse-fake-channel',
        ]);
        $this->fail("assertEventBroadcasted asserted that an event was broadcasted on given channels when it wasn't");
    } catch (ExpectationFailedException $e) {
    }
}

Testing

composer test

Changelog

Please see CHANGELOG for more information on what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security

If you discover any security related issues, please email xxx instead of using the issue tracker.

Credits

License

The MIT License (MIT). Please see License File for more information.

genl / laravel-broadcast-testing

Maintainers

Details