logstash-input-exec 3.4.0 → 3.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9c34902b8be4e548af7df0fa8a539ca5c795e9faeff9d4dccaa9d357e080c424
-  data.tar.gz: d4d9f5e6aa8d1afd53e7d6fcb37f5e84277c3ea0038a44d0ec27577497447f8f
+  metadata.gz: 01d8e2cf6057c8c259d53f056dab08b583d222b367adda70a80a045eac7fa08d
+  data.tar.gz: 30536c1078190608e0894f9e018dc70cb7fffe0b72ce80ed08a36294d804def8
 SHA512:
-  metadata.gz: 7ff940ad3f3a22894d5242d1ee3b5238e805af2e629c1aa7a93f1f7d5986cf70140c519c859abb2776101550b80b80c40c0669a60e9e0b6b1a2aa21ad8d19865
-  data.tar.gz: 18f68b20afd72dde8384d8c5d39a468436666d3a43014425a1f17ffa6d42bdcd23e27dce2721f0f97ded83159375a2e9aec2d11de95b88fbc74475cd4107eeef
+  metadata.gz: cf1aa23f2e652c11dbdf22cfb78a1831ab0965befa58b69fbef3d83e71f85e65e98f48d71363df258aa087d9d01f0fdc43b784ec8ee4a38631af5d0615aee467
+  data.tar.gz: d517483d728e1c59f99bbce6318aeb685f0933e8300d1fbc144362c4828a40c67015edcaefe735b44c12b08f9a6ffff01e208cb3f6779581afc8cc7d37a2c407

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+## 3.6.0
+  - Refactor: start using scheduler mixin [#33](https://github.com/logstash-plugins/logstash-input-exec/pull/33)
+  - Fix: Test failures due to insufficient time given for scheduler to start [#32](https://github.com/logstash-plugins/logstash-input-exec/pull/32) 
+
+## 3.5.0
+  - Fix: behavior incompatiblity between (standalone) LS and LS in Docker [#30](https://github.com/logstash-plugins/logstash-input-exec/pull/30)
+
 ## 3.4.0
   - Feat: adjust fields for ECS compatibility [#28](https://github.com/logstash-plugins/logstash-input-exec/pull/28)
   - Plugin will no longer override fields if they exist in the decoded payload.

data/lib/logstash/inputs/exec.rb

@@ -1,11 +1,12 @@
 # encoding: utf-8
 require "logstash/inputs/base"
 require "logstash/namespace"
+require "open3"
 require "socket" # for Socket.gethostname
 require "stud/interval"
-require "rufus/scheduler"
 
 require 'logstash/plugin_mixins/ecs_compatibility_support'
+require "logstash/plugin_mixins/scheduler"
 
 # Periodically run a shell command and capture the whole output as an event.
 #
@@ -17,6 +18,7 @@ require 'logstash/plugin_mixins/ecs_compatibility_support'
 class LogStash::Inputs::Exec < LogStash::Inputs::Base
 
   include LogStash::PluginMixins::ECSCompatibilitySupport(:disabled, :v1, :v8 => :v1)
+  include LogStash::PluginMixins::Scheduler
 
   config_name "exec"
 
@@ -36,8 +38,7 @@ class LogStash::Inputs::Exec < LogStash::Inputs::Base
 
   def register
     @hostname = Socket.gethostname.freeze
-    @io       = nil
-    
+
     if (@interval.nil? && @schedule.nil?) || (@interval && @schedule)
       raise LogStash::ConfigurationError, "exec input: either 'interval' or 'schedule' option must be defined."
     end
@@ -53,11 +54,8 @@ class LogStash::Inputs::Exec < LogStash::Inputs::Base
 
   def run(queue)
     if @schedule
-      @scheduler = Rufus::Scheduler.new(:max_work_threads => 1)
-      @scheduler.cron @schedule do
-        execute(queue)
-      end
-      @scheduler.join
+      scheduler.cron(@schedule) { execute(queue) }
+      scheduler.join
     else
       while !stop?
         duration = execute(queue)
@@ -67,8 +65,7 @@ class LogStash::Inputs::Exec < LogStash::Inputs::Base
   end # def run
 
   def stop
-    close_io()
-    @scheduler.shutdown(:wait) if @scheduler
+    close_out_and_in
   end
 
   # Execute a given command
@@ -105,20 +102,26 @@ class LogStash::Inputs::Exec < LogStash::Inputs::Base
   private
 
   def run_command
-    @io = IO.popen(@command)
-    output = @io.read
-    @io.close # required in order to read $?
-    exit_status = $?.exitstatus
+    @p_in, @p_out, waiter = Open3.popen2(@command)
+    output = @p_out.read
+    exit_status = waiter.value.exitstatus
     [output, exit_status]
   ensure
-    close_io()
+    close_out_and_in
+  end
+
+  def close_out_and_in
+    close_io(@p_out)
+    @p_out = nil
+    close_io(@p_in)
+    @p_in = nil
   end
 
-  # Close @io
-  def close_io
-    return if @io.nil? || @io.closed?
-    @io.close
-    @io = nil
+  def close_io(io)
+    return if io.nil? || io.closed?
+    io.close
+  rescue => e
+    @logger.debug("ignoring exception raised while closing io", :io => io, :exception => e.class, :message => e.message)
   end
 
   # Wait until the end of the interval

data/logstash-input-exec.gemspec

@@ -1,7 +1,7 @@
 Gem::Specification.new do |s|
 
   s.name            = 'logstash-input-exec'
-  s.version         = '3.4.0'
+  s.version         = '3.6.0'
   s.licenses        = ['Apache License (2.0)']
   s.summary         = "Captures the output of a shell command 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/logstash-plugin install gemname. This gem is not a stand-alone program"
@@ -22,10 +22,10 @@ Gem::Specification.new do |s|
   # Gem dependencies
   s.add_runtime_dependency "logstash-core-plugin-api", ">= 1.60", "<= 2.99"
   s.add_runtime_dependency 'logstash-mixin-ecs_compatibility_support', '~> 1.3'
+  s.add_runtime_dependency "logstash-mixin-scheduler", '~> 1.0'
 
   s.add_runtime_dependency 'stud', '~> 0.0.22'
   s.add_runtime_dependency 'logstash-codec-plain'
-  s.add_runtime_dependency 'rufus-scheduler'
 
   s.add_development_dependency 'logstash-devutils'
   s.add_development_dependency 'timecop'

data/spec/inputs/exec_spec.rb

@@ -46,6 +46,23 @@ describe LogStash::Inputs::Exec, :ecs_compatibility_support do
       end
     end
 
+    context "when command fails" do
+      let(:input) { described_class.new("command" => "invalid_command 1 2 3", "interval" => 0) }
+      let(:queue) { [] }
+
+      before :each do
+        input.register
+      end
+
+      it "does not enqueue an event (in a non-Docker env)" do
+        expect(input.logger).to receive(:error).and_call_original
+
+        input.execute(queue)
+
+        expect(queue.map(&:to_hash)).to be_empty
+      end
+    end
+
     context "when a command runs normally" do
       let(:command) { "/bin/sh -c 'sleep 1; /bin/echo -n two; exit 3'" }
       let(:input) { described_class.new("command" => command, "interval" => 0) }
@@ -73,7 +90,7 @@ describe LogStash::Inputs::Exec, :ecs_compatibility_support do
         expect(elapsed_time).to be > 1 * 1_000_000
         expect(elapsed_time).to be < 3 * 1_000_000
       end if ecs_select.active_mode != :disabled
-      
+
       it "has output as expected" do
         expect(queue.pop.get('message')).to eq "two"
       end
@@ -99,25 +116,28 @@ describe LogStash::Inputs::Exec, :ecs_compatibility_support do
   end
 
   context "when scheduling" do
-    let(:input) { described_class.new("command" => "ls --help", "schedule" => "* * * * * UTC") }
+    let(:input) { described_class.new("command" => "ls --help", "schedule" => "5-6 * * * * UTC") }
     let(:queue) { [] }
 
     before do
+      Timecop.travel(Time.new(2000))
+      Timecop.scale(60)
       input.register
     end
 
+    after do
+      Timecop.return
+    end
+
     it "should properly schedule" do
-      Timecop.travel(Time.new(2000))
-      Timecop.scale(60)
       runner = Thread.new do
         input.run(queue)
       end
-      sleep 3
+      sleep 10
       input.stop
       runner.kill
       runner.join
       expect(queue.size).to eq(2)
-      Timecop.return
     end
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: logstash-input-exec
 version: !ruby/object:Gem::Version
-  version: 3.4.0
+  version: 3.6.0
 platform: ruby
 authors:
 - Elastic
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-11-16 00:00:00.000000000 Z
+date: 2022-06-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
@@ -49,36 +49,36 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.0.22
-  name: stud
+        version: '1.0'
+  name: logstash-mixin-scheduler
   prerelease: false
   type: :runtime
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.0.22
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
-  name: logstash-codec-plain
+        version: 0.0.22
+  name: stud
   prerelease: false
   type: :runtime
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.0.22
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  name: rufus-scheduler
+  name: logstash-codec-plain
   prerelease: false
   type: :runtime
   version_requirements: !ruby/object:Gem::Requirement