require "logstash/devutils/rspec/spec_helper"
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
  

  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.get("firstname") } == "Borat"
      insist { subject.get("lastname") } == "Sagdiyev"
      insist { subject.get("fullname") } == "Borat Sagdiyev"
      insist { subject.get("country") } == "Kazakhstan"
      insist { subject.get("location") } == "Somethere in Kazakhstan"
      insist { subject.get("hobby") } == "Cloud"
      insist { subject.get("status") } == "200"
      insist { subject.get("Borat_saying") } == "Cloud is not ready for enterprise if is not integrate with single server running Active Directory."
      insist { subject.get("%{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.get("firstname") } == "Borat"
      insist { subject.get("lastname") } == nil
      insist { subject.get("fullname") } == nil
      insist { subject.get("country") } == nil
      insist { subject.get("location") } == nil
      insist { subject.get("hobby") } == "Cloud"
      insist { subject.get("status") } == "200"
      insist { subject.get("Borat_saying") } == nil
      insist { subject.get("%{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.get("firstname") } == "Borat"
      insist { subject.get("lastname") } == nil
      insist { subject.get("fullname") } == nil
      insist { subject.get("country") } == nil
      insist { subject.get("location") } == nil
      insist { subject.get("hobby") } == "Cloud"
      insist { subject.get("status") } == "200"
      insist { subject.get("Borat_saying") } == "Cloud is not ready for enterprise if is not integrate with single server running Active Directory."
      insist { subject.get("%{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.get("firstname") } == nil
      insist { subject.get("lastname") } == "Sagdiyev"
      insist { subject.get("fullname") } == "Borat Sagdiyev"
      insist { subject.get("country") } == "Kazakhstan"
      insist { subject.get("location") } == "Somethere in Kazakhstan"
      insist { subject.get("hobby") } == nil
      insist { subject.get("status") } == nil
      insist { subject.get("Borat_saying") } == "Cloud is not ready for enterprise if is not integrate with single server running Active Directory."
      insist { subject.get("%{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.get("firstname") } == nil
      insist { subject.get("lastname") } == "Sagdiyev"
      insist { subject.get("fullname") } == "Borat Sagdiyev"
      insist { subject.get("country") } == "Kazakhstan"
      insist { subject.get("location") } == "Somethere in Kazakhstan"
      insist { subject.get("hobby") } == nil
      insist { subject.get("status") } == nil
      insist { subject.get("Borat_saying") } == nil
      insist { subject.get("%{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.get("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.get("lastname") } == "Sagdiyev"
      insist { subject.get("fullname") } == nil
      insist { subject.get("country") } == "Kazakhstan"
      insist { subject.get("location") } == nil
      insist { subject.get("hobby") } == "Cloud"
      insist { subject.get("status") } == "200"
      insist { subject.get("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.get("%{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.get("firstname") } == "Borat"
      insist { subject.get("lastname") } == "Sagdiyev"
      insist { subject.get("fullname") } == "Borat Sagdiyev"
      insist { subject.get("country") } == "Kazakhstan"
      insist { subject.get("location") } == nil
      insist { subject.get("hobby") } == "Cloud"
      insist { subject.get("status") } == "200"
      insist { subject.get("Borat_saying") } == "Cloud is not ready for enterprise if is not integrate with single server running Active Directory."
      insist { subject.get("%{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.get("firstname") } == nil
      insist { subject.get("lastname") } == "Sagdiyev"
      insist { subject.get("fullname") } == "Borat Sagdiyev"
      insist { subject.get("country") } == "Kazakhstan"
      insist { subject.get("location") } == "Somethere in Kazakhstan"
      insist { subject.get("hobby") } == "Cloud"
      insist { subject.get("status") } == nil
      insist { subject.get("Borat_saying") } == "Cloud is not ready for enterprise if is not integrate with single server running Active Directory."
      insist { subject.get("%{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.get("firstname") } == nil
      insist { subject.get("lastname") } == "Sagdiyev"
      insist { subject.get("fullname") } == nil
      insist { subject.get("country") } == "Kazakhstan"
      insist { subject.get("location") } == "Somethere in Kazakhstan"
      insist { subject.get("hobby") } == "Cloud"
      insist { subject.get("status") } == nil
      insist { subject.get("Borat_saying") } == nil
      insist { subject.get("%{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.get("blah") } == "foo"
      insist { subject.get("error") } == nil
      insist { subject.get("xxx") } == [ "1 2 3", "3 4 5" ]
      insist { subject.get("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.get("blah") } == "foo"
      insist { subject.get("error") } == [ "This is foolish", "Need smthing smart too" ]
      insist { subject.get("xxx") } == nil
      insist { subject.get("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.get("blah") } == "foo"
      insist { subject.get("error") } == [ "This is foolish" ]
      insist { subject.get("xxx") } == [ "1 2 3", "3 4 5" ]
      insist { subject.get("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.get("blah") } == "foo"
      insist { subject.get("error") } == [ "Need smthing smart too" ]
      insist { subject.get("xxx") } == nil
      insist { subject.get("status") } == [ "400", "500" ]
    end
  end

end