Mocking your kafka consumer | Laravel Kafka [ K Laravel Kafka ](/) [Docs](/docs) [Blog](https://laravelkafka.com/blog) [GitHub](https://github.com/mateusjunges/laravel-kafka) Search ⌘K [ Login with GitHub Login ](https://laravelkafka.com/oauth/github/redirect) Docs for version selected v3.0 v2.13 v2.12 v2.11 v2.10 v2.9 v2.8 v1.13 - - [ Introduction ](/docs/v3.0/introduction) - [ Requirements ](/docs/v3.0/requirements) - [ Installation and Setup ](/docs/v3.0/installation-and-setup) - [ Questions and issues ](/docs/v3.0/questions-and-issues) - [ Changelog ](/docs/v3.0/changelog) - [ Upgrade guide ](/docs/v3.0/upgrade-guide) - [ Example docker-compose file ](/docs/v3.0/example-docker-compose) - Producing messages ------------------ - [ Producing messages ](/docs/v3.0/producing-messages/producing-messages) - [ Configuring your kafka producer ](/docs/v3.0/producing-messages/configuring-producers) - [ Configuring message payload ](/docs/v3.0/producing-messages/configuring-message-payload) - [ Custom serializers ](/docs/v3.0/producing-messages/custom-serializers) - [ Publishing to kafka ](/docs/v3.0/producing-messages/publishing-to-kafka) - Consuming messages ------------------ - [ Creating a kafka consumer ](/docs/v3.0/consuming-messages/creating-consumer) - [ Subscribing to kafka topics ](/docs/v3.0/consuming-messages/subscribing-to-kafka-topics) - [ Using regex to subscribe to kafka topics ](/docs/v3.0/consuming-messages/using-regex-to-subscribe-to-kafka-topics) - [ Assigning consumers to a topic partition ](/docs/v3.0/consuming-messages/assigning-partitions) - [ Consuming messages from specific offsets ](/docs/v3.0/consuming-messages/consuming-from-specific-offsets) - [ Consumer groups ](/docs/v3.0/consuming-messages/consumer-groups) - [ Partition Discovery and Dynamic Assignment ](/docs/v3.0/consuming-messages/partition-discovery) - [ Message handlers ](/docs/v3.0/consuming-messages/message-handlers) - [ Configuring consumer options ](/docs/v3.0/consuming-messages/configuring-consumer-options) - [ Handling failed messages ](/docs/v3.0/consuming-messages/handling-failed-messages) - [ Custom deserializers ](/docs/v3.0/consuming-messages/custom-deserializers) - [ Consuming messages ](/docs/v3.0/consuming-messages/consuming-messages) - [ Pausing partitions ](/docs/v3.0/consuming-messages/pausing-partitions) - [ Consumer classes ](/docs/v3.0/consuming-messages/class-structure) - [ Using consumers with Laravel Telescope ](/docs/v3.0/consuming-messages/laravel-telescope) - Advanced usage -------------- - [ Connections ](/docs/v3.0/advanced-usage/connections) - [ Replacing the default serializer/deserializer ](/docs/v3.0/advanced-usage/replacing-default-serializer) - [ Graceful shutdown ](/docs/v3.0/advanced-usage/graceful-shutdown) - [ Running consumers in production ](/docs/v3.0/advanced-usage/running-consumers-in-production) - [ SASL Authentication ](/docs/v3.0/advanced-usage/sasl-authentication) - [ Custom Committers ](/docs/v3.0/advanced-usage/custom-committers) - [ Manual Commit ](/docs/v3.0/advanced-usage/manual-commit) - [ Middlewares ](/docs/v3.0/advanced-usage/middlewares) - [ Stop consumer when there are no messages left ](/docs/v3.0/advanced-usage/stop-consumer-after-last-message) - [ Stop consumer on demand ](/docs/v3.0/advanced-usage/stopping-a-consumer) - [ Writing custom loggers ](/docs/v3.0/advanced-usage/custom-loggers) - [ Before and after callbacks ](/docs/v3.0/advanced-usage/before-callbacks) - [ Setting global configurations ](/docs/v3.0/advanced-usage/setting-global-configuration) - [ Sending multiple messages with the same producer ](/docs/v3.0/advanced-usage/sending-multiple-messages-with-the-same-producer) - [ Events ](/docs/v3.0/advanced-usage/events) - [ Consumer lag ](/docs/v3.0/advanced-usage/consumer-lag) - Testing ------- - [ Kafka fake ](/docs/v3.0/testing/fake) - [ Assert Published ](/docs/v3.0/testing/assert-published) - [ Assert published On ](/docs/v3.0/testing/assert-published-on) - [ Assert not published ](/docs/v3.0/testing/assert-not-published) - [ Assert nothing published ](/docs/v3.0/testing/assert-nothing-published) - [ Assert published times ](/docs/v3.0/testing/assert-published-times) - [ Assert published on times ](/docs/v3.0/testing/assert-published-on-times) - [ Mocking your kafka consumer ](/docs/v3.0/testing/mocking-your-kafka-consumer) Mocking your kafka consumer ============================= If you want to test that your consumers are working correctly, you can mock and execute the consumer to ensure that everything works as expected. Sponsorship Support Laravel Kafka by sponsoring me! Laravel Kafka is free and Open Source software, built to empower developers like you. Your support helps maintain and enhance the project. If you find it valuable, please consider sponsoring me on GitHub. Every contribution makes a difference and keeps the development going strong! Thank you! [ Become a Sponsor ](https://github.com/sponsors/mateusjunges) Want to hide this message? Sponsor at any tier of $10/month or more! You just need to tell kafka which messages the consumer should receive and then start your consumer. This package will run all the specified messages through the consumer and stop after the last message, so you can perform whatever assertions you want to. For example, let's say you want to test that a simple blog post was published after consuming a `post-published` message: ``` public function test_post_is_marked_as_published() { // First, you use the fake method: \Junges\Kafka\Facades\Kafka::fake(); // Then, tells Kafka what messages the consumer should receive: \Junges\Kafka\Facades\Kafka::shouldReceiveMessages([ new \Junges\Kafka\Message\ConsumedMessage( topicName: 'mark-post-as-published-topic', body: ['post_id' => 1], ), ]); // Now, instantiate your consumer and start consuming messages. It will consume only the messages // specified in `shouldReceiveMessages` method: $consumer = \Junges\Kafka\Facades\Kafka::consumer(['mark-post-as-published-topic']) ->withHandler(function (\Junges\Kafka\Contracts\ConsumerMessage $message) use (&$posts) { $post = Post::find($message->getBody()['post_id']); $post->update(['published_at' => now()->format("Y-m-d H:i:s")]); return 0; })->build(); $consumer->consume(); // Now, you can test if the post published_at field is not empty, or anything else you want to test: $this->assertNotNull($post->refresh()->published_at); } ``` Only the topic name and the body of the messages are usually relevant. The partition and the offset default to `0`, the headers to an empty array, and the key and timestamp to `null`. ### [](#content-failed-messages "Permalink")Failed messages Faked consumers handle failed messages like real ones: they are [ retried ](../consuming-messages/handling-failed-messages), with the attempt number available through `getAttempts()`, the failure callback is called, and the message is then sent to the dead letter queue, skipped, or stops the consumer with a `Junges\Kafka\Exceptions\ConsumerException`. Instead of publishing messages to the dead letter queue, faked consumers only dispatch the `MessageSentToDLQ` event, so you can assert that a message was sent to it: ``` use Illuminate\Support\Facades\Event; use Junges\Kafka\Events\MessageSentToDLQ; Event::fake([MessageSentToDLQ::class]); Kafka::consumerFor(OrdersConsumer::class)->build()->consume(); Event::assertDispatched(MessageSentToDLQ::class); ``` ### [](#content-testing-consumer-classes "Permalink")Testing consumer classes [ Consumer classes ](../consuming-messages/class-structure) can be tested the same way, building them with the `consumerFor` method: ``` use App\Kafka\Consumers\OrdersConsumer; use Junges\Kafka\Facades\Kafka; use Junges\Kafka\Message\ConsumedMessage; public function test_orders_are_created() { Kafka::fake(); Kafka::shouldReceiveMessages([ new ConsumedMessage(topicName: 'orders', body: ['id' => 1]), ]); Kafka::consumerFor(OrdersConsumer::class)->build()->consume(); $this->assertDatabaseHas('orders', ['id' => 1]); } ``` Previous [ Assert published on times ](https://laravelkafka.com/docs/v3.0/testing/assert-published-on-times) Sponsors [ version="1.0" encoding="UTF-8"? EasyCal ](https://easycal.app/) [ Search ⌘ K ](https://typesense.org/)