logstash-filter-phpserialize 1.0 → 1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a3932a9341d306d9566fd430aa6519c78b7b5595
-  data.tar.gz: 0538a0022ad134b8a4d7d0b8ac1ba2461766eaf3
+  metadata.gz: 6e270d256ba5929961c6ed3c7b3b0a968351a813
+  data.tar.gz: 4ea5454e356cf6fff18440385588188fb2c1f2ba
 SHA512:
-  metadata.gz: 4cf09a14ddb6eb8a2e769e5831a7e291016f4efae20b7ef2938cb251a48409334d704be67c43677d7d2b839c07a219803c71baffc6486d6c8b2a61e4f29452bd
-  data.tar.gz: b25b30061f055bc8abda8089339ad27ad749e5fdf4d1a7ce77b40e71b7200a514faeae5072d82ba24c17b0de78a554e0992f659db595a1e4fba4843437007022
+  metadata.gz: a09bab6fabc5821918fe547f5cd14ed20f3ca558df836e7ead803074a1f27e3459aff8a0d9de53ab73c3e7d5014031af52b8fb2c74d2970b223304b62aee0a35
+  data.tar.gz: 10edb10d4eab626aa3fe3d280176656a2444224218038725b9896e72c099dc1b35d892dbdf02c3fe1ab57fd29bf96ed97f59818a18ccfbdc91dc208bf9e2b689

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+## 1.1
+  - Include proper error handling
+  - default target field to "message"
+  - Add more tests
+
 ## 1.0
   - Simple implementation
 

data/lib/logstash/filters/phpserialize.rb

@@ -20,8 +20,8 @@ class LogStash::Filters::Phpserialize < LogStash::Filters::Base
   config_name "phpserialize"
   
   config :source, :validate => :string, :default => "message"
-  config :target, :validate => :string
-  
+  config :target, :validate => :string, :default => "message"
+  config :tag_on_failure, :validate => :array, :default => ["_phpunserializefailure"]
 
   public
   def register
@@ -30,10 +30,15 @@ class LogStash::Filters::Phpserialize < LogStash::Filters::Base
 
   public
   def filter(event)
+    source = event.get(@source)
+    return if source.nil?
 
-    data = PHP.unserialize(event.get(@source))
-    if @source
+    begin
+      data = PHP.unserialize(source)
       event.set(@target, data)
+    rescue StandardError
+      @tag_on_failure.each {|tag| event.tag(tag)}
+      return
     end
 
     # filter_matched should go in the last line of our successful code

data/logstash-filter-phpserialize.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name          = 'logstash-filter-phpserialize'
-  s.version       = '1.0'
+  s.version       = '1.1'
   s.licenses      = ['BSD-3-Clause']
   s.summary       = 'Allow to decode phpserialized values'
   s.homepage      = 'https://github.com/has-to-be/logstash-filter-phpserialize'

data/spec/filters/phpserialize_spec.rb

@@ -7,15 +7,72 @@ describe LogStash::Filters::Phpserialize do
     let(:config) do <<-CONFIG
       filter {
         phpserialize {
-          target => "php"
         }
       }
     CONFIG
     end
 
-    sample("message" => 's:11:"Hello World";') do
-      expect(subject).to include('php')
-      expect(subject.get('php')).to eq('Hello World')
+    sample('s:11:"Hello World";') do
+      expect(subject.get('message')).to eq('Hello World')
+    end
+  end
+
+  describe "parse empty field" do
+    let(:config) do <<-CONFIG
+      filter {
+        phpserialize {
+        }
+      }
+    CONFIG
+    end
+
+    sample('') do
+      expect(subject.get('message')).to eq('')
+    end
+  end
+
+  describe "parse non-existing field" do
+    let(:config) do <<-CONFIG
+      filter {
+        phpserialize {
+          source => "in"
+        }
+      }
+    CONFIG
+    end
+
+    sample('') do
+      expect(subject.get('message')).to eq('')
+      expect(subject.get('tags')).to be_nil
+    end
+  end
+
+  describe "parse null value" do
+    let(:config) do <<-CONFIG
+      filter {
+        phpserialize {
+        }
+      }
+    CONFIG
+    end
+
+    sample('N;') do
+      expect(subject.get('message')).to be_nil
+    end
+  end
+
+  describe "parse corrupt value" do
+    let(:config) do <<-CONFIG
+      filter {
+        phpserialize {
+        }
+      }
+    CONFIG
+    end
+
+    sample('Hello World') do
+      expect(subject.get('message')).to eq('Hello World')
+      expect(subject.get('tags')).to include('_phpunserializefailure')
     end
   end
 
@@ -23,16 +80,30 @@ describe LogStash::Filters::Phpserialize do
     let(:config) do <<-CONFIG
       filter {
         phpserialize {
-          source => "php_in"
-          target => "php_out"
+          source => "in"
+        }
+      }
+    CONFIG
+    end
+
+    sample("in" => 'i:42;') do
+      expect(subject.get('message')).to eq(42)
+    end
+  end
+
+  describe "parse into target field" do
+    let(:config) do <<-CONFIG
+      filter {
+        phpserialize {
+          target => "php"
         }
       }
     CONFIG
     end
 
-    sample("php_in" => 'i:42;') do
-      expect(subject).to include('php_out')
-      expect(subject.get('php_out')).to eq(42)
+    sample('i:42;') do
+      expect(subject).to include('php')
+      expect(subject.get('php')).to eq(42)
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: logstash-filter-phpserialize
 version: !ruby/object:Gem::Version
-  version: '1.0'
+  version: '1.1'
 platform: ruby
 authors:
 - Roland Angerer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-04-03 00:00:00.000000000 Z
+date: 2017-05-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: logstash-core-plugin-api
@@ -89,7 +89,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.5.2
 signing_key: 
 specification_version: 4
 summary: Allow to decode phpserialized values