karafka-testing 2.3.3 → 2.4.0.beta1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 91a12f6c61514bc890bdfd8f6c91e1a834dd1516299f8a6d421c54037d3b55b3
-  data.tar.gz: 70d467cb5994992d5a3046511bca0676fabc673b2b36c45d366b98d6aeeeae06
+  metadata.gz: e62624d40d7aa454841a212de1beaf67127ef06873bd0604dcbfe4747a397cf5
+  data.tar.gz: 2e031857e92ce50f55ea24e3cb32309a070c11ea930de263f05ec9c82f24992d
 SHA512:
-  metadata.gz: ebb18327ff48e4443377a54a09d35611c84f6806bc298ceb0792d1b2862f7f1c35e2c528bdb8b7e611d61998201f851dc8648530d398fdbbd33ec504d7fedae7
-  data.tar.gz: 9898b5f1bd9264b696361cfd60039226864eb26743722c21a251fad26d2bd9d633b9be0cadcf62dbc7638a5287b69a0aaf720b12ad70595cc03c6bc1c4fe920f
+  metadata.gz: b2c5398aa8d03a31499a29b60f3e45456e6151cbbd57f979dac9ddc6aea283e5fb6b0613a1df336fb3d46284af16861125a7df980c9701ace2af2d2d3ef8336f
+  data.tar.gz: f32201af31b9e0840ce41e7c17a16a64b7fedfb99a4cb1815f2b18a1fa45bed474eb9dc02e3b68e504a0d2be2191a141e64ed52fad25fee9ba86e42030250a0f

data/.github/workflows/ci.yml

@@ -22,7 +22,6 @@ jobs:
           - '3.2'
           - '3.1'
           - '3.0'
-          - '2.7'
         include:
           - ruby: '3.3'
             coverage: 'true'
@@ -40,24 +39,14 @@ jobs:
 
       - name: Install latest bundler
         run: |
-          if [[ "$(ruby -v | awk '{print $2}')" == 2.7.8* ]]; then
-            gem install bundler -v 2.4.22 --no-document
-            bundle config set version 2.4.22
-            gem update --system 3.4.22 --no-document
-          else
-            gem install bundler --no-document
-            gem update --system --no-document
-          fi
+          gem install bundler --no-document
+          gem update --system --no-document
 
           bundle config set without 'tools benchmarks docs'
 
       - name: Bundle install
         run: |
-          if [[ "$(ruby -v | awk '{print $2}')" == 2.7.8* ]]; then
-            BUNDLER_VERSION=2.4.22 bundle install --jobs 4 --retry 3
-          else
-            bundle install --jobs 4 --retry 3
-          fi
+          bundle install --jobs 4 --retry 3
 
   diffend:
     runs-on: ubuntu-latest

data/CHANGELOG.md

@@ -1,11 +1,8 @@
 # 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.4.0 (Unreleased)
+- **[Breaking]** Drop Ruby `2.7` support.
+- [Fix] Support again `require: false` on gem loading.
 
 ## 2.3.1 (2024-03-07)
 - [Enhancement] Prevent usage of testing when Karafka is not loaded.

data/Gemfile.lock

@@ -1,9 +1,9 @@
 PATH
   remote: .
   specs:
-    karafka-testing (2.3.3)
-      karafka (>= 2.3.0, < 2.4.0)
-      waterdrop (>= 2.6.12)
+    karafka-testing (2.4.0.beta1)
+      karafka (>= 2.3.0, < 2.5.0)
+      waterdrop (>= 2.7.0.beta2)
 
 GEM
   remote: https://rubygems.org/
@@ -13,16 +13,16 @@ GEM
       karafka-core (>= 2.3.0, < 2.4.0)
       waterdrop (>= 2.6.12, < 3.0.0)
       zeitwerk (~> 2.3)
-    karafka-core (2.3.0)
-      karafka-rdkafka (>= 0.14.8, < 0.15.0)
-    karafka-rdkafka (0.14.10)
+    karafka-core (2.4.0.beta2)
+      karafka-rdkafka (>= 0.15.0.beta3, < 0.16.0)
+    karafka-rdkafka (0.15.0.beta3)
       ffi (~> 1.15)
       mini_portile2 (~> 2.6)
       rake (> 12)
     mini_portile2 (2.8.5)
     rake (13.1.0)
-    waterdrop (2.6.14)
-      karafka-core (>= 2.2.3, < 3.0.0)
+    waterdrop (2.7.0.beta2)
+      karafka-core (>= 2.4.0.beta2, < 3.0.0)
       zeitwerk (~> 2.3)
     zeitwerk (2.6.13)
 

data/karafka-testing.gemspec

@@ -24,8 +24,10 @@ 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.4.0'
-  spec.add_dependency 'waterdrop', '>= 2.6.12'
+  spec.add_dependency 'karafka', '>= 2.3.0', '< 2.5.0'
+  spec.add_dependency 'waterdrop', '>= 2.7.0.beta2'
+
+  spec.required_ruby_version = '>= 3.0.0'
 
   spec.metadata = {
     'funding_uri' => 'https://karafka.io/#become-pro',

data/lib/karafka/testing/errors.rb

@@ -15,7 +15,17 @@ module Karafka
       TopicInManyConsumerGroupsError = Class.new(BaseError)
 
       # Raised when you requested a topic from a consumer group that does not exist
-      ConsumerGroupNotFound = Class.new(BaseError)
+      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)
     end
   end
 end

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

@@ -1,7 +1,7 @@
 # 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'
@@ -17,25 +17,19 @@ 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)
-            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)
+            base.class_eval do
+              setup do
+                Karafka::Testing.ensure_karafka_initialized!
 
-              @_karafka_consumer_messages.clear
-              @_karafka_producer_client.reset
+                @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.producer.stubs(:client).returns(@_karafka_producer_client)
-            end
+                @_karafka_consumer_messages.clear
+                @_karafka_producer_client.reset
 
-            if base.to_s == 'Minitest::Spec'
-              base.class_eval do
-                before(&eval_flow)
-              end
-            else
-              base.class_eval do
-                setup(&eval_flow)
+                Karafka.producer.stubs(:client).returns(@_karafka_producer_client)
               end
             end
           end
@@ -54,7 +48,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 = Testing::Helpers.karafka_consumer_find_candidate_topics(
+          selected_topics = _karafka_consumer_find_candidate_topics(
             requested_topic.to_s,
             requested_consumer_group.to_s
           )
@@ -136,10 +130,10 @@ module Karafka
         # @return [Hash] message default options
         def _karafka_message_metadata_defaults
           {
-            deserializer: @consumer.topic.deserializer,
+            deserializers: @consumer.topic.deserializers,
             timestamp: Time.now,
-            headers: {},
-            key: nil,
+            raw_headers: {},
+            raw_key: nil,
             offset: @_karafka_consumer_messages.size,
             partition: 0,
             received_at: Time.now,
@@ -167,6 +161,48 @@ 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

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
 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'
@@ -31,6 +31,8 @@ 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
 
@@ -58,7 +60,7 @@ module Karafka
         #     subject(:consumer) { karafka.consumer_for(:my_requested_topic) }
         #   end
         def _karafka_consumer_for(requested_topic, requested_consumer_group = nil)
-          selected_topics = Testing::Helpers.karafka_consumer_find_candidate_topics(
+          selected_topics = _karafka_consumer_find_candidate_topics(
             requested_topic.to_s,
             requested_consumer_group.to_s
           )
@@ -145,10 +147,10 @@ module Karafka
         # @return [Hash] message default options
         def _karafka_message_metadata_defaults
           {
-            deserializer: consumer.topic.deserializer,
+            deserializers: consumer.topic.deserializers,
             timestamp: Time.now,
-            headers: {},
-            key: nil,
+            raw_headers: {},
+            raw_key: nil,
             offset: _karafka_consumer_messages.size,
             partition: 0,
             received_at: Time.now,
@@ -177,6 +179,48 @@ 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.3'
+    VERSION = '2.4.0.beta1'
   end
 end

data/lib/karafka/testing.rb

@@ -4,5 +4,32 @@
 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.3
+  version: 2.4.0.beta1
 platform: ruby
 authors:
 - Maciej Mensfeld
@@ -35,7 +35,7 @@ cert_chain:
   AnG1dJU+yL2BK7vaVytLTstJME5mepSZ46qqIJXMuWob/YPDmVaBF39TDSG9e34s
   msG3BiCqgOgHAnL23+CN3Rt8MsuRfEtoTKpJVcCfoEoNHOkc
   -----END CERTIFICATE-----
-date: 2024-04-22 00:00:00.000000000 Z
+date: 2024-03-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: karafka
@@ -46,7 +46,7 @@ dependencies:
         version: 2.3.0
     - - "<"
       - !ruby/object:Gem::Version
-        version: 2.4.0
+        version: 2.5.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -56,21 +56,21 @@ dependencies:
         version: 2.3.0
     - - "<"
       - !ruby/object:Gem::Version
-        version: 2.4.0
+        version: 2.5.0
 - !ruby/object:Gem::Dependency
   name: waterdrop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.6.12
+        version: 2.7.0.beta2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.6.12
+        version: 2.7.0.beta2
 description: Library which provides helpers for easier Karafka consumers tests
 email:
 - contact@karafka.io
@@ -97,7 +97,6 @@ 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
@@ -125,7 +124,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 3.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="

data/lib/karafka/testing/helpers.rb

@@ -1,55 +0,0 @@
-# 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