fluent-plugin-geoip 0.8.2 → 1.0.0

data/test/helper.rb

@@ -1,31 +1,7 @@
-require 'rubygems'
-require 'bundler'
-begin
-  Bundler.setup(:default, :development)
-rescue Bundler::BundlerError => e
-  $stderr.puts e.message
-  $stderr.puts "Run `bundle install` to install missing gems"
-  exit e.status_code
-end
+require 'bundler/setup'
 require 'test/unit'
 
-$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
-$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(__dir__, '..', 'lib'))
+$LOAD_PATH.unshift(__dir__)
 require 'fluent/test'
-unless ENV.has_key?('VERBOSE')
-  nulllogger = Object.new
-  nulllogger.instance_eval {|obj|
-    def method_missing(method, *args)
-      # pass
-    end
-  }
-  $log = nulllogger
-end
-
-require 'fluent/plugin/out_geoip'
-if Fluent.const_defined?(:Filter)
-  require 'fluent/plugin/filter_geoip'
-end
-
-class Test::Unit::TestCase
-end
+require 'fluent/test/helpers'

data/test/plugin/test_filter_geoip.rb

@@ -1,35 +1,30 @@
 require 'helper'
+require 'fluent/plugin/filter_geoip'
+require 'fluent/test/driver/filter'
 
 class GeoipFilterTest < Test::Unit::TestCase
   def setup
-    omit_unless(Fluent.const_defined?(:Filter))
     Fluent::Test.setup
     @time = Fluent::Engine.now
   end
 
-  def create_driver(conf='', tag='test', use_v1=false)
-    Fluent::Test::FilterTestDriver.new(Fluent::GeoipFilter, tag).configure(conf, use_v1)
+  CONFIG = %[
+    geoip_lookup_key  host
+    enable_key_city   geoip_city
+  ]
+
+  def create_driver(conf = CONFIG, syntax: :v1)
+    Fluent::Test::Driver::Filter.new(Fluent::Plugin::GeoipFilter).configure(conf, syntax: syntax)
   end
 
-  def filter(config, messages, use_v1=false)
-    d = create_driver(config, 'test', use_v1)
-    yield d if block_given?
-    d.run {
+  def filter(config, messages, syntax: :v1)
+    d = create_driver(config, syntax: syntax)
+    d.run(default_tag: "input.access") {
       messages.each {|message|
-        d.filter(message, @time)
+        d.feed(@time, message)
       }
     }
-    filtered = d.filtered_as_array
-    filtered.map {|m| m[2] }
-  end
-
-  def setup_geoip_mock(d)
-    geoip = d.instance.instance_variable_get(:@geoip)
-    db = Object.new
-    def db.lookup(ip)
-      {}
-    end
-    geoip.instance_variable_set(:@geoip, db)
+    d.filtered_records
   end
 
   sub_test_case "configure" do
@@ -71,7 +66,8 @@ class GeoipFilterTest < Test::Unit::TestCase
     end
 
     test "invalid json structure w/ Ruby hash like" do
-      assert_raise(Fluent::ConfigError) {
+
+      assert_raise(Fluent::ConfigParseError) {
         create_driver %[
           geoip_lookup_key  host
           <record>
@@ -82,7 +78,7 @@ class GeoipFilterTest < Test::Unit::TestCase
     end
 
     test "invalid json structure w/ unquoted string literal" do
-      assert_raise(Fluent::ConfigError) {
+      assert_raise(Fluent::ConfigParseError) {
         create_driver %[
           geoip_lookup_key  host
           <record>
@@ -130,27 +126,6 @@ class GeoipFilterTest < Test::Unit::TestCase
   end
 
   sub_test_case "geoip2_c" do
-    def test_filter_with_include_tag_key
-      config = %[
-        backend_library   geoip2_c
-        geoip_lookup_key  ip.origin, ip.dest
-        <record>
-          origin_country  ${country.iso_code['ip.origin']}
-          dest_country    ${country.iso_code['ip.dest']}
-        </record>
-        include_tag_key   true
-      ]
-      messages = [
-        {'ip.origin' => '66.102.3.80', 'ip.dest' => '8.8.8.8'}
-      ]
-      expected = [
-        {'ip.origin' => '66.102.3.80', 'ip.dest' => '8.8.8.8',
-         'origin_country' => 'US', 'dest_country' => 'US', 'tag' => 'test' }
-      ]
-      filtered = filter(config, messages)
-      assert_equal(expected, filtered)
-    end
-
     def test_filter_with_dot_key
       config = %[
         backend_library   geoip2_c
@@ -190,7 +165,7 @@ class GeoipFilterTest < Test::Unit::TestCase
         {'host' => '203.0.113.1', 'message' => 'invalid ip', 'geoip_city' => nil, 'geopoint' => [nil, nil]},
         {'host' => '0', 'message' => 'invalid ip', 'geoip_city' => nil, 'geopoint' => [nil, nil]}
       ]
-      filtered = filter(config, messages)
+      filtered = filter(config, messages, syntax: :v0)
       assert_equal(expected, filtered)
     end
 
@@ -216,7 +191,7 @@ class GeoipFilterTest < Test::Unit::TestCase
         {'host' => '66.102.3.80', 'message' => 'google bot',
          'geoip_city' => 'Mountain View', 'geopoint' => [-122.0574, 37.419200000000004]}
       ]
-      filtered = filter(config, messages)
+      filtered = filter(config, messages, syntax: :v0)
       assert_equal(expected, filtered)
     end
 
@@ -281,7 +256,7 @@ class GeoipFilterTest < Test::Unit::TestCase
           'broken_array2' => [nil, nil]
         },
       ]
-      filtered = filter(config, messages)
+      filtered = filter(config, messages, syntax: :v0)
       # test-unit cannot calculate diff between large Array
       assert_equal(expected[0], filtered[0])
       assert_equal(expected[1], filtered[1])
@@ -322,7 +297,7 @@ class GeoipFilterTest < Test::Unit::TestCase
           'string_array' => [nil, nil]
         }
       ]
-      filtered = filter(config, messages)
+      filtered = filter(config, messages, syntax: :v0)
       assert_equal(expected, filtered)
     end
 
@@ -383,7 +358,7 @@ class GeoipFilterTest < Test::Unit::TestCase
           'peculiar_pattern' => '[GEOIP] message => {"lat":37.419200000000004, "lon":-122.0574}'
         }
       ]
-      filtered = filter(config_quoted_record, messages, true)
+      filtered = filter(config_quoted_record, messages)
       assert_equal(expected, filtered)
     end
 
@@ -414,33 +389,7 @@ class GeoipFilterTest < Test::Unit::TestCase
           }
         }
       ]
-      filtered = filter(config, messages, true)
-      assert_equal(expected, filtered)
-    end
-
-    def test_filter_when_latitude_longitude_is_nil
-      config = %[
-        backend_library   geoip2_c
-        geoip_lookup_key  host
-        <record>
-          latitude  ${location.latitude['host']}
-          longitude ${location.longitude['host']}
-        </record>
-      ]
-      messages = [
-        { "host" => "180.94.85.84", "message" => "nil latitude and longitude" }
-      ]
-      expected = [
-        {
-          "host" => "180.94.85.84",
-          "message" => "nil latitude and longitude",
-          "latitude" => 0.0,
-          "longitude" => 0.0
-        }
-      ]
-      filtered = filter(config, messages) do |d|
-        setup_geoip_mock(d)
-      end
+      filtered = filter(config, messages)
       assert_equal(expected, filtered)
     end
   end
@@ -485,7 +434,7 @@ class GeoipFilterTest < Test::Unit::TestCase
         {'host' => '203.0.113.1', 'message' => 'invalid ip', 'geoip_city' => nil, 'geopoint' => [nil, nil]},
         {'host' => '0', 'message' => 'invalid ip', 'geoip_city' => nil, 'geopoint' => [nil, nil]}
       ]
-      filtered = filter(config, messages)
+      filtered = filter(config, messages, syntax: :v0)
       assert_equal(expected, filtered)
     end
 
@@ -511,7 +460,7 @@ class GeoipFilterTest < Test::Unit::TestCase
         {'host' => '66.102.3.80', 'message' => 'google bot',
          'geoip_city' => 'Mountain View', 'geopoint' => [-122.0574, 37.419200000000004]}
       ]
-      filtered = filter(config, messages)
+      filtered = filter(config, messages, syntax: :v0)
       assert_equal(expected, filtered)
     end
 
@@ -576,7 +525,7 @@ class GeoipFilterTest < Test::Unit::TestCase
           'broken_array2' => [nil, nil]
         },
       ]
-      filtered = filter(config, messages)
+      filtered = filter(config, messages, syntax: :v0)
       # test-unit cannot calculate diff between large Array
       assert_equal(expected[0], filtered[0])
       assert_equal(expected[1], filtered[1])
@@ -617,7 +566,7 @@ class GeoipFilterTest < Test::Unit::TestCase
           'string_array' => [nil, nil]
         }
       ]
-      filtered = filter(config, messages)
+      filtered = filter(config, messages, syntax: :v0)
       assert_equal(expected, filtered)
     end
 
@@ -678,7 +627,7 @@ class GeoipFilterTest < Test::Unit::TestCase
           'peculiar_pattern' => '[GEOIP] message => {"lat":37.419200000000004, "lon":-122.0574}'
         }
       ]
-      filtered = filter(config_quoted_record, messages, true)
+      filtered = filter(config_quoted_record, messages)
       assert_equal(expected, filtered)
     end
 
@@ -709,51 +658,6 @@ class GeoipFilterTest < Test::Unit::TestCase
           }
         }
       ]
-      filtered = filter(config, messages, true)
-      assert_equal(expected, filtered)
-    end
-
-    def test_filter_when_latitude_longitude_is_nil
-      config = %[
-        backend_library   geoip2_compat
-        geoip_lookup_key  host
-        <record>
-          latitude  ${latitude['host']}
-          longitude ${longitude['host']}
-        </record>
-      ]
-      messages = [
-        { "host" => "180.94.85.84", "message" => "nil latitude and longitude" }
-      ]
-      expected = [
-        {
-          "host" => "180.94.85.84",
-          "message" => "nil latitude and longitude",
-          "latitude" => 0.0,
-          "longitude" => 0.0
-        }
-      ]
-      filtered = filter(config, messages) do |d|
-        setup_geoip_mock(d)
-      end
-      assert_equal(expected, filtered)
-    end
-
-    def test_filter_with_include_tag_key
-      config = %[
-        backend_library geoip2_compat
-        geoip_lookup_key  host
-        enable_key_city   geoip_city
-        include_tag_key   true
-      ]
-      messages = [
-        {'host' => '66.102.3.80', 'message' => 'valid ip'},
-        {'message' => 'missing field'},
-      ]
-      expected = [
-        {'host' => '66.102.3.80', 'message' => 'valid ip', 'geoip_city' => 'Mountain View', 'tag' => 'test'},
-        {'message' => 'missing field', 'geoip_city' => nil, 'tag' => 'test'},
-      ]
       filtered = filter(config, messages)
       assert_equal(expected, filtered)
     end
@@ -762,6 +666,7 @@ class GeoipFilterTest < Test::Unit::TestCase
   sub_test_case "geoip legacy" do
     def test_filter
       config = %[
+        backend_library geoip
         geoip_lookup_key  host
         enable_key_city   geoip_city
       ]
@@ -779,6 +684,7 @@ class GeoipFilterTest < Test::Unit::TestCase
 
     def test_filter_with_dot_key
       config = %[
+        backend_library geoip
         geoip_lookup_key  ip.origin, ip.dest
         <record>
           origin_country  ${country_code['ip.origin']}
@@ -798,6 +704,7 @@ class GeoipFilterTest < Test::Unit::TestCase
 
     def test_filter_nested_attr
       config = %[
+        backend_library geoip
         geoip_lookup_key  host.ip
         enable_key_city   geoip_city
       ]
@@ -815,6 +722,7 @@ class GeoipFilterTest < Test::Unit::TestCase
 
     def test_filter_with_unknown_address
       config = %[
+        backend_library geoip
         geoip_lookup_key  host
         <record>
           geoip_city      ${city['host']}
@@ -831,12 +739,13 @@ class GeoipFilterTest < Test::Unit::TestCase
         {'host' => '203.0.113.1', 'message' => 'invalid ip', 'geoip_city' => nil, 'geopoint' => [nil, nil]},
         {'host' => '0', 'message' => 'invalid ip', 'geoip_city' => nil, 'geopoint' => [nil, nil]}
       ]
-      filtered = filter(config, messages)
+      filtered = filter(config, messages, syntax: :v0)
       assert_equal(expected, filtered)
     end
 
     def test_filter_with_skip_unknown_address
       config = %[
+        backend_library geoip
         geoip_lookup_key  host
         <record>
           geoip_city      ${city['host']}
@@ -856,12 +765,13 @@ class GeoipFilterTest < Test::Unit::TestCase
         {'host' => '66.102.3.80', 'message' => 'google bot',
          'geoip_city' => 'Mountain View', 'geopoint' => [-122.05740356445312, 37.4192008972168]}
       ]
-      filtered = filter(config, messages)
+      filtered = filter(config, messages, syntax: :v0)
       assert_equal(expected, filtered)
     end
 
     def test_filter_multiple_key
       config = %[
+        backend_library geoip
         geoip_lookup_key  from.ip, to.ip
         enable_key_city   from_city, to_city
       ]
@@ -874,12 +784,13 @@ class GeoipFilterTest < Test::Unit::TestCase
          'from_city' => 'Mountain View', 'to_city' => 'Tokorozawa'},
         {'message' => 'missing field', 'from_city' => nil, 'to_city' => nil}
       ]
-      filtered = filter(config, messages)
+      filtered = filter(config, messages, syntax: :v0)
       assert_equal(expected, filtered)
     end
 
     def test_filter_multiple_key_multiple_record
       config = %[
+        backend_library geoip
         geoip_lookup_key  from.ip, to.ip
         enable_key_city   from_city, to_city
         enable_key_country_name from_country, to_country
@@ -913,12 +824,13 @@ class GeoipFilterTest < Test::Unit::TestCase
           'to_country' => nil
         }
       ]
-      filtered = filter(config, messages)
+      filtered = filter(config, messages, syntax: :v0)
       assert_equal(expected, filtered)
     end
 
     def test_filter_record_directive
       config = %[
+        backend_library geoip
         geoip_lookup_key  from.ip
         <record>
           from_city       ${city['from.ip']}
@@ -977,7 +889,7 @@ class GeoipFilterTest < Test::Unit::TestCase
           'broken_array2' => [nil, nil]
         },
       ]
-      filtered = filter(config, messages)
+      filtered = filter(config, messages, syntax: :v0)
       # test-unit cannot calculate diff between large Array
       assert_equal(expected[0], filtered[0])
       assert_equal(expected[1], filtered[1])
@@ -985,6 +897,7 @@ class GeoipFilterTest < Test::Unit::TestCase
 
     def test_filter_record_directive_multiple_record
       config = %[
+        backend_library geoip
         geoip_lookup_key  from.ip, to.ip
         <record>
           from_city       ${city['from.ip']}
@@ -1017,12 +930,13 @@ class GeoipFilterTest < Test::Unit::TestCase
           'string_array' => [nil, nil]
         }
       ]
-      filtered = filter(config, messages)
+      filtered = filter(config, messages, syntax: :v0)
       assert_equal(expected, filtered)
     end
 
     def config_quoted_record
       %[
+        backend_library geoip
         geoip_lookup_key  host
         <record>
           location_properties  '{ "country_code" : "${country_code["host"]}", "lat": ${latitude["host"]}, "lon": ${longitude["host"]} }'
@@ -1077,12 +991,13 @@ class GeoipFilterTest < Test::Unit::TestCase
           'peculiar_pattern' => '[GEOIP] message => {"lat":37.4192008972168, "lon":-122.05740356445312}'
         }
       ]
-      filtered = filter(config_quoted_record, messages, true)
+      filtered = filter(config_quoted_record, messages)
       assert_equal(expected, filtered)
     end
 
     def test_filter_multiline_v1_config
       config = %[
+        backend_library geoip
         geoip_lookup_key  host
         <record>
           location_properties  {
@@ -1107,50 +1022,6 @@ class GeoipFilterTest < Test::Unit::TestCase
           }
         }
       ]
-      filtered = filter(config, messages, true)
-      assert_equal(expected, filtered)
-    end
-
-    def test_filter_when_latitude_longitude_is_nil
-      config = %[
-        backend_library   geoip
-        geoip_lookup_key  host
-        <record>
-          latitude  ${latitude['host']}
-          longitude ${longitude['host']}
-        </record>
-      ]
-      messages = [
-        { "host" => "180.94.85.84", "message" => "nil latitude and longitude" }
-      ]
-      expected = [
-        {
-          "host" => "180.94.85.84",
-          "message" => "nil latitude and longitude",
-          "latitude" => 0.0,
-          "longitude" => 0.0
-        }
-      ]
-      filtered = filter(config, messages) do |d|
-        setup_geoip_mock(d)
-      end
-      assert_equal(expected, filtered)
-    end
-
-    def test_filter_with_include_tag_key
-      config = %[
-        geoip_lookup_key  host
-        enable_key_city   geoip_city
-        include_tag_key   true
-      ]
-      messages = [
-        {'host' => '66.102.3.80', 'message' => 'valid ip'},
-        {'message' => 'missing field'},
-      ]
-      expected = [
-        {'host' => '66.102.3.80', 'message' => 'valid ip', 'geoip_city' => 'Mountain View', 'tag' => 'test'},
-        {'message' => 'missing field', 'geoip_city' => nil, 'tag' => 'test'},
-      ]
       filtered = filter(config, messages)
       assert_equal(expected, filtered)
     end