karafka-testing 2.3.0 → 2.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7234ba09684afa8617cf8c3f335462e418dbe1369792949d189029f9ec22e40c
-  data.tar.gz: '0861af20657686d3f7b3b0f99453959df567eb2b91f5ba1e60c23416e272633a'
+  metadata.gz: 5b5e94cc98b3418a25cd549e4e9f4851d22fa819b499b77185afb7ee1e1f10c6
+  data.tar.gz: 415e32601301d2f07de6c575109c443af8f489c178041e387d6fe1d1530550ca
 SHA512:
-  metadata.gz: a210c2545d78aa92c4b9fd554f7d9687268d39e9ccd86ca5ebe8f94de55a295226e5c10126e948b11a769695baecbfaee183aa2318a1ce9a3e8aa4f0e8136791
-  data.tar.gz: 1f6365ee9adec3023b077c073c74ed10e66271d00ebd656eeb54bc12f912a981583f3e10e113bff530fa3a4dc3994ee95d4b95e93347f7576d6efa186ee0ff7b
+  metadata.gz: 17eb73114b43f84c813ad176f8a8913fde8f175f0b41ecbe78bfd3bb20c30259aaab791cd9cb719c1aab9cef0daceed651d7c342201fffd227db495f5d55ce51
+  data.tar.gz: e42445092d3ab33eb27d1145c9897f94b3758bd57b624935fd8d8fd3f37999d3333caf70b2c713196a672978b478a8dc4a5923aa6924387331c076334e14391f

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 # Karafka Test gem changelog
 
+## 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.
+- [Fix] Same CG multiplexing topic builder fails with `TopicInManyConsumerGroupsError`.
+
 ## 2.3.0 (2024-01-26)
 - [Maintenance] Release matching Karafka `2.3.0` release.
 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    karafka-testing (2.3.0)
+    karafka-testing (2.3.1)
       karafka (>= 2.3.0, < 2.4.0)
       waterdrop (>= 2.6.12)
 
@@ -9,22 +9,22 @@ GEM
   remote: https://rubygems.org/
   specs:
     ffi (1.16.3)
-    karafka (2.3.0)
+    karafka (2.3.3)
       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.8)
+    karafka-rdkafka (0.14.10)
       ffi (~> 1.15)
       mini_portile2 (~> 2.6)
       rake (> 12)
     mini_portile2 (2.8.5)
     rake (13.1.0)
-    waterdrop (2.6.12)
+    waterdrop (2.6.14)
       karafka-core (>= 2.2.3, < 3.0.0)
       zeitwerk (~> 2.3)
-    zeitwerk (2.6.12)
+    zeitwerk (2.6.13)
 
 PLATFORMS
   ruby
@@ -34,4 +34,4 @@ DEPENDENCIES
   karafka-testing!
 
 BUNDLED WITH
-   2.5.5
+   2.5.6

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

@@ -18,6 +18,8 @@ module Karafka
           def included(base)
             base.class_eval do
               setup do
+                Karafka::Testing.ensure_karafka_initialized!
+
                 @karafka = Karafka::Testing::Minitest::Proxy.new(self)
                 @_karafka_consumer_messages = []
                 @_karafka_consumer_client = Karafka::Testing::SpecConsumerClient.new
@@ -176,6 +178,7 @@ module Karafka
             rescue Karafka::Errors::TopicNotFoundError
               nil
             end
+            .uniq(&:consumer_group)
         end
 
         # Finds subscription groups from the requested consumer group or selects all if no

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

@@ -30,6 +30,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
 
@@ -194,6 +196,7 @@ module Karafka
             rescue Karafka::Errors::TopicNotFoundError
               nil
             end
+            .uniq(&:consumer_group)
         end
 
         # Finds subscription groups from the requested consumer group or selects all if no

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.0'
+    VERSION = '2.3.1'
   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.0
+  version: 2.3.1
 platform: ruby
 authors:
 - Maciej Mensfeld
@@ -35,7 +35,7 @@ cert_chain:
   AnG1dJU+yL2BK7vaVytLTstJME5mepSZ46qqIJXMuWob/YPDmVaBF39TDSG9e34s
   msG3BiCqgOgHAnL23+CN3Rt8MsuRfEtoTKpJVcCfoEoNHOkc
   -----END CERTIFICATE-----
-date: 2024-01-26 00:00:00.000000000 Z
+date: 2024-03-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: karafka