karafka-testing 2.4.2 → 2.4.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6aecdc81babc8c73c80c65934abb2dfcddd59a919228cf0a62afe4fa787c7e68
-  data.tar.gz: 1be6197c9e2f9186b8e56e176351254eb54726166cfdf4ebbd2ee48836c08048
+  metadata.gz: 7dbd023d8dfb5cb1f11dce4a3ddf893c005228b9f8bc9f0bf199d37eaad6a5be
+  data.tar.gz: 17754c2c15f2b975241294fd6eff2e0ff40f64188b0bffcf110f019e52fc3e84
 SHA512:
-  metadata.gz: 7a2ec5091955cafed3cafcd29407ac8ac38b90c378c2a950fd9ad7690582c9a1b7553ad64bbd0763783ecda5b75d507f821f8f6555fe81c665b4cf78c0b175e3
-  data.tar.gz: 406958b6a7c9ee99e446ebe33564a7ebb9e87c50384c89fc7b855ff280c68b51e15b2f3d50f0daa14faefcd58caed8bc0028a0bdb68cb3d26697dc49b2a54aab
+  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,9 +1,17 @@
 # Karafka Test gem changelog
 
-## 2.4.2 (2024-06-30)
+## 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
+- [Fix] Fix: headers is not being assigned for minitest and rspec
+
+## 2.4.2 (2024-04-30)
 - [Fix] Fix FrozenError when accessing key and headers in `Karafka::Messages::Metadata` (tldn0718)
 
-## 2.4.1 (2024-06-29)
+## 2.4.1 (2024-04-29)
 - [Fix] Fix instance variable in minitest helper (tldn0718)
 
 ## 2.4.0 (2024-04-26)

data/Gemfile.lock

@@ -1,30 +1,34 @@
 PATH
   remote: .
   specs:
-    karafka-testing (2.4.2)
+    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

@@ -14,6 +14,14 @@ module Karafka
     module Minitest
       # Minitest helpers module that needs to be included
       module Helpers
+        # Map to convert dispatch attributes into their "delivery" format, since we bypass Kafka
+        METADATA_DISPATCH_MAPPINGS = {
+          raw_key: :key,
+          raw_headers: :headers
+        }.freeze
+
+        private_constant :METADATA_DISPATCH_MAPPINGS
+
         class << self
           # Adds all the needed extra functionalities to the minitest group
           # @param base [Class] Minitest example group we want to extend
@@ -29,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
 
@@ -79,24 +89,32 @@ 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|
-            next unless message.key?(key)
+            message_key = METADATA_DISPATCH_MAPPINGS.fetch(key, key)
 
-            metadata[key] = message.fetch(key)
+            next unless message.key?(message_key)
+
+            metadata[key] = message.fetch(message_key)
           end
+
           # Add this message to previously produced messages
           @_karafka_consumer_messages << Karafka::Messages::Message.new(
             message[:payload],
@@ -105,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
           )
@@ -121,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)
           )
@@ -136,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
 
@@ -168,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

@@ -15,6 +15,14 @@ module Karafka
     module RSpec
       # RSpec helpers module that needs to be included
       module Helpers
+        # Map to convert dispatch attributes into their "delivery" format, since we bypass Kafka
+        METADATA_DISPATCH_MAPPINGS = {
+          raw_key: :key,
+          raw_headers: :headers
+        }.freeze
+
+        private_constant :METADATA_DISPATCH_MAPPINGS
+
         class << self
           # Adds all the needed extra functionalities to the rspec group
           # @param base [Class] RSpec example group we want to extend
@@ -36,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)
@@ -86,23 +95,30 @@ 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|
-            next unless message.key?(key)
+            message_key = METADATA_DISPATCH_MAPPINGS.fetch(key, key)
 
-            metadata[key] = message.fetch(key)
+            next unless message.key?(message_key)
+
+            metadata[key] = message.fetch(message_key)
           end
 
           # Add this message to previously produced messages
@@ -114,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
           )
@@ -130,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)
           )
@@ -145,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
 
@@ -178,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.2'
+    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.2
+  version: 2.4.4
 platform: ruby
 authors:
 - Maciej Mensfeld
@@ -35,7 +35,7 @@ cert_chain:
   AnG1dJU+yL2BK7vaVytLTstJME5mepSZ46qqIJXMuWob/YPDmVaBF39TDSG9e34s
   msG3BiCqgOgHAnL23+CN3Rt8MsuRfEtoTKpJVcCfoEoNHOkc
   -----END CERTIFICATE-----
-date: 2024-04-30 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