karafka-testing 2.0.5 → 2.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 513e1bb6f2a9ac5806fc7df36f788f4ba1b1f72286110e0584ad882d347453fe
-  data.tar.gz: a758a804787420eea61375763bcad90a6c2033426d46f8b07707fc5c22d9de72
+  metadata.gz: 053ac6d1b86ca621030d7d73ad5e8c629a8b3c4ebf05c83ab89646772edf6565
+  data.tar.gz: 3c8182120690c121f41ea395ddef68b35ef18af9a4a448b106dc1efbd45cb5d2
 SHA512:
-  metadata.gz: e313af611899b8a3b47791d63694b24612bd97b27dde6262b929a7af315b64c0c2a1e0fd0b22fe25838d41b3c592c302b610e67031b44b27f08ee2daf78a4705
-  data.tar.gz: 18d88784906a4d19a33dab5ceca6236c1720d488c58b56e324464eb5730096c5f3bcfcfa3b8481fe4db974c10a2d294d3c91a50b9d7c030e28a0314531c1798c
+  metadata.gz: 8dc3c9437a06c83b85329170d670172152b17c0057b6a40655630032d885f7a743306eaafdd737ac7a65db4a0a9aa3da2d53f2aac2659587a31b8b3e9a3cb16e
+  data.tar.gz: 67cbaef664caedeadb54cd8fa1ccc3be917fbc17f5cfe34b22a1ad8ee259937f652de68e16dc870ef7b490f66ec16856d2de3f3e841075ad17620725e041f329

data/.github/FUNDING.yml

@@ -0,0 +1 @@
+custom: ['https://karafka.io/#become-pro']

data/.github/workflows/ci.yml

@@ -16,14 +16,15 @@ jobs:
       fail-fast: false
       matrix:
         ruby:
+          - '3.2'
           - '3.1'
           - '3.0'
           - '2.7'
         include:
-          - ruby: '3.1'
+          - ruby: '3.2'
             coverage: 'true'
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
       - name: Install package dependencies
         run: "[ -e $APT_DEPS ] || sudo apt-get install -y --no-install-recommends $APT_DEPS"
       - name: Set up Ruby
@@ -42,13 +43,13 @@ jobs:
     strategy:
       fail-fast: false
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
         with:
           fetch-depth: 0
       - name: Set up Ruby
         uses: ruby/setup-ruby@v1
         with:
-          ruby-version: 3.1
+          ruby-version: 3.2
       - name: Install latest bundler
         run: gem install bundler --no-document
       - name: Install Diffend plugin

data/.ruby-version

@@ -1 +1 @@
-3.1.2
+3.2.2

data/CHANGELOG.md

@@ -1,5 +1,42 @@
 # Karafka Test gem changelog
 
+## 2.1.4 (2023-06-20)
+- [Fix] Fix invalid consumer group assignment for consumers created for non-default consumer group when same topic is being used multiple times.
+
+## 2.1.3 (2023-06-19)
+- [Enhancement] Align with Karafka `2.1.5` API.
+
+## 2.1.2 (2023-06-13)
+- [Enhancement] Depend on WaterDrop `>=` `2.6.0` directly and not via Karafka to make sure correct version is used.
+- [Fix] Use proper WaterDrop `>=` `2.6.0` buffered client reference.
+
+## 2.1.1 (2023-06-07)
+- [Enhancement] Support WaterDrop stubs with Mocha.
+
+## 2.1.0 (2023-05-22)
+- [Maintenance] Align Karafka expectations to match `2.1.0`.
+
+## 2.0.11 (2023-04-13)
+- Align metadata builder format with Karafka `2.0.40`.
+
+## 2.0.10 (2023-04-11)
+- Align with changes in Karafka `2.0.39`
+- Replace direct `described_class` reference for consumer building with `topic.consumer` Karafka routing based one. This change will allow for usage of `karafka.consumer_for` from any specs.
+
+## 2.0.9 (2023-02-10)
+- Inject consumer strategy to the test consumer instance.
+
+## 2.0.8 (2022-11-03)
+- Do not lock Ruby and rely on `karafka-core` via `karafka`.
+- Due to changes in the engine, lock to `2.0.20`.
+
+## 2.0.7 (2022-11-03)
+- Release version with cert with valid access permissions (#114).
+
+## 2.0.6 (2022-10-26)
+- Replace the `subject` reference with named `consumer` reference.
+- Do not forward sent messages to `consumer` unless it's a Karafka consumer.
+
 ## 2.0.5 (2022-10-19)
 - Fix for: Test event production without defining a subject (#102)
 

data/Gemfile.lock

@@ -1,34 +1,34 @@
 PATH
   remote: .
   specs:
-    karafka-testing (2.0.5)
-      karafka (>= 2.0, < 3.0.0)
+    karafka-testing (2.1.4)
+      karafka (>= 2.1.5, < 3.0.0)
+      waterdrop (>= 2.6.1)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    concurrent-ruby (1.1.10)
+    concurrent-ruby (1.2.2)
     ffi (1.15.5)
-    karafka (2.0.14)
-      karafka-core (>= 2.0.2, < 3.0.0)
-      rdkafka (>= 0.12)
+    karafka (2.1.5)
+      karafka-core (>= 2.1.0, < 2.2.0)
       thor (>= 0.20)
-      waterdrop (>= 2.4.1, < 3.0.0)
+      waterdrop (>= 2.6.1, < 3.0.0)
       zeitwerk (~> 2.3)
-    karafka-core (2.0.3)
+    karafka-core (2.1.0)
       concurrent-ruby (>= 1.1)
-    mini_portile2 (2.8.0)
-    rake (13.0.6)
-    rdkafka (0.12.0)
+      karafka-rdkafka (>= 0.13.0, < 0.14.0)
+    karafka-rdkafka (0.13.0)
       ffi (~> 1.15)
       mini_portile2 (~> 2.6)
       rake (> 12)
+    mini_portile2 (2.8.1)
+    rake (13.0.6)
     thor (1.2.1)
-    waterdrop (2.4.2)
-      karafka-core (>= 2.0.2, < 3.0.0)
-      rdkafka (>= 0.10)
+    waterdrop (2.6.1)
+      karafka-core (>= 2.1.0, < 3.0.0)
       zeitwerk (~> 2.3)
-    zeitwerk (2.6.1)
+    zeitwerk (2.6.7)
 
 PLATFORMS
   arm64-darwin
@@ -38,4 +38,4 @@ DEPENDENCIES
   karafka-testing!
 
 BUNDLED WITH
-   2.3.24
+   2.4.12

data/karafka-testing.gemspec

@@ -20,16 +20,20 @@ Gem::Specification.new do |spec|
   spec.require_paths = %w[lib]
   spec.cert_chain    = %w[certs/cert_chain.pem]
 
-  spec.required_ruby_version = '>= 2.7'
-
   if $PROGRAM_NAME.end_with?('gem')
     spec.signing_key = File.expand_path('~/.ssh/gem-private_key.pem')
   end
 
-  spec.add_dependency 'karafka', '>= 2.0', '< 3.0.0'
+  spec.add_dependency 'karafka', '>= 2.1.5', '< 3.0.0'
+  spec.add_dependency 'waterdrop', '>= 2.6.1'
 
   spec.metadata = {
+    'funding_uri' => 'https://karafka.io/#become-pro',
+    'homepage_uri' => 'https://karafka.io',
+    'changelog_uri' => 'https://github.com/karafka/karafka-testing/blob/master/CHANGELOG.md',
+    'bug_tracker_uri' => 'https://github.com/karafka/karafka-testing/issues',
     'source_code_uri' => 'https://github.com/karafka/karafka-testing',
+    'documentation_uri' => 'https://karafka.io/docs',
     'rubygems_mfa_required' => 'true'
   }
 end

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

@@ -33,7 +33,11 @@ module Karafka
               _karafka_consumer_messages.clear
               _karafka_producer_client.reset
 
-              allow(Karafka.producer).to receive(:client).and_return(_karafka_producer_client)
+              if Object.const_defined?('Mocha', false)
+                Karafka.producer.stubs(:client).returns(_karafka_producer_client)
+              else
+                allow(Karafka.producer).to receive(:client).and_return(_karafka_producer_client)
+              end
             end
           end
         end
@@ -44,7 +48,7 @@ module Karafka
         #   create a consumer instance
         # @param requested_consumer_group [String, Symbol, nil] optional name of the consumer group
         #   if we have multiple consumer groups listening on the same topic
-        # @return [Object] described_class instance
+        # @return [Object] Karafka consumer instance
         # @raise [Karafka::Testing::Errors::TopicNotFoundError] raised when we're unable to find
         #   topic that was requested
         #
@@ -85,13 +89,15 @@ module Karafka
         #     karafka.produce({ 'hello' => 'world' }.to_json, 'partition' => 6)
         #   end
         def _karafka_add_message_to_consumer_if_needed(message)
-          # We're interested in adding message to subject only when it is a consumer
+          # Consumer needs to be defined in order to pass messages to it
+          return unless defined?(consumer)
+          # We're interested in adding message to consumer only when it is a Karafka consumer
           # Users may want to test other things (models producing messages for example) and in
-          # their case subject will not be a consumer
-          return unless subject.is_a?(Karafka::BaseConsumer)
+          # their case consumer will not be a consumer
+          return unless consumer.is_a?(Karafka::BaseConsumer)
           # We target to the consumer only messages that were produced to it, since specs may also
           # produce other messages targeting other topics
-          return unless message[:topic] == subject.topic.name
+          return unless message[:topic] == consumer.topic.name
 
           # Build message metadata and copy any metadata that would come from the message
           metadata = _karafka_message_metadata_defaults
@@ -111,12 +117,13 @@ module Karafka
           # Update batch metadata
           batch_metadata = Karafka::Messages::Builders::BatchMetadata.call(
             _karafka_consumer_messages,
-            subject.topic,
+            consumer.topic,
+            0,
             Time.now
           )
 
           # Update consumer messages batch
-          subject.messages = Karafka::Messages::Messages.new(
+          consumer.messages = Karafka::Messages::Messages.new(
             _karafka_consumer_messages,
             batch_metadata
           )
@@ -128,7 +135,7 @@ module Karafka
         def _karafka_produce(payload, metadata = {})
           Karafka.producer.produce_sync(
             {
-              topic: subject.topic.name,
+              topic: consumer.topic.name,
               payload: payload
             }.merge(metadata)
           )
@@ -144,14 +151,14 @@ module Karafka
         # @return [Hash] message default options
         def _karafka_message_metadata_defaults
           {
-            deserializer: subject.topic.deserializer,
+            deserializer: consumer.topic.deserializer,
             timestamp: Time.now,
             headers: {},
             key: nil,
             offset: _karafka_consumer_messages.size,
             partition: 0,
             received_at: Time.now,
-            topic: subject.topic.name
+            topic: consumer.topic.name
           }
         end
 
@@ -160,11 +167,15 @@ module Karafka
         # @param topic [Karafka::Routing::Topic] topic for which we want to build the consumer
         # @return [Object] karafka consumer
         def _karafka_build_consumer_for(topic)
-          coordinators = Karafka::Processing::CoordinatorsBuffer.new
+          coordinators = Karafka::Processing::CoordinatorsBuffer.new(
+            Karafka::Routing::Topics.new([topic])
+          )
 
-          consumer = described_class.new
-          consumer.topic = topic
+          consumer = topic.consumer.new
           consumer.producer = Karafka::App.producer
+          # 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.coordinator = coordinators.find_or_create(topic.name, 0)
           consumer.coordinator.seek_offset = 0

data/lib/karafka/testing/spec_consumer_client.rb

@@ -12,6 +12,11 @@ module Karafka
       ].each do |caught_delegator|
         define_method(caught_delegator) { |*| }
       end
+
+      # @return [Boolean] assignments are never lost for specs
+      def assignment_lost?
+        false
+      end
     end
   end
 end

data/lib/karafka/testing/spec_producer_client.rb

@@ -3,40 +3,21 @@
 module Karafka
   module Testing
     # Spec producer client used to buffer messages that we send out in specs
-    class SpecProducerClient < ::WaterDrop::Producer::DummyClient
-      attr_accessor :messages
-
-      # Sync fake response for the message delivery to Kafka, since we do not dispatch anything
-      class SyncResponse
-        # @param _args Handler wait arguments (irrelevant as waiting is fake here)
-        def wait(*_args)
-          false
-        end
-      end
-
+    class SpecProducerClient < ::WaterDrop::Clients::Buffered
       # @param rspec [RSpec::Core::ExampleGroup] rspec example we need to hold to trigger actions
       #   on it that are rspec context aware
       def initialize(rspec)
-        super()
+        super(nil)
         @rspec = rspec
-        self.messages = []
       end
 
       # "Produces" message to Kafka. That is, it acknowledges it locally, adds it to the internal
       # buffer and adds it (if needed) into the current consumer messages buffer
       # @param message [Hash] `Karafka.producer.produce_sync` message hash
       def produce(message)
-        messages << message
-
         @rspec._karafka_add_message_to_consumer_if_needed(message)
 
-        SyncResponse.new
-      end
-
-      # Clears internal buffer
-      # Used in between specs so messages do not leak out
-      def reset
-        messages.clear
+        super
       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.0.5'
+    VERSION = '2.1.4'
   end
 end

data/renovate.json

@@ -0,0 +1,6 @@
+{
+  "$schema": "https://docs.renovatebot.com/renovate-schema.json",
+  "extends": [
+    "config:base"
+  ]
+}

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: karafka-testing
 version: !ruby/object:Gem::Version
-  version: 2.0.5
+  version: 2.1.4
 platform: ruby
 authors:
 - Maciej Mensfeld
@@ -35,7 +35,7 @@ cert_chain:
   Qf04B9ceLUaC4fPVEz10FyobjaFoY4i32xRto3XnrzeAgfEe4swLq8bQsR3w/EF3
   MGU0FeSV2Yj7Xc2x/7BzLK8xQn5l7Yy75iPF+KP3vVmDHnNl
   -----END CERTIFICATE-----
-date: 2022-10-19 00:00:00.000000000 Z
+date: 2023-06-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: karafka
@@ -43,7 +43,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: 2.1.5
     - - "<"
       - !ruby/object:Gem::Version
         version: 3.0.0
@@ -53,10 +53,24 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: 2.1.5
     - - "<"
       - !ruby/object:Gem::Version
         version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: waterdrop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.6.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.6.1
 description: Library which provides helpers for easier Karafka consumers tests
 email:
 - contact@karafka.io
@@ -66,6 +80,7 @@ extra_rdoc_files: []
 files:
 - ".coditsu/ci.yml"
 - ".diffend.yml"
+- ".github/FUNDING.yml"
 - ".github/workflows/ci.yml"
 - ".gitignore"
 - ".rspec"
@@ -87,11 +102,17 @@ files:
 - lib/karafka/testing/spec_consumer_client.rb
 - lib/karafka/testing/spec_producer_client.rb
 - lib/karafka/testing/version.rb
+- renovate.json
 homepage: https://karafka.io
 licenses:
 - MIT
 metadata:
+  funding_uri: https://karafka.io/#become-pro
+  homepage_uri: https://karafka.io
+  changelog_uri: https://github.com/karafka/karafka-testing/blob/master/CHANGELOG.md
+  bug_tracker_uri: https://github.com/karafka/karafka-testing/issues
   source_code_uri: https://github.com/karafka/karafka-testing
+  documentation_uri: https://karafka.io/docs
   rubygems_mfa_required: 'true'
 post_install_message: 
 rdoc_options: []
@@ -101,14 +122,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.7'
+      version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.4.10
 signing_key: 
 specification_version: 4
 summary: Library which provides helpers for easier Karafka consumers tests