logstash-input-exec 2.0.2 → 2.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9ee98f76ace84a124e270c9c0c549fa7ff1de3e4
-  data.tar.gz: c282719c6909289b370b17d4a4880787cbf9e339
+  metadata.gz: 1838721f463687da2fdf8d3d94bb9aefb043b84d
+  data.tar.gz: 38275e923b71a58734c510c1924a0fe136748da0
 SHA512:
-  metadata.gz: 9a78a43c27abc3944d56ba99a00aa7f1dccace2f06d85f95713a538c11150e12e1155504c4e45250c50605e794a0707ae687a4108ecfd9538e3909cceee70c94
-  data.tar.gz: 008e043fa4f4c45fb544a4c0df16fffaea986350a01850c3be4ed771a1886ad3706d7a43c0eedeabfc0f8ecf63cd6f909b98962143accdc3dddee22d66d1ef6d
+  metadata.gz: c25fc3abcdcd4270a5dfa0af02e6816ffc37ee1006d5a4baa6f3cbd8dec3a2867892633be1c2705e2702b7eae177918fbedc09c2658c1b6dd9824798fffea703
+  data.tar.gz: f6dbccaf648dd4d1a6b94f37f665fbb52553de1b83ad1b52aa1383a205a6dd375dc5c3bdac354574c2a1c555b573386ef5c0faf2140c901c5849d3efcc7e0fca

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 2.0.3
+ - fix masked errors due to rescue Exception
+ - fix random race condition on closing io object
+ - refactor code for more reliable tests
 ## 2.0.1
  - Replace non-whitespace character in code
 

data/lib/logstash/inputs/exec.rb

@@ -33,23 +33,25 @@ class LogStash::Inputs::Exec < LogStash::Inputs::Base
   end # def register
 
   def run(queue)
-
     while !stop?
-      start = Time.now
-      execute(@command)
-      duration = Time.now - start
-
-      @logger.info? && @logger.info("Command completed", :command => @command, :duration => duration)
-
-      wait_until_end_of_interval(duration)
+      inner_run(queue)
     end # loop
   end # def run
 
+  def inner_run(queue)
+    start = Time.now
+    execute(@command, queue)
+    duration = Time.now - start
+
+    @logger.info? && @logger.info("Command completed", :command => @command, :duration => duration)
+
+    wait_until_end_of_interval(duration)
+  end
+
   def stop
-    if @io
-      @io.close
-      @io = nil
-    end
+    return if @io.nil? || @io.closed?
+    @io.close
+    @io = nil
   end
 
   private
@@ -60,17 +62,18 @@ class LogStash::Inputs::Exec < LogStash::Inputs::Base
     # Sleep for the remainder of the interval, or 0 if the duration ran
     # longer than the interval.
     sleeptime = [0, @interval - duration].max
-    if sleeptime == 0
+    if sleeptime > 0
+      Stud.stoppable_sleep(sleeptime) { stop? }
+    else
       @logger.warn("Execution ran longer than the interval. Skipping sleep.",
                    :command => @command, :duration => duration, :interval => @interval)
-    else
-      Stud.stoppable_sleep(sleeptime) { stop? }
     end
   end
 
   # Execute a given command
   # @param [String] A command string
-  def execute(command)
+  # @param [Array or Queue] A queue to append events to
+  def execute(command, queue)
     @logger.info? && @logger.info("Running exec", :command => command)
     begin
       @io = IO.popen(command)
@@ -80,12 +83,14 @@ class LogStash::Inputs::Exec < LogStash::Inputs::Base
         event["command"] = command
         queue << event
       end
+    rescue StandardError => e
+      @logger.error("Error while running command",
+        :command => command, :e => e, :backtrace => e.backtrace)
     rescue Exception => e
-      @logger.error("Exception while running command", :e => e, :backtrace => e.backtrace)
+      @logger.error("Exception while running command",
+        :command => command, :e => e, :backtrace => e.backtrace)
     ensure
-      @io.close
-      @io = nil
+      stop
     end
   end
-
 end # class LogStash::Inputs::Exec

data/logstash-input-exec.gemspec

@@ -1,7 +1,7 @@
 Gem::Specification.new do |s|
 
   s.name            = 'logstash-input-exec'
-  s.version         = '2.0.2'
+  s.version         = '2.0.3'
   s.licenses        = ['Apache License (2.0)']
   s.summary         = "Run command line tools and capture the whole output as an event."
   s.description     = "This gem is a logstash plugin required to be installed on top of the Logstash core pipeline using $LS_HOME/bin/plugin install gemname. This gem is not a stand-alone program"

data/spec/inputs/exec_spec.rb

@@ -4,20 +4,45 @@ require_relative "../spec_helper"
 describe LogStash::Inputs::Exec do
 
   it "should register" do
-    input = LogStash::Plugin.lookup("input", "exec").new("command" => "uptime", "interval" => 0)
+    input = LogStash::Plugin.lookup("input", "exec").new("command" => "ls", "interval" => 0)
 
     # register will try to load jars and raise if it cannot find jars or if org.apache.log4j.spi.LoggingEvent class is not present
     expect {input.register}.to_not raise_error
   end
 
+  context "when operating normally" do
+    let(:input) { LogStash::Plugin.lookup("input", "exec").new("command" => "ls", "interval" => 0) }
+    let(:queue) { [] }
+    let(:loggr) { double('loggr') }
+
+    before do
+      allow(loggr).to receive(:info)
+      allow(loggr).to receive(:info?)
+      allow(loggr).to receive(:warn)
+      allow(loggr).to receive(:warn?)
+      allow(loggr).to receive(:debug)
+      allow(loggr).to receive(:debug?)
+    end
+
+    it "enqueues some events" do
+      input.logger = loggr
+      input.register
+      expect(loggr).not_to receive(:error)
+
+      input.inner_run(queue)
+
+      expect(queue.size).not_to be_zero
+    end
+  end
+
   context "when interrupting the plugin" do
 
     it_behaves_like "an interruptible input plugin" do
-      let(:config) { { "command" => "uptime", "interval" => 0 } }
+      let(:config) { { "command" => "ls", "interval" => 0 } }
     end
 
     it_behaves_like "an interruptible input plugin" do
-      let(:config) { { "command" => "uptime", "interval" => 100 } }
+      let(:config) { { "command" => "ls", "interval" => 100 } }
     end
 
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: logstash-input-exec
 version: !ruby/object:Gem::Version
-  version: 2.0.2
+  version: 2.0.3
 platform: ruby
 authors:
 - Elastic
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2015-10-09 00:00:00.000000000 Z
+date: 2015-10-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement