logstash-input-unix 1.0.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b83e7bbe2583a9b77bba96f3f6e087e34821721b
-  data.tar.gz: 3fc5a0be2fa8505137ba1da455004de9d6a158cf
+  metadata.gz: ef37b6ec56baca1660701d989e36a7896e73f2d8
+  data.tar.gz: 88f5eb311cafe9f088db03df8bdd2d03f376bfba
 SHA512:
-  metadata.gz: efd6b46b03effc65c11fbbaaf29d13ed0096dd44c94edd4706f003a0f3807e33212b3addb0ea396817a5eecdd962980bcfba65d1213d44bc09eb56fc484e77db
-  data.tar.gz: c0868bd20f028758ac5b76782393173b1046780fc5518d6f91f63f7e4bd7d9522c2f338a9c2a067b59061d30180aea8500b982950d07ccafe3a9acf71ba27a88
+  metadata.gz: 5b33029bc4b66ae9d0ecf0d4a443a85b92c381aac27dd15e5600e6255eb524a0d22fe38c9ccca36cd2971c5bf5533b88f02e46b6586d9cc5ec9fa78780b5c741
+  data.tar.gz: 9441f735054e324611531bb7b1e868bdcc6638f76024db724ed4fea20188e960a2caab9b4c6d583b8e6f3dd9d875e0b824908a3871706e59f9a5f87e5dfa11cc

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/unix.rb

@@ -1,7 +1,7 @@
 # encoding: utf-8
 require "logstash/inputs/base"
 require "logstash/namespace"
-require "socket"
+require "logstash/util/socket_peer"
 
 # Read events over a UNIX socket.
 #
@@ -68,7 +68,7 @@ class LogStash::Inputs::Unix < LogStash::Inputs::Base
   def handle_socket(socket, output_queue)
     begin
       hostname = Socket.gethostname
-      loop do
+      while !stop?
         buf = nil
         # NOTE(petef): the timeout only hits after the line is read
         # or socket dies
@@ -86,13 +86,11 @@ class LogStash::Inputs::Unix < LogStash::Inputs::Base
           event["path"] = @path
           output_queue << event
         end
-      end # loop do
+      end
     rescue => e
-      @logger.debug("Closing connection", :path => @path,
-      :exception => e, :backtrace => e.backtrace)
+      @logger.debug("Closing connection", :path => @path, :exception => e, :backtrace => e.backtrace)
     rescue Timeout::Error
-      @logger.debug("Closing connection after read timeout",
-      :path => @path)
+      @logger.debug("Closing connection after read timeout", :path => @path)
     end # begin
 
   ensure
@@ -100,7 +98,7 @@ class LogStash::Inputs::Unix < LogStash::Inputs::Base
       socket.close
     rescue IOError
       #pass
-    end # begin
+    end
   end
 
   private
@@ -111,52 +109,31 @@ class LogStash::Inputs::Unix < LogStash::Inputs::Base
   public
   def run(output_queue)
     if server?
-      @thread = Thread.current
       @client_threads = []
-      loop do
+      while !stop?
         # Start a new thread for each connection.
-        begin
-          @client_threads << Thread.start(@server_socket.accept) do |s|
-            # TODO(sissel): put this block in its own method.
-
-            @logger.debug("Accepted connection",
-                          :server => "#{@path}")
-            begin
-              handle_socket(s, output_queue)
-            rescue Interrupted
-              s.close rescue nil
-            end
-          end # Thread.start
-        rescue IOError, Interrupted
-          if @interrupted
-            # Intended shutdown, get out of the loop
-            @server_socket.close
-            @client_threads.each do |thread|
-              thread.raise(IOError.new)
-            end
-            break
-          else
-            # Else it was a genuine IOError caused by something else, so propagate it up..
-            raise
-          end
+        @client_threads << Thread.start(@server_socket.accept) do |s|
+          @logger.debug("Accepted connection", :server => "#{@path}")
+          handle_socket(s, output_queue)
         end
-      end # loop
+      end
     else
-      loop do
-        client_socket = UNIXSocket.new(@path)
-        client_socket.instance_eval { class << self; include ::LogStash::Util::SocketPeer end }
+      while !stop?
+        @client_socket = UNIXSocket.new(@path)
+        @client_socket.instance_eval { class << self; include ::LogStash::Util::SocketPeer end }
         @logger.debug("Opened connection", :client => @path)
-        handle_socket(client_socket, output_queue)
-      end # loop
+        handle_socket(@client_socket, output_queue)
+      end
     end
   end # def run
 
   public
-  def teardown
+  def stop
     if server?
       File.unlink(@path)
-      @interrupted = true
-      @thread.raise(Interrupted.new)
+      @server_socket.close
+    else
+      @client_socket.close
     end
-  end # def teardown
+  end # def stop
 end # class LogStash::Inputs::Unix

data/logstash-input-unix.gemspec

@@ -1,7 +1,7 @@
 Gem::Specification.new do |s|
 
   s.name            = 'logstash-input-unix'
-  s.version         = '1.0.0'
+  s.version         = '2.0.0'
   s.licenses        = ['Apache License (2.0)']
   s.summary         = "Read events over a UNIX socket."
   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,7 +20,7 @@ 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 'logstash-codec-line'
   s.add_development_dependency 'logstash-devutils'

data/spec/inputs/unix_spec.rb

@@ -1 +1,51 @@
-require "logstash/devutils/rspec/spec_helper"
+# encoding: utf-8
+require_relative "../spec_helper"
+require "stud/temporary"
+require "tempfile"
+
+describe LogStash::Inputs::Unix do
+
+  let(:tempfile)   { Tempfile.new("/tmp/foo") }
+
+  it "should register without errors" do
+    plugin = LogStash::Plugin.lookup("input", "unix").new({ "path" => tempfile.path, "force_unlink" => true })
+    expect { plugin.register }.to_not raise_error
+  end
+
+  describe "when interrupting the plugin" do
+
+    context "#server" do
+      it_behaves_like "an interruptible input plugin" do
+        let(:config) { { "path" => tempfile.path, "force_unlink" => true } }
+      end
+    end
+
+    context "#client" do
+      let(:tempfile)    { "/tmp/sock#{rand(65532)}" }
+      let(:config)      { { "path" => tempfile, "mode" => "client" } }
+      let(:unix_socket) { UnixSocketHelper.new.new_socket(tempfile) }
+      let(:run_forever) { true }
+
+      before(:each) do
+        unix_socket.loop(run_forever)
+      end
+
+      after(:each) do
+        unix_socket.close
+      end
+
+      context "when the unix socket has data to be read" do
+        it_behaves_like "an interruptible input plugin" do
+          let(:run_forever) { true }
+        end
+      end
+
+      context "when the unix socket has no data to be read" do
+        it_behaves_like "an interruptible input plugin" do
+          let(:run_forever) { false }
+        end
+      end
+    end
+
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,33 @@
+# encoding: utf-8
+require "logstash/devutils/rspec/spec_helper"
+require 'logstash/inputs/unix'
+
+class UnixSocketHelper
+
+  attr_reader :path
+
+  def initialize
+    @socket = nil
+  end
+
+  def new_socket(path)
+    @path   = path
+    File.unlink if File.exists?(path) && File.socket?(path)
+    @socket = UNIXServer.new(path)
+    self
+  end
+
+  def loop(forever=false)
+    @thread = Thread.new do
+      s = @socket.accept
+      s.puts "hi" while forever
+    end
+    self
+  end
+
+  def close
+    @thread.kill
+    @socket.close
+    File.unlink(path)
+  end
+end

metadata

@@ -1,80 +1,73 @@
 --- !ruby/object:Gem::Specification
 name: logstash-input-unix
 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
-  name: logstash-core
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '>='
-      - !ruby/object:Gem::Version
-        version: 1.4.0
-    - - <
-      - !ruby/object:Gem::Version
-        version: 2.0.0
   requirement: !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
+  name: logstash-core
   prerelease: false
   type: :runtime
-- !ruby/object:Gem::Dependency
-  name: logstash-codec-line
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.0.0.snapshot
+- !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
+  name: logstash-codec-line
   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/unix.rb
 - logstash-input-unix.gemspec
 - spec/inputs/unix_spec.rb
+- spec/spec_helper.rb
 homepage: http://www.elastic.co/guide/en/logstash/current/index.html
 licenses:
 - Apache License (2.0)
@@ -97,9 +90,10 @@ 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: Read events over a UNIX socket.
 test_files:
 - spec/inputs/unix_spec.rb
+- spec/spec_helper.rb

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"