logstash-input-pipe 1.0.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 579fb827a872f386082fe93a45e3e742b9121de5
-  data.tar.gz: 9f89c0ae073b612cd4aaceb63136eb07a0bf27af
+  metadata.gz: 9c11181e67feca984d004877b6958667cc79f302
+  data.tar.gz: 37d6a9bbcd4411d7880977594de3eb8ee84429e6
 SHA512:
-  metadata.gz: 9a9d3727b6f96220923bebd504a729d6f53e4651cb602c2c6b20c8d86cd91ae512c7584f451dc7afbe18db569eacf7c988b2f7474614a4f36c6756173db5db82
-  data.tar.gz: 7e9f03b2220f1d641ec92de033a433890e57699d3e8d2078fddd317bc829c1ec0411a988be1ad4221e8b34a9f9ce41b3665dca84b82abfa9537b312d5a5a2ee9
+  metadata.gz: 06e1b1aca0ce72438625a374dc171f656c40b453a00389e3bcbfa70a568549322d02bf62c46b11adef8825b5b331fb6c8f98e5c031217d22d8a39e14bb86c5e8
+  data.tar.gz: 12f4fe9f83be96ec309dbad3bbdbb7f87a923435cde82683dd5684fbf507aabf93286925a249e5f35c35d9aff934b174d215be17b4739444d9c5c094bc33f4a1

data/README.md

@@ -1,15 +1,15 @@
 # Logstash Plugin
 
-This is a plugin for [Logstash](https://github.com/elasticsearch/logstash).
+This is a plugin for [Logstash](https://github.com/elastic/logstash).
 
 It is fully free and fully open source. The license is Apache 2.0, meaning you are pretty much free to use it however you want in whatever way.
 
 ## Documentation
 
-Logstash provides infrastructure to automatically generate documentation for this plugin. We use the asciidoc format to write documentation so any comments in the source code will be first converted into asciidoc and then into html. All plugin documentation are placed under one [central location](http://www.elasticsearch.org/guide/en/logstash/current/).
+Logstash provides infrastructure to automatically generate documentation for this plugin. We use the asciidoc format to write documentation so any comments in the source code will be first converted into asciidoc and then into html. All plugin documentation are placed under one [central location](http://www.elastic.co/guide/en/logstash/current/).
 
 - For formatting code or config example, you can use the asciidoc `[source,ruby]` directive
-- For more asciidoc formatting tips, see the excellent reference here https://github.com/elasticsearch/docs#asciidoc-guide
+- For more asciidoc formatting tips, see the excellent reference here https://github.com/elastic/docs#asciidoc-guide
 
 ## Need Help?
 
@@ -83,4 +83,4 @@ Programming is not a required skill. Whatever you've seen about open source and
 
 It is more important to the community that you are able to contribute.
 
-For more information about contributing, see the [CONTRIBUTING](https://github.com/elasticsearch/logstash/blob/master/CONTRIBUTING.md) file.
+For more information about contributing, see the [CONTRIBUTING](https://github.com/elastic/logstash/blob/master/CONTRIBUTING.md) file.

data/lib/logstash/inputs/pipe.rb

@@ -6,6 +6,7 @@ end
 require "logstash/inputs/base"
 require "logstash/namespace"
 require "socket" # for Socket.gethostname
+require "stud/interval"
 
 # Stream events from a long running command pipe.
 #
@@ -28,7 +29,6 @@ class LogStash::Inputs::Pipe < LogStash::Inputs::Base
 
   def initialize(params)
     super
-    @shutdown_requested = false
     @pipe = nil
   end # def initialize
 
@@ -39,9 +39,9 @@ class LogStash::Inputs::Pipe < LogStash::Inputs::Base
 
   public
   def run(queue)
-    while !@shutdown_requested
+    while !stop?
       begin
-        @pipe = IO.popen(@command, mode = "r")
+        @pipe = IO.popen(@command, "r")
         hostname = Socket.gethostname
 
         @pipe.each do |line|
@@ -56,25 +56,22 @@ class LogStash::Inputs::Pipe < LogStash::Inputs::Base
         end
         @pipe.close
         @pipe = nil
-      rescue LogStash::ShutdownSignal => e
-        break
       rescue Exception => e
         @logger.error("Exception while running command", :e => e, :backtrace => e.backtrace)
       end
 
       # Keep running the command forever.
-      sleep(10)
+      Stud.stoppable_sleep(10) do
+        stop?
+      end
     end
   end # def run
 
-  def teardown
-    @shutdown_requested = true
+  def stop
     if @pipe
       Process.kill("KILL", @pipe.pid) rescue nil
       @pipe.close rescue nil
       @pipe = nil
     end
-    finished
   end
-
 end # class LogStash::Inputs::Pipe

data/logstash-input-pipe.gemspec

@@ -1,7 +1,7 @@
 Gem::Specification.new do |s|
 
   s.name            = 'logstash-input-pipe'
-  s.version         = '1.0.0'
+  s.version         = '2.0.0'
   s.licenses        = ['Apache License (2.0)']
   s.summary         = "Stream events from a long running command pipe"
   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"
@@ -11,7 +11,7 @@ Gem::Specification.new do |s|
   s.require_paths = ["lib"]
 
   # Files
-  s.files = `git ls-files`.split($\)+::Dir.glob('vendor/*')
+  s.files = Dir['lib/**/*','spec/**/*','vendor/**/*','*.gemspec','*.md','CONTRIBUTORS','Gemfile','LICENSE','NOTICE.TXT']
 
   # Tests
   s.test_files = s.files.grep(%r{^(test|spec|features)/})
@@ -20,8 +20,8 @@ Gem::Specification.new do |s|
   s.metadata = { "logstash_plugin" => "true", "logstash_group" => "input" }
 
   # Gem dependencies
-  s.add_runtime_dependency "logstash-core", '>= 1.4.0', '< 2.0.0'
-
+  s.add_runtime_dependency "logstash-core", "~> 2.0.0.snapshot"
+  s.add_runtime_dependency 'stud', '~> 0.0.22'
   s.add_runtime_dependency 'logstash-codec-plain'
   s.add_development_dependency 'logstash-devutils'
 end

data/spec/inputs/pipe_spec.rb

@@ -1,43 +1,68 @@
 # encoding: utf-8
 require "logstash/devutils/rspec/spec_helper"
+require "logstash/inputs/pipe"
 require "tempfile"
 
-describe "inputs/pipe", :unix => true do
+describe LogStash::Inputs::Pipe, :unix => true do
 
-  # rince and repeat a few times to stress the shutdown sequence
-  5.times.each do
-    it "should pipe from echo" do
-      conf = <<-CONFIG
+  it "should register" do
+    input = LogStash::Plugin.lookup("input", "pipe").new("command" => "echo 'world'")
+
+    # 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 interrupting the plugin" do
+
+    it_behaves_like "an interruptible input plugin" do
+      let(:config) { { "command" => "echo ☹" } }
+    end
+
+    it_behaves_like "an interruptible input plugin" do
+      let(:config) { { "command" => "echo foo" } }
+    end
+
+  end
+
+  describe "pipe from echo" do
+
+    let(:config) do <<-CONFIG
       input {
         pipe {
           command => "echo ☹"
         }
       }
-      CONFIG
+    CONFIG
+    end
 
-      event = input(conf) do |pipeline, queue|
+    let(:event) do
+      input(config) do |pipeline, queue|
         queue.pop
       end
+    end
 
-      insist { event["message"] } == "☹"
+    it "should receive the pipe" do
+      expect(event["message"]).to eq("☹")
     end
+
   end
 
-  # rince and repeat a few times to stress the shutdown sequence
-  5.times.each do
-    it "should pipe from tail -f" do
-      event_count = 10
-      tmp_file = Tempfile.new('logstash-spec-input-pipe')
+  describe "pipe from tail" do
 
-      conf = <<-CONFIG
-      input {
+    let(:tmp_file)    { Tempfile.new('logstash-spec-input-pipe') }
+    let(:event_count) { 10 }
+
+    let(:config) do <<-CONFIG
+    input {
         pipe {
           command => "tail -n +0 -f #{tmp_file.path}"
         }
       }
-      CONFIG
+    CONFIG
+    end
 
-      events = input(conf) do |pipeline, queue|
+    let(:events) do
+      input(config) do |pipeline, queue|
         File.open(tmp_file, "a") do |fd|
           event_count.times do |i|
             # unicode smiley for testing unicode support!
@@ -46,9 +71,11 @@ describe "inputs/pipe", :unix => true do
         end
         event_count.times.map { queue.pop }
       end
+    end
 
+    it "should receive all piped elements" do
       event_count.times do |i|
-        insist { events[i]["message"] } == "#{i} ☹"
+        expect(events[i]["message"]).to eq("#{i} ☹")
       end
     end
   end

metadata

@@ -1,77 +1,83 @@
 --- !ruby/object:Gem::Specification
 name: logstash-input-pipe
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Elastic
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2015-06-24 00:00:00.000000000 Z
+date: 2015-09-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.0.0.snapshot
   name: logstash-core
+  prerelease: false
+  type: :runtime
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
-      - !ruby/object:Gem::Version
-        version: 1.4.0
-    - - <
+    - - ~>
       - !ruby/object:Gem::Version
-        version: 2.0.0
+        version: 2.0.0.snapshot
+- !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
-      - !ruby/object:Gem::Version
-        version: 1.4.0
-    - - <
+    - - ~>
       - !ruby/object:Gem::Version
-        version: 2.0.0
+        version: 0.0.22
+  name: stud
   prerelease: false
   type: :runtime
-- !ruby/object:Gem::Dependency
-  name: logstash-codec-plain
   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: logstash-codec-plain
   prerelease: false
   type: :runtime
-- !ruby/object:Gem::Dependency
-  name: logstash-devutils
   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-devutils
   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/plugin install gemname. This gem is not a stand-alone program
 email: info@elastic.co
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
 - CHANGELOG.md
 - CONTRIBUTORS
 - Gemfile
 - LICENSE
 - NOTICE.TXT
 - README.md
-- Rakefile
 - lib/logstash/inputs/pipe.rb
 - logstash-input-pipe.gemspec
 - spec/inputs/pipe_spec.rb
@@ -97,7 +103,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project:
-rubygems_version: 2.2.2
+rubygems_version: 2.4.8
 signing_key:
 specification_version: 4
 summary: Stream events from a long running command pipe

data/.gitignore

@@ -1,4 +0,0 @@
-*.gem
-Gemfile.lock
-.bundle
-vendor

data/Rakefile

@@ -1,7 +0,0 @@
-@files=[]
-
-task :default do
-  system("rake -T")
-end
-
-require "logstash/devutils/rake"