karafka-testing 2.5.4 → 2.5.6

data/Gemfile.lint.lock

@@ -0,0 +1,108 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.3)
+    json (2.18.0)
+    language_server-protocol (3.17.0.5)
+    lint_roller (1.1.0)
+    parallel (1.27.0)
+    parser (3.3.10.1)
+      ast (~> 2.4.1)
+      racc
+    prism (1.8.0)
+    racc (1.8.1)
+    rainbow (3.1.1)
+    regexp_parser (2.11.3)
+    rubocop (1.82.1)
+      json (~> 2.3)
+      language_server-protocol (~> 3.17.0.2)
+      lint_roller (~> 1.1.0)
+      parallel (~> 1.10)
+      parser (>= 3.3.0.2)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 2.9.3, < 3.0)
+      rubocop-ast (>= 1.48.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 4.0)
+    rubocop-ast (1.49.0)
+      parser (>= 3.3.7.2)
+      prism (~> 1.7)
+    rubocop-minitest (0.39.1)
+      lint_roller (~> 1.1)
+      rubocop (>= 1.75.0, < 2.0)
+      rubocop-ast (>= 1.38.0, < 2.0)
+    rubocop-performance (1.26.1)
+      lint_roller (~> 1.1)
+      rubocop (>= 1.75.0, < 2.0)
+      rubocop-ast (>= 1.47.1, < 2.0)
+    rubocop-thread_safety (0.7.3)
+      lint_roller (~> 1.1)
+      rubocop (~> 1.72, >= 1.72.1)
+      rubocop-ast (>= 1.44.0, < 2.0)
+    ruby-progressbar (1.13.0)
+    standard (1.53.0)
+      language_server-protocol (~> 3.17.0.2)
+      lint_roller (~> 1.0)
+      rubocop (~> 1.82.0)
+      standard-custom (~> 1.0.0)
+      standard-performance (~> 1.8)
+    standard-custom (1.0.2)
+      lint_roller (~> 1.0)
+      rubocop (~> 1.50)
+    standard-minitest (1.0.0)
+      lint_roller (~> 1.0)
+      rubocop-minitest
+    standard-performance (1.9.0)
+      lint_roller (~> 1.1)
+      rubocop-performance (~> 1.26.0)
+    unicode-display_width (3.2.0)
+      unicode-emoji (~> 4.1)
+    unicode-emoji (4.2.0)
+    yard (0.9.38)
+    yard-lint (1.4.0)
+      yard (~> 0.9)
+      zeitwerk (~> 2.6)
+    zeitwerk (2.7.4)
+
+PLATFORMS
+  ruby
+  x86_64-linux
+
+DEPENDENCIES
+  rubocop-minitest
+  rubocop-performance
+  rubocop-thread_safety
+  standard
+  standard-minitest
+  standard-performance
+  yard-lint
+
+CHECKSUMS
+  ast (2.4.3) sha256=954615157c1d6a382bc27d690d973195e79db7f55e9765ac7c481c60bdb4d383
+  json (2.18.0) sha256=b10506aee4183f5cf49e0efc48073d7b75843ce3782c68dbeb763351c08fd505
+  language_server-protocol (3.17.0.5) sha256=fd1e39a51a28bf3eec959379985a72e296e9f9acfce46f6a79d31ca8760803cc
+  lint_roller (1.1.0) sha256=2c0c845b632a7d172cb849cc90c1bce937a28c5c8ccccb50dfd46a485003cc87
+  parallel (1.27.0) sha256=4ac151e1806b755fb4e2dc2332cbf0e54f2e24ba821ff2d3dcf86bf6dc4ae130
+  parser (3.3.10.1) sha256=06f6a725d2cd91e5e7f2b7c32ba143631e1f7c8ae2fb918fc4cebec187e6a688
+  prism (1.8.0) sha256=84453a16ef5530ea62c5f03ec16b52a459575ad4e7b9c2b360fd8ce2c39c1254
+  racc (1.8.1) sha256=4a7f6929691dbec8b5209a0b373bc2614882b55fc5d2e447a21aaa691303d62f
+  rainbow (3.1.1) sha256=039491aa3a89f42efa1d6dec2fc4e62ede96eb6acd95e52f1ad581182b79bc6a
+  regexp_parser (2.11.3) sha256=ca13f381a173b7a93450e53459075c9b76a10433caadcb2f1180f2c741fc55a4
+  rubocop (1.82.1) sha256=09f1a6a654a960eda767aebea33e47603080f8e9c9a3f019bf9b94c9cab5e273
+  rubocop-ast (1.49.0) sha256=49c3676d3123a0923d333e20c6c2dbaaae2d2287b475273fddee0c61da9f71fd
+  rubocop-minitest (0.39.1) sha256=998398d6da4026d297f0f9bf709a1eac5f2b6947c24431f94af08138510cf7ed
+  rubocop-performance (1.26.1) sha256=cd19b936ff196df85829d264b522fd4f98b6c89ad271fa52744a8c11b8f71834
+  rubocop-thread_safety (0.7.3) sha256=067cdd52fbf5deffc18995437e45b5194236eaff4f71de3375a1f6052e48f431
+  ruby-progressbar (1.13.0) sha256=80fc9c47a9b640d6834e0dc7b3c94c9df37f08cb072b7761e4a71e22cff29b33
+  standard (1.53.0) sha256=f3c9493385db7079d0abce6f7582f553122156997b81258cd361d3480eeacf9c
+  standard-custom (1.0.2) sha256=424adc84179a074f1a2a309bb9cf7cd6bfdb2b6541f20c6bf9436c0ba22a652b
+  standard-minitest (1.0.0) sha256=450caa86a64a6e6f6f186cc88601dbb49b6cfaa3b0dce77a73b50ba8cdc15b2a
+  standard-performance (1.9.0) sha256=49483d31be448292951d80e5e67cdcb576c2502103c7b40aec6f1b6e9c88e3f2
+  unicode-display_width (3.2.0) sha256=0cdd96b5681a5949cdbc2c55e7b420facae74c4aaf9a9815eee1087cb1853c42
+  unicode-emoji (4.2.0) sha256=519e69150f75652e40bf736106cfbc8f0f73aa3fb6a65afe62fefa7f80b0f80f
+  yard (0.9.38) sha256=721fb82afb10532aa49860655f6cc2eaa7130889df291b052e1e6b268283010f
+  yard-lint (1.4.0) sha256=7dd88fbb08fd77cb840bea899d58812817b36d92291b5693dd0eeb3af9f91f0f
+  zeitwerk (2.7.4) sha256=2bef90f356bdafe9a6c2bd32bcd804f83a4f9b8bc27f3600fff051eb3edcec8b
+
+BUNDLED WITH
+  4.0.3

data/Gemfile.lock

@@ -1,46 +1,77 @@
 PATH
   remote: .
   specs:
-    karafka-testing (2.5.4)
+    karafka-testing (2.5.6)
       karafka (>= 2.5.0, < 2.6.0)
       waterdrop (>= 2.8.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    base64 (0.2.0)
-    ffi (1.17.0)
-    ffi (1.17.0-x86_64-linux-gnu)
-    json (2.13.2)
-    karafka (2.5.0)
+    base64 (0.3.0)
+    diff-lcs (1.6.2)
+    docile (1.4.1)
+    drb (2.2.3)
+    ffi (1.17.3)
+    ffi (1.17.3-x86_64-linux-gnu)
+    json (2.19.2)
+    karafka (2.5.1)
       base64 (~> 0.2)
-      karafka-core (>= 2.5.2, < 2.6.0)
-      karafka-rdkafka (>= 0.19.5)
-      waterdrop (>= 2.8.3, < 3.0.0)
+      karafka-core (>= 2.5.6, < 2.6.0)
+      karafka-rdkafka (>= 0.22.0)
+      waterdrop (>= 2.8.9, < 3.0.0)
       zeitwerk (~> 2.3)
-    karafka-core (2.5.6)
+    karafka-core (2.5.10)
       karafka-rdkafka (>= 0.20.0)
       logger (>= 1.6.0)
-    karafka-rdkafka (0.21.0)
-      ffi (~> 1.15)
+    karafka-rdkafka (0.24.0)
+      ffi (~> 1.17.1)
       json (> 2.0)
       logger
       mini_portile2 (~> 2.6)
       rake (> 12)
-    karafka-rdkafka (0.21.0-x86_64-linux-gnu)
-      ffi (~> 1.15)
+    karafka-rdkafka (0.24.0-x86_64-linux-gnu)
+      ffi (~> 1.17.1)
       json (> 2.0)
       logger
       mini_portile2 (~> 2.6)
       rake (> 12)
     logger (1.7.0)
-    mini_portile2 (2.8.7)
-    rake (13.2.1)
-    waterdrop (2.8.3)
+    mini_portile2 (2.8.9)
+    minitest (6.0.2)
+      drb (~> 2.0)
+      prism (~> 1.5)
+    mocha (3.1.0)
+      ruby2_keywords (>= 0.0.5)
+    ostruct (0.6.3)
+    prism (1.9.0)
+    rake (13.3.1)
+    rspec (3.13.2)
+      rspec-core (~> 3.13.0)
+      rspec-expectations (~> 3.13.0)
+      rspec-mocks (~> 3.13.0)
+    rspec-core (3.13.6)
+      rspec-support (~> 3.13.0)
+    rspec-expectations (3.13.5)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.13.0)
+    rspec-mocks (3.13.7)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.13.0)
+    rspec-support (3.13.6)
+    ruby2_keywords (0.0.5)
+    simplecov (0.22.0)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+      simplecov_json_formatter (~> 0.1)
+    simplecov-html (0.13.2)
+    simplecov_json_formatter (0.1.4)
+    warning (1.5.0)
+    waterdrop (2.8.12)
       karafka-core (>= 2.4.9, < 3.0.0)
-      karafka-rdkafka (>= 0.19.1)
+      karafka-rdkafka (>= 0.20.0)
       zeitwerk (~> 2.3)
-    zeitwerk (2.6.16)
+    zeitwerk (2.7.3)
 
 PLATFORMS
   ruby
@@ -48,6 +79,12 @@ PLATFORMS
 
 DEPENDENCIES
   karafka-testing!
+  minitest
+  mocha
+  ostruct
+  rspec
+  simplecov
+  warning
 
 BUNDLED WITH
    2.6.3

data/Rakefile

@@ -1,4 +1,14 @@
 # frozen_string_literal: true
 
-require 'bundler/setup'
-require 'bundler/gem_tasks'
+require "bundler/setup"
+require "bundler/gem_tasks"
+
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.test_files = FileList["test/test_helper.rb", "test/**/*_test.rb"]
+    .exclude("test/integration/**/*")
+end
+
+task default: :test

data/karafka-testing.gemspec

@@ -1,35 +1,35 @@
 # frozen_string_literal: true
 
-lib = File.expand_path('lib', __dir__)
+lib = File.expand_path("lib", __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
-require 'karafka/testing/version'
+require "karafka/testing/version"
 
 Gem::Specification.new do |spec|
-  spec.name          = 'karafka-testing'
-  spec.platform      = Gem::Platform::RUBY
-  spec.version       = Karafka::Testing::VERSION
-  spec.authors       = ['Maciej Mensfeld']
-  spec.email         = %w[contact@karafka.io]
-  spec.summary       = 'Library which provides helpers for easier Karafka consumers tests'
-  spec.description   = 'Library which provides helpers for easier Karafka consumers tests'
-  spec.homepage      = 'https://karafka.io'
-  spec.license       = 'MIT'
-  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(spec)/}) }
-  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.name = "karafka-testing"
+  spec.platform = Gem::Platform::RUBY
+  spec.version = Karafka::Testing::VERSION
+  spec.authors = ["Maciej Mensfeld"]
+  spec.email = %w[contact@karafka.io]
+  spec.summary = "Library which provides helpers for easier Karafka consumers tests"
+  spec.description = "Library which provides helpers for easier Karafka consumers tests"
+  spec.homepage = "https://karafka.io"
+  spec.license = "MIT"
+  spec.files = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test)/}) }
+  spec.executables = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.require_paths = %w[lib]
 
-  spec.add_dependency 'karafka', '>= 2.5.0', '< 2.6.0'
-  spec.add_dependency 'waterdrop', '>= 2.8.0'
+  spec.add_dependency "karafka", ">= 2.5.0", "< 2.6.0"
+  spec.add_dependency "waterdrop", ">= 2.8.0"
 
-  spec.required_ruby_version = '>= 3.2.0'
+  spec.required_ruby_version = ">= 3.2.0"
 
   spec.metadata = {
-    'homepage_uri' => 'https://karafka.io',
-    'changelog_uri' => 'https://karafka.io/docs/Changelog-Karafka-Testing',
-    'bug_tracker_uri' => 'https://github.com/karafka/karafka-testing/issues',
-    'source_code_uri' => 'https://github.com/karafka/karafka-testing',
-    'documentation_uri' => 'https://karafka.io/docs',
-    'rubygems_mfa_required' => 'true'
+    "homepage_uri" => "https://karafka.io",
+    "changelog_uri" => "https://karafka.io/docs/Changelog-Karafka-Testing",
+    "bug_tracker_uri" => "https://github.com/karafka/karafka-testing/issues",
+    "source_code_uri" => "https://github.com/karafka/karafka-testing",
+    "documentation_uri" => "https://karafka.io/docs",
+    "rubygems_mfa_required" => "true"
   }
 end

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

@@ -1,11 +1,11 @@
 # frozen_string_literal: true
 
-require 'karafka/testing'
-require 'karafka/testing/errors'
-require 'karafka/testing/helpers'
-require 'karafka/testing/spec_consumer_client'
-require 'karafka/testing/spec_producer_client'
-require 'karafka/testing/minitest/proxy'
+require "karafka/testing"
+require "karafka/testing/errors"
+require "karafka/testing/helpers"
+require "karafka/testing/spec_consumer_client"
+require "karafka/testing/spec_producer_client"
+require "karafka/testing/minitest/proxy"
 
 module Karafka
   module Testing
@@ -42,14 +42,23 @@ module Karafka
               Karafka.producer.stubs(:client).returns(@_karafka_producer_client)
             end
 
-            if base.to_s == 'Minitest::Spec'
+            if base.to_s == "Minitest::Spec"
               base.class_eval do
                 before(&eval_flow)
               end
-            else
+            elsif base.respond_to?(:setup) && base.method(:setup).arity != 0
               base.class_eval do
                 setup(&eval_flow)
               end
+            else
+              setup_mod = Module.new do
+                define_method(:setup) do
+                  instance_exec(&eval_flow)
+                  super()
+                end
+              end
+
+              base.prepend(setup_mod)
             end
           end
         end
@@ -89,11 +98,13 @@ 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_obj = if message[:consumer_group]
+            _karafka_find_consumer_for_message(message)
+          elsif defined?(@consumer)
+            @consumer
+          else
+            _karafka_find_consumer_for_message(message)
+          end
           # Consumer needs to be defined in order to pass messages to it
           return unless defined?(consumer_obj)
           # We're interested in adding message to consumer only when it is a Karafka consumer
@@ -103,6 +114,9 @@ module Karafka
           # 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_obj.topic.name
+          # If consumer_group is explicitly specified, verify it matches
+          return if message[:consumer_group] &&
+            message[:consumer_group].to_s != consumer_obj.topic.consumer_group.name
 
           # Build message metadata and copy any metadata that would come from the message
           metadata = _karafka_message_metadata_defaults(consumer_obj)
@@ -137,21 +151,30 @@ module Karafka
 
         # Produces message with a given payload to the consumer matching topic
         # @param payload [String] payload we want to dispatch
-        # @param metadata [Hash] any metadata we want to dispatch alongside the payload
+        # @param metadata [Hash] any metadata we want to dispatch alongside the payload.
+        #   Supports an `offset` key to set a custom offset for the message (otherwise
+        #   offsets auto-increment from 0).
         def _karafka_produce(payload, metadata = {})
+          # Extract offset before passing to WaterDrop since it is not a valid
+          # WaterDrop message attribute (Kafka assigns offsets, not producers)
+          @_karafka_next_offset = metadata.delete(:offset)
+
           topic = if metadata[:topic]
-                    metadata[:topic]
-                  elsif defined?(@consumer)
-                    @consumer.topic.name
-                  else
-                    @_karafka_consumer_mappings&.keys&.last
-                  end
+            metadata[:topic]
+          elsif defined?(@consumer)
+            @consumer.topic.name
+          else
+            last_consumer = @_karafka_consumer_mappings&.values&.last
+            last_consumer&.topic&.name
+          end
           Karafka.producer.produce_sync(
             {
               topic: topic,
               payload: payload
             }.merge(metadata)
           )
+        ensure
+          @_karafka_next_offset = nil
         end
 
         # @return [Array<Hash>] messages that were produced
@@ -165,8 +188,52 @@ module Karafka
           @_karafka_consumer_messages
         end
 
+        # Produces message to a specific consumer instance
+        # Use when testing multiple consumers for the same topic
+        #
+        # @param consumer_instance [Object] the consumer to produce to
+        # @param payload [String] message content (usually serialized JSON) to deliver to the
+        #   consumer
+        # @param metadata [Hash] any metadata to dispatch alongside the payload
+        #
+        # @example Produce to specific consumer when multiple exist for same topic
+        #   consumer1 = @karafka.consumer_for(:events, :analytics_group)
+        #   consumer2 = @karafka.consumer_for(:events, :notifications_group)
+        #   @karafka.produce_to(consumer1, { 'event' => 'click' }.to_json)
+        def _karafka_produce_to(consumer_instance, payload, metadata = {})
+          _karafka_produce(
+            payload,
+            metadata.merge(
+              topic: consumer_instance.topic.name,
+              consumer_group: consumer_instance.topic.consumer_group.name
+            )
+          )
+        end
+
         private
 
+        # Finds a consumer for the given message with backward-compatible fallback
+        # @param message [Hash] the message being routed
+        # @return [Object, nil] the consumer instance or nil
+        def _karafka_find_consumer_for_message(message)
+          return nil unless @_karafka_consumer_mappings
+
+          topic_name = message[:topic]
+          consumer_group = message[:consumer_group]
+
+          if consumer_group
+            # Explicit consumer group - find by composite key pattern
+            @_karafka_consumer_mappings.values.find do |c|
+              c.topic.name == topic_name && c.topic.consumer_group.name == consumer_group.to_s
+            end
+          else
+            # No consumer group specified - find all consumers for this topic
+            matching = @_karafka_consumer_mappings.values.select { |c| c.topic.name == topic_name }
+            # If exactly one consumer matches, use it (backward compatible)
+            (matching.size == 1) ? matching.first : nil
+          end
+        end
+
         # @param consumer_obj [Karafka::BaseConsumer] consumer reference
         # @return [Hash] message default options
         def _karafka_message_metadata_defaults(consumer_obj)
@@ -175,7 +242,7 @@ module Karafka
             timestamp: Time.now,
             raw_headers: {},
             raw_key: nil,
-            offset: @_karafka_consumer_messages.size,
+            offset: @_karafka_next_offset.nil? ? @_karafka_consumer_messages.size : @_karafka_next_offset,
             partition: 0,
             received_at: Time.now,
             topic: consumer_obj.topic.name
@@ -200,10 +267,10 @@ module Karafka
           @consumer.coordinator = coordinators.find_or_create(topic.name, 0)
           @consumer.coordinator.seek_offset = 0
           # Indicate usage as for tests no direct enqueuing happens
-          @consumer.instance_variable_set('@used', true)
+          @consumer.instance_variable_set(:@used, true)
           expansions = processing_cfg.expansions_selector.find(topic)
           expansions.each { |expansion| @consumer.singleton_class.include(expansion) }
-          @_karafka_consumer_mappings[topic.name] = @consumer
+          @_karafka_consumer_mappings[topic.id] = @consumer
           @consumer
         end
       end

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

@@ -11,14 +11,19 @@ module Karafka
           @minitest_example = minitest_example
         end
 
-        # @param args Anything that the `#_karafka_consumer_for` accepts
-        def consumer_for(*args)
-          @minitest_example._karafka_consumer_for(*args)
+        # Forwards all arguments to `#_karafka_consumer_for`
+        def consumer_for(*)
+          @minitest_example._karafka_consumer_for(*)
         end
 
-        # @param args Anything that `#_karafka_produce` accepts
-        def produce(*args)
-          @minitest_example._karafka_produce(*args)
+        # Forwards all arguments to `#_karafka_produce`
+        def produce(*)
+          @minitest_example._karafka_produce(*)
+        end
+
+        # Forwards all arguments to `#_karafka_produce_to`
+        def produce_to(*)
+          @minitest_example._karafka_produce_to(*)
         end
 
         # @return [Array<Hash>] messages produced via `Karafka#producer`