karafka-testing 2.3.3 → 2.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 91a12f6c61514bc890bdfd8f6c91e1a834dd1516299f8a6d421c54037d3b55b3
-  data.tar.gz: 70d467cb5994992d5a3046511bca0676fabc673b2b36c45d366b98d6aeeeae06
+  metadata.gz: 6aecdc81babc8c73c80c65934abb2dfcddd59a919228cf0a62afe4fa787c7e68
+  data.tar.gz: 1be6197c9e2f9186b8e56e176351254eb54726166cfdf4ebbd2ee48836c08048
 SHA512:
-  metadata.gz: ebb18327ff48e4443377a54a09d35611c84f6806bc298ceb0792d1b2862f7f1c35e2c528bdb8b7e611d61998201f851dc8648530d398fdbbd33ec504d7fedae7
-  data.tar.gz: 9898b5f1bd9264b696361cfd60039226864eb26743722c21a251fad26d2bd9d633b9be0cadcf62dbc7638a5287b69a0aaf720b12ad70595cc03c6bc1c4fe920f
+  metadata.gz: 7a2ec5091955cafed3cafcd29407ac8ac38b90c378c2a950fd9ad7690582c9a1b7553ad64bbd0763783ecda5b75d507f821f8f6555fe81c665b4cf78c0b175e3
+  data.tar.gz: 406958b6a7c9ee99e446ebe33564a7ebb9e87c50384c89fc7b855ff280c68b51e15b2f3d50f0daa14faefcd58caed8bc0028a0bdb68cb3d26697dc49b2a54aab

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/.ruby-version

@@ -1 +1 @@
-3.3.0
+3.3.1

data/CHANGELOG.md

@@ -1,7 +1,15 @@
 # Karafka Test gem changelog
 
-## 2.3.3 (2024-04-19)
+## 2.4.2 (2024-06-30)
+- [Fix] Fix FrozenError when accessing key and headers in `Karafka::Messages::Metadata` (tldn0718)
+
+## 2.4.1 (2024-06-29)
+- [Fix] Fix instance variable in minitest helper (tldn0718)
+
+## 2.4.0 (2024-04-26)
+- **[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)

data/Gemfile.lock

@@ -1,28 +1,28 @@
 PATH
   remote: .
   specs:
-    karafka-testing (2.3.3)
-      karafka (>= 2.3.0, < 2.4.0)
-      waterdrop (>= 2.6.12)
+    karafka-testing (2.4.2)
+      karafka (>= 2.4.0, < 2.5.0)
+      waterdrop (>= 2.7.0)
 
 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)
+      karafka-core (>= 2.4.0, < 2.5.0)
+      waterdrop (>= 2.7.0, < 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)
+      karafka-rdkafka (>= 0.15.0, < 0.16.0)
+    karafka-rdkafka (0.15.0)
       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)
+    rake (13.2.1)
+    waterdrop (2.7.0)
+      karafka-core (>= 2.4.0, < 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,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.4.0', '< 2.5.0'
+  spec.add_dependency 'waterdrop', '>= 2.7.0'
+
+  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,5 +1,6 @@
 # frozen_string_literal: true
 
+require 'karafka/testing'
 require 'karafka/testing/errors'
 require 'karafka/testing/helpers'
 require 'karafka/testing/spec_consumer_client'
@@ -18,6 +19,8 @@ module Karafka
           # @param base [Class] Minitest example group we want to extend
           def included(base)
             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
@@ -97,7 +100,7 @@ module Karafka
           # Add this message to previously produced messages
           @_karafka_consumer_messages << Karafka::Messages::Message.new(
             message[:payload],
-            Karafka::Messages::Metadata.new(metadata).freeze
+            Karafka::Messages::Metadata.new(metadata)
           )
           # Update batch metadata
           batch_metadata = Karafka::Messages::Builders::BatchMetadata.call(
@@ -136,10 +139,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,
@@ -160,7 +163,7 @@ module Karafka
           # Inject appropriate strategy so needed options and components are available
           strategy = Karafka::App.config.internal.processing.strategy_selector.find(topic)
           @consumer.singleton_class.include(strategy)
-          @consumer.client = @karafka_consumer_client
+          @consumer.client = @_karafka_consumer_client
           @consumer.coordinator = coordinators.find_or_create(topic.name, 0)
           @consumer.coordinator.seek_offset = 0
           # Indicate usage as for tests no direct enqueuing happens

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

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require 'waterdrop'
+require 'karafka/testing'
 require 'karafka/testing/errors'
 require 'karafka/testing/helpers'
 require 'karafka/testing/spec_consumer_client'
@@ -31,6 +32,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
 
@@ -105,7 +108,7 @@ module Karafka
           # Add this message to previously produced messages
           _karafka_consumer_messages << Karafka::Messages::Message.new(
             message[:payload],
-            Karafka::Messages::Metadata.new(metadata).freeze
+            Karafka::Messages::Metadata.new(metadata)
           )
 
           # Update batch metadata
@@ -145,10 +148,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,

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.2'
   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.2
 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-04-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: karafka
@@ -43,34 +43,34 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.3.0
+        version: 2.4.0
     - - "<"
       - !ruby/object:Gem::Version
-        version: 2.4.0
+        version: 2.5.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.3.0
+        version: 2.4.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
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.6.12
+        version: 2.7.0
 description: Library which provides helpers for easier Karafka consumers tests
 email:
 - contact@karafka.io
@@ -125,14 +125,14 @@ 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:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.3
+rubygems_version: 3.5.9
 signing_key: 
 specification_version: 4
 summary: Library which provides helpers for easier Karafka consumers tests