logstash-output-exec 3.0.1 → 3.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 74821568bb9fcb89c1d0a7b5c0875641dbe2955c
-  data.tar.gz: b5e03f878079e60cefda4b8f3aafadd12573faee
+  metadata.gz: de991ebd043dcba69a36d370a66ec776ec431bc5
+  data.tar.gz: e7377aa117439b77a95a72c0ce64713635fb2619
 SHA512:
-  metadata.gz: 22f2f51a7e96acdfc767587a53a17715ed0033d4518296445cfe2e9134a48eafeddb0efc9c0d93c8c8a9f589e1ec70df5e08d5a31915e0f9d2b9c2a1ba4611b9
-  data.tar.gz: 80f23be85a09d7319ee253c87824e00a2df3428d2bde6766b74ce29096c02956348fce54d40d2b4c8c58a1b59192405ab272f213a7bb0c563aa9b746ce0184f3
+  metadata.gz: 3c1c09d96af06902190344f75e964c67abaea4172f4b1c7edd2e89fa62f7f7cb03b4db45a3bc58a83b690a234505159430055d082119fd9dfe4ed91ee95dbe18
+  data.tar.gz: 6fa544d93d63d0264db98a67e14a8e65099dcaff9ce7bba153d8b41a453b81837c5b77fe0793c4ccfea7ea4527c930f1573de0ecdf49838dd928efabb71ec696

data/CHANGELOG.md

@@ -1,11 +1,21 @@
+## 3.0.2
+ - Replace `Kernel.system` with `Open3.open3` and fixes `ThreadDeath` issues
+ - Will now log stdout and stderr of the command when running logstash in debug mode, the response is streamed to the log.
+ - Added a `quiet` option to not print the result of the command to stdout, this option is on by default for backward compatibility
+ - Added tests
+
 ## 3.0.1
   - Republish all the gems under jruby.
+
 ## 3.0.0
   - Update the plugin to the version 2.0 of the plugin api, this change is required for Logstash 5.0 compatibility. See https://github.com/elastic/logstash/issues/5141
-# 2.0.4
+
+## 2.0.4
   - Depend on logstash-core-plugin-api instead of logstash-core, removing the need to mass update plugins on major releases of logstash
-# 2.0.3
+
+## 2.0.3
   - New dependency requirements for logstash-core for the 5.0 release
+
 ## 2.0.0
  - Plugins were updated to follow the new shutdown semantic, this mainly allows Logstash to instruct input plugins to terminate gracefully, 
    instead of using Thread.raise on the plugins' threads. Ref: https://github.com/elastic/logstash/pull/3895

data/lib/logstash/outputs/exec.rb

@@ -1,6 +1,7 @@
 # encoding: utf-8
 require "logstash/namespace"
 require "logstash/outputs/base"
+require "open3"
 
 # The exec output will run a command for each event received. Ruby's
 # `system()` function will be used, i.e. the command string will
@@ -34,16 +35,33 @@ class LogStash::Outputs::Exec < LogStash::Outputs::Base
   # dynamic strings.
   config :command, :validate => :string, :required => true
 
+  # display the result of the command to the terminal
+  config :quiet, :validate => :boolean, :default => false
+
   public
   def register
     @logger.debug("exec output registered", :config => @config)
-  end # def register
+  end
 
   public
   def receive(event)
-    
-    @logger.debug("running exec command", :command => event.sprintf(@command))
-    system(event.sprintf(@command))
-  end # def receive
+    cmd = event.sprintf(@command)
+    @logger.debug("running exec command", :command => cmd)
+
+    Open3.popen3(cmd) do |stdin, stdout, stderr|
+      if @logger.debug?
+        @logger.pipe(stdout => :debug, stderr => :debug)
+      else
+        # This is for backward compatibility,
+        # the previous implementation was using `Kernel#system' and the default behavior
+        # of this method is to output the result to the terminal.
+        @logger.terminal(stdout.read.chomp) unless quiet?
+      end
+    end
+  end
 
+  private
+  def quiet?
+    @quiet
+  end
 end

data/logstash-output-exec.gemspec

@@ -1,7 +1,6 @@
 Gem::Specification.new do |s|
-
   s.name            = 'logstash-output-exec'
-  s.version         = '3.0.1'
+  s.version         = '3.0.2'
   s.licenses        = ['Apache License (2.0)']
   s.summary         = "This output will run a command for any matching 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"
@@ -23,5 +22,6 @@ Gem::Specification.new do |s|
   s.add_runtime_dependency "logstash-core-plugin-api", "~> 2.0"
 
   s.add_development_dependency 'logstash-devutils'
+  s.add_development_dependency "logstash-codec-plain"
 end
 

data/spec/outputs/exec_spec.rb

@@ -1 +1,48 @@
+# encoding: utf-8
+require "logstash/outputs/exec"
+require "logstash/event"
 require "logstash/devutils/rspec/spec_helper"
+require "tempfile"
+
+describe LogStash::Outputs::Exec do
+  let(:event) { LogStash::Event.new({ "params" => "1234" }) }
+  let(:output) { "1" }
+  let(:command) { "echo #{output}" }
+
+  let(:config) do
+    { "command" => command }
+  end
+
+  let(:error_message) { "Oulala" }
+  let(:stderr) { Tempfile.new(error_message) }
+  let(:stdout) { Tempfile.new(output) }
+  let(:stdin) { Tempfile.new("") }
+
+  subject { described_class.new(config) }
+
+  it "receive a command and execute it" do
+    expect(Open3).to receive(:popen3).with(command)
+    subject.receive(event)
+  end
+
+  context "when debugging" do
+    before :each do
+      allow(subject.logger).to receive(:debug?).and_return(true)
+      expect(Open3).to receive(:popen3).with(command).and_yield(stdin, stdout, stderr)
+    end
+
+    it "register the stdout and stderr to the logger" do
+      expect(subject.logger).to receive(:pipe).with(stdout => :debug, stderr => :debug)
+      subject.receive(event)
+    end
+  end
+
+  context "When debugging is off" do
+    context "when quiet is off" do
+      it "write output to the terminal" do
+        expect(subject.logger).to receive(:terminal).with(output)
+        subject.receive(event)
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: logstash-output-exec
 version: !ruby/object:Gem::Version
-  version: 3.0.1
+  version: 3.0.2
 platform: ruby
 authors:
 - Elastic
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2016-05-09 00:00:00.000000000 Z
+date: 2016-06-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
@@ -38,6 +38,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  name: logstash-codec-plain
+  prerelease: false
+  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 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
 email: info@elastic.co
 executables: []