karafka-testing 2.0.3 → 2.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c7a7e11e7f5ba273fc7875d3c20bd2b1457d46f315f168e933f1f48f82f6bbf6
-  data.tar.gz: 0ac2a1804d0b7e94cfd409763edd8ced61dd64fdde2219d9d42a375f9a21542a
+  metadata.gz: 513e1bb6f2a9ac5806fc7df36f788f4ba1b1f72286110e0584ad882d347453fe
+  data.tar.gz: a758a804787420eea61375763bcad90a6c2033426d46f8b07707fc5c22d9de72
 SHA512:
-  metadata.gz: 38d9372fcf299860d91efe18061ed219583a95fb1955a4817536a9fe4ae5ac6e9f86fc4e92c35c02a256cf9b9a1162f0a2cd54c17d6dd48b503f9a36c1d2be6c
-  data.tar.gz: fa0f0e8395e9fc00b155074a5e0059ad8dc4aecf0f9e93b0edaf6806574a873e17e183ad8bbede526237e3dcd321b378664252755d05d82204329c3351361861
+  metadata.gz: e313af611899b8a3b47791d63694b24612bd97b27dde6262b929a7af315b64c0c2a1e0fd0b22fe25838d41b3c592c302b610e67031b44b27f08ee2daf78a4705
+  data.tar.gz: 18d88784906a4d19a33dab5ceca6236c1720d488c58b56e324464eb5730096c5f3bcfcfa3b8481fe4db974c10a2d294d3c91a50b9d7c030e28a0314531c1798c

data/.github/workflows/ci.yml

@@ -61,7 +61,7 @@ jobs:
     strategy:
       fail-fast: false
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
         with:
           fetch-depth: 0
       - name: Run Coditsu

data/2.0-Upgrade.md

@@ -7,7 +7,7 @@ Karafka-Testing 2.0 some breaking changes in the way consumer builder and messag
 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`
+- Replace `#publish_for_karafka` in your specs with `#karafka.produce`
 
 And that's all!
 
@@ -24,8 +24,8 @@ RSpec.describe CountersConsumer do
   let(:sum) { nr1_value + nr2_value }
 
   before do
-    karafka.publish({ 'number' => nr1_value }.to_json)
-    karafka.publish({ 'number' => nr2_value }.to_json, partition: 2)
+    karafka.produce({ 'number' => nr1_value }.to_json)
+    karafka.produce({ 'number' => nr2_value }.to_json, partition: 2)
     allow(Karafka.logger).to receive(:info)
   end
 

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Karafka Test gem changelog
 
+## 2.0.5 (2022-10-19)
+- Fix for: Test event production without defining a subject (#102)
+
+## 2.0.4 (2022-10-14)
+- Align changes with Karafka `2.0.13` changes.
+
 ## 2.0.3 (2022-09-30)
 - Fix direct name reference `consumer` instead of `subject` (#97).
 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    karafka-testing (2.0.3)
+    karafka-testing (2.0.5)
       karafka (>= 2.0, < 3.0.0)
 
 GEM
@@ -9,13 +9,13 @@ GEM
   specs:
     concurrent-ruby (1.1.10)
     ffi (1.15.5)
-    karafka (2.0.11)
+    karafka (2.0.14)
       karafka-core (>= 2.0.2, < 3.0.0)
       rdkafka (>= 0.12)
       thor (>= 0.20)
       waterdrop (>= 2.4.1, < 3.0.0)
       zeitwerk (~> 2.3)
-    karafka-core (2.0.2)
+    karafka-core (2.0.3)
       concurrent-ruby (>= 1.1)
     mini_portile2 (2.8.0)
     rake (13.0.6)
@@ -28,13 +28,14 @@ GEM
       karafka-core (>= 2.0.2, < 3.0.0)
       rdkafka (>= 0.10)
       zeitwerk (~> 2.3)
-    zeitwerk (2.6.0)
+    zeitwerk (2.6.1)
 
 PLATFORMS
+  arm64-darwin
   x86_64-linux
 
 DEPENDENCIES
   karafka-testing!
 
 BUNDLED WITH
-   2.3.22
+   2.3.24

data/README.md

@@ -6,114 +6,9 @@
 
 Karafka-Testing is a library that provides RSpec helpers, to make testing of Karafka consumers and producer much easier.
 
-## Installation
+## Installation and usage
 
-Add this gem to your Gemfile in the `test` group:
-```ruby
-group :test do
-  gem 'karafka-testing'
-  gem 'rspec'
-end
-```
-
-and then in your `spec_helper.rb` file:
-
-```ruby
-require 'karafka/testing/rspec/helpers'
-
-RSpec.configure do |config|
-  config.include Karafka::Testing::RSpec::Helpers
-end
-```
-
-## Usage
-
-Once included in your RSpec setup, this library will provide you with a special `#karafka` object that contains three methods that you can use within your specs:
-
-- `#consumer_for` - creates a consumer instance for the desired topic. It **needs** to be set as the spec subject.
-- `#produce` - "sends" message to the consumer instance.
-- `#produced_messages` - contains all the messages "sent" to Kafka during spec execution.
-
-**Note:** Messages sent using the `#produce` method and directly from `Karafka.producer` won't be sent to Kafka. They will be buffered and accessible in a per-spec buffer in case you want to test messages production.
-
-Messages that target the topic built using the `karafka#consumer_for` method will additionally be delivered to the consumer you want to test.
-
-### Testing messages consumption (consumers)
-
-```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') }
-
-  let(:nr1_value) { rand }
-  let(:nr2_value) { rand }
-  let(:sum) { nr1_value + nr2_value }
-
-  before do
-    # Sends first message to Karafka consumer
-    karafka.produce({ 'number' => nr1_value }.to_json)
-
-    # Sends second message to Karafka consumer
-    karafka.produce({ '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
-```
-
-If your consumers use `producer` to dispatch messages, you can check its operations as well:
-
-```ruby
-RSpec.describe InlineBatchConsumer do
-  subject(:consumer) { karafka.consumer_for(:inline_batch_data) }
-
-  before { karafka.produce({ 'number' => 1 }.to_json) }
-
-  it 'expects to dispatch async message to messages topic with value bigger by 1' do
-    consumer.consume
-
-    expect(karafka.produced_messages.last.payload).to eq({ number: 2 }.to_json)
-  end
-end
-```
-
-### Testing messages production (producer)
-
-When running RSpec, Karafka will not dispatch messages to Kafka using `Karafka.producer` but will buffer them internally.
-
-This means you can check your application flow, making sure your logic acts as expected:
-
-```ruby
-# Example class in which there is a message production
-class UsersBuilder
-  def create(user_details)
-    user = ::User.create!(user_details)
-
-    Karafka.producer.produce_sync(
-      topic: 'users_changes',
-      payload: { user_id: user.id, type: 'user.created' },
-      key: user.id.to_s
-    )
-
-    user
-  end
-end
-
-RSpec.describe InlineBatchConsumer do
-  let(:created_user) { UsersBuilder.new.create(user_details) }
-
-  before { created_user }
-
-  it { expect(karafka.produced_messages.size).to eq(1) }
-  it { expect(karafka.produced_messages.first[:topic]).to eq('user.created') }
-  it { expect(karafka.produced_messages.first[:key]).to eq(created_user.id.to_s) }
-end
-```
+`karafka-testing` docs are part of Karafka framework docs. You can find the testing section [here](https://karafka.io/docs/Testing/).
 
 ## Note on contributions
 

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

@@ -85,6 +85,10 @@ 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
+          # 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)
           # 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
@@ -163,6 +167,7 @@ module Karafka
           consumer.producer = Karafka::App.producer
           consumer.client = _karafka_consumer_client
           consumer.coordinator = coordinators.find_or_create(topic.name, 0)
+          consumer.coordinator.seek_offset = 0
           consumer
         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.3'
+    VERSION = '2.0.5'
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: karafka-testing
 version: !ruby/object:Gem::Version
-  version: 2.0.3
+  version: 2.0.5
 platform: ruby
 authors:
 - Maciej Mensfeld
@@ -35,7 +35,7 @@ cert_chain:
   Qf04B9ceLUaC4fPVEz10FyobjaFoY4i32xRto3XnrzeAgfEe4swLq8bQsR3w/EF3
   MGU0FeSV2Yj7Xc2x/7BzLK8xQn5l7Yy75iPF+KP3vVmDHnNl
   -----END CERTIFICATE-----
-date: 2022-09-30 00:00:00.000000000 Z
+date: 2022-10-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: karafka