Refactor and add some basic tests

Author: Juuso Mäyränen

lib/logstash/inputs/redis.rb

@@ -55,7 +55,7 @@ module LogStash module Inputs class Redis < LogStash::Inputs::Threadable
   # Specify either list or channel.  If `data_type` is `list`, then we will BLPOP the
   # key.  If `data_type` is `channel`, then we will SUBSCRIBE to the key.
   # If `data_type` is `pattern_channel`, then we will PSUBSCRIBE to the key.
-  config :data_type, :validate => [ "list", "list_pattern", "channel", "pattern_channel" ], :required => true
+  config :data_type, :validate => [ "list", "pattern_list", "channel", "pattern_channel" ], :required => true
 
   # The number of events to return from Redis using EVAL.
   config :batch_count, :validate => :number, :default => 125
@@ -83,6 +83,17 @@ def new_redis_instance
     @redis_builder.call
   end
 
+  def init_threadpool
+    @threadpool_queue_max ||= 2 * @worker_thread_count
+    @threadpool ||= Concurrent::ThreadPoolExecutor.new(
+        min_threads: @worker_thread_count,
+        max_threads: @worker_thread_count,
+        max_queue: @threadpool_queue_max
+    )
+    @items_processed ||= Concurrent::AtomicFixnum.new
+    @current_workers ||= Concurrent::Set.new
+  end
+
   def register
     @redis_url = @path.nil? ? "redis://#{@password}@#{@host}:#{@port}/#{@db}" : "#{@password}@#{@path}/#{@db}"
 
@@ -92,7 +103,7 @@ def register
     if @data_type == 'list' || @data_type == 'dummy'
       @run_method = method(:list_runner)
       @stop_method = method(:list_stop)
-    elsif @data_type == 'list_pattern'
+    elsif @data_type == 'pattern_list'
       @run_method = method(:list_pattern_runner)
       @stop_method = method(:list_pattern_stop)
     elsif @data_type == 'channel'
@@ -282,23 +293,16 @@ def ensure_workers(output_queue)
   end
 
   # private
-  def init_list_pattern_runner(output_queue)
-    @threadpool_queue_max ||= 2 * @worker_thread_count
-    @threadpool ||= Concurrent::ThreadPoolExecutor.new(
-        min_threads: @worker_thread_count,
-        max_threads: @worker_thread_count,
-        max_queue: @threadpool_queue_max
-    )
-    @items_processed ||= Concurrent::AtomicFixnum.new
-    @current_workers ||= Concurrent::Set.new
+  def init_list_pattern_runner
+    init_threadpool
     @redis ||= connect
   end
 
   # private
   def list_pattern_runner(output_queue)
     while !stop?
       begin
-        init_list_pattern_runner(output_queue) if @redis.nil?
+        init_list_pattern_runner if @redis.nil?
         ensure_workers(output_queue)
         sleep(0.1)
       rescue ::Redis::BaseError => e

spec/inputs/redis_spec.rb

@@ -63,6 +63,26 @@ def process(conf, event_count)
     populate(key, event_count)
     process(conf, event_count)
   end
+
+  it "should read events from a list pattern" do
+    key_base = SecureRandom.hex
+    conf = <<-CONFIG
+      input {
+        redis {
+          type => "blah"
+          key => "#{key}.*"
+          data_type => "list_pattern"
+        }
+      }
+    CONFIG
+    total_event_count = 0
+    (0..10).each do |idx|
+      event_count = 100 + rand(50)
+      total_event_count += event_count
+      populate("#{key_base}.#{idx}", event_count)
+    end
+    process(conf, total_event_count)
+  end
 end
 
 # unit tests ---------------------
@@ -264,6 +284,64 @@ def process(conf, event_count)
     end
   end
 
+  context 'runtime for pattern_list data_type' do
+    let(:data_type) { 'pattern_list' }
+    let(:key) { 'foo.*' }
+    before do
+      subject.register
+      subject.init_threadpool
+    end
+
+    context 'close when redis is unset' do
+      let(:quit_calls) { [:quit, :unsubscribe, :punsubscribe, :connection, :disconnect!] }
+
+      it 'does not attempt to quit' do
+        allow(redis).to receive(:nil?).and_return(true)
+        quit_calls.each do |call|
+          expect(redis).not_to receive(call)
+        end
+        expect {subject.do_stop}.not_to raise_error
+      end
+    end
+
+    it 'calling the run method, adds events to the queue' do
+      expect(redis).to receive(:keys).at_least(:once).and_return(['foo.bar'])
+      expect(redis).to receive(:lpop).at_least(:once).and_return('l1')
+
+      allow(redis).to receive(:connected?).and_return(connected.last)
+      allow(redis).to receive(:quit)
+
+      tt = Thread.new do
+        end_by = Time.now + 3
+        while accumulator.size < 1 and Time.now <= end_by
+          sleep 0.1
+        end
+        subject.do_stop
+      end
+
+      subject.run(accumulator)
+
+      tt.join
+
+      expect(accumulator.size).to be > 0
+    end
+
+    it 'multiple close calls, calls to redis once' do
+      subject.use_redis(redis)
+      allow(redis).to receive(:keys).at_least(:once).and_return(['foo.bar'])
+      allow(redis).to receive(:lpop).and_return('l1')
+      expect(redis).to receive(:connected?).and_return(connected.last)
+      quit_calls.each do |call|
+        expect(redis).to receive(call).at_most(:once)
+      end
+
+      subject.do_stop
+      connected.push(false) #can't use let block here so push to array
+      expect {subject.do_stop}.not_to raise_error
+      subject.do_stop
+    end
+  end
+
   context 'for the subscribe data_types' do
     def run_it_thread(inst)
       Thread.new(inst) do |subj|
@@ -396,7 +474,7 @@ def close_thread(inst, rt)
 
   describe LogStash::Inputs::Redis do
     context "when using data type" do
-      ["list", "channel", "pattern_channel"].each do |data_type|
+      ["list", "channel", "pattern_channel", "pattern_list"].each do |data_type|
         context data_type do
           it_behaves_like "an interruptible input plugin" do
             let(:config) { {'key' => 'foo', 'data_type' => data_type } }