karafka-testing 2.4.3 → 2.4.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fe477f5bd2b71d1114928a4db25c35f6fffe0a4eed5265eca11bbdaf631be953
-  data.tar.gz: 30fa033178bdb55bcca8cbce705a5f91224380bb6900c2998b78da50af2291d5
+  metadata.gz: 7dbd023d8dfb5cb1f11dce4a3ddf893c005228b9f8bc9f0bf199d37eaad6a5be
+  data.tar.gz: 17754c2c15f2b975241294fd6eff2e0ff40f64188b0bffcf110f019e52fc3e84
 SHA512:
-  metadata.gz: dbcb1174a90f12d0743474462802e495674627d34f60499cdbc28d48214512371a2532c71e7d94a2a565d4513c3161807e82f117f11d83e38f1aad11fc0f5f6a
-  data.tar.gz: f621736a76fd8c2f20ab8908e1f1addc43e1913027cdd67d9a077e93a014f581f9a97d3b028d8b18eaee1246feb3a6d14abaddf3de766e17b7c3b47541f974c5
+  metadata.gz: 2ee758d81cc2ddf98fedafeac9105cf3c50aa0ad6845bca729aa3dde5c461f82328c91a6dd449faa460ee28c8e27e5b26ea87f1bbdc541f4be8c11aae6388020
+  data.tar.gz: 80d66738edd43d2e8a373f29b3658f12fce556505c5185af5929bc4e721c80eec54af6479661129cb1b57f67c7bc506fca0ddd410aea5418f85be8b71e6b6608

data/.github/workflows/ci.yml

@@ -18,6 +18,7 @@ jobs:
       fail-fast: false
       matrix:
         ruby:
+          - '3.4.0-preview1'
           - '3.3'
           - '3.2'
           - '3.1'

data/.ruby-version

@@ -1 +1 @@
-3.3.1
+3.3.3

data/CHANGELOG.md

@@ -1,5 +1,8 @@
 # Karafka Test gem changelog
 
+## 2.4.4 (2024-07-02)
+- [Enhancement] Memoize `consumer_for` so consumers can be set up for multiple topics and `let(:consumer)` is no longer a requirement. (dorner)
+
 ## 2.4.3 (2024-05-06)
 - [Fix] Fix: raw_key is not being assigned for rspec (CaioPenhalver)
 - [Fix] Fix: raw_key is not being assigned for minitest

data/Gemfile.lock

@@ -1,30 +1,34 @@
 PATH
   remote: .
   specs:
-    karafka-testing (2.4.3)
+    karafka-testing (2.4.4)
       karafka (>= 2.4.0, < 2.5.0)
       waterdrop (>= 2.7.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    ffi (1.16.3)
-    karafka (2.4.0)
+    base64 (0.2.0)
+    ffi (1.17.0)
+    ffi (1.17.0-x86_64-linux-gnu)
+    karafka (2.4.3)
+      base64 (~> 0.2)
       karafka-core (>= 2.4.0, < 2.5.0)
-      waterdrop (>= 2.7.0, < 3.0.0)
+      waterdrop (>= 2.7.3, < 3.0.0)
       zeitwerk (~> 2.3)
-    karafka-core (2.4.0)
-      karafka-rdkafka (>= 0.15.0, < 0.16.0)
-    karafka-rdkafka (0.15.0)
+    karafka-core (2.4.3)
+      karafka-rdkafka (>= 0.15.0, < 0.17.0)
+    karafka-rdkafka (0.16.0)
       ffi (~> 1.15)
       mini_portile2 (~> 2.6)
       rake (> 12)
-    mini_portile2 (2.8.5)
+    mini_portile2 (2.8.7)
     rake (13.2.1)
-    waterdrop (2.7.0)
+    waterdrop (2.7.3)
       karafka-core (>= 2.4.0, < 3.0.0)
+      karafka-rdkafka (>= 0.15.1)
       zeitwerk (~> 2.3)
-    zeitwerk (2.6.13)
+    zeitwerk (2.6.16)
 
 PLATFORMS
   ruby
@@ -34,4 +38,4 @@ DEPENDENCIES
   karafka-testing!
 
 BUNDLED WITH
-   2.5.7
+   2.5.14

data/lib/karafka/testing/minitest/helpers.rb

@@ -37,6 +37,8 @@ module Karafka
               @_karafka_consumer_messages.clear
               @_karafka_producer_client.reset
 
+              @_karafka_consumer_mappings = {}
+
               Karafka.producer.stubs(:client).returns(@_karafka_producer_client)
             end
 
@@ -87,18 +89,23 @@ module Karafka
         # @example Send a json message to consumer and simulate, that it is partition 6
         #   @karafka.produce({ 'hello' => 'world' }.to_json, 'partition' => 6)
         def _karafka_add_message_to_consumer_if_needed(message)
+          consumer_obj = if defined?(@consumer)
+                           @consumer
+                         else
+                           @_karafka_consumer_mappings&.dig(message[:topic])
+                         end
           # Consumer needs to be defined in order to pass messages to it
-          return unless defined?(@consumer)
+          return unless defined?(consumer_obj)
           # We're interested in adding message to consumer only when it is a Karafka consumer
           # Users may want to test other things (models producing messages for example) and in
           # their case consumer will not be a consumer
-          return unless @consumer.is_a?(Karafka::BaseConsumer)
+          return unless consumer_obj.is_a?(Karafka::BaseConsumer)
           # We target to the consumer only messages that were produced to it, since specs may also
           # produce other messages targeting other topics
-          return unless message[:topic] == @consumer.topic.name
+          return unless message[:topic] == consumer_obj.topic.name
 
           # Build message metadata and copy any metadata that would come from the message
-          metadata = _karafka_message_metadata_defaults
+          metadata = _karafka_message_metadata_defaults(consumer_obj)
 
           metadata.keys.each do |key|
             message_key = METADATA_DISPATCH_MAPPINGS.fetch(key, key)
@@ -116,13 +123,13 @@ module Karafka
           # Update batch metadata
           batch_metadata = Karafka::Messages::Builders::BatchMetadata.call(
             @_karafka_consumer_messages,
-            @consumer.topic,
+            consumer_obj.topic,
             0,
             Time.now
           )
 
           # Update consumer messages batch
-          @consumer.messages = Karafka::Messages::Messages.new(
+          consumer_obj.messages = Karafka::Messages::Messages.new(
             @_karafka_consumer_messages,
             batch_metadata
           )
@@ -132,9 +139,16 @@ module Karafka
         # @param payload [String] payload we want to dispatch
         # @param metadata [Hash] any metadata we want to dispatch alongside the payload
         def _karafka_produce(payload, metadata = {})
+          topic = if metadata[:topic]
+                    metadata[:topic]
+                  elsif defined?(@consumer)
+                    @consumer.topic.name
+                  else
+                    @_karafka_consumer_mappings&.keys&.last
+                  end
           Karafka.producer.produce_sync(
             {
-              topic: @consumer.topic.name,
+              topic: topic,
               payload: payload
             }.merge(metadata)
           )
@@ -147,17 +161,18 @@ module Karafka
 
         private
 
+        # @param consumer_obj [Karafka::BaseConsumer] consumer reference
         # @return [Hash] message default options
-        def _karafka_message_metadata_defaults
+        def _karafka_message_metadata_defaults(consumer_obj)
           {
-            deserializers: @consumer.topic.deserializers,
+            deserializers: consumer_obj.topic.deserializers,
             timestamp: Time.now,
             raw_headers: {},
             raw_key: nil,
             offset: @_karafka_consumer_messages.size,
             partition: 0,
             received_at: Time.now,
-            topic: @consumer.topic.name
+            topic: consumer_obj.topic.name
           }
         end
 
@@ -179,6 +194,7 @@ module Karafka
           @consumer.coordinator.seek_offset = 0
           # Indicate usage as for tests no direct enqueuing happens
           @consumer.instance_variable_set('@used', true)
+          @_karafka_consumer_mappings[topic.name] = @consumer
           @consumer
         end
       end

data/lib/karafka/testing/rspec/helpers.rb

@@ -44,6 +44,7 @@ module Karafka
 
               _karafka_consumer_messages.clear
               _karafka_producer_client.reset
+              @_karafka_consumer_mappings = {}
 
               if Object.const_defined?('Mocha', false)
                 Karafka.producer.stubs(:client).returns(_karafka_producer_client)
@@ -94,18 +95,23 @@ module Karafka
         #     karafka.produce({ 'hello' => 'world' }.to_json, 'partition' => 6)
         #   end
         def _karafka_add_message_to_consumer_if_needed(message)
+          consumer_obj = if defined?(consumer)
+                           consumer
+                         else
+                           @_karafka_consumer_mappings&.dig(message[:topic])
+                         end
           # Consumer needs to be defined in order to pass messages to it
-          return unless defined?(consumer)
+          return unless consumer_obj
           # We're interested in adding message to consumer only when it is a Karafka consumer
           # Users may want to test other things (models producing messages for example) and in
           # their case consumer will not be a consumer
-          return unless consumer.is_a?(Karafka::BaseConsumer)
+          return unless consumer_obj.is_a?(Karafka::BaseConsumer)
           # We target to the consumer only messages that were produced to it, since specs may also
           # produce other messages targeting other topics
-          return unless message[:topic] == consumer.topic.name
+          return unless message[:topic] == consumer_obj.topic.name
 
           # Build message metadata and copy any metadata that would come from the message
-          metadata = _karafka_message_metadata_defaults
+          metadata = _karafka_message_metadata_defaults(consumer_obj)
 
           metadata.keys.each do |key|
             message_key = METADATA_DISPATCH_MAPPINGS.fetch(key, key)
@@ -124,13 +130,13 @@ module Karafka
           # Update batch metadata
           batch_metadata = Karafka::Messages::Builders::BatchMetadata.call(
             _karafka_consumer_messages,
-            consumer.topic,
+            consumer_obj.topic,
             0,
             Time.now
           )
 
           # Update consumer messages batch
-          consumer.messages = Karafka::Messages::Messages.new(
+          consumer_obj.messages = Karafka::Messages::Messages.new(
             _karafka_consumer_messages,
             batch_metadata
           )
@@ -140,9 +146,16 @@ module Karafka
         # @param payload [String] payload we want to dispatch
         # @param metadata [Hash] any metadata we want to dispatch alongside the payload
         def _karafka_produce(payload, metadata = {})
+          topic = if metadata[:topic]
+                    metadata[:topic]
+                  elsif defined?(consumer)
+                    consumer.topic.name
+                  else
+                    @_karafka_consumer_mappings&.keys&.last
+                  end
           Karafka.producer.produce_sync(
             {
-              topic: consumer.topic.name,
+              topic: topic,
               payload: payload
             }.merge(metadata)
           )
@@ -155,17 +168,18 @@ module Karafka
 
         private
 
+        # @param consumer_obj [Karafka::BaseConsumer] consumer reference
         # @return [Hash] message default options
-        def _karafka_message_metadata_defaults
+        def _karafka_message_metadata_defaults(consumer_obj)
           {
-            deserializers: consumer.topic.deserializers,
+            deserializers: consumer_obj.topic.deserializers,
             timestamp: Time.now,
             raw_headers: {},
             raw_key: nil,
             offset: _karafka_consumer_messages.size,
             partition: 0,
             received_at: Time.now,
-            topic: consumer.topic.name
+            topic: consumer_obj.topic.name
           }
         end
 
@@ -188,6 +202,8 @@ module Karafka
           consumer.coordinator.seek_offset = 0
           # Indicate usage as for tests no direct enqueuing happens
           consumer.instance_variable_set('@used', true)
+
+          @_karafka_consumer_mappings[topic.name] = consumer
           consumer
         end
       end

data/lib/karafka/testing/version.rb

@@ -4,6 +4,6 @@
 module Karafka
   module Testing
     # Current version of gem. It should match Karafka framework version
-    VERSION = '2.4.3'
+    VERSION = '2.4.4'
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: karafka-testing
 version: !ruby/object:Gem::Version
-  version: 2.4.3
+  version: 2.4.4
 platform: ruby
 authors:
 - Maciej Mensfeld
@@ -35,7 +35,7 @@ cert_chain:
   AnG1dJU+yL2BK7vaVytLTstJME5mepSZ46qqIJXMuWob/YPDmVaBF39TDSG9e34s
   msG3BiCqgOgHAnL23+CN3Rt8MsuRfEtoTKpJVcCfoEoNHOkc
   -----END CERTIFICATE-----
-date: 2024-05-06 00:00:00.000000000 Z
+date: 2024-07-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: karafka
@@ -132,7 +132,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.9
+rubygems_version: 3.5.11
 signing_key: 
 specification_version: 4
 summary: Library which provides helpers for easier Karafka consumers tests

metadata.gz.sig

@@ -1 +1,2 @@
-Z���K�IW��{�[�����:���>��n�n�^�y	=Ϝ�x:�G���<��N���(E��c���m��zSlv�;=�|P��	���D��z��2��J��JeR�Z-�8"����V��$�JP��Pn�寡�"�ʎV��𳯃�Fy�4ե�c*�;�ȩ)������ot��e;�]���n��U�/v8xް$c\oѳͼ~m�H�t2��~�8��0�)ZC������j}�RSz��D+c-�}2"w�δ�/����!t�qQUA�R\n�	��D0:��,6�ʹr�)L��1�@�M^��}Y.�ó�]��Yc��
Ȑ����0�Nk�Z��oMYIo�w�x+S��e��S/qU��J!�������-��X�O>�
+H�ó�ֳ�2�Yu�j������8+���q�4���~����間j�	���-�O��zM(>(�.;^�&� U{B�#x��셎�������;��ɨ��+5/Nt/��ٲ��آV��3���-Qmx^��E]QB�#���?ks�r���H���}��rԤǘ��o[�E������F�‡�\�9��?.ܪ���D���/c��te�T�
+l�