fluent-plugin-eval-filter 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a257fc65a23332bc41401a9778f14a8bf68a0d18
-  data.tar.gz: 22336f20a60b02d204341b61012c9efb5f3d08b5
+  metadata.gz: 6765bfbe982ee8ab3f79203bc16c41905c367373
+  data.tar.gz: cc5f7b09aae48c79710766f835fe5cf419800209
 SHA512:
-  metadata.gz: 70ce05adece616793f764b662ccd87a2799f4762defed8fbc5ffbf604ca8d481214e698b2c2c491c4350fd20032b3435aee36c4106e9c818a00827cd44f57b45
-  data.tar.gz: 75f31b4b744bff8f512e96d026f0fea6cf94514822741574fbcc0315cc2fa1e1cee245ca277dcb6011451aac8ef4d914dfdd019501898d7ed3af4b3ceb9031d4
+  metadata.gz: 05b3f8c2ea08ec5b9aa6865ce8fcee0bb1449d1ffbcbbfbc75d63127396e6b673cda42e53009a804ca47bc50681d61fdc61ca240debbf78df520bac6b3cabbdc
+  data.tar.gz: 70701cb426b287d3494faf4803a0b50306387f8a2a768de03b17e4cea34d28c5d2bc4d44273f695387305487d8469e49bc737eb5d79a288f52dde1b45ec1d7fc

data/.gitignore

@@ -15,3 +15,4 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
+vendor

data/.travis.yml

@@ -0,0 +1,8 @@
+language: ruby
+rvm:
+  - 2.1.0
+  - 2.0.0
+  - 1.9.3
+  - 1.9.2
+before_install:
+  - gem update --remote bundler

data/README.md

@@ -1,4 +1,4 @@
-# fluent-plugin-eval-filter
+# fluent-plugin-eval-filter, a plugin for [Fluentd](http://fluentd.org) [![Build Status](https://travis-ci.org/ephemeralsnow/fluent-plugin-eval-filter.png?branch=master)](https://travis-ci.org/ephemeralsnow/fluent-plugin-eval-filter) [![Code Climate](https://codeclimate.com/github/ephemeralsnow/fluent-plugin-eval-filter.png)](https://codeclimate.com/github/ephemeralsnow/fluent-plugin-eval-filter)
 
 ## Installation
 
@@ -28,6 +28,20 @@ Or install it yourself as:
 </match>
 ```
 
+## Limitation
+
+Can not be used expression substitution.
+```
+<match raw.apache.access>
+  filter1 "#{tag}"
+</match>
+```
+
+'#' Is interpreted as the beginning of a comment.
+```
+  filter1 #=> "\""
+```
+
 ## Contributing
 
 1. Fork it

data/Rakefile

@@ -1 +1,10 @@
-require "bundler/gem_tasks"
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+task default: :test

data/fluent-plugin-eval-filter.gemspec

@@ -4,7 +4,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
   spec.name          = "fluent-plugin-eval-filter"
-  spec.version       = "0.0.2"
+  spec.version       = "0.0.3"
   spec.authors       = ["Yuzuki Masaru"]
   spec.email         = ["ephemeralsnow@gmail.com"]
   spec.description   = %q{Fluentd Output eval filter plugin.}

data/lib/fluent/plugin/out_eval_filter.rb

@@ -1,50 +1,77 @@
-class Fluent::EvalFilterOutput < Fluent::Output
-  include Fluent::HandleTagNameMixin
-
-  Fluent::Plugin.register_output('eval_filter', self)
-
-  def configure(conf)
-    super
-
-    conf.keys.select { |key| key =~ /^config\d+$/ }.sort_by { |key| key.sub('config', '').to_i }.each do |key|
-      instance_eval("#{conf[key]}")
-    end
-
-    @filters = []
-    conf.keys.select { |key| key =~ /^filter\d+$/ }.sort_by { |key| key.sub('filter', '').to_i }.each do |key|
-      @filters << instance_eval("lambda do |tag, time, record| #{conf[key]} end")
-    end
-  end
-
-  def emit(tag, es, chain)
-    es.each do |time, record|
-      result = filter_record(tag.clone, time, record)
-      Fluent::Engine.emit(*result) if result
-    end
-    chain.next
-  end
-
-  def filter_record(tag, time, record)
-    super
-
-    @filters.each do |filter|
-      filter_result = filter.call(tag, time, record)
-      result = create_result(tag, time, record, filter_result) if filter_result
-      return result if result
-    end
-    nil
-  end
-
-  def create_result(tag, time, record, result)
-    result = [result] unless result.is_a?(Array)
-
-    result.each do |value|
-      tag = value if value.is_a?(String)
-      time = value if value.is_a?(Integer)
-      record = value if value.is_a?(Hash)
-    end
-
-    [tag, time, record]
-  end
-
-end
+class Fluent::EvalFilterOutput < Fluent::Output
+
+  Fluent::Plugin.register_output('eval_filter', self)
+
+  def configure(conf)
+    super
+
+    if remove_tag_prefix = conf['remove_tag_prefix']
+      @remove_tag_prefix = /^#{Regexp.escape(remove_tag_prefix)}\.*/
+    end
+    if remove_tag_suffix = conf['remove_tag_suffix']
+      @remove_tag_suffix = /\.*#{Regexp.escape(remove_tag_suffix)}$/
+    end
+    @add_tag_prefix = conf['add_tag_prefix']
+    @add_tag_suffix = conf['add_tag_suffix']
+
+    conf.keys.select { |key| key =~ /^config\d+$/ }.sort_by { |key| key.sub('config', '').to_i }.each do |key|
+      begin
+        instance_eval("#{conf[key]}")
+      rescue Exception => e
+        raise Fluent::ConfigError, "#{key} #{conf[key]}\n" + e.to_s
+      end
+    end
+
+    @filters = []
+    conf.keys.select { |key| key =~ /^filter\d+$/ }.sort_by { |key| key.sub('filter', '').to_i }.each do |key|
+      begin
+        @filters << instance_eval("lambda do |tag, time, record| #{conf[key]} end")
+      rescue Exception => e
+        raise Fluent::ConfigError, "#{key} #{conf[key]}\n" + e.to_s
+      end
+    end
+
+    if @filters.empty?
+      raise Fluent::ConfigError, "missing filters"
+    end
+  end
+
+  def emit(tag, es, chain)
+    tag = handle_tag(tag)
+    es.each do |time, record|
+      result = filter_record(tag, time, record)
+      Fluent::Engine.emit(*result) if result
+    end
+    chain.next
+  end
+
+  def handle_tag(tag)
+    tag = tag.sub(@remove_tag_prefix, '') if @remove_tag_prefix
+    tag = tag.sub(@remove_tag_suffix, '') if @remove_tag_suffix
+    tag = tag.sub(/^\.*/, "#{@add_tag_prefix}.") if @add_tag_prefix
+    tag = tag.sub(/\.*$/, ".#{@add_tag_suffix}") if @add_tag_suffix
+    tag
+  end
+
+  def filter_record(tag, time, record)
+    @filters.each do |filter|
+      filter_result = filter.call(tag, time, record)
+      result = create_result(tag, time, record, filter_result) if filter_result
+      return result if result
+    end
+    nil
+  end
+
+  def create_result(tag, time, record, result)
+    result = [result] unless result.is_a?(Array)
+
+    result.each do |value|
+      tag = value if value.is_a?(String)
+      time = value if value.is_a?(Integer)
+      record = value if value.is_a?(Hash)
+    end
+
+    [tag, time, record]
+  end
+
+end

data/test/helper.rb

@@ -0,0 +1,28 @@
+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 'test/unit'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+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_eval_filter'
+
+class Test::Unit::TestCase
+end

data/test/plugin/test_out_eval_filter.rb

@@ -0,0 +1,187 @@
+require 'helper'
+
+class EvalFilterTest < Test::Unit::TestCase
+
+  def setup
+    Fluent::Test.setup
+  end
+
+  def create_driver(conf, tag = 'test')
+    Fluent::Test::OutputTestDriver.new(Fluent::EvalFilterOutput, tag).configure(conf)
+  end
+
+  def test_configure
+    assert_raise(Fluent::ConfigError) do
+      create_driver('')
+    end
+    assert_raise(Fluent::ConfigError) do
+      create_driver(%[config1 @test = "\#{self.to_s}"])
+    end
+    assert_raise(Fluent::ConfigError) do
+      create_driver(%[filter1 "\#{tag}"])
+    end
+  end
+
+  def test_remove_tag_prefix
+    d = create_driver(%[
+      remove_tag_prefix t1
+      filter1 tag
+    ], 't1.t2.t3')
+
+    d.run { d.emit({}) }
+
+    emits = d.emits
+    assert_equal 1, emits.size
+    p emits[0]
+    assert_equal 't2.t3', emits[0][0]
+  end
+
+  def test_remove_tag_suffix
+    d = create_driver(%[
+      remove_tag_suffix t3
+      filter1 tag
+    ], 't1.t2.t3')
+
+    d.run { d.emit({}) }
+
+    emits = d.emits
+    assert_equal 1, emits.size
+    p emits[0]
+    assert_equal 't1.t2', emits[0][0]
+  end
+
+  def test_add_tag_prefix
+    d = create_driver(%[
+      add_tag_prefix t0
+      filter1 tag
+    ], 't1.t2.t3')
+
+    d.run { d.emit({}) }
+
+    emits = d.emits
+    assert_equal 1, emits.size
+    p emits[0]
+    assert_equal 't0.t1.t2.t3', emits[0][0]
+  end
+
+  def test_add_tag_suffix
+    d = create_driver(%[
+      add_tag_suffix t4
+      filter1 tag
+    ], 't1.t2.t3')
+
+    d.run { d.emit({}) }
+
+    emits = d.emits
+    assert_equal 1, emits.size
+    p emits[0]
+    assert_equal 't1.t2.t3.t4', emits[0][0]
+  end
+
+  def test_handle_tag_all
+    d = create_driver(%[
+      remove_tag_prefix t1
+      remove_tag_suffix t3
+      add_tag_prefix t4
+      add_tag_suffix t5
+      filter1 tag
+    ], 't1.t2.t3')
+
+    d.run { d.emit({}) }
+
+    emits = d.emits
+    assert_equal 1, emits.size
+    p emits[0]
+    assert_equal 't4.t2.t5', emits[0][0]
+  end
+
+  def test_drop_all_filter
+    d = create_driver(%[
+      filter1 nil
+    ])
+
+    d.run { d.emit({}) }
+
+    emits = d.emits
+    p emits
+    assert_equal 0, emits.size
+  end
+
+  def test_modify_record_filter
+    d = create_driver(%[
+      filter1 record.merge!({'key' => 'value'})
+    ])
+
+    d.run { d.emit({}) }
+
+    emits = d.emits
+    assert_equal 1, emits.size
+    p emits[0]
+    assert_equal 'test', emits[0][0]
+    assert_equal 1, emits[0][2].size
+    assert_equal true, emits[0][2].key?('key')
+    assert_equal 'value', emits[0][2]['key']
+  end
+
+  def test_replace_all_filter
+    d = create_driver(%[
+      filter1 nil
+      filter2 ['tag', 0, {'key' => 'value'}]
+    ])
+
+    d.run { d.emit({}) }
+
+    emits = d.emits
+    assert_equal 1, emits.size
+    p emits[0]
+    assert_equal 'tag', emits[0][0]
+    assert_equal 0, emits[0][1]
+    assert_equal 1, emits[0][2].size
+    assert_equal true, emits[0][2].key?('key')
+    assert_equal 'value', emits[0][2]['key']
+  end
+
+  def test_conditional_filter
+    d = create_driver(%[
+      filter1 [['http', tag].join('.'), record] if /^http:/.match(record['url'])
+      filter2 (record['secure'] = true; [['https', tag].join('.'), record]) if /^https:/.match(record['url'])
+    ])
+
+    d.run do
+      d.emit({'url' => 'http://example.com/'})
+      d.emit({'url' => 'https://example.com/'})
+      d.emit({'url' => 'ftp://example.com/'})
+    end
+
+    emits = d.emits
+    assert_equal 2, emits.size
+    p emits[0]
+    assert_equal 'http.test', emits[0][0]
+    assert_equal 1, emits[0][2].size
+    assert_equal true, emits[0][2].key?('url')
+    assert_equal 'http://example.com/', emits[0][2]['url']
+    p emits[1]
+    assert_equal 'https.test', emits[1][0]
+    assert_equal 2, emits[1][2].size
+    assert_equal true, emits[1][2].key?('url')
+    assert_equal 'https://example.com/', emits[1][2]['url']
+    assert_equal true, emits[1][2].key?('secure')
+    assert_equal true, emits[1][2]['secure']
+  end
+
+  def test_reference_to_an_instance_variable_filter
+    hostname = `hostname -s`.chomp
+    d = create_driver(%[
+      config1 @hostname = `hostname -s`.chomp
+      filter1 [tag, @hostname].join('.')
+    ])
+
+    d.run { d.emit({}) }
+
+    emits = d.emits
+    assert_equal 1, emits.size
+    p emits[0]
+    assert_equal "test.#{hostname}", emits[0][0]
+  end
+
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fluent-plugin-eval-filter
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Yuzuki Masaru
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-12-27 00:00:00.000000000 Z
+date: 2014-05-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fluentd
@@ -46,12 +46,15 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".travis.yml"
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - fluent-plugin-eval-filter.gemspec
 - lib/fluent/plugin/out_eval_filter.rb
+- test/helper.rb
+- test/plugin/test_out_eval_filter.rb
 homepage: https://github.com/ephemeralsnow/fluent-plugin-eval-filter
 licenses:
 - Apache 2.0
@@ -72,8 +75,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.0
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Fluentd Output eval filter plugin.
-test_files: []
+test_files:
+- test/helper.rb
+- test/plugin/test_out_eval_filter.rb