karafka-testing 2.3.1 → 2.3.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5b5e94cc98b3418a25cd549e4e9f4851d22fa819b499b77185afb7ee1e1f10c6
-  data.tar.gz: 415e32601301d2f07de6c575109c443af8f489c178041e387d6fe1d1530550ca
+  metadata.gz: 91a12f6c61514bc890bdfd8f6c91e1a834dd1516299f8a6d421c54037d3b55b3
+  data.tar.gz: 70d467cb5994992d5a3046511bca0676fabc673b2b36c45d366b98d6aeeeae06
 SHA512:
-  metadata.gz: 17eb73114b43f84c813ad176f8a8913fde8f175f0b41ecbe78bfd3bb20c30259aaab791cd9cb719c1aab9cef0daceed651d7c342201fffd227db495f5d55ce51
-  data.tar.gz: e42445092d3ab33eb27d1145c9897f94b3758bd57b624935fd8d8fd3f37999d3333caf70b2c713196a672978b478a8dc4a5923aa6924387331c076334e14391f
+  metadata.gz: ebb18327ff48e4443377a54a09d35611c84f6806bc298ceb0792d1b2862f7f1c35e2c528bdb8b7e611d61998201f851dc8648530d398fdbbd33ec504d7fedae7
+  data.tar.gz: 9898b5f1bd9264b696361cfd60039226864eb26743722c21a251fad26d2bd9d633b9be0cadcf62dbc7638a5287b69a0aaf720b12ad70595cc03c6bc1c4fe920f

data/CHANGELOG.md

@@ -1,5 +1,12 @@
 # Karafka Test gem changelog
 
+## 2.3.3 (2024-04-19)
+- [Refactor] Extract common components for Minitest and RSpec.
+- [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.
 - [Enhancement] Prevent usage of testing when Karafka is not initialized.

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    karafka-testing (2.3.1)
+    karafka-testing (2.3.3)
       karafka (>= 2.3.0, < 2.4.0)
       waterdrop (>= 2.6.12)
 

data/lib/karafka/testing/errors.rb

@@ -15,17 +15,7 @@ module Karafka
       TopicInManyConsumerGroupsError = Class.new(BaseError)
 
       # Raised when you requested a topic from a consumer group that does not exist
-      ConsumerGroupNotFoundError = Class.new(BaseError)
-
-      # Raised when trying to use testing without Karafka app being visible
-      # If you are seeing this error, then you tried to use testing helpers without Karafka being
-      # loaded prior to this happening.
-      KarafkaNotLoadedError = Class.new(BaseError)
-
-      # Raised when there is an attempt to use the testing primitives without Karafka app being
-      # configured. Prior to initialization process, most of config values are nils, etc and
-      # mocks will not work.
-      KarafkaNotInitializedError = Class.new(BaseError)
+      ConsumerGroupNotFound = Class.new(BaseError)
     end
   end
 end

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

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 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'
@@ -16,19 +17,25 @@ 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 = 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)
+            end
 
-                Karafka.producer.stubs(:client).returns(@_karafka_producer_client)
+            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
@@ -47,7 +54,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
           )
@@ -160,48 +167,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

@@ -2,6 +2,7 @@
 
 require 'waterdrop'
 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'
@@ -30,8 +31,6 @@ module Karafka
             base.let(:_karafka_producer_client) { Karafka::Testing::SpecProducerClient.new(self) }
 
             base.prepend_before do
-              Karafka::Testing.ensure_karafka_initialized!
-
               _karafka_consumer_messages.clear
               _karafka_producer_client.reset
 
@@ -59,7 +58,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
           )
@@ -178,48 +177,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.3.1'
+    VERSION = '2.3.3'
   end
 end

data/lib/karafka/testing.rb

@@ -4,32 +4,5 @@
 module Karafka
   # Testing lib module
   module Testing
-    class << self
-      # Makes sure, that we do not use the testing stubs, etc when Karafka app is not loaded
-      #
-      # You should never use karafka-testing primitives when framework is not loaded because
-      # testing lib stubs certain pieces of Karafka that need to be initialized.
-      def ensure_karafka_loaded!
-        return if ::Karafka.const_defined?('App', false)
-
-        raise(
-          Karafka::Testing::Errors::KarafkaNotLoadedError,
-          'Make sure to load Karafka framework prior to usage of the testing components.'
-        )
-      end
-
-      # If you do not initialize Karafka always within your specs, do not include/use this lib
-      # in places where Karafka would not be loaded.
-      def ensure_karafka_initialized!
-        ensure_karafka_loaded!
-
-        return unless Karafka::App.initializing?
-
-        raise(
-          Karafka::Testing::Errors::KarafkaNotInitializedError,
-          'Make sure to initialize Karafka framework prior to usage of the testing components.'
-        )
-      end
-    end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: karafka-testing
 version: !ruby/object:Gem::Version
-  version: 2.3.1
+  version: 2.3.3
 platform: ruby
 authors:
 - Maciej Mensfeld
@@ -35,7 +35,7 @@ cert_chain:
   AnG1dJU+yL2BK7vaVytLTstJME5mepSZ46qqIJXMuWob/YPDmVaBF39TDSG9e34s
   msG3BiCqgOgHAnL23+CN3Rt8MsuRfEtoTKpJVcCfoEoNHOkc
   -----END CERTIFICATE-----
-date: 2024-03-07 00:00:00.000000000 Z
+date: 2024-04-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: karafka
@@ -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