logstash-filter-mutate 1.0.1 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c6e8dbce3ff65a25dce65dbd8ae7751a404cd60a
-  data.tar.gz: 9d2cfdaf0d3af46964281aa880c2f70dbf6768dd
+  metadata.gz: 2340f9a8f015a3c4f928f77ac33c833914dcc76f
+  data.tar.gz: a96cd73c174e946d1c9bc2e97b3b4a26e39776f5
 SHA512:
-  metadata.gz: 2fe9cdfb16596fe8dc140a6b31f44a442de3ce76c30d5090f627bb3187c2c1f55b58da9af6b825710ec2470014417226e272c891fe08f595b354b080a00bcb17
-  data.tar.gz: c1fed55596c84f174835abf6a5d7a44e7281c5d8d31aa523a017e9c3d5d348f0570c6e43930c6a76ab67a6dd1cb6cb83ea1fb061d2e1028d73343178f6945595
+  metadata.gz: 2488ab08c2dc09fc29a7a3e759a620e9944250b6922b7b5a06aa0c78f1bb7a0f3cc63dcf735cb6dcda486b9a62e6aa33137ddb5ec47cd7aae481f9b0ad1c61b4
+  data.tar.gz: dc9942e5c4c6cbb951dcb8d91c1805f1d54ee0ade7017a7458c2c066eb678eac4debe13826b7ac50df377ead42ab3fda69f800aac481264f7bd42f5e4608b63a

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 1.0.2
+ - Fix for uppercase and lowercase fail when value is already desired case
+ - Modify tests to prove bug and verify fix.
+
 ## 1.0.1
  - Fix for uppercase and lowercase malfunction
  - Specific test to prove bug and fix.

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/filters/mutate.rb

@@ -342,11 +342,17 @@ class LogStash::Filters::Mutate < LogStash::Filters::Base
   def uppercase(event)
     @uppercase.each do |field|
       original = event[field]
+      # in certain cases JRuby returns a proxy wrapper of the event[field] value
+      # therefore we can't assume that we are modifying the actual value behind
+      # the key so read, modify and overwrite
       event[field] = case original
         when Array
-          original.map(&:upcase!)
+          # can't map upcase! as it replaces an already upcase value with nil
+          # ["ABCDEF"].map(&:upcase!) => [nil]
+          original.map(&:upcase)
         when String
-          original.upcase!
+          # nil means no change was made to the String
+          original.upcase! || original
         else
           @logger.debug("Can't uppercase something that isn't a string",
                         :field => field, :value => original)
@@ -357,13 +363,14 @@ class LogStash::Filters::Mutate < LogStash::Filters::Base
 
   private
   def lowercase(event)
+    #see comments for #uppercase
     @lowercase.each do |field|
       original = event[field]
       event[field] = case original
         when Array
-          original.map(&:downcase!)
+          original.map(&:downcase)
         when String
-          original.downcase!
+          original.downcase! || original
         else
           @logger.debug("Can't lowercase something that isn't a string",
                         :field => field, :value => original)

data/logstash-filter-mutate.gemspec

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

@@ -34,7 +34,7 @@ describe LogStash::Filters::Mutate do
 
   describe 'MUTATE-33: multi stage with json, grok and mutate, Case mutation' do
     let(:event) do
-      "{\"message\":\"hello WORLD\",\"examplefield\":\"PPQQRRSS\"}"
+      "{\"message\":\"hello WORLD\",\"lower1\":\"PPQQRRSS\",\"lower2\":\"pppqqq\"}"
     end
 
     let(:config) do
@@ -46,7 +46,7 @@ filter {
         singles => true
     }
     mutate {
-      lowercase => [ "bar", "examplefield" ]
+      lowercase => [ "bar", "lower1", "lower2" ]
     }
 }
 CONFIG
@@ -57,9 +57,14 @@ CONFIG
       expect(result["bar"]).to eq('world')
     end
 
-    it 'change case of the target, examplefield value is lowercase' do
+    it 'change case of the target, lower1 value is lowercase' do
       result = results.first
-      expect(result["examplefield"]).to eq("ppqqrrss")
+      expect(result["lower1"]).to eq("ppqqrrss")
+    end
+
+    it 'change case of the target, lower2 value is lowercase' do
+      result = results.first
+      expect(result["lower2"]).to eq("pppqqq")
     end
 
   end

data/spec/filters/mutate_spec.rb

@@ -45,8 +45,8 @@ describe LogStash::Filters::Mutate do
     config <<-CONFIG
       filter {
         mutate {
-          lowercase => "lowerme"
-          uppercase => "upperme"
+          lowercase => ["lowerme","Lowerme", "lowerMe"]
+          uppercase => ["upperme", "Upperme", "upperMe"]
           convert => [ "intme", "integer", "floatme", "float" ]
           rename => [ "rename1", "rename2" ]
           replace => [ "replaceme", "hello world" ]
@@ -59,8 +59,12 @@ describe LogStash::Filters::Mutate do
     CONFIG
 
     event = {
-      "lowerme" => [ "ExAmPlE" ],
-      "upperme" => [ "ExAmPlE" ],
+      "lowerme" => "example",
+      "upperme" => "EXAMPLE",
+      "Lowerme" => "ExAmPlE",
+      "Upperme" => "ExAmPlE",
+      "lowerMe" => [ "ExAmPlE", "example" ],
+      "upperMe" => [ "ExAmPlE", "EXAMPLE" ],
       "intme" => [ "1234", "7890.4", "7.9" ],
       "floatme" => [ "1234.455" ],
       "rename1" => [ "hello world" ],
@@ -70,8 +74,12 @@ describe LogStash::Filters::Mutate do
     }
 
     sample event do
-      expect(subject["lowerme"]).to eq ['example']
-      expect(subject["upperme"]).to eq ['EXAMPLE']
+      expect(subject["lowerme"]).to eq 'example'
+      expect(subject["upperme"]).to eq 'EXAMPLE'
+      expect(subject["Lowerme"]).to eq 'example'
+      expect(subject["Upperme"]).to eq 'EXAMPLE'
+      expect(subject["lowerMe"]).to eq ['example', 'example']
+      expect(subject["upperMe"]).to eq ['EXAMPLE', 'EXAMPLE']
       expect(subject["intme"] ).to eq [1234, 7890, 7]
       expect(subject["floatme"]).to eq [1234.455]
       expect(subject).not_to include("rename1")
@@ -85,6 +93,28 @@ describe LogStash::Filters::Mutate do
     end
   end
 
+  describe "case handling of multibyte unicode strings will only change ASCII" do
+    config <<-CONFIG
+      filter {
+        mutate {
+          lowercase => ["lowerme"]
+          uppercase => ["upperme"]
+        }
+      }
+    CONFIG
+
+    event = {
+      "lowerme" => [ "АБВГД\0MMM", "こにちわ", "XyZółć", "NÎcË GÛŸ"],
+      "upperme" => [ "аБвгд\0mmm", "こにちわ", "xYzółć", "Nîcë gûÿ"],
+    }
+
+    sample event do
+      # ATM, only the ASCII characters will case change
+      expect(subject["lowerme"]).to eq [ "АБВГД\0mmm", "こにちわ", "xyzółć", "nÎcË gÛŸ"]
+      expect(subject["upperme"]).to eq [ "аБвгд\0MMM", "こにちわ", "XYZółć", "NîCë Gûÿ"]
+    end
+  end
+
   describe "remove multiple fields" do
     config '
       filter {

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: logstash-filter-mutate
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.2
 platform: ruby
 authors:
 - Elastic
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2015-08-14 00:00:00.000000000 Z
+date: 2015-08-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: logstash-core