Module: Deimos::TestHelpers

Extended by:
ActiveSupport::Concern
Defined in:
lib/deimos/test_helpers.rb

Overview

Include this module in your RSpec spec_helper to stub out external dependencies and add methods to use to test encoding/decoding.

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.included(base) ⇒ Object 



15
16
17
18
 
# File 'lib/deimos/test_helpers.rb', line 15

def self.included(base)
  super
  base.include Karafka::Testing::RSpec::Helpers
end

.normalize_message(m) ⇒ Object 



63
64
65
66
67
68
69
70
71
72
73
 
# File 'lib/deimos/test_helpers.rb', line 63

def self.normalize_message(m)
  return nil if m.nil?

  if m.respond_to?(:to_h)
    m = m.to_h
  end
  if m.respond_to?(:with_indifferent_access)
    m = m.with_indifferent_access
  end
  m
end

.sent_messages ⇒ Array<Hash>

Returns:

  • (Array<Hash>) 


27
28
29
30
31
32
33
34
35
 
# File 'lib/deimos/test_helpers.rb', line 27

def sent_messages
  Karafka.producer.client.messages.map do |m|
    produced_message = m.except(:label).deep_dup
    Deimos.decode_message(produced_message)
    produced_message[:payload] = Deimos::TestHelpers.normalize_message(produced_message[:payload])
    produced_message[:key] = Deimos::TestHelpers.normalize_message(produced_message[:key])
    produced_message
  end
end

.unit_test! ⇒ void

This method returns an undefined value.

Set the config to the right settings for a unit test



39
40
41
42
 
# File 'lib/deimos/test_helpers.rb', line 39

def unit_test!
  Deimos.config.schema.backend = :avro_validation
  warn "unit_test! is deprecated and can be replaced by setting Deimos's schema backend to `:avro_validation`. All other test behavior is provided by Karafka."
end

Instance Method Details

#clear_kafka_messages! ⇒ void

This method returns an undefined value.

Clear all sent messages - e.g. if we want to check that particular messages were sent or not sent after a point in time.



130
131
132
133
 
# File 'lib/deimos/test_helpers.rb', line 130

def clear_kafka_messages!
  puts "[Deprecated] clear_kafka_messages! can be replaced with `karafka.produced_messages.clear`"
  karafka.produced_messages.clear
end

#sent_messages ⇒ Array<Hash>

Returns:

  • (Array<Hash>) 


21
22
23
 
# File 'lib/deimos/test_helpers.rb', line 21

def sent_messages
  self.class.sent_messages
end

#test_consume_batch(handler_class_or_topic, payloads, keys: [], call_original: nil, single: false, partition_keys: [], &block) ⇒ void

This method returns an undefined value.

Test that a given handler will consume a given batch payload correctly, i.e. that the schema is correct. If a block is given, that block will be executed when ‘consume` is called. Otherwise it will just confirm that `consume` is called at all. Deimos::Consumer or the topic as a string

Parameters:

  • handler_class_or_topic (Class, String) —

    Class which inherits from

  • payloads (Array<Hash>) —

    the payload to consume

  • call_original (Boolean, nil) (defaults to: nil) —

    legacy parameter.

  • keys (Array<Object>) (defaults to: [])
  • partition_keys (Array<Object>) (defaults to: [])
  • single (Boolean) (defaults to: false) —

    used internally.



175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
 
# File 'lib/deimos/test_helpers.rb', line 175

def test_consume_batch(handler_class_or_topic,
                       payloads,
                       keys: [],
                       call_original: nil,
                       single: false,
                       partition_keys: [], &block)
  unless call_original.nil?
    puts "test_consume_batch(call_original: true) is deprecated and will be removed in the future. You can remove the call_original parameter."
  end
  karafka.consumer_messages.clear
  consumer = nil
  topic_name = nil
  if handler_class_or_topic.is_a?(String)
    topic_name = handler_class_or_topic
    consumer = karafka.consumer_for(topic_name)
  else
    topic_name = Deimos.topic_for_consumer(handler_class_or_topic)
    consumer = karafka.consumer_for(topic_name)
  end

  Deimos.karafka_config_for(topic: topic_name).each_message(single)

  # don't record messages sent with test_consume_batch
  original_messages = karafka.produced_messages.dup
  payloads.each_with_index do |payload, i|
   karafka.produce(payload, {key: keys[i], partition_key: partition_keys[i], topic: consumer.topic.name})
  end
  if block_given?
    if single
      allow(consumer).to receive(:consume_message) do
       yield consumer.messages.first.payload, consumer.messages.first.as_json['metadata']
      end
    else
      allow(consumer).to receive(:consume_batch) do
       yield consumer.messages
      end
    end
  end

  # sent_messages should only include messages sent by application code, not this method
  karafka.produced_messages.clear
  karafka.produced_messages.concat(original_messages)

  consumer.consume
end

#test_consume_message(handler_class_or_topic, payload, key: nil, call_original: nil, partition_key: nil, &block) ⇒ void

This method returns an undefined value.

Test that a given handler will consume a given payload correctly, i.e. that the schema is correct. If a block is given, that block will be executed when ‘consume` is called. Otherwise it will just confirm that `consume` is called at all. Deimos::Consumer or the topic as a string

Parameters:

  • handler_class_or_topic (Class, String) —

    Class which inherits from

  • payload (Hash) —

    the payload to consume

  • key (Object) (defaults to: nil) —

    the key to use.

  • call_original (Symbol) (defaults to: nil) —

    legacy parameter.

  • partition_key (Object) (defaults to: nil) —

    the partition key to use.



146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
 
# File 'lib/deimos/test_helpers.rb', line 146

def test_consume_message(handler_class_or_topic,
                         payload,
                         key: nil,
                         call_original: nil,
                         partition_key: nil,
                         &block)
  unless call_original.nil?
    puts "test_consume_message(call_original: true) is deprecated and will be removed in the future. You can remove the call_original parameter."
  end
  test_consume_batch(handler_class_or_topic,
                     [payload],
                     keys: [key],
                     partition_keys: [partition_key],
                     single: true,
                     &block)
end