logstash-filter-mutate 1.0.2 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2340f9a8f015a3c4f928f77ac33c833914dcc76f
-  data.tar.gz: a96cd73c174e946d1c9bc2e97b3b4a26e39776f5
+  metadata.gz: bef0aa2c5c7cb7ad5eb0ef8c611df606f9603eb9
+  data.tar.gz: 023ae7f16509abd314efe929633fce32d73cfd30
 SHA512:
-  metadata.gz: 2488ab08c2dc09fc29a7a3e759a620e9944250b6922b7b5a06aa0c78f1bb7a0f3cc63dcf735cb6dcda486b9a62e6aa33137ddb5ec47cd7aae481f9b0ad1c61b4
-  data.tar.gz: dc9942e5c4c6cbb951dcb8d91c1805f1d54ee0ade7017a7458c2c066eb678eac4debe13826b7ac50df377ead42ab3fda69f800aac481264f7bd42f5e4608b63a
+  metadata.gz: 50a1215e8a2f924be132df3e24011b932766fdedf14b49542da5f2fb7fb0ff3f05965988c69cd702fe87a8b70333abda944fdbeb7d90d620cc60a734d60e26f2
+  data.tar.gz: 7d645fbfd6d8947781b4e4db0a0c38dc1467fc083376feba1ac996ef9fbc4d647b4391db7f3dfb716b68e0bf213050d90ccbcfa166f57aac7d2403d6ca882429

data/lib/logstash/filters/mutate.rb

@@ -226,16 +226,17 @@ class LogStash::Filters::Mutate < LogStash::Filters::Base
 
   private
   def remove(event)
-    # TODO(sissel): use event.sprintf on the field names?
     @remove.each do |field|
+      field = event.sprintf(field)
       event.remove(field)
     end
   end # def remove
 
   private
   def rename(event)
-    # TODO(sissel): use event.sprintf on the field names?
     @rename.each do |old, new|
+      old = event.sprintf(old)
+      new = event.sprintf(new)
       next unless event.include?(old)
       event[new] = event.remove(old)
     end
@@ -349,7 +350,9 @@ class LogStash::Filters::Mutate < LogStash::Filters::Base
         when Array
           # can't map upcase! as it replaces an already upcase value with nil
           # ["ABCDEF"].map(&:upcase!) => [nil]
-          original.map(&:upcase)
+          original.map do |elem|
+           (elem.is_a?(String) ? elem.upcase : elem)
+          end
         when String
           # nil means no change was made to the String
           original.upcase! || original
@@ -368,7 +371,9 @@ class LogStash::Filters::Mutate < LogStash::Filters::Base
       original = event[field]
       event[field] = case original
         when Array
-          original.map(&:downcase)
+          original.map! do |elem|
+            (elem.is_a?(String) ? elem.downcase : elem)
+          end
         when String
           original.downcase! || original
         else

data/logstash-filter-mutate.gemspec

@@ -1,7 +1,7 @@
 Gem::Specification.new do |s|
 
   s.name            = 'logstash-filter-mutate'
-  s.version         = '1.0.2'
+  s.version         = '2.0.0'
   s.licenses        = ['Apache License (2.0)']
   s.summary         = "The mutate filter allows you to perform general mutations on fields. You can rename, remove, replace, and modify fields in your events."
   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($\)
+  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" => "filter" }
 
   # 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-patterns-core'
   s.add_runtime_dependency 'logstash-filter-grok'
   s.add_development_dependency 'logstash-devutils'

data/spec/filters/mutate_spec.rb

@@ -10,6 +10,100 @@ unless LogStash::Environment.const_defined?(:LOGSTASH_HOME)
   LogStash::Environment::LOGSTASH_HOME = File.expand_path("../../../", __FILE__)
 end
 
+
+describe LogStash::Filters::Mutate do
+
+  let(:config) { {} }
+  subject      { LogStash::Filters::Mutate.new(config) }
+
+  let(:attrs) { { } }
+  let(:event) { LogStash::Event.new(attrs) }
+
+  before(:each) do
+    subject.register
+  end
+
+  context "when doing uppercase of an array" do
+
+    let(:config) do
+      { "uppercase" => ["array_of"] }
+    end
+
+    let(:attrs) { { "array_of" => ["a", 2, "C"] } }
+
+    it "should uppercase not raise an error" do
+      expect { subject.filter(event) }.not_to raise_error
+    end
+
+    it "should convert only string elements" do
+      subject.filter(event)
+      expect(event["array_of"]).to eq(["A", 2, "C"])
+    end
+  end
+
+  context "when doing lowercase of an array" do
+
+    let(:config) do
+      { "lowercase" => ["array_of"] }
+    end
+
+    let(:attrs) { { "array_of" => ["a", 2, "C"] } }
+
+    it "should lowercase all string elements" do
+      expect { subject.filter(event) }.not_to raise_error
+    end
+
+    it "should convert only string elements" do
+      subject.filter(event)
+      expect(event["array_of"]).to eq(["a", 2, "c"])
+    end
+  end
+
+end
+
+describe LogStash::Filters::Mutate do
+
+  let(:config) { {} }
+  subject      { LogStash::Filters::Mutate.new(config) }
+
+  let(:attrs) { { } }
+  let(:event) { LogStash::Event.new(attrs) }
+
+  before(:each) do
+    subject.register
+  end
+
+  describe "#strip" do
+
+    let(:config) do
+      { "strip" => ["path"] }
+    end
+
+    let(:attrs) { { "path" => " /store.php " } }
+
+    it "should cleam trailing spaces" do
+      subject.filter(event)
+      expect(event["path"]).to eq("/store.php")
+    end
+
+    context "when converting multiple attributed at once" do
+
+      let(:config) do
+        { "strip" => ["foo", "bar"] }
+      end
+
+      let(:attrs) { { "foo" => " /bar.php ", "bar" => " foo" } }
+
+      it "should cleam trailing spaces" do
+        subject.filter(event)
+        expect(event["foo"]).to eq("/bar.php")
+        expect(event["bar"]).to eq("foo")
+      end
+    end
+  end
+
+end
+
 describe LogStash::Filters::Mutate do
 
   context "config validation" do
@@ -139,6 +233,38 @@ describe LogStash::Filters::Mutate do
     end
   end
 
+  describe "remove on non-existent field" do
+    config '
+      filter {
+        mutate {
+          remove => "[foo][bar]"
+        }
+      }'
+
+    sample(
+       "abc"  => "def"
+    ) do
+      insist { subject["abc"] } == "def"
+    end
+  end
+  
+
+  describe "remove with dynamic fields (%{})" do
+    config '
+      filter {
+        mutate {
+          remove => [ "field_%{x}" ]
+        }
+      }'
+
+    sample(
+      "x" => "one",
+      "field_one" => "value"
+    ) do
+      reject { subject }.include?("field_one")
+    end
+  end
+
   describe "convert one field to string" do
     config '
       filter {
@@ -289,6 +415,36 @@ describe LogStash::Filters::Mutate do
     end
   end
 
+  describe "rename with dynamic origin field (%{})" do
+    config <<-CONFIG
+      filter {
+        mutate {
+          rename => [ "field_%{x}", "destination" ]
+        }
+      }
+    CONFIG
+
+    sample("field_one" => "value", "x" => "one") do
+      reject { subject }.include?("field_one")
+      insist { subject }.include?("destination")
+    end
+  end
+
+  describe "rename with dynamic destination field (%{})" do
+    config <<-CONFIG
+      filter {
+        mutate {
+          rename => [ "origin", "field_%{x}" ]
+        }
+      }
+    CONFIG
+
+    sample("field_one" => "value", "x" => "one") do
+      reject { subject }.include?("origin")
+      insist { subject }.include?("field_one")
+    end
+  end
+
   describe "convert should work on nested fields" do
     config <<-CONFIG
       filter {

metadata

@@ -1,91 +1,83 @@
 --- !ruby/object:Gem::Specification
 name: logstash-filter-mutate
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 2.0.0
 platform: ruby
 authors:
 - Elastic
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2015-08-27 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-patterns-core
   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-patterns-core
   prerelease: false
   type: :runtime
-- !ruby/object:Gem::Dependency
-  name: logstash-filter-grok
   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-filter-grok
   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/filters/mutate.rb
 - logstash-filter-mutate.gemspec
 - spec/filters/integration/multi_stage_spec.rb
@@ -112,7 +104,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project:
-rubygems_version: 2.1.9
+rubygems_version: 2.4.8
 signing_key:
 specification_version: 4
 summary: The mutate filter allows you to perform general mutations on fields. You can rename, remove, replace, and modify fields in your events.

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"