fluent-plugin-script_append 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 27280a3d62cd0c8ceeb6e9f548bc5fa1ef5b4ad1
-  data.tar.gz: e34fd0d9a34b70de1d56843593b8b4b2be377992
+  metadata.gz: 4de353b594ee8b985c00c7a4e00f007aec9b8ade
+  data.tar.gz: 59e139968b6ef81edeeac4062b400526b29a275b
 SHA512:
-  metadata.gz: 741ce22c7fba57d85f4874d5b59fcbdda8cc68f5fb1b8a7329e58cd8c8ebd39c1042f9b47926b7e0f55c0801f40e4583e1e140d11955930c807c11d7835a4fac
-  data.tar.gz: 6f00de3e9a025ba1ebb251df249d1126d6893e00f26aeac485c34e6155555df5dddc20c9c3dcd8e9719d8a5a8de210d1a427d8771f6c4fd82e8179e653a8dd37
+  metadata.gz: 28cb5c8fd6e11e1e67fd86f3a8b43d4ece148b1b15d708fd61f03951fc5460bc76fed0e8a40443209934d5c2e756dc6b39f43ed909f67614e2641ca3cfebea91
+  data.tar.gz: e5eb2819657bd7038f0e7a4c4f99a4af537420d4ab9324ba6d28d33c5c00d42475c69b3fd7a042df65c91f5420fa91aa0dc092acd58e5519d7c4434f3bdd6671

data/README.md

@@ -1,26 +1,60 @@
 # Fluent::Plugin::ScriptAppend
 
-TODO: Write a gem description
+A fluent plugin to add script-run result to existing json data
+
+[![wercker status](https://app.wercker.com/status/56186aa7c9f166ffea49aba97971e40d/m "wercker status")](https://app.wercker.com/project/bykey/56186aa7c9f166ffea49aba97971e40d)
 
 ## Installation
 
-Add this line to your application's Gemfile:
+Install it yourself as:
+
+    $ fluent-gem install fluent-plugin-script_append
 
-```ruby
-gem 'fluent-plugin-script_append'
+## Usage
+
+```conf
+<match access.foo>
+  type script_append
+  # currently only ruby supported
+  language ruby
+  run_script record['one'].to_i + record['two'].to_i
+  key three
+</match>
 ```
 
-And then execute:
+Input:
 
-    $ bundle
+```json
+{
+  "one" : 1,
+  "two" : 2
+}
+```
 
-Or install it yourself as:
+Then get emitted:
 
-    $ gem install fluent-plugin-script_append
+```json
+{
+  "one" : 1,
+  "two" : 2,
+  "three" : 3
+}
+```
 
-## Usage
+## Parameters
+
+* `key`, A key for added record to use in json. Required
+* `language`, A language of script, default to ruby, available: `ruby, sh(ell)`
+    * In `language ruby`, the record to add is the value of specified expression
+    * In `language shell`, the record to add is the stdout of specified shell script
+* `run_script`, A script for generating data. Required
+* `record_var_name`, A variable name for original json data in `ruby` script. Default to `record`
+* `new_tag`, A tag name to use in new emissions
+* `prefix`, A tag prefix to add original tag in new emissions. `new_tag` or `prefix` is required
+
+## See also
 
-TODO: Write usage instructions here
+* https://github.com/ephemeralsnow/fluent-plugin-eval-filter
 
 ## Contributing
 

data/lib/fluent/plugin/out_script_append.rb

@@ -4,11 +4,13 @@ class Fluent::ScriptAppendOutput < Fluent::Output
 
   config_param :key,             :string, :default => nil
   config_param :language,        :string, :default => 'ruby'
-  config_param :run_script,      :string, :default => ''
+  config_param :run_script,      :string, :default => nil
   config_param :record_var_name, :string, :default => 'record'
   config_param :new_tag,         :string, :default => nil
   config_param :prefix,          :string, :default => nil
 
+  SUPPORTED_SCRIPT_NAME = %w(ruby sh shell)
+
   def configure(conf)
     super
     ensure_param_set!(:key, @key)
@@ -17,16 +19,26 @@ class Fluent::ScriptAppendOutput < Fluent::Output
 
     @script_runner = Object.new
 
-    # TODO multiple script language support
-    if @language != 'ruby'
+    unless SUPPORTED_SCRIPT_NAME.include? @language
       warn "Plugin out_script_append would not accept 'language' value other than 'ruby'. Ignoring."
+      @language = 'ruby'
     end
 
-    eval <<-RUBY
-      def @script_runner.run(#{@record_var_name})
-        #{@run_script}
-      end
-    RUBY
+    case @language
+    when 'ruby'
+      eval <<-RUBY
+        def @script_runner.run(#{@record_var_name})
+          #{@run_script}
+        end
+      RUBY
+    when 'sh', 'shell'
+      script = @run_script.gsub(/`/, '\\\`')
+      eval <<-RUBY
+        def @script_runner.run(*)
+          `#{@run_script}`
+        end
+      RUBY
+    end
   end
 
   def emit(tag, event_stream, chain)
@@ -49,7 +61,7 @@ class Fluent::ScriptAppendOutput < Fluent::Output
 
   def ensure_param_set!(name, value)
     unless value
-      raise "#{name} must be set"
+      raise Fluent::ConfigError, "#{name} must be set"
     end
   end
 

data/lib/fluent/plugin/script_append/version.rb

@@ -1,7 +1,7 @@
 module Fluent
   module Plugin
     module ScriptAppend
-      VERSION = "0.0.1"
+      VERSION = "0.1.0"
     end
   end
 end

data/test/plugin/test_out_script_append.rb

@@ -1,7 +1,7 @@
 require 'helper'
 
 class ScriptAppendOutputTest < Test::Unit::TestCase
-  def create_driver(conf ,tag='test')
+  def create_driver(conf, tag='test')
     Fluent::Test::OutputTestDriver.new(Fluent::ScriptAppendOutput, tag).configure(conf)
   end
 
@@ -16,20 +16,54 @@ class ScriptAppendOutputTest < Test::Unit::TestCase
     new_tag test.result
   FLUENTD
 
+  def config_with_run_script(script)
+    CONFIG_DEFAULT.sub(
+      /^ +run_script.*$/,
+      "run_script #{script}"
+    )
+  end
+
   test 'configure' do
     d = create_driver CONFIG_DEFAULT
     assert_equal "sample", d.instance.config['key']
     assert_equal '"Hello, World"', d.instance.config['run_script']
   end
 
-  test 'appends a result' do
-    config = <<-FLUENTD
-      key sample
-      language ruby
-      run_script "Hello, World"
-      new_tag test.result
-    FLUENTD
+  test 'invalid config' do
+    assert_raise Fluent::ConfigError do
+      create_driver <<-FLUENTD
+        language ruby
+        run_script "Hello, World"
+        new_tag test.result
+      FLUENTD
+    end
+
+    assert_raise Fluent::ConfigError do
+      create_driver <<-FLUENTD
+        key invakid
+        language ruby
+        new_tag test.result
+      FLUENTD
+    end
+
+    assert_raise Fluent::ConfigError do
+      create_driver <<-FLUENTD
+        key invakid
+        language ruby
+        run_script "Hello, World"
+      FLUENTD
+    end
+
+    assert_nothing_raised do
+      create_driver <<-FLUENTD
+        key invalid
+        run_script "Hello, World"
+        new_tag test.result
+      FLUENTD
+    end
+  end
 
+  test 'appends a result' do
     d = create_driver CONFIG_DEFAULT, 'input.access'
     d.run do
       d.emit({'domain' => 'www.google.com', 'path' => '/foo/bar?key=value', 'agent' => 'Googlebot', 'response_time' => 1000000})
@@ -39,4 +73,51 @@ class ScriptAppendOutputTest < Test::Unit::TestCase
     assert_equal 'test.result', emits[0][0]
     assert_equal 'Hello, World', emits[0][2]['sample']
   end
+
+  test 'appends a result using record' do
+    d = create_driver config_with_run_script("record['one'].to_i + record['two'].to_i")
+    d.run do
+      d.emit({'one' => 1, 'two' => 2})
+    end
+
+    emits = d.emits
+    assert_equal 'test.result', emits[0][0]
+    assert_equal 3, emits[0][2]['sample']
+  end
+
+  test 'appends with prefix' do
+    d = create_driver CONFIG_DEFAULT.sub(/new_tag.*$/m, 'prefix the_prefix'), 'with_suffix'
+    d.run do
+      d.emit({'domain' => 'www.google.com', 'path' => '/foo/bar?key=value', 'agent' => 'Googlebot', 'response_time' => 1000000})
+    end
+
+    emits = d.emits
+    assert_equal 'the_prefix.with_suffix', emits[0][0]
+    assert_equal 'Hello, World', emits[0][2]['sample']
+  end
+
+  test 'customizes variable name in script' do
+    d = create_driver \
+      config_with_run_script("data['one'].to_i + data['two'].to_i * 10").
+      sub(/\z/, "\n record_var_name data")
+    d.run do
+      d.emit({'one' => 1, 'two' => 2})
+    end
+
+    emits = d.emits
+    assert_equal 21, emits[0][2]['sample']
+  end
+
+  test 'runs shell via Kernel#`' do
+    d = create_driver \
+      config_with_run_script(%{echo "Hello world via shell"}).
+      sub(/language.*$/, "language shell")
+
+    d.run do
+      d.emit({'domain' => 'www.google.com', 'path' => '/foo/bar?key=value', 'agent' => 'Googlebot', 'response_time' => 1000000})
+    end
+
+    emits = d.emits
+    assert_equal "Hello world via shell\n", emits[0][2]['sample']
+  end
 end

data/wercker.yml

@@ -0,0 +1,16 @@
+box: wercker/rvm
+build:
+    steps:
+        - rvm-use:
+            version: ruby-2.1.5
+        - bundle-install
+        - script:
+            name: run test-unit
+            code: bundle exec rake test
+
+        - rvm-use:
+            version: ruby-2.0.0-p598
+        - bundle-install
+        - script:
+            name: run test-unit
+            code: bundle exec rake test

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fluent-plugin-script_append
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - Uchio KONDO
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-26 00:00:00.000000000 Z
+date: 2015-01-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fluentd
@@ -126,6 +126,7 @@ files:
 - lib/fluent/plugin/script_append/version.rb
 - test/helper.rb
 - test/plugin/test_out_script_append.rb
+- wercker.yml
 homepage: https://github.com/udzura/fluent-plugin-script_append
 licenses:
 - Apache 2.0