Deps: allow any scheduler version with plugin (#132)

Author: kares

.travis.yml

@@ -1,2 +1,7 @@
 import:
-- logstash-plugins/.ci:travis/[email protected]
+  - logstash-plugins/.ci:travis/[email protected]
+
+env:
+  jobs: # test with old scheduler version (3.0 was locked in LS 7.x)
+    - ELASTIC_STACK_VERSION=7.x RUFUS_SCHEDULER_VERSION=3.0.9 LOG_LEVEL=info
+    - ELASTIC_STACK_VERSION=6.x RUFUS_SCHEDULER_VERSION=3.0.9

CHANGELOG.md

@@ -1,3 +1,6 @@
+## 5.2.1
+  - Deps: unpin rufus-scheduler dependency [#130](https://github.com/logstash-plugins/logstash-input-http_poller/pull/130)
+
 ## 5.2.0
   - Feat: support ssl_verification_mode option [#131](https://github.com/logstash-plugins/logstash-input-http_poller/pull/131)
 

Gemfile

@@ -9,3 +9,5 @@ if Dir.exist?(logstash_path) && use_logstash_source
   gem 'logstash-core', :path => "#{logstash_path}/logstash-core"
   gem 'logstash-core-plugin-api', :path => "#{logstash_path}/logstash-core-plugin-api"
 end
+
+gem 'rufus-scheduler', ENV['RUFUS_SCHEDULER_VERSION'] if ENV['RUFUS_SCHEDULER_VERSION']

lib/logstash/inputs/http_poller.rb

@@ -55,9 +55,12 @@ def register
     setup_requests!
   end
 
+  # @overload
   def stop
-    Stud.stop!(@interval_thread) if @interval_thread
-    @scheduler.stop if @scheduler
+    if @scheduler
+      @scheduler.shutdown # on newer Rufus (3.8) this joins on the scheduler thread
+    end
+    # TODO implement client.close as we as releasing it's pooled resources!
   end
 
   private
@@ -163,16 +166,15 @@ def setup_schedule(queue)
     #schedule hash must contain exactly one of the allowed keys
     msg_invalid_schedule = "Invalid config. schedule hash must contain " +
       "exactly one of the following keys - cron, at, every or in"
-    raise Logstash::ConfigurationError, msg_invalid_schedule if @schedule.keys.length !=1
+    raise Logstash::ConfigurationError, msg_invalid_schedule if @schedule.keys.length != 1
     schedule_type = @schedule.keys.first
     schedule_value = @schedule[schedule_type]
     raise LogStash::ConfigurationError, msg_invalid_schedule unless Schedule_types.include?(schedule_type)
 
     @scheduler = Rufus::Scheduler.new(:max_work_threads => 1)
-    #as of v3.0.9, :first_in => :now doesn't work. Use the following workaround instead
     opts = schedule_type == "every" ? { :first_in => 0.01 } : {} 
     @scheduler.send(schedule_type, schedule_value, opts) { run_once(queue) }
-    @scheduler.join
+    @scheduler.thread.join # due newer rufus (3.8) doing a blocking operation on scheduler.join
   end
 
   def run_once(queue)

logstash-input-http_poller.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name        = 'logstash-input-http_poller'
-  s.version     = '5.2.0'
+  s.version     = '5.2.1'
   s.licenses    = ['Apache License (2.0)']
   s.summary     = "Decodes the output of an HTTP API into events"
   s.description     = "This gem is a Logstash plugin required to be installed on top of the Logstash core pipeline using $LS_HOME/bin/logstash-plugin install gemname. This gem is not a stand-alone program"
@@ -21,8 +21,7 @@ Gem::Specification.new do |s|
   s.add_runtime_dependency "logstash-core-plugin-api", ">= 1.60", "<= 2.99"
   s.add_runtime_dependency 'logstash-codec-plain'
   s.add_runtime_dependency "logstash-mixin-http_client", ">= 7.1.0"
-  s.add_runtime_dependency 'stud', "~> 0.0.22"
-  s.add_runtime_dependency 'rufus-scheduler', "~>3.0.9"
+  s.add_runtime_dependency 'rufus-scheduler', ">= 3.0.9"
   s.add_runtime_dependency 'logstash-mixin-ecs_compatibility_support', '~>1.3'
   s.add_runtime_dependency 'logstash-mixin-event_support', '~> 1.0', '>= 1.0.1'
   s.add_runtime_dependency 'logstash-mixin-validator_support', '~> 1.0'

spec/inputs/http_poller_spec.rb

@@ -25,18 +25,19 @@
       "schedule" => default_schedule,
       "urls" => default_urls,
       "codec" => "json",
-      "metadata_target" => metadata_target
+      "metadata_target" => metadata_target,
+      "pool_max" => 3, "pool_max_per_route" => 1, 'keepalive' => false
     }
   }
-  let(:klass) { LogStash::Inputs::HTTP_Poller }
+  let(:opts) { default_opts }
 
+  subject(:plugin) { described_class.new(opts) }
 
   describe "instances" do
-    subject { klass.new(default_opts) }
+    subject { described_class.new(default_opts) }
 
-    before do
-      subject.register
-    end
+    before { subject.register }
+    after { subject.stop }
 
     describe "#run" do
       it "should setup a scheduler" do
@@ -189,22 +190,21 @@
           "metadata_target" => metadata_target
         }
       }
-      it "should run at the schedule" do
-        instance = klass.new(opts)
-        instance.register
+
+      before do
         Timecop.travel(Time.new(2000,1,1,0,0,0,'+00:00'))
         Timecop.scale(60)
-        queue = Queue.new
-        runner = Thread.new do
-          instance.run(queue)
-        end
-        sleep 3
-        instance.stop
-        runner.kill
-        runner.join
-        expect(queue.size).to eq(2)
+      end
+
+      after do
         Timecop.return
       end
+
+      it "should run at the schedule" do
+        run_plugin_and_yield_queue(plugin, sleep: 3) do |queue|
+          try(5) { expect(queue.size).to be >= 2 }
+        end
+      end
     end
 
     context "given 'at' expression" do
@@ -216,22 +216,21 @@
           "metadata_target" => metadata_target
         }
       }
-      it "should run at the schedule" do
-        instance = klass.new(opts)
-        instance.register
+
+      before do
         Timecop.travel(Time.new(2000,1,1,0,0,0,'+00:00'))
-        Timecop.scale(60 * 5)
-        queue = Queue.new
-        runner = Thread.new do
-          instance.run(queue)
-        end
-        sleep 2
-        instance.stop
-        runner.kill
-        runner.join
-        expect(queue.size).to eq(1)
+        Timecop.scale (60 * 5) / 2
+      end
+
+      after do
         Timecop.return
       end
+
+      it "should run at the schedule" do
+        run_plugin_and_yield_queue(plugin, sleep: 2) do |queue|
+          try(5) { expect(queue.size).to eq(1) }
+        end
+      end
     end
 
     context "given 'every' expression" do
@@ -244,20 +243,12 @@
         }
       }
       it "should run at the schedule" do
-        instance = klass.new(opts)
-        instance.register
-        queue = Queue.new
-        runner = Thread.new do
-          instance.run(queue)
+        run_plugin_and_yield_queue(plugin, sleep: 5) do |queue|
+          #T       0123456
+          #events  x x x x
+          #expects 3 events at T=5
+          try(5) { expect(queue.size).to be_between(2, 3) }
         end
-        #T       0123456
-        #events  x x x x
-        #expects 3 events at T=5
-        sleep 5
-        instance.stop
-        runner.kill
-        runner.join
-        expect(queue.size).to be_between(2, 3)
       end
     end
 
@@ -271,21 +262,28 @@
         }
       }
       it "should run at the schedule" do
-        instance = klass.new(opts)
-        instance.register
-        queue = Queue.new
-        runner = Thread.new do
-          instance.run(queue)
+        run_plugin_and_yield_queue(plugin, sleep: 2.5) do |queue|
+          try(5) { expect(queue.size).to eq(1) }
         end
-        sleep 3
-        instance.stop
-        runner.kill
-        runner.join
-        expect(queue.size).to eq(1)
       end
     end
   end
 
+  def run_plugin_and_yield_queue(plugin, sleep: nil)
+    plugin.register
+    queue = Queue.new
+    begin
+      runner = Thread.new do
+        plugin.run(queue)
+      end
+      sleep(sleep) if sleep
+      yield(queue)
+    ensure
+      plugin.stop
+      runner.join if runner
+    end
+  end
+
   describe "events", :ecs_compatibility_support, :aggregate_failures do
     ecs_compatibility_matrix(:disabled, :v1, :v8 => :v1) do |ecs_select|
       before do
@@ -339,6 +337,8 @@
           event # materialize the subject
         end
 
+        after { poller.stop }
+
         it "should enqueue a message" do
           expect(event).to be_a(LogStash::Event)
         end
@@ -399,9 +399,6 @@
         let(:payload) { {"a" => 2, "hello" => ["a", "b", "c"]} }
         let(:response_body) { LogStash::Json.dump(payload) }
         let(:opts) { default_opts }
-        let(:instance) {
-          klass.new(opts)
-        }
         let(:name) { default_name }
         let(:url) { default_url }
         let(:code) { 202 }
@@ -411,30 +408,30 @@
         }
 
         before do
-          instance.register
+          plugin.register
           u = url.is_a?(Hash) ? url["url"] : url # handle both complex specs and simple string URLs
-          instance.client.stub(u,
+          plugin.client.stub(u,
                                :body => response_body,
                                :code => code
           )
-          allow(instance).to receive(:decorate)
-          instance.send(:run_once, queue)
+          allow(plugin).to receive(:decorate)
+          plugin.send(:run_once, queue)
         end
 
         it "should have a matching message" do
           expect(event.to_hash).to include(payload)
         end
 
         it "should decorate the event" do
-          expect(instance).to have_received(:decorate).once
+          expect(plugin).to have_received(:decorate).once
         end
 
         include_examples("matching metadata")
 
         context "with an empty body" do
           let(:response_body) { "" }
           it "should return an empty event" do
-            instance.send(:run_once, queue)
+            plugin.send(:run_once, queue)
             headers_field = ecs_select[disabled: "[#{metadata_target}][response_headers]",
                                       v1: "[#{metadata_target}][input][http_poller][response][headers]"]
             expect(event.get("#{headers_field}[content-length]")).to eql("0")
@@ -449,7 +446,7 @@
           }
 
           it "should not have any metadata on the event" do
-            instance.send(:run_once, queue)
+            plugin.send(:run_once, queue)
             expect(event.get(metadata_target)).to be_nil
           end
         end
@@ -555,6 +552,8 @@
 
   describe "stopping" do
     let(:config) { default_opts }
-    it_behaves_like "an interruptible input plugin"
+    it_behaves_like "an interruptible input plugin" do
+      let(:allowed_lag) { 10 } # CI: wait till scheduler shuts down
+    end
   end
 end