{"id":17108354,"url":"https://github.com/jlndk/laravel-test-broadcaster","last_synced_at":"2025-04-13T02:46:33.719Z","repository":{"id":57000141,"uuid":"254203119","full_name":"jlndk/laravel-test-broadcaster","owner":"jlndk","description":"A broadcast provider for testing event broadcasting","archived":false,"fork":false,"pushed_at":"2020-04-09T18:26:35.000Z","size":21,"stargazers_count":8,"open_issues_count":1,"forks_count":6,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-04-13T02:46:10.797Z","etag":null,"topics":["broadcasting","broadcasting-events","laravel","laravel-events","php","tdd"],"latest_commit_sha":null,"homepage":null,"language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/jlndk.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2020-04-08T21:19:51.000Z","updated_at":"2023-04-19T04:09:07.000Z","dependencies_parsed_at":"2022-08-21T11:40:42.514Z","dependency_job_id":null,"html_url":"https://github.com/jlndk/laravel-test-broadcaster","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":"spatie/package-skeleton-laravel","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jlndk%2Flaravel-test-broadcaster","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jlndk%2Flaravel-test-broadcaster/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jlndk%2Flaravel-test-broadcaster/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jlndk%2Flaravel-test-broadcaster/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/jlndk","download_url":"https://codeload.github.com/jlndk/laravel-test-broadcaster/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248657859,"owners_count":21140843,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["broadcasting","broadcasting-events","laravel","laravel-events","php","tdd"],"created_at":"2024-10-14T16:05:08.633Z","updated_at":"2025-04-13T02:46:33.699Z","avatar_url":"https://github.com/jlndk.png","language":"PHP","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Test Laravel Event Broadcasting\n\n[![Latest Version on Packagist](https://img.shields.io/packagist/v/jlndk/laravel-test-broadcaster.svg?style=flat-square)](https://packagist.org/packages/jlndk/laravel-test-broadcaster)\n[![GitHub Tests Action Status](https://img.shields.io/github/workflow/status/jlndk/laravel-test-broadcaster/run-tests?label=tests)](https://github.com/jlndk/laravel-test-broadcaster/actions?query=workflow%3Arun-tests+branch%3Amaster)\n[![Total Downloads](https://img.shields.io/packagist/dt/jlndk/laravel-test-broadcaster.svg?style=flat-square)](https://packagist.org/packages/jlndk/laravel-test-broadcaster)\n\nThis package lets you test if Laravel events has been broadcasted. This is useful for TDD and End-to-end testing.\n\n\n## Installation\n\n1. Install the package via composer:\n\n```bash\ncomposer require jlndk/laravel-test-broadcaster\n```\n\n2. Add the test broadcaster to the `connections` array in `app/config/broadcasting.php`.\n```php\n'connections' =\u003e [\n    ...\n    'test' =\u003e [\n        'driver' =\u003e 'test'\n    ],\n],\n\n```\n\n3. Set the default broadcaster for testing in the `php` element of `phpunit.xml`.\n```xml\n\u003cphp\u003e\n    ...\n    \u003cenv name=\"BROADCAST_DRIVER\" value=\"test\"/\u003e\n\u003c/php\u003e\n```\n\n4. Finally add the `Jlndk\\TestBroadcaster\\CanTestBroadcasting` trait to `tests/TestCase.php`.\n```php\nuse Jlndk\\TestBroadcaster\\CanTestBroadcasting;\nabstract class TestCase extends BaseTestCase\n{\n    use CanTestBroadcasting;\n}\n```\n\n## Usage\nThis package adds the `assertEventBroadcasted` method to your testing.\n``` php\n/**\n * @test\n */\npublic function it_can_assert_when_an_event_is_broadcasted()\n{\n    event(new TestEvent());\n    $this-\u003eassertEventBroadcasted(TestEvent::class);\n}\n```\n\nFuthermore it is also possible to test for how many times an even is broadcasted\n```php\n/**\n * @test\n */\npublic function it_can_assert_if_an_event_was_broadcasted_a_given_amount_of_times()\n{\n    event(new TestEvent());\n    $this-\u003eassertEventBroadcasted(TestEvent::class, 1);\n\n    event(new TestEvent());\n    $this-\u003eassertEventBroadcasted(TestEvent::class, 2);\n}\n```\n\n```php\n/**\n * @test\n */\npublic function it_can_assert_if_an_event_was_broadcasted_a_given_amount_of_times()\n{\n    event(new TestEvent());\n    $this-\u003eassertEventBroadcasted(TestEvent::class, 1);\n\n    event(new TestEvent());\n    $this-\u003eassertEventBroadcasted(TestEvent::class, 2);\n}\n```\n\nThe `assertEventBroadcasted` method can also assert on which channels the event is broadcasted to.\nIt can either take a single string, for a single channel, or an array of channel names.\n```php\n/**\n * @test\n */\npublic function it_can_assert_if_an_event_was_broadcasted_on_multiple_channels()\n{\n    event(new TestEvent());\n\n    // \n    $this-\u003eassertEventBroadcasted(TestEvent::class, ['private-channel-name', 'private-another-channel-name']);\n\n    try {\n        $this-\u003eassertEventBroadcasted(TestEvent::class, [\n            'private-channel-name',\n            'somethingelse-fake-channel',\n        ]);\n        $this-\u003efail(\"assertEventBroadcasted asserted that an event was broadcasted on given channels when it wasn't\");\n    } catch (ExpectationFailedException $e) {\n    }\n}\n```\n\n## Testing\n\n``` bash\ncomposer test\n```\n\n## Changelog\n\nPlease see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.\n\n## Contributing\n\nPlease see [CONTRIBUTING](CONTRIBUTING.md) for details.\n\n## Security\n\nIf you discover any security related issues, please email xxx instead of using the issue tracker.\n\n## Credits\n\n- [jlndk](https://github.com/jlndk)\n- [All Contributors](../../contributors)\n\n## License\n\nThe MIT License (MIT). Please see [License File](LICENSE.md) for more information.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjlndk%2Flaravel-test-broadcaster","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjlndk%2Flaravel-test-broadcaster","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjlndk%2Flaravel-test-broadcaster/lists"}