logstash-lib 1.3.2

data/spec/filters/noop.rb

@@ -0,0 +1,221 @@
+require "test_utils"
+require "logstash/filters/noop"
+
+#NOOP filter is perfect for testing Filters::Base features with minimal overhead
+describe LogStash::Filters::NOOP do
+  extend LogStash::RSpec
+
+  describe "adding multiple value to one field" do
+    config <<-CONFIG
+    filter {
+      noop {
+        add_field => ["new_field", "new_value"]
+        add_field => ["new_field", "new_value_2"]
+      }
+    }
+    CONFIG
+
+    sample "example" do
+      insist { subject["new_field"] } == ["new_value", "new_value_2"]
+    end
+  end
+
+  describe "type parsing" do
+    config <<-CONFIG
+    filter {
+      noop {
+        type => "noop"
+        add_tag => ["test"]
+      }
+    }
+    CONFIG
+
+    sample("type" => "noop") do
+      insist { subject["tags"] } == ["test"]
+    end
+
+    sample("type" => "not_noop") do
+      insist { subject["tags"] }.nil?
+    end
+  end
+
+  describe "tags parsing with one tag" do
+    config <<-CONFIG
+    filter {
+      noop {
+        type => "noop"
+        tags => ["t1"]
+        add_tag => ["test"]
+      }
+    }
+    CONFIG
+
+    sample("type" => "noop") do
+      insist { subject["tags"] }.nil?
+    end
+
+    sample("type" => "noop", "tags" => ["t1", "t2"]) do
+      insist { subject["tags"] } == ["t1", "t2", "test"]
+    end
+  end
+
+  describe "tags parsing with multiple tags" do
+    config <<-CONFIG
+    filter {
+      noop {
+        type => "noop"
+        tags => ["t1", "t2"]
+        add_tag => ["test"]
+      }
+    }
+    CONFIG
+
+    sample("type" => "noop") do
+      insist { subject["tags"] }.nil?
+    end
+
+    sample("type" => "noop", "tags" => ["t1"]) do
+      insist { subject["tags"] } == ["t1"]
+    end
+
+    sample("type" => "noop", "tags" => ["t1", "t2"]) do
+      insist { subject["tags"] } == ["t1", "t2", "test"]
+    end
+
+    sample("type" => "noop", "tags" => ["t1", "t2", "t3"]) do
+      insist { subject["tags"] } == ["t1", "t2", "t3", "test"]
+    end
+  end
+
+  describe "exclude_tags with 1 tag" do
+    config <<-CONFIG
+    filter {
+      noop {
+        type => "noop"
+        tags => ["t1"]
+        add_tag => ["test"]
+        exclude_tags => ["t2"]
+      }
+    }
+    CONFIG
+
+    sample("type" => "noop") do
+      insist { subject["tags"] }.nil?
+    end
+
+    sample("type" => "noop", "tags" => ["t1"]) do
+      insist { subject["tags"] } == ["t1", "test"]
+    end
+
+    sample("type" => "noop", "tags" => ["t1", "t2"]) do
+      insist { subject["tags"] } == ["t1", "t2"]
+    end
+  end
+
+  describe "exclude_tags with >1 tags" do
+    config <<-CONFIG
+    filter {
+      noop {
+        type => "noop"
+        tags => ["t1"]
+        add_tag => ["test"]
+        exclude_tags => ["t2", "t3"]
+      }
+    }
+    CONFIG
+
+    sample("type" => "noop", "tags" => ["t1", "t2", "t4"]) do
+      insist { subject["tags"] } == ["t1", "t2", "t4"]
+    end
+
+    sample("type" => "noop", "tags" => ["t1", "t3", "t4"]) do
+      insist { subject["tags"] } == ["t1", "t3", "t4"]
+    end
+
+    sample("type" => "noop", "tags" => ["t1", "t4", "t5"]) do
+      insist { subject["tags"] } == ["t1", "t4", "t5", "test"]
+    end
+  end
+
+  describe "remove_tag" do
+    config <<-CONFIG
+    filter {
+      noop {
+        type => "noop"
+        tags => ["t1"]
+        remove_tag => ["t2", "t3"]
+      }
+    }
+    CONFIG
+
+    sample("type" => "noop", "tags" => ["t4"]) do
+      insist { subject["tags"] } == ["t4"]
+    end
+
+    sample("type" => "noop", "tags" => ["t1", "t2", "t3"]) do
+      insist { subject["tags"] } == ["t1"]
+    end
+
+    sample("type" => "noop", "tags" => ["t1", "t2"]) do
+      insist { subject["tags"] } == ["t1"]
+    end
+  end
+
+  describe "remove_tag with dynamic value" do
+    config <<-CONFIG
+    filter {
+      noop {
+        type => "noop"
+        tags => ["t1"]
+        remove_tag => ["%{blackhole}"]
+      }
+    }
+    CONFIG
+
+    sample("type" => "noop", "tags" => ["t1", "goaway", "t3"], "blackhole" => "goaway") do
+      insist { subject["tags"] } == ["t1", "t3"]
+    end
+  end
+
+  describe "remove_field" do
+    config <<-CONFIG
+    filter {
+      noop {
+        type => "noop"
+        remove_field => ["t2", "t3"]
+      }
+    }
+    CONFIG
+
+    sample("type" => "noop", "t4" => "four") do
+      insist { subject }.include?("t4")
+    end
+
+    sample("type" => "noop", "t1" => "one", "t2" => "two", "t3" => "three") do
+      insist { subject }.include?("t1")
+      reject { subject }.include?("t2")
+      reject { subject }.include?("t3")
+    end
+
+    sample("type" => "noop", "t1" => "one", "t2" => "two") do
+      insist { subject }.include?("t1")
+      reject { subject }.include?("t2")
+    end
+  end
+
+  describe "remove_field with dynamic value in field name" do
+    config <<-CONFIG
+    filter {
+      noop {
+        type => "noop"
+        remove_field => ["%{blackhole}"]
+      }
+    }
+    CONFIG
+
+    sample("type" => "noop", "blackhole" => "go", "go" => "away") do
+      insist { subject }.include?("blackhole")
+      reject { subject }.include?("go")
+    end
+  end
+end

data/spec/filters/prune.rb

@@ -0,0 +1,441 @@
+require "test_utils"
+require "logstash/filters/prune"
+
+# Currently the prune filter has bugs and I can't really tell what the intended
+# behavior is.
+#
+# See the 'whitelist field values with interpolation' test for a commented
+# explanation of my confusion.
+describe LogStash::Filters::Prune, :if => false  do
+  extend LogStash::RSpec
+
+  describe "defaults" do
+
+    config <<-CONFIG
+      filter {
+        prune { }
+      }
+    CONFIG
+    
+    sample(
+      "firstname"    => "Borat",
+      "lastname"     => "Sagdiyev",
+      "fullname"     => "Borat Sagdiyev",
+      "country"      => "Kazakhstan",
+      "location"     => "Somethere in Kazakhstan",
+      "hobby"        => "Cloud",
+      "status"       => "200",
+      "Borat_saying" => "Cloud is not ready for enterprise if is not integrate with single server running Active Directory.",
+      "%{hmm}"       => "doh"
+    ) do
+      insist { subject["firstname"] } == "Borat"
+      insist { subject["lastname"] } == "Sagdiyev"
+      insist { subject["fullname"] } == "Borat Sagdiyev"
+      insist { subject["country"] } == "Kazakhstan"
+      insist { subject["location"] } == "Somethere in Kazakhstan"
+      insist { subject["hobby"] } == "Cloud"
+      insist { subject["status"] } == "200"
+      insist { subject["Borat_saying"] } == "Cloud is not ready for enterprise if is not integrate with single server running Active Directory."
+      insist { subject["%{hmm}"] } == nil
+    end
+  end
+
+  describe "whitelist field names" do
+
+    config <<-CONFIG
+      filter {
+        prune {
+          whitelist_names => [ "firstname", "(hobby|status)", "%{firstname}_saying" ]
+        }
+      }
+    CONFIG
+    
+    sample(
+      "firstname"    => "Borat",
+      "lastname"     => "Sagdiyev",
+      "fullname"     => "Borat Sagdiyev",
+      "country"      => "Kazakhstan",
+      "location"     => "Somethere in Kazakhstan",
+      "hobby"        => "Cloud",
+      "status"       => "200",
+      "Borat_saying" => "Cloud is not ready for enterprise if is not integrate with single server running Active Directory.",
+      "%{hmm}"       => "doh"
+    ) do
+      insist { subject["firstname"] } == "Borat"
+      insist { subject["lastname"] } == nil
+      insist { subject["fullname"] } == nil
+      insist { subject["country"] } == nil
+      insist { subject["location"] } == nil
+      insist { subject["hobby"] } == "Cloud"
+      insist { subject["status"] } == "200"
+      insist { subject["Borat_saying"] } == nil
+      insist { subject["%{hmm}"] } == nil
+    end
+  end
+
+  describe "whitelist field names with interpolation" do
+
+    config <<-CONFIG
+      filter {
+        prune {
+          whitelist_names => [ "firstname", "(hobby|status)", "%{firstname}_saying" ]
+          interpolate     => true
+        }
+      }
+    CONFIG
+    
+    sample(
+      "firstname"    => "Borat",
+      "lastname"     => "Sagdiyev",
+      "fullname"     => "Borat Sagdiyev",
+      "country"      => "Kazakhstan",
+      "location"     => "Somethere in Kazakhstan",
+      "hobby"        => "Cloud",
+      "status"       => "200",
+      "Borat_saying" => "Cloud is not ready for enterprise if is not integrate with single server running Active Directory.",
+      "%{hmm}"       => "doh"
+    ) do
+      insist { subject["firstname"] } == "Borat"
+      insist { subject["lastname"] } == nil
+      insist { subject["fullname"] } == nil
+      insist { subject["country"] } == nil
+      insist { subject["location"] } == nil
+      insist { subject["hobby"] } == "Cloud"
+      insist { subject["status"] } == "200"
+      insist { subject["Borat_saying"] } == "Cloud is not ready for enterprise if is not integrate with single server running Active Directory."
+      insist { subject["%{hmm}"] } == nil
+    end
+  end
+
+  describe "blacklist field names" do
+
+    config <<-CONFIG
+      filter {
+        prune {
+          blacklist_names => [ "firstname", "(hobby|status)", "%{firstname}_saying" ]
+        }
+      }
+    CONFIG
+
+    sample(
+      "firstname"    => "Borat",
+      "lastname"     => "Sagdiyev",
+      "fullname"     => "Borat Sagdiyev",
+      "country"      => "Kazakhstan",
+      "location"     => "Somethere in Kazakhstan",
+      "hobby"        => "Cloud",
+      "status"       => "200",
+      "Borat_saying" => "Cloud is not ready for enterprise if is not integrate with single server running Active Directory.",
+      "%{hmm}"       => "doh"
+    ) do
+      insist { subject["firstname"] } == nil
+      insist { subject["lastname"] } == "Sagdiyev"
+      insist { subject["fullname"] } == "Borat Sagdiyev"
+      insist { subject["country"] } == "Kazakhstan"
+      insist { subject["location"] } == "Somethere in Kazakhstan"
+      insist { subject["hobby"] } == nil
+      insist { subject["status"] } == nil
+      insist { subject["Borat_saying"] } == "Cloud is not ready for enterprise if is not integrate with single server running Active Directory."
+      insist { subject["%{hmm}"] } == "doh"
+    end
+  end
+
+  describe "blacklist field names with interpolation" do
+
+    config <<-CONFIG
+      filter {
+        prune {
+          blacklist_names => [ "firstname", "(hobby|status)", "%{firstname}_saying" ]
+          interpolate     => true
+        }
+      }
+    CONFIG
+
+    sample(
+      "firstname"    => "Borat",
+      "lastname"     => "Sagdiyev",
+      "fullname"     => "Borat Sagdiyev",
+      "country"      => "Kazakhstan",
+      "location"     => "Somethere in Kazakhstan",
+      "hobby"        => "Cloud",
+      "status"       => "200",
+      "Borat_saying" => "Cloud is not ready for enterprise if is not integrate with single server running Active Directory.",
+      "%{hmm}"       => "doh"
+    ) do
+      insist { subject["firstname"] } == nil
+      insist { subject["lastname"] } == "Sagdiyev"
+      insist { subject["fullname"] } == "Borat Sagdiyev"
+      insist { subject["country"] } == "Kazakhstan"
+      insist { subject["location"] } == "Somethere in Kazakhstan"
+      insist { subject["hobby"] } == nil
+      insist { subject["status"] } == nil
+      insist { subject["Borat_saying"] } == nil
+      insist { subject["%{hmm}"] } == "doh"
+    end
+  end
+
+  describe "whitelist field values" do
+
+    config <<-CONFIG
+      filter {
+        prune {
+          # This should only  permit fields named 'firstname', 'fullname',
+          # 'location', 'status', etc.
+          whitelist_values => [ "firstname", "^Borat$",
+                                "fullname", "%{firstname} Sagdiyev",
+                                "location", "no no no",
+                                "status", "^2",
+                                "%{firstname}_saying", "%{hobby}.*Active" ]
+        }
+      }
+    CONFIG
+
+    sample(
+      "firstname"    => "Borat",
+      "lastname"     => "Sagdiyev",
+      "fullname"     => "Borat Sagdiyev",
+      "country"      => "Kazakhstan",
+      "location"     => "Somethere in Kazakhstan",
+      "hobby"        => "Cloud",
+      "status"       => "200",
+      "Borat_saying" => "Cloud is not ready for enterprise if is not integrate with single server running Active Directory.",
+      "%{hmm}"       => "doh"
+    ) do
+      insist { subject["firstname"] } == "Borat"
+
+      # TODO(sissel): According to the config above, this should be nil because
+      # it is not in the list of whitelisted fields, but we expect it to be
+      # "Sagdiyev" ? I am confused.
+      insist { subject["lastname"] } == "Sagdiyev"
+      insist { subject["fullname"] } == nil
+      insist { subject["country"] } == "Kazakhstan"
+      insist { subject["location"] } == nil
+      insist { subject["hobby"] } == "Cloud"
+      insist { subject["status"] } == "200"
+      insist { subject["Borat_saying"] } == "Cloud is not ready for enterprise if is not integrate with single server running Active Directory."
+
+      # TODO(sissel): Contrary to the 'lastname' check, we expect %{hmm} field
+      # to be nil because it is not whitelisted, yes? Contradictory insists 
+      # here. I don't know what the intended behavior is... Seems like
+      # whitelist means 'anything not here' but since this test is written
+      # confusingly, I dont' know how to move forward.
+      insist { subject["%{hmm}"] } == nil
+    end
+  end
+
+  describe "whitelist field values with interpolation" do
+
+    config <<-CONFIG
+      filter {
+        prune {
+          whitelist_values => [ "firstname", "^Borat$",
+                                "fullname", "%{firstname} Sagdiyev",
+                                "location", "no no no",
+                                "status", "^2",
+                                "%{firstname}_saying", "%{hobby}.*Active" ]
+          interpolate      => true
+        }
+      }
+    CONFIG
+
+    sample(
+      "firstname"    => "Borat",
+      "lastname"     => "Sagdiyev",
+      "fullname"     => "Borat Sagdiyev",
+      "country"      => "Kazakhstan",
+      "location"     => "Somethere in Kazakhstan",
+      "hobby"        => "Cloud",
+      "status"       => "200",
+      "Borat_saying" => "Cloud is not ready for enterprise if is not integrate with single server running Active Directory.",
+      "%{hmm}"       => "doh"
+    ) do
+      insist { subject["firstname"] } == "Borat"
+      insist { subject["lastname"] } == "Sagdiyev"
+      insist { subject["fullname"] } == "Borat Sagdiyev"
+      insist { subject["country"] } == "Kazakhstan"
+      insist { subject["location"] } == nil
+      insist { subject["hobby"] } == "Cloud"
+      insist { subject["status"] } == "200"
+      insist { subject["Borat_saying"] } == "Cloud is not ready for enterprise if is not integrate with single server running Active Directory."
+      insist { subject["%{hmm}"] } == nil
+    end
+  end
+
+  describe "blacklist field values" do
+
+    config <<-CONFIG
+      filter {
+        prune {
+          blacklist_values => [ "firstname", "^Borat$",
+                                "fullname", "%{firstname} Sagdiyev",
+                                "location", "no no no",
+                                "status", "^2",
+                                "%{firstname}_saying", "%{hobby}.*Active" ]
+        }
+      }
+    CONFIG
+
+    sample(
+      "firstname"    => "Borat",
+      "lastname"     => "Sagdiyev",
+      "fullname"     => "Borat Sagdiyev",
+      "country"      => "Kazakhstan",
+      "location"     => "Somethere in Kazakhstan",
+      "hobby"        => "Cloud",
+      "status"       => "200",
+      "Borat_saying" => "Cloud is not ready for enterprise if is not integrate with single server running Active Directory.",
+      "%{hmm}"       => "doh"
+    ) do
+      insist { subject["firstname"] } == nil
+      insist { subject["lastname"] } == "Sagdiyev"
+      insist { subject["fullname"] } == "Borat Sagdiyev"
+      insist { subject["country"] } == "Kazakhstan"
+      insist { subject["location"] } == "Somethere in Kazakhstan"
+      insist { subject["hobby"] } == "Cloud"
+      insist { subject["status"] } == nil
+      insist { subject["Borat_saying"] } == "Cloud is not ready for enterprise if is not integrate with single server running Active Directory."
+      insist { subject["%{hmm}"] } == nil
+    end
+  end
+
+  describe "blacklist field values with interpolation" do
+
+    config <<-CONFIG
+      filter {
+        prune {
+          blacklist_values => [ "firstname", "^Borat$",
+                                "fullname", "%{firstname} Sagdiyev",
+                                "location", "no no no",
+                                "status", "^2",
+                                "%{firstname}_saying", "%{hobby}.*Active" ]
+          interpolate      => true
+        }
+      }
+    CONFIG
+
+    sample(
+      "firstname"    => "Borat",
+      "lastname"     => "Sagdiyev",
+      "fullname"     => "Borat Sagdiyev",
+      "country"      => "Kazakhstan",
+      "location"     => "Somethere in Kazakhstan",
+      "hobby"        => "Cloud",
+      "status"       => "200",
+      "Borat_saying" => "Cloud is not ready for enterprise if is not integrate with single server running Active Directory.",
+      "%{hmm}"       => "doh"
+    ) do
+      insist { subject["firstname"] } == nil
+      insist { subject["lastname"] } == "Sagdiyev"
+      insist { subject["fullname"] } == nil
+      insist { subject["country"] } == "Kazakhstan"
+      insist { subject["location"] } == "Somethere in Kazakhstan"
+      insist { subject["hobby"] } == "Cloud"
+      insist { subject["status"] } == nil
+      insist { subject["Borat_saying"] } == nil
+      insist { subject["%{hmm}"] } == nil
+    end
+  end
+
+  describe "whitelist field values on fields witn array values" do
+
+    config <<-CONFIG
+      filter {
+        prune {
+          whitelist_values => [ "status", "^(1|2|3)",
+                                "xxx", "3",
+                                "error", "%{blah}" ]
+        }
+      }
+    CONFIG
+
+    sample(
+      "blah"   => "foo",
+      "xxx" => [ "1 2 3", "3 4 5" ],
+      "status" => [ "100", "200", "300", "400", "500" ],
+      "error"  => [ "This is foolish" , "Need smthing smart too" ]
+    ) do
+      insist { subject["blah"] } == "foo"
+      insist { subject["error"] } == nil
+      insist { subject["xxx"] } == [ "1 2 3", "3 4 5" ]
+      insist { subject["status"] } == [ "100", "200", "300" ]
+    end
+  end
+
+  describe "blacklist field values on fields witn array values" do
+
+    config <<-CONFIG
+      filter {
+        prune {
+          blacklist_values => [ "status", "^(1|2|3)",
+                                "xxx", "3",
+                                "error", "%{blah}" ]
+        }
+      }
+    CONFIG
+
+    sample(
+      "blah"   => "foo",
+      "xxx" => [ "1 2 3", "3 4 5" ],
+      "status" => [ "100", "200", "300", "400", "500" ],
+      "error"  => [ "This is foolish", "Need smthing smart too" ]
+    ) do
+      insist { subject["blah"] } == "foo"
+      insist { subject["error"] } == [ "This is foolish", "Need smthing smart too" ]
+      insist { subject["xxx"] } == nil
+      insist { subject["status"] } == [ "400", "500" ]
+    end
+  end
+
+  describe "whitelist field values with interpolation on fields witn array values" do
+ 
+    config <<-CONFIG
+      filter {
+        prune {
+          whitelist_values => [ "status", "^(1|2|3)",
+                                "xxx", "3",
+                                "error", "%{blah}" ]
+          interpolate      => true
+        }
+      }
+    CONFIG
+
+    sample(
+      "blah"   => "foo",
+      "xxx" => [ "1 2 3", "3 4 5" ],
+      "status" => [ "100", "200", "300", "400", "500" ],
+      "error"  => [ "This is foolish" , "Need smthing smart too" ]
+    ) do
+      insist { subject["blah"] } == "foo"
+      insist { subject["error"] } == [ "This is foolish" ]
+      insist { subject["xxx"] } == [ "1 2 3", "3 4 5" ]
+      insist { subject["status"] } == [ "100", "200", "300" ]
+    end
+  end
+
+  describe "blacklist field values with interpolation on fields witn array values" do
+
+    config <<-CONFIG
+      filter {
+        prune {
+          blacklist_values => [ "status", "^(1|2|3)",
+                                "xxx", "3",
+                                "error", "%{blah}" ]
+          interpolate      => true
+        }
+      }
+    CONFIG
+
+    sample(
+      "blah"   => "foo",
+      "xxx" => [ "1 2 3", "3 4 5" ],
+      "status" => [ "100", "200", "300", "400", "500" ],
+      "error"  => [ "This is foolish" , "Need smthing smart too" ]
+    ) do
+      insist { subject["blah"] } == "foo"
+      insist { subject["error"] } == [ "Need smthing smart too" ]
+      insist { subject["xxx"] } == nil
+      insist { subject["status"] } == [ "400", "500" ]
+    end
+  end
+
+end