karafka-testing 2.4.0.beta1 → 2.4.0.rc2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e62624d40d7aa454841a212de1beaf67127ef06873bd0604dcbfe4747a397cf5
-  data.tar.gz: 2e031857e92ce50f55ea24e3cb32309a070c11ea930de263f05ec9c82f24992d
+  metadata.gz: 91dfd9d61d189ef4382255dd90805291525c7ce596002f5932eddbf60d0ed4d4
+  data.tar.gz: c288612346f823379c454a2de964c6600a4705a99704c2261b78e8f685f33068
 SHA512:
-  metadata.gz: b2c5398aa8d03a31499a29b60f3e45456e6151cbbd57f979dac9ddc6aea283e5fb6b0613a1df336fb3d46284af16861125a7df980c9701ace2af2d2d3ef8336f
-  data.tar.gz: f32201af31b9e0840ce41e7c17a16a64b7fedfb99a4cb1815f2b18a1fa45bed474eb9dc02e3b68e504a0d2be2191a141e64ed52fad25fee9ba86e42030250a0f
+  metadata.gz: 49458d3a51b4d8ba2a6b073c67dd43a85d1987aa9a300a1047a5268d6f61ae85d4c60a587fe9e8078bec0c61a900b129a8272a931a81fef3f017d548d04ce83b
+  data.tar.gz: 27e88641a3c2b0795731bebddf56bb5a81159730152c8fb3859543af5dcdb8bca9f762e4edaaafee931ef8cfc6d18f62c44a2993c321d44b104160826922d974

data/CHANGELOG.md

@@ -2,7 +2,12 @@
 
 ## 2.4.0 (Unreleased)
 - **[Breaking]** Drop Ruby `2.7` support.
+- [Refactor] Extract common components for Minitest and RSpec.
 - [Fix] Support again `require: false` on gem loading.
+- [Fix] Fix a case where multiplexed SG would fail with `TopicInManyConsumerGroupsError`
+
+## 2.3.2 (2024-04-03)
+- [Enhancement] Support `Minitest::Spec`.
 
 ## 2.3.1 (2024-03-07)
 - [Enhancement] Prevent usage of testing when Karafka is not loaded.

data/Gemfile.lock

@@ -1,28 +1,28 @@
 PATH
   remote: .
   specs:
-    karafka-testing (2.4.0.beta1)
-      karafka (>= 2.3.0, < 2.5.0)
-      waterdrop (>= 2.7.0.beta2)
+    karafka-testing (2.4.0.rc2)
+      karafka (>= 2.4.0.beta1, < 2.5.0)
+      waterdrop (>= 2.7.0.rc1)
 
 GEM
   remote: https://rubygems.org/
   specs:
     ffi (1.16.3)
-    karafka (2.3.3)
-      karafka-core (>= 2.3.0, < 2.4.0)
-      waterdrop (>= 2.6.12, < 3.0.0)
+    karafka (2.4.0.beta1)
+      karafka-core (>= 2.4.0.rc1, < 2.5.0)
+      waterdrop (>= 2.7.0.rc1, < 3.0.0)
       zeitwerk (~> 2.3)
-    karafka-core (2.4.0.beta2)
-      karafka-rdkafka (>= 0.15.0.beta3, < 0.16.0)
-    karafka-rdkafka (0.15.0.beta3)
+    karafka-core (2.4.0.rc1)
+      karafka-rdkafka (>= 0.15.0.rc1, < 0.16.0)
+    karafka-rdkafka (0.15.0.rc1)
       ffi (~> 1.15)
       mini_portile2 (~> 2.6)
       rake (> 12)
     mini_portile2 (2.8.5)
-    rake (13.1.0)
-    waterdrop (2.7.0.beta2)
-      karafka-core (>= 2.4.0.beta2, < 3.0.0)
+    rake (13.2.1)
+    waterdrop (2.7.0.rc1)
+      karafka-core (>= 2.4.0.rc1, < 3.0.0)
       zeitwerk (~> 2.3)
     zeitwerk (2.6.13)
 
@@ -34,4 +34,4 @@ DEPENDENCIES
   karafka-testing!
 
 BUNDLED WITH
-   2.5.6
+   2.5.7

data/karafka-testing.gemspec

@@ -24,8 +24,8 @@ Gem::Specification.new do |spec|
     spec.signing_key = File.expand_path('~/.ssh/gem-private_key.pem')
   end
 
-  spec.add_dependency 'karafka', '>= 2.3.0', '< 2.5.0'
-  spec.add_dependency 'waterdrop', '>= 2.7.0.beta2'
+  spec.add_dependency 'karafka', '>= 2.4.0.beta1', '< 2.5.0'
+  spec.add_dependency 'waterdrop', '>= 2.7.0.rc1'
 
   spec.required_ruby_version = '>= 3.0.0'
 

data/lib/karafka/testing/helpers.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+module Karafka
+  module Testing
+    # Common helper methods that are shared in between RSpec and Minitest
+    module Helpers
+      class << self
+        # Finds all the routing topics matching requested topic within all topics or within
+        # provided consumer group based on name
+        #
+        # @param requested_topic [String] requested topic name
+        # @param requested_consumer_group [String] requested consumer group or nil to look in all
+        # @return [Array<Karafka::Routing::Topic>] all matching topics
+        #
+        # @note Since we run the lookup on subscription groups, the search will automatically
+        #   expand with matching patterns
+        def karafka_consumer_find_candidate_topics(requested_topic, requested_consumer_group)
+          karafka_consumer_find_subscription_groups(requested_consumer_group)
+            # multiplexed subscriptions of the same origin share name, thus we can reduced
+            # multiplexing to the first one as during testing, there is no multiplexing parallel
+            # execution anyhow
+            .uniq(&:name)
+            .map(&:topics)
+            .filter_map do |topics|
+              topics.find(requested_topic.to_s)
+            rescue Karafka::Errors::TopicNotFoundError
+              nil
+            end
+        end
+
+        # Finds subscription groups from the requested consumer group or selects all if no
+        # consumer group specified
+        # @param requested_consumer_group [String] requested consumer group or nil to look in all
+        # @return [Array<Karafka::Routing::SubscriptionGroup>] requested subscription groups
+        def karafka_consumer_find_subscription_groups(requested_consumer_group)
+          if requested_consumer_group && !requested_consumer_group.empty?
+            ::Karafka::App
+              .subscription_groups
+              # Find matching consumer group
+              .find { |cg, _sgs| cg.name == requested_consumer_group.to_s }
+              # Raise error if not found
+              .tap { |cg| cg || raise(Errors::ConsumerGroupNotFound, requested_consumer_group) }
+              # Since lookup was on a hash, get the value, that is subscription groups
+              .last
+          else
+            ::Karafka::App
+              .subscription_groups
+              .values
+              .flatten
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -2,6 +2,7 @@
 
 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'
@@ -17,19 +18,27 @@ module Karafka
           # Adds all the needed extra functionalities to the minitest group
           # @param base [Class] Minitest example group we want to extend
           def included(base)
-            base.class_eval do
-              setup do
-                Karafka::Testing.ensure_karafka_initialized!
+            eval_flow = lambda do
+              Karafka::Testing.ensure_karafka_initialized!
 
-                @karafka = Karafka::Testing::Minitest::Proxy.new(self)
-                @_karafka_consumer_messages = []
-                @_karafka_consumer_client = Karafka::Testing::SpecConsumerClient.new
-                @_karafka_producer_client = Karafka::Testing::SpecProducerClient.new(self)
+              @karafka = Karafka::Testing::Minitest::Proxy.new(self)
+              @_karafka_consumer_messages = []
+              @_karafka_consumer_client = Karafka::Testing::SpecConsumerClient.new
+              @_karafka_producer_client = Karafka::Testing::SpecProducerClient.new(self)
 
-                @_karafka_consumer_messages.clear
-                @_karafka_producer_client.reset
+              @_karafka_consumer_messages.clear
+              @_karafka_producer_client.reset
 
-                Karafka.producer.stubs(:client).returns(@_karafka_producer_client)
+              Karafka.producer.stubs(:client).returns(@_karafka_producer_client)
+            end
+
+            if base.to_s == 'Minitest::Spec'
+              base.class_eval do
+                before(&eval_flow)
+              end
+            else
+              base.class_eval do
+                setup(&eval_flow)
               end
             end
           end
@@ -48,7 +57,7 @@ module Karafka
         # @example Creates a consumer instance with settings for `my_requested_topic`
         #   consumer = @karafka.consumer_for(:my_requested_topic)
         def _karafka_consumer_for(requested_topic, requested_consumer_group = nil)
-          selected_topics = _karafka_consumer_find_candidate_topics(
+          selected_topics = Testing::Helpers.karafka_consumer_find_candidate_topics(
             requested_topic.to_s,
             requested_consumer_group.to_s
           )
@@ -161,48 +170,6 @@ module Karafka
           @consumer.instance_variable_set('@used', true)
           @consumer
         end
-
-        # Finds all the routing topics matching requested topic within all topics or within
-        # provided consumer group based on name
-        #
-        # @param requested_topic [String] requested topic name
-        # @param requested_consumer_group [String] requested consumer group or nil to look in all
-        # @return [Array<Karafka::Routing::Topic>] all matching topics
-        #
-        # @note Since we run the lookup on subscription groups, the search will automatically
-        #   expand with matching patterns
-        def _karafka_consumer_find_candidate_topics(requested_topic, requested_consumer_group)
-          _karafka_consumer_find_subscription_groups(requested_consumer_group)
-            .map(&:topics)
-            .filter_map do |topics|
-              topics.find(requested_topic.to_s)
-            rescue Karafka::Errors::TopicNotFoundError
-              nil
-            end
-            .uniq(&:consumer_group)
-        end
-
-        # Finds subscription groups from the requested consumer group or selects all if no
-        # consumer group specified
-        # @param requested_consumer_group [String] requested consumer group or nil to look in all
-        # @return [Array<Karafka::Routing::SubscriptionGroup>] requested subscription groups
-        def _karafka_consumer_find_subscription_groups(requested_consumer_group)
-          if requested_consumer_group && !requested_consumer_group.empty?
-            ::Karafka::App
-              .subscription_groups
-              # Find matching consumer group
-              .find { |cg, _sgs| cg.name == requested_consumer_group.to_s }
-              # Raise error if not found
-              .tap { |cg| cg || raise(Errors::ConsumerGroupNotFound, requested_consumer_group) }
-              # Since lookup was on a hash, get the value, that is subscription groups
-              .last
-          else
-            ::Karafka::App
-              .subscription_groups
-              .values
-              .flatten
-          end
-        end
       end
     end
   end

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

@@ -3,6 +3,7 @@
 require 'waterdrop'
 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/rspec/proxy'
@@ -60,7 +61,7 @@ module Karafka
         #     subject(:consumer) { karafka.consumer_for(:my_requested_topic) }
         #   end
         def _karafka_consumer_for(requested_topic, requested_consumer_group = nil)
-          selected_topics = _karafka_consumer_find_candidate_topics(
+          selected_topics = Testing::Helpers.karafka_consumer_find_candidate_topics(
             requested_topic.to_s,
             requested_consumer_group.to_s
           )
@@ -179,48 +180,6 @@ module Karafka
           consumer.instance_variable_set('@used', true)
           consumer
         end
-
-        # Finds all the routing topics matching requested topic within all topics or within
-        # provided consumer group based on name
-        #
-        # @param requested_topic [String] requested topic name
-        # @param requested_consumer_group [String] requested consumer group or nil to look in all
-        # @return [Array<Karafka::Routing::Topic>] all matching topics
-        #
-        # @note Since we run the lookup on subscription groups, the search will automatically
-        #   expand with matching patterns
-        def _karafka_consumer_find_candidate_topics(requested_topic, requested_consumer_group)
-          _karafka_consumer_find_subscription_groups(requested_consumer_group)
-            .map(&:topics)
-            .filter_map do |topics|
-              topics.find(requested_topic.to_s)
-            rescue Karafka::Errors::TopicNotFoundError
-              nil
-            end
-            .uniq(&:consumer_group)
-        end
-
-        # Finds subscription groups from the requested consumer group or selects all if no
-        # consumer group specified
-        # @param requested_consumer_group [String] requested consumer group or nil to look in all
-        # @return [Array<Karafka::Routing::SubscriptionGroup>] requested subscription groups
-        def _karafka_consumer_find_subscription_groups(requested_consumer_group)
-          if requested_consumer_group && !requested_consumer_group.empty?
-            ::Karafka::App
-              .subscription_groups
-              # Find matching consumer group
-              .find { |cg, _sgs| cg.name == requested_consumer_group.to_s }
-              # Raise error if not found
-              .tap { |cg| cg || raise(Errors::ConsumerGroupNotFound, requested_consumer_group) }
-              # Since lookup was on a hash, get the value, that is subscription groups
-              .last
-          else
-            ::Karafka::App
-              .subscription_groups
-              .values
-              .flatten
-          end
-        end
       end
     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.0.beta1'
+    VERSION = '2.4.0.rc2'
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: karafka-testing
 version: !ruby/object:Gem::Version
-  version: 2.4.0.beta1
+  version: 2.4.0.rc2
 platform: ruby
 authors:
 - Maciej Mensfeld
@@ -35,7 +35,7 @@ cert_chain:
   AnG1dJU+yL2BK7vaVytLTstJME5mepSZ46qqIJXMuWob/YPDmVaBF39TDSG9e34s
   msG3BiCqgOgHAnL23+CN3Rt8MsuRfEtoTKpJVcCfoEoNHOkc
   -----END CERTIFICATE-----
-date: 2024-03-27 00:00:00.000000000 Z
+date: 2024-04-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: karafka
@@ -43,7 +43,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.3.0
+        version: 2.4.0.beta1
     - - "<"
       - !ruby/object:Gem::Version
         version: 2.5.0
@@ -53,7 +53,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.3.0
+        version: 2.4.0.beta1
     - - "<"
       - !ruby/object:Gem::Version
         version: 2.5.0
@@ -63,14 +63,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.7.0.beta2
+        version: 2.7.0.rc1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.7.0.beta2
+        version: 2.7.0.rc1
 description: Library which provides helpers for easier Karafka consumers tests
 email:
 - contact@karafka.io
@@ -97,6 +97,7 @@ files:
 - lib/karafka-testing.rb
 - lib/karafka/testing.rb
 - lib/karafka/testing/errors.rb
+- lib/karafka/testing/helpers.rb
 - lib/karafka/testing/minitest/helpers.rb
 - lib/karafka/testing/minitest/proxy.rb
 - lib/karafka/testing/rspec/helpers.rb