logstash-filter-mutate 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4354c58e43d72e6cd7fc60a41f7e5b48331bcaf7
-  data.tar.gz: 66e6c06675347f0b253b07b5676782dc1ed17237
+  metadata.gz: c6e8dbce3ff65a25dce65dbd8ae7751a404cd60a
+  data.tar.gz: 9d2cfdaf0d3af46964281aa880c2f70dbf6768dd
 SHA512:
-  metadata.gz: eeb689f3109dbe90ad2e8b1472a453ae4b7ffe5178b49ca8352aadac5a0a9c19b78558454cd6f1b6ec193b6b60785c16a670ec9e8b36ff2c741226ae0d71ac16
-  data.tar.gz: 6399801f7de10d778d119fe8472a70e89f0368940996198aa214b3151d29e1efbd2baf13cd4acf8d4044c29bd3161f8d238bae64e02c84d041ee3c4d515925b5
+  metadata.gz: 2fe9cdfb16596fe8dc140a6b31f44a442de3ce76c30d5090f627bb3187c2c1f55b58da9af6b825710ec2470014417226e272c891fe08f595b354b080a00bcb17
+  data.tar.gz: c1fed55596c84f174835abf6a5d7a44e7281c5d8d31aa523a017e9c3d5d348f0570c6e43930c6a76ab67a6dd1cb6cb83ea1fb061d2e1028d73343178f6945595

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+## 1.0.1
+ - Fix for uppercase and lowercase malfunction
+ - Specific test to prove bug and fix.

data/Gemfile

@@ -1,2 +1,2 @@
 source 'https://rubygems.org'
-gemspec
+gemspec

data/lib/logstash/filters/mutate.rb

@@ -62,11 +62,11 @@ class LogStash::Filters::Mutate < LogStash::Filters::Base
   # If the field is a hash, no action will be taken.
   #
   # If the conversion type is `boolean`, the acceptable values are:
-  # 
+  #
   # * **True:** `true`, `t`, `yes`, `y`, and `1`
   # * **False:** `false`, `f`, `no`, `n`, and `0`
   #
-  # If a value other than these is provided, it will pass straight through 
+  # If a value other than these is provided, it will pass straight through
   # and log a warning message.
   #
   # Valid conversion targets are: integer, float, string, and boolean.
@@ -341,31 +341,38 @@ class LogStash::Filters::Mutate < LogStash::Filters::Base
   private
   def uppercase(event)
     @uppercase.each do |field|
-      if event[field].is_a?(Array)
-        event[field].each { |v| v.upcase! }
-      elsif event[field].is_a?(String)
-        event[field].upcase!
-      else
-        @logger.debug("Can't uppercase something that isn't a string",
-                      :field => field, :value => event[field])
-      end
+      original = event[field]
+      event[field] = case original
+        when Array
+          original.map(&:upcase!)
+        when String
+          original.upcase!
+        else
+          @logger.debug("Can't uppercase something that isn't a string",
+                        :field => field, :value => original)
+          original
+        end
     end
   end # def uppercase
 
   private
   def lowercase(event)
     @lowercase.each do |field|
-      if event[field].is_a?(Array)
-        event[field].each { |v| v.downcase! }
-      elsif event[field].is_a?(String)
-        event[field].downcase!
-      else
-        @logger.debug("Can't lowercase something that isn't a string",
-                      :field => field, :value => event[field])
-      end
+      original = event[field]
+      event[field] = case original
+        when Array
+          original.map(&:downcase!)
+        when String
+          original.downcase!
+        else
+          @logger.debug("Can't lowercase something that isn't a string",
+                        :field => field, :value => original)
+          original
+        end
     end
   end # def lowercase
 
+
   private
   def split(event)
     @split.each do |field, separator|

data/logstash-filter-mutate.gemspec

@@ -1,7 +1,7 @@
 Gem::Specification.new do |s|
 
   s.name            = 'logstash-filter-mutate'
-  s.version         = '1.0.0'
+  s.version         = '1.0.1'
   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"

data/spec/filters/integration/multi_stage_spec.rb

@@ -0,0 +1,66 @@
+# encoding: utf-8
+require "logstash/devutils/rspec/spec_helper"
+require "logstash/filters/mutate"
+
+# running mutate which depends on grok  outside a logstash package means
+# LOGSTASH_HOME will not be defined, so let's set it here
+# before requiring the grok filter
+unless LogStash::Environment.const_defined?(:LOGSTASH_HOME)
+  LogStash::Environment::LOGSTASH_HOME = File.expand_path("../../../", __FILE__)
+end
+
+describe LogStash::Filters::Mutate do
+  let(:pipeline) { LogStash::Pipeline.new(config) }
+  let(:events) do
+    arr = event.is_a?(Array) ? event : [event]
+    arr.map do |evt|
+      LogStash::Event.new(evt.is_a?(String) ? LogStash::Json.load(evt) : evt)
+    end
+  end
+
+  let(:results) do
+    pipeline.instance_eval { @filters.each(&:register) }
+    results  = []
+    events.each do |evt|
+      # filter call the block on all filtered events, included new events added by the filter
+      pipeline.filter(evt) do |filtered_event|
+        results.push(filtered_event)
+      end
+    end
+    pipeline.flush_filters(:final => true) { |flushed_event| results << flushed_event }
+
+    results.select { |e| !e.cancelled? }
+  end
+
+  describe 'MUTATE-33: multi stage with json, grok and mutate, Case mutation' do
+    let(:event) do
+      "{\"message\":\"hello WORLD\",\"examplefield\":\"PPQQRRSS\"}"
+    end
+
+    let(:config) do
+      <<-CONFIG
+filter {
+    grok {
+        match => { "message" => "(?:hello) %{WORD:bar}" }
+        break_on_match => false
+        singles => true
+    }
+    mutate {
+      lowercase => [ "bar", "examplefield" ]
+    }
+}
+CONFIG
+    end
+
+    it 'change case of the target, bar value is lowercase' do
+      result = results.first
+      expect(result["bar"]).to eq('world')
+    end
+
+    it 'change case of the target, examplefield value is lowercase' do
+      result = results.first
+      expect(result["examplefield"]).to eq("ppqqrrss")
+    end
+
+  end
+end

data/spec/filters/mutate_spec.rb

@@ -23,7 +23,7 @@ describe LogStash::Filters::Mutate do
       CONFIG
 
       sample "not_really_important" do
-        insist {subject}.raises LogStash::ConfigurationError
+        expect {subject}.to raise_error LogStash::ConfigurationError
       end
     end
     describe "invalid gsub triad should raise a configuration error" do
@@ -36,7 +36,7 @@ describe LogStash::Filters::Mutate do
       CONFIG
 
       sample "not_really_important" do
-        insist {subject}.raises LogStash::ConfigurationError
+        expect {subject}.to raise_error LogStash::ConfigurationError
       end
     end
   end
@@ -70,18 +70,18 @@ describe LogStash::Filters::Mutate do
     }
 
     sample event do
-      insist { subject["lowerme"] } == ['example']
-      insist { subject["upperme"] } == ['EXAMPLE']
-      insist { subject["intme"] }   == [1234, 7890, 7]
-      insist { subject["floatme"] } == [1234.455]
-      reject { subject }.include?("rename1")
-      insist { subject["rename2"] } == [ "hello world" ]
-      reject { subject }.include?("removeme")
-
-      insist { subject }.include?("newfield")
-      insist { subject["newfield"] } == "newnew"
-      reject { subject }.include?("nosuchfield")
-      insist { subject["updateme"] } == "updated"
+      expect(subject["lowerme"]).to eq ['example']
+      expect(subject["upperme"]).to eq ['EXAMPLE']
+      expect(subject["intme"] ).to eq [1234, 7890, 7]
+      expect(subject["floatme"]).to eq [1234.455]
+      expect(subject).not_to include("rename1")
+      expect(subject["rename2"]).to eq [ "hello world" ]
+      expect(subject).not_to include("removeme")
+
+      expect(subject).to include("newfield")
+      expect(subject["newfield"]).to eq "newnew"
+      expect(subject).not_to include("nosuchfield")
+      expect(subject["updateme"]).to eq "updated"
     end
   end
 
@@ -100,11 +100,12 @@ describe LogStash::Filters::Mutate do
       "survivor"   => "Hello.",
       "one" => { "two" => "wee" }
     ) do
-      insist { subject["survivor"] } == "Hello."
-      reject { subject }.include?("remove-me")
-      reject { subject }.include?("remove-me2")
-      reject { subject }.include?("diedie")
-      reject { subject["one"] }.include?("two")
+      expect(subject["survivor"]).to eq "Hello."
+
+      expect(subject).not_to include("remove-me")
+      expect(subject).not_to include("remove-me2")
+      expect(subject).not_to include("diedie")
+      expect(subject["one"]).not_to include("two")
     end
   end
 
@@ -117,7 +118,7 @@ describe LogStash::Filters::Mutate do
       }'
 
     sample("unicorns" => 1234) do
-      insist { subject["unicorns"] } == "1234"
+      expect(subject["unicorns"]).to eq "1234"
     end
   end
 
@@ -176,7 +177,7 @@ describe LogStash::Filters::Mutate do
       }'
 
     sample("unicorns" => "Magnificient, but extinct, animals") do
-      insist { subject["unicorns"] } == "Magnificient, and common, animals"
+      expect(subject["unicorns"]).to eq "Magnificient, and common, animals"
     end
   end
 
@@ -191,7 +192,7 @@ describe LogStash::Filters::Mutate do
     sample("unicorns" => [
       "Magnificient extinct animals", "Other extinct ideas" ]
     ) do
-      insist { subject["unicorns"] } == [
+      expect(subject["unicorns"]).to eq [
         "Magnificient common animals",
         "Other common ideas"
       ]
@@ -208,8 +209,8 @@ describe LogStash::Filters::Mutate do
       }'
 
     sample("colors" => "One red car", "shapes" => "Four red squares") do
-      insist { subject["colors"] } == "One blue car"
-      insist { subject["shapes"] } == "Four red circles"
+      expect(subject["colors"]).to eq "One blue car"
+      expect(subject["shapes"]).to eq "Four red circles"
     end
   end
 
@@ -222,7 +223,7 @@ describe LogStash::Filters::Mutate do
       }'
 
     sample("colors" => "red3") do
-      insist { subject["colors"] } == "redblue"
+      expect(subject["colors"]).to eq "redblue"
     end
   end
 
@@ -239,7 +240,7 @@ describe LogStash::Filters::Mutate do
     CONFIG
 
     sample "HELLO WORLD" do
-      insist { subject["foo"] } == "hello"
+      expect(subject["foo"]).to eq "hello"
     end
   end
 
@@ -253,8 +254,8 @@ describe LogStash::Filters::Mutate do
     CONFIG
 
     sample "whatever" do
-      reject { subject }.include?("nosuchfield")
-      reject { subject }.include?("hello")
+      expect(subject).not_to include("nosuchfield")
+      expect(subject).not_to include("hello")
     end
   end
 
@@ -268,8 +269,8 @@ describe LogStash::Filters::Mutate do
     CONFIG
 
     sample({ "foo" => { "bar" => "1000" } }) do
-      insist { subject["[foo][bar]"] } == 1000
-      insist { subject["[foo][bar]"] }.is_a?(Fixnum)
+      expect(subject["[foo][bar]"]).to eq 1000
+      expect(subject["[foo][bar]"]).to be_a(Fixnum)
     end
   end
 
@@ -283,8 +284,8 @@ describe LogStash::Filters::Mutate do
     CONFIG
 
     sample({ "foo" => ["100", "200"] }) do
-      insist { subject["[foo][0]"] } == 100
-      insist { subject["[foo][0]"] }.is_a?(Fixnum)
+      expect(subject["[foo][0]"]).to eq 100
+      expect(subject["[foo][0]"]).to be_a(Fixnum)
     end
   end
 
@@ -298,7 +299,7 @@ describe LogStash::Filters::Mutate do
       }'
 
     sample("unicorns" => "Unicorns of type blue are common", "unicorn_type" => "blue") do
-      insist { subject["unicorns"] } == "Unicorns green are common"
+      expect(subject["unicorns"]).to eq "Unicorns green are common"
     end
   end
 
@@ -312,7 +313,7 @@ describe LogStash::Filters::Mutate do
       }'
 
     sample("unicorns2" => "Unicorns of type blue are common", "unicorn_color" => "blue") do
-      insist { subject["unicorns2"] } == "Unicorns blue and green are common"
+      expect(subject["unicorns2"]).to eq "Unicorns blue and green are common"
     end
   end
 
@@ -329,7 +330,7 @@ describe LogStash::Filters::Mutate do
         "Unicorns of type blue are found in Alaska", "Unicorns of type blue are extinct" ],
            "color" => "blue"
     ) do
-      insist { subject["unicorns_array"] } == [
+      expect(subject["unicorns_array"]).to eq [
           "Unicorns blue and green are found in Alaska",
           "Unicorns blue and green are extinct"
       ]
@@ -345,8 +346,8 @@ describe LogStash::Filters::Mutate do
       }'
 
     sample("foo" => "bar") do
-      insist { subject["list"] } == ["bar"]
-      insist { subject["foo"] } == "bar"
+      expect(subject["list"]).to eq ["bar"]
+      expect(subject["foo"]).to eq "bar"
     end
   end
 
@@ -359,8 +360,8 @@ describe LogStash::Filters::Mutate do
       }'
 
     sample("foo" => "bar", "list" => []) do
-      insist { subject["list"] } == ["bar"]
-      insist { subject["foo"] } == "bar"
+      expect(subject["list"]).to eq ["bar"]
+      expect(subject["foo"]).to eq "bar"
     end
   end
 
@@ -373,8 +374,8 @@ describe LogStash::Filters::Mutate do
       }'
 
     sample("foo" => "bar", "list" => ["baz"]) do
-      insist { subject["list"] } == ["baz", "bar"]
-      insist { subject["foo"] } == "bar"
+      expect(subject["list"]).to eq ["baz", "bar"]
+      expect(subject["foo"]).to eq "bar"
     end
   end
 
@@ -387,8 +388,8 @@ describe LogStash::Filters::Mutate do
       }'
 
     sample("foo" => ["bar"], "list" => ["baz"]) do
-      insist { subject["list"] } == ["baz", "bar"]
-      insist { subject["foo"] } == ["bar"]
+      expect(subject["list"]).to eq ["baz", "bar"]
+      expect(subject["foo"]).to eq ["bar"]
     end
   end
 
@@ -401,8 +402,8 @@ describe LogStash::Filters::Mutate do
       }'
 
     sample("foo" => [], "list" => ["baz"]) do
-      insist { subject["list"] } == ["baz"]
-      insist { subject["foo"] } == []
+      expect(subject["list"]).to eq ["baz"]
+      expect(subject["foo"]).to eq []
     end
   end
 
@@ -415,8 +416,8 @@ describe LogStash::Filters::Mutate do
       }'
 
     sample("foo" => ["bar"], "list" => "baz") do
-      insist { subject["list"] } == ["baz", "bar"]
-      insist { subject["foo"] } == ["bar"]
+      expect(subject["list"]).to eq ["baz", "bar"]
+      expect(subject["foo"]).to eq ["bar"]
     end
   end
 
@@ -429,8 +430,8 @@ describe LogStash::Filters::Mutate do
       }'
 
     sample("foo" => "bar", "list" => "baz") do
-      insist { subject["list"] } == ["baz", "bar"]
-      insist { subject["foo"] } == "bar"
+      expect(subject["list"]).to eq ["baz", "bar"]
+      expect(subject["foo"]).to eq "bar"
     end
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: logstash-filter-mutate
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Elastic
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2015-06-24 00:00:00.000000000 Z
+date: 2015-08-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: logstash-core
@@ -88,6 +88,7 @@ files:
 - Rakefile
 - lib/logstash/filters/mutate.rb
 - logstash-filter-mutate.gemspec
+- spec/filters/integration/multi_stage_spec.rb
 - spec/filters/mutate_spec.rb
 homepage: http://www.elastic.co/guide/en/logstash/current/index.html
 licenses:
@@ -111,9 +112,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project:
-rubygems_version: 2.2.2
+rubygems_version: 2.1.9
 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.
 test_files:
+- spec/filters/integration/multi_stage_spec.rb
 - spec/filters/mutate_spec.rb