logstash-output-exec 2.0.4 → 2.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1f7b33fee44ee6c1ab390d0ce6c187ba1a21da76
-  data.tar.gz: 87e2adfacfc6c4efe76cebe0ea3c2468a018f95d
+  metadata.gz: 4fa722dbb26dda585a5bad9fb5c8730c1003351e
+  data.tar.gz: cc16d47ab25586b1ea7372e02045043c69d02731
 SHA512:
-  metadata.gz: 452d1f513e7d9bb9fc5570d34a332eff130ce1b0ff8ec25a6fd7593a27c6e985898bb9956fef5d21bb247be9888d89aa626bac9bf6ebf1c48008907073325ca4
-  data.tar.gz: ad6e9e5ac6d896b55b45eb3a7b8588671442b16a444f9f4c9476e638ac17c7be95545621c75ecbeec571a363fe0b64ca76d9275aad2a81baf6d755d13a592274
+  metadata.gz: 6b06b2ce9884f534baaa564f3e0ff13e5c1e4765d66ccd98627ee8844a66d8c86d90457e1ff7470faa2aa7b8bf2bc5ad10e6914910a09ac877cc5a204ab92ad6
+  data.tar.gz: 92aac26fab00849f14046955ee2ee02ce6403e324469e3b9609cda2d2acca81bfadb4d4f25fbf57921276567fe40eabb08aca98508b91c13be81cc04d8d57624

data/CHANGELOG.md

@@ -1,7 +1,15 @@
-# 2.0.4
+## 2.0.5
+  - 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
+
+## 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/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2012–2015 Elasticsearch <http://www.elastic.co>
+Copyright (c) 2012–2016 Elasticsearch <http://www.elastic.co>
 
 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.

data/README.md

@@ -1,7 +1,6 @@
 # Logstash Plugin
 
-[![Build
-Status](http://build-eu-00.elastic.co/view/LS%20Plugins/view/LS%20Outputs/job/logstash-plugin-output-exec-unit/badge/icon)](http://build-eu-00.elastic.co/view/LS%20Plugins/view/LS%20Outputs/job/logstash-plugin-output-exec-unit/)
+[![Travis Build Status](https://travis-ci.org/logstash-plugins/logstash-output-exec.svg)](https://travis-ci.org/logstash-plugins/logstash-output-exec)
 
 This is a plugin for [Logstash](https://github.com/elastic/logstash).
 
@@ -56,7 +55,12 @@ gem "logstash-filter-awesome", :path => "/your/local/logstash-filter-awesome"
 ```
 - Install plugin
 ```sh
+# Logstash 2.3 and higher
+bin/logstash-plugin install --no-verify
+
+# Prior to Logstash 2.3
 bin/plugin install --no-verify
+
 ```
 - Run Logstash with your plugin
 ```sh
@@ -74,7 +78,12 @@ gem build logstash-filter-awesome.gemspec
 ```
 - Install the plugin from the Logstash home
 ```sh
-bin/plugin install /your/local/plugin/logstash-filter-awesome.gem
+# Logstash 2.3 and higher
+bin/logstash-plugin install --no-verify
+
+# Prior to Logstash 2.3
+bin/plugin install --no-verify
+
 ```
 - Start Logstash and proceed to test the plugin
 

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,10 +1,9 @@
 Gem::Specification.new do |s|
-
   s.name            = 'logstash-output-exec'
-  s.version         = '2.0.4'
+  s.version         = '2.0.5'
   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/plugin install gemname. This gem is not a stand-alone program"
+  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"
   s.authors         = ["Elastic"]
   s.email           = 'info@elastic.co'
   s.homepage        = "http://www.elastic.co/guide/en/logstash/current/index.html"
@@ -23,5 +22,6 @@ Gem::Specification.new do |s|
   s.add_runtime_dependency "logstash-core-plugin-api", "~> 1.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: 2.0.4
+  version: 2.0.5
 platform: ruby
 authors:
 - Elastic
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2016-03-24 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,7 +38,21 @@ dependencies:
     - - ">="
       - !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/plugin install gemname. This gem is not a stand-alone program
+- !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: []
 extensions: []