karafka-testing 1.4.4 → 2.0.0.alpha1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0a8b62a849029aa280ad8a28a60fd8b6036b28d40fdbf083168ef6f0a5f5b730
-  data.tar.gz: b2a1ac0a92174695f008e8c1caf39c7dc114c76cd8a535c295fa02e21a2a24bd
+  metadata.gz: 99b31b45b503aded03f25274fc7819219b3707644cbfa57a6136426351b52ae1
+  data.tar.gz: 1321c4e974d9dcd25f9f38fb0b8237a503d3f4399cc08ea299820d6dd8ce2479
 SHA512:
-  metadata.gz: e832fff04817a75ee3838019fc3c1fa4d304fc122a7cf1dcace77460a71b1dea5a780cd6eb8dc546e6773b4bad343446e5557ed2dbf9760bb40ace51605fb6eb
-  data.tar.gz: cb3042d870d0abf1039764e1a4f8e45a83d3701942210b7caafdbb51497e5c5a4485b135b36d8ff1456720a790cc38ea67a5930a6e36c06c5e0c41569809ba54
+  metadata.gz: aeb543efd92f2c9c7cafb50bb389e8d0baf388ce086cbe8751b2a2362d1e666c96766f771ff3fe20d38fcc9d3f8b69563073d4709fc93d756c880cbf4c6646e1
+  data.tar.gz: c5eb1aaeeedeb7ab8c08e77998422b5a249069818b50abc842e9cf0d9599b59f07d88167e71c4d9791f62e979babb15b659816fb9249a8927e11e65909d40e1f

data/.github/workflows/ci.yml

@@ -1,5 +1,7 @@
 name: ci
 
+concurrency: ci-${{ github.ref }}
+
 on:
   pull_request:
   push:
@@ -14,11 +16,11 @@ jobs:
       fail-fast: false
       matrix:
         ruby:
+          - '3.1'
           - '3.0'
           - '2.7'
-          - '2.6'
         include:
-          - ruby: '3.0'
+          - ruby: '3.1'
             coverage: 'true'
     steps:
       - uses: actions/checkout@v2
@@ -46,7 +48,7 @@ jobs:
       - name: Set up Ruby
         uses: ruby/setup-ruby@v1
         with:
-          ruby-version: 3.0
+          ruby-version: 3.1
       - name: Install latest bundler
         run: gem install bundler --no-document
       - name: Install Diffend plugin

data/.ruby-version

@@ -1 +1 @@
-3.0.3
+3.1.0

data/2.0-Upgrade.md

@@ -0,0 +1,60 @@
+# Welcome to Karafka-Testing 2.0!
+
+Karafka-Testing 2.0 some breaking changes in the way consumer builder and message publishing is done.
+
+## Upgrade
+
+Please upgrade your application to `Karafka 2.0` first.
+
+- Replace `#karafka_consumer_for` in your specs with `#karafka.consumer_for`
+- Replace `#publish_for_karafka` in your specs with `#karafka.publish`
+
+And that's all!
+
+Below you can find same example written for Karafka `2.0` and `1.4`.
+
+### Karafka 2.0
+
+```ruby
+RSpec.describe CountersConsumer do
+  subject(:consumer) { karafka.consumer_for(:counters) }
+
+  let(:nr1_value) { rand }
+  let(:nr2_value) { rand }
+  let(:sum) { nr1_value + nr2_value }
+
+  before do
+    karafka.publish({ 'number' => nr1_value }.to_json)
+    karafka.publish({ 'number' => nr2_value }.to_json, partition: 2)
+    allow(Karafka.logger).to receive(:info)
+  end
+
+  it 'expects to log a proper message' do
+    expect(Karafka.logger).to receive(:info).with("Sum of 2 elements equals to: #{sum}")
+    consumer.consume
+  end
+end
+```
+
+### Karafka 1.4
+
+```ruby
+RSpec.describe InlineBatchConsumer do
+  subject(:consumer) { karafka_consumer_for(:counters) }
+
+  let(:nr1_value) { rand }
+  let(:nr2_value) { rand }
+  let(:sum) { nr1_value + nr2_value }
+
+  before do
+    publish_for_karafka({ 'number' => nr1_value }.to_json)
+    publish_for_karafka({ 'number' => nr2_value }.to_json, partition: 2)
+    allow(Karafka.logger).to receive(:info)
+  end
+
+  it 'expects to log a proper message' do
+    expect(Karafka.logger).to receive(:info).with("Sum of 2 elements equals to: #{sum}")
+    consumer.consume
+  end
+end
+```

data/CHANGELOG.md

@@ -1,10 +1,9 @@
 # Karafka Test gem changelog
 
-## 1.4.4 (2021-12-05)
-- Source code metadata url added to the gemspec
-
-## 1.4.3 (2021-11-27)
-- #71 - `mark_as_consumed!` is not stubbed, causing `Karafka::Errors::MissingClientError`
+## 2.0.0.alpha1 (2022-01-30)
+- Change the API to be more comprehensive
+- Update to work with Karafka 2.0
+- Support for Ruby 3.1
 
 ## 1.4.2 (2021-04-21)
 - Restore MIT license

data/Gemfile.lock

@@ -1,19 +1,14 @@
 PATH
   remote: .
   specs:
-    karafka-testing (1.4.4)
-      karafka (~> 1.4.0)
+    karafka-testing (2.0.0.alpha1)
+      karafka (~> 2.0.alpha1)
 
 GEM
   remote: https://rubygems.org/
   specs:
     concurrent-ruby (1.1.9)
-    delivery_boy (1.1.0)
-      king_konf (~> 1.0)
-      ruby-kafka (~> 1.0)
-    digest-crc (0.6.4)
-      rake (>= 12.0.0, < 14.0.0)
-    dry-configurable (0.13.0)
+    dry-configurable (0.14.0)
       concurrent-ruby (~> 1.0)
       dry-core (~> 0.6)
     dry-container (0.9.0)
@@ -25,7 +20,7 @@ GEM
       concurrent-ruby (~> 1.0)
       dry-core (~> 0.5, >= 0.5)
     dry-inflector (0.2.1)
-    dry-initializer (3.0.4)
+    dry-initializer (3.1.1)
     dry-logic (1.2.0)
       concurrent-ruby (~> 1.0)
       dry-core (~> 0.5, >= 0.5)
@@ -52,37 +47,30 @@ GEM
       dry-core (~> 0.5, >= 0.5)
       dry-initializer (~> 3.0)
       dry-schema (~> 1.8, >= 1.8.0)
-    envlogic (1.1.4)
-      dry-inflector (~> 0.1)
-    io-console (0.5.9)
-    irb (1.3.7)
-      reline (>= 0.2.7)
-    karafka (1.4.11)
+    ffi (1.15.5)
+    karafka (2.0.0.alpha1)
       dry-configurable (~> 0.13)
-      dry-inflector (~> 0.2)
       dry-monitor (~> 0.5)
       dry-validation (~> 1.7)
-      envlogic (~> 1.1)
-      irb (~> 1.3)
-      ruby-kafka (>= 1.3.0)
-      thor (>= 1.1)
-      waterdrop (~> 1.4)
-      zeitwerk (~> 2.4)
-    king_konf (1.0.0)
+      rdkafka (>= 0.10)
+      thor (>= 0.20)
+      waterdrop (>= 2.1.0, < 3.0.0)
+      zeitwerk (~> 2.3)
+    mini_portile2 (2.7.1)
     rake (13.0.6)
-    reline (0.2.7)
-      io-console (~> 0.5)
-    ruby-kafka (1.4.0)
-      digest-crc
-    thor (1.1.0)
-    waterdrop (1.4.4)
-      delivery_boy (>= 0.2, < 2.x)
+    rdkafka (0.11.1)
+      ffi (~> 1.15)
+      mini_portile2 (~> 2.6)
+      rake (> 12)
+    thor (1.2.1)
+    waterdrop (2.1.0)
+      concurrent-ruby (>= 1.1)
       dry-configurable (~> 0.13)
       dry-monitor (~> 0.5)
       dry-validation (~> 1.7)
-      ruby-kafka (>= 1.3.0)
-      zeitwerk (~> 2.4)
-    zeitwerk (2.5.1)
+      rdkafka (>= 0.10)
+      zeitwerk (~> 2.3)
+    zeitwerk (2.5.4)
 
 PLATFORMS
   x86_64-linux
@@ -91,4 +79,4 @@ DEPENDENCIES
   karafka-testing!
 
 BUNDLED WITH
-   2.2.32
+   2.3.5

data/README.md

@@ -1,5 +1,9 @@
 # Karafka Testing library
 
+**Note**: Documentation presented below works with not yet released Karafka `2.0`.
+
+Please refer to [this](https://github.com/karafka/testing/tree/1.4) branch and its documentation for details about usage with Karafka `1.4`.
+
 [![Build Status](https://github.com/karafka/testing/workflows/ci/badge.svg)](https://github.com/karafka/testing/actions?query=workflow%3Aci)
 [![Gem Version](https://badge.fury.io/rb/karafka-testing.svg)](http://badge.fury.io/rb/karafka-testing)
 [![Join the chat at https://slack.karafka.io](https://raw.githubusercontent.com/karafka/misc/master/slack.svg)](https://slack.karafka.io)
@@ -28,18 +32,17 @@ end
 
 ## Usage
 
-Once included into your RSpec setup, this library will provide you two methods that you can use with your specs:
-
-- `#karafka_consumer_for` - this method will create a consumer instance for the desired topic. It **needs** to be set as the spec subject.
-- `#publish_for_karafka` - this method will "send" message to the consumer instance.
+Once included into your RSpec setup, this library will provide you with a special object `#karafka` that includes two methods that you can use with your specs:
 
+- `#consumer_for` - creates a consumer instance for the desired topic. It **needs** to be set as the spec subject.
+- `#publish` - "sends" message to the consumer instance.
 
-**Note:** Messages sent using the `#publish_for_karafka` method won't be sent to Kafka. They will be "virtually" delegated to the created consumer instance so your specs can run without Kafka setup.
+**Note:** Messages sent using the `#publish` method won't be sent to Kafka. They will be "virtually" delegated to the created consumer instance so your specs can run without Kafka setup.
 
 ```ruby
 RSpec.describe InlineBatchConsumer do
   # This will create a consumer instance with all the settings defined for the given topic
-  subject(:consumer) { karafka_consumer_for(:inline_batch_data) }
+  subject(:consumer) { karafka.consumer_for(:inline_batch_data) }
 
   let(:nr1_value) { rand }
   let(:nr2_value) { rand }
@@ -47,9 +50,9 @@ RSpec.describe InlineBatchConsumer do
 
   before do
     # Sends first message to Karafka consumer
-    publish_for_karafka({ 'number' => nr1_value }.to_json)
+    karafka.publish({ 'number' => nr1_value }.to_json)
     # Sends second message to Karafka consumer
-    publish_for_karafka({ 'number' => nr2_value }.to_json)
+    karafka.publish({ 'number' => nr2_value }.to_json, partition: 2)
     allow(Karafka.logger).to receive(:info)
   end
 

data/karafka-testing.gemspec

@@ -27,5 +27,5 @@ Gem::Specification.new do |spec|
     spec.signing_key = File.expand_path('~/.ssh/gem-private_key.pem')
   end
 
-  spec.add_dependency 'karafka', '~> 1.4.0'
+  spec.add_dependency 'karafka', '~> 2.0.alpha1'
 end

data/lib/karafka/testing/dummy_client.rb

@@ -9,8 +9,6 @@ module Karafka
       %i[
         mark_as_consumed
         mark_as_consumed!
-        trigger_heartbeat
-        trigger_heartbeat!
       ].each do |caught_delegator|
         define_method(caught_delegator) { |*| }
       end

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

@@ -2,6 +2,7 @@
 
 require 'karafka/testing/errors'
 require 'karafka/testing/dummy_client'
+require 'karafka/testing/rspec/proxy'
 
 module Karafka
   module Testing
@@ -16,16 +17,15 @@ module Karafka
           def included(base)
             # This is an internal buffer for keeping "to be sent" messages before
             # we run the consume
-            base.let(:_karafka_raw_data) { [] }
-            # Inject a dummy client that will intercept commands directed to the kafka client
-            base.before { Persistence::Client.write(DummyClient.new) }
-            # Clear the messages buffer after each spec, so nothing will leak
-            # in between them
-            base.after { _karafka_raw_data.clear }
+            base.let(:_karafka_messages) { [] }
+            base.let(:karafka) { Karafka::Testing::RSpec::Proxy.new(self) }
+            # Clear the messages buffer after each spec, so nothing leaks in between them
+            base.after { _karafka_messages.clear }
           end
         end
 
-        # Creates a consumer instance for given topic
+        # Creates a consumer instance for a given topic
+        #
         # @param requested_topic [String, Symbol] name of the topic for which we want to
         #   create a consumer instance
         # @return [Object] described_class instance
@@ -34,12 +34,12 @@ module Karafka
         #
         # @example Creates a MyConsumer consumer instance with settings for `my_requested_topic`
         #   RSpec.describe MyConsumer do
-        #     subject(:consumer) { karafka_consumer_for(:my_requested_topic) }
+        #     subject(:consumer) { karafka.consumer_for(:my_requested_topic) }
         #   end
         def karafka_consumer_for(requested_topic)
           selected_topic = nil
 
-          # @note Remove in 2.0. This won't work without the global state
+          # @note Remove in 2.1. This won't work without the global state
           ::Karafka::App.consumer_groups.each do |consumer_group|
             consumer_group.topics.each do |topic|
               selected_topic = topic if topic.name == requested_topic.to_s
@@ -48,47 +48,59 @@ module Karafka
 
           raise Karafka::Testing::Errors::TopicNotFoundError, requested_topic unless selected_topic
 
-          described_class.new(selected_topic)
+          consumer = described_class.new
+          consumer.topic = selected_topic
+          consumer.client = Karafka::Testing::DummyClient.new
+          consumer
         end
 
-        # Adds a new Karafka params instance with given payload and options into an internal
+        # Adds a new Karafka message instance with given payload and options into an internal
         # buffer that will be used to simulate messages delivery to the consumer
         #
-        # @param raw_payload [String] anything you want to send
+        # @param payload [String] anything you want to send
         # @param opts [Hash] additional options with which you want to overwrite the
         #   message defaults (key, offset, etc)
         #
         # @example Send a json message to consumer
         #   before do
-        #     publish_for_karafka({ 'hello' => 'world' }.to_json)
+        #     karafka.publish({ 'hello' => 'world' }.to_json)
         #   end
         #
         # @example Send a json message to consumer and simulate, that it is partition 6
         #   before do
-        #     publish_for_karafka({ 'hello' => 'world' }.to_json, 'partition' => 6)
+        #     karafka.publish({ 'hello' => 'world' }.to_json, 'partition' => 6)
         #   end
-        def publish_for_karafka(raw_payload, opts = {})
-          metadata = Karafka::Params::Metadata.new(
-            **metadata_defaults.merge(opts)
+        def karafka_publish(payload, opts = {})
+          metadata = Karafka::Messages::Metadata.new(
+            **karafka_message_metadata_defaults.merge(opts)
           ).freeze
 
-          _karafka_raw_data << Karafka::Params::Params.new(raw_payload, metadata)
-          subject.params_batch = Karafka::Params::ParamsBatch.new(_karafka_raw_data)
+          # Add this message to previously published messages
+          _karafka_messages << Karafka::Messages::Message.new(payload, metadata)
+
+          # Update batch metadata
+          batch_metadata = Karafka::Messages::Builders::BatchMetadata.call(
+            _karafka_messages,
+            subject.topic,
+            Time.now
+          )
+
+          # Update consumer messages batch
+          subject.messages = Karafka::Messages::Messages.new(_karafka_messages, batch_metadata)
         end
 
         private
 
         # @return [Hash] message default options
-        def metadata_defaults
+        def karafka_message_metadata_defaults
           {
             deserializer: subject.topic.deserializer,
-            create_time: Time.now,
+            timestamp: Time.now,
             headers: {},
-            is_control_record: false,
             key: nil,
-            offset: 0,
+            offset: _karafka_messages.size,
             partition: 0,
-            receive_time: Time.now,
+            received_at: Time.now,
             topic: subject.topic.name
           }
         end

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

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Karafka
+  module Testing
+    module RSpec
+      # Proxy object for a nicer `karafka.` API within RSpec
+      class Proxy
+        # @param rspec_example [RSpec::ExampleGroups] rspec context
+        def initialize(rspec_example)
+          @rspec_example = rspec_example
+        end
+
+        # @param args Anything that the `#karafka_consumer_for` accepts
+        def consumer_for(*args)
+          @rspec_example.karafka_consumer_for(*args)
+        end
+
+        # @param args Anything that the `#karafka_publish` accepts
+        def publish(*args)
+          @rspec_example.karafka_publish(*args)
+        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 = '1.4.4'
+    VERSION = '2.0.0.alpha1'
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: karafka-testing
 version: !ruby/object:Gem::Version
-  version: 1.4.4
+  version: 2.0.0.alpha1
 platform: ruby
 authors:
 - Maciej Mensfeld
@@ -34,7 +34,7 @@ cert_chain:
   R2P11bWoCtr70BsccVrN8jEhzwXngMyI2gVt750Y+dbTu1KgRqZKp/ECe7ZzPzXj
   pIy9vHxTANKYVyI4qj8OrFdEM5BQNu8oQpL0iQ==
   -----END CERTIFICATE-----
-date: 2021-12-05 00:00:00.000000000 Z
+date: 2022-01-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: karafka
@@ -42,14 +42,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.4.0
+        version: 2.0.alpha1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.4.0
+        version: 2.0.alpha1
 description: Library which provides helpers for easier Karafka consumers tests
 email:
 - maciej@mensfeld.pl
@@ -64,6 +64,7 @@ files:
 - ".rspec"
 - ".ruby-gemset"
 - ".ruby-version"
+- 2.0-Upgrade.md
 - CHANGELOG.md
 - Gemfile
 - Gemfile.lock
@@ -76,6 +77,7 @@ files:
 - lib/karafka/testing/dummy_client.rb
 - lib/karafka/testing/errors.rb
 - lib/karafka/testing/rspec/helpers.rb
+- lib/karafka/testing/rspec/proxy.rb
 - lib/karafka/testing/version.rb
 homepage: https://karafka.io
 licenses:
@@ -93,11 +95,11 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: 2.6.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
-rubygems_version: 3.2.32
+rubygems_version: 3.3.4
 signing_key: 
 specification_version: 4
 summary: Library which provides helpers for easier Karafka consumers tests