logstash-output-exec 2.0.5 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4fa722dbb26dda585a5bad9fb5c8730c1003351e
-  data.tar.gz: cc16d47ab25586b1ea7372e02045043c69d02731
+  metadata.gz: 2bdeec96c14614c24d71fd8f1a4c1650292e1ac1
+  data.tar.gz: d11697e80a52dff7fa5470cd682812e015eb18e8
 SHA512:
-  metadata.gz: 6b06b2ce9884f534baaa564f3e0ff13e5c1e4765d66ccd98627ee8844a66d8c86d90457e1ff7470faa2aa7b8bf2bc5ad10e6914910a09ac877cc5a204ab92ad6
-  data.tar.gz: 92aac26fab00849f14046955ee2ee02ce6403e324469e3b9609cda2d2acca81bfadb4d4f25fbf57921276567fe40eabb08aca98508b91c13be81cc04d8d57624
+  metadata.gz: 418783b92cde5628872a56963cc47cbb238ba456733db1fa29d1e5ccccbbcf4730d4256fd5b76538f914be99431a4ac89f6e398bd4d27d09a5d21335604a01b1
+  data.tar.gz: 31be010132dfe5a3d9d80a62cde32a8c18f149d4e630990e1a5ec3f3c2c326910c010c1a0d7c5cf624957efd9f70a9a2abe6956416229691ec03dfe4a4ffc894

data/CHANGELOG.md

@@ -1,15 +1,9 @@
-## 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
+## 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
   - 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/Gemfile

@@ -1,2 +1,4 @@
 source 'https://rubygems.org'
-gemspec
+
+# Specify your gem's dependencies in logstash-mass_effect.gemspec
+gemspec

data/lib/logstash/outputs/exec.rb

@@ -1,7 +1,6 @@
 # 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
@@ -35,33 +34,16 @@ 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
+  end # def register
 
   public
   def receive(event)
-    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
+    
+    @logger.debug("running exec command", :command => event.sprintf(@command))
+    system(event.sprintf(@command))
+  end # def receive
 
-  private
-  def quiet?
-    @quiet
-  end
 end

data/logstash-output-exec.gemspec

@@ -1,6 +1,7 @@
 Gem::Specification.new do |s|
+
   s.name            = 'logstash-output-exec'
-  s.version         = '2.0.5'
+  s.version         = '3.0.0'
   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"
@@ -19,9 +20,8 @@ Gem::Specification.new do |s|
   s.metadata = { "logstash_plugin" => "true", "logstash_group" => "output" }
 
   # Gem dependencies
-  s.add_runtime_dependency "logstash-core-plugin-api", "~> 1.0"
+  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,48 +1 @@
-# 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,58 +1,46 @@
 --- !ruby/object:Gem::Specification
 name: logstash-output-exec
 version: !ruby/object:Gem::Version
-  version: 2.0.5
+  version: 3.0.0
 platform: ruby
 authors:
 - Elastic
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-06-22 00:00:00.000000000 Z
+date: 2016-05-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
+  name: logstash-core-plugin-api
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
-  name: logstash-core-plugin-api
-  prerelease: false
+        version: '2.0'
   type: :runtime
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
   name: logstash-devutils
-  prerelease: false
-  type: :development
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !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
+  prerelease: false
   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
+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: []
@@ -73,7 +61,7 @@ licenses:
 metadata:
   logstash_plugin: 'true'
   logstash_group: output
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -88,9 +76,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project:
-rubygems_version: 2.4.8
-signing_key:
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
 specification_version: 4
 summary: This output will run a command for any matching event.
 test_files: