fluent-helper-plugin-spec 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2e22bf34a843d4e84954ed1c448686ffe4929578
+  data.tar.gz: 11f79243f143bc39aca296e540cb6fcd3ac68301
+SHA512:
+  metadata.gz: 9f490e0f4954966d7fd028d23ca7e15f770602a747f478f6f29925f0e7e85f952ea8965932f30412b9013eb70a5fca2c65196ad02be17aa5cc0ad840c06e353e
+  data.tar.gz: af86e171a262e1d33671eb2e39ab798ac6342b78860e0a5f96ff12062f06362bf3a8aac764d0c6ee2d9329fd333c691378a536bcd6ce84714a4f5639a4746fa6

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in fluent-helper-plugin-spec.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,13 @@
+Copyright (c) 2012- TAGOMORI Satoshi
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.md

@@ -0,0 +1,31 @@
+# Fluentd plugin spec helper
+
+This is RSpec helper library for Fluentd plugins. This is for developers of fluentd plugins, not users.
+
+**Documents are under construction**
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'fluent-helper-plugin-spec'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install fluent-helper-plugin-spec
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it ( http://github.com/<my-github-username>/fluent-helper-plugin-spec/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/fluent-helper-plugin-spec.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+
+Gem::Specification.new do |spec|
+  spec.name          = "fluent-helper-plugin-spec"
+  spec.version       = "0.0.1"
+  spec.authors       = ["TAGOMORI Satoshi"]
+  spec.email         = ["tagomoris@gmail.com"]
+  spec.summary       = %q{RSpec helper for Fluentd plugin development}
+  spec.description   = %q{RSpec helper to develop Fluentd plugin with rspec, instead of Fluentd default test/unit. This spec helper requires Ruby 2.1.}
+  spec.homepage      = "https://github.com/tagomoris/fluent-helper-plugin-spec"
+  spec.license       = "APLv2"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.required_ruby_version = '>= 2.1.0'
+
+  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "rake"
+
+  spec.add_runtime_dependency "fluentd"
+  spec.add_runtime_dependency "rspec"
+end

data/lib/fluent-helper-plugin-spec.rb

@@ -0,0 +1,3 @@
+# This file MUST NOT be required from any fluentd modules except for 'PLUGIN_spec.rb'!
+
+require './fluent/helper/plugin_spec'

data/lib/fluent/helper/plugin_spec.rb

@@ -0,0 +1,166 @@
+# This file MUST NOT be required from any fluentd modules except for 'PLUGIN_spec.rb'!
+
+require 'fluent/log'
+require 'fluent/engine'
+require 'fluent/plugin'
+require 'fluent/config'
+require 'fluent/input'
+require 'fluent/output'
+
+$log ||= Fluent::Log.new
+
+module Fluent::PluginSpecUser
+  refine Fluent::EngineClass do
+    def emit(tag, time, record)
+      Fluent::Helper::PluginEmitStub.emit_event(tag, time, record)
+    end
+    def emits(tag, es)
+      es.each do |time, record|
+        Fluent::Helper::PluginEmitStub.emit_event(tag, time, record)
+      end
+    end
+  end
+end
+
+module Fluent::Helper
+  module PluginEmitStub
+    def self.register_target(klass)
+      @@current_target = klass
+      @@store ||= {}
+      @@store[Thread.current] ||= {}
+      @@store[Thread.current][klass] = {} # tag => [events]
+    end
+
+    def self.emit_event(tag, time, record)
+      @@store[Thread.current][@@current_target][tag] ||= []
+      @@store[Thread.current][@@current_target][tag].push( PluginSpec::Event.new(time, record) )
+    end
+
+    def self.stored(tag)
+      @@store[Thread.current][@@current_target] || {}
+    end
+  end
+
+  module PluginSpec
+    class Driver
+      attr_reader :instance
+
+      def initialize(plugin_klass, conf)
+        @plugin_klass = plugin_klass
+        Fluent::Helper::PluginEmitStub.register_target(plugin_klass)
+
+        plugin = plugin_klass.new
+        unless plugin.is_a?(Fluent::Input) || plugin.is_a?(Fluent::Output)
+          raise ArgumentError, "unknown class as plugin #{plugin.class}"
+        end
+
+        logger = TestLogger.new
+
+        conf = Fluent::Config.parse(conf, '[test config]')
+        plugin.configure(conf)
+
+        plugin_loglevel = plugin.instance_variable_get(:@log_level)
+        if plugin_loglevel
+          logger.log_level = plugin_loglevel
+        end
+        plugin.log = logger
+
+        @instance = plugin
+      end
+
+      def pitch(tag, time, record)
+        @instance.emit(tag, time, record)
+      end
+
+      def pitches(tag, es)
+        @instance.emits(tag, es)
+      end
+
+      class BatchPitcher
+        def initialize(parent, tag, time=Time.now.to_i)
+          @parent = parent
+          @tag = tag
+          @time = time
+        end
+        def pitch(record, time=nil)
+          @parent.pitch(@tag, time ? time : @time, record)
+        end
+
+        def pitches(es)
+          @parent.pitches(@tag, es)
+        end
+      end
+
+      def with(tag, time=Time.now.to_i)
+        raise ArgumentError unless block_given?
+        yield BatchPitcher.new(self, tag, time)
+      end
+
+      def run
+        raise ArgumentError unless block_given?
+        @instance.start
+        yield self
+        @instance.shutdown
+      end
+
+      def events
+        Fluent::Helper::PluginEmitStub.stored(@plugin_klass)
+      end
+    end
+
+    def generate_driver(plugin, conf)
+      Driver.new(plugin, conf)
+    end
+
+    class Event
+      def initialize(time, record)
+        @time = time
+        @record = record
+      end
+      attr_reader :time, :record
+      alias_method :t, :time
+      alias_method :r, :record
+    end
+
+    class DummyLogDevice
+      attr_reader :logs
+
+      def initialize
+        @logs = []
+      end
+
+      def tty?
+        false
+      end
+
+      def puts(*args)
+        args.each do |arg|
+          write(arg + "\n")
+        end
+      end
+
+      def write(message)
+        @logs.push message
+      end
+
+      def flush
+        true
+      end
+
+      def close
+        true
+      end
+    end
+
+    class TestLogger < Fluent::PluginLogger
+      def initialize
+        @logdev = DummyLogDevice.new
+        super(Fluent::Log.new(@logdev))
+      end
+
+      def logs
+        @logdev.logs
+      end
+    end
+  end
+end

data/spec/out_retag_spec.rb

@@ -0,0 +1,34 @@
+require 'fluent/helper/plugin_spec'
+include Fluent::Helper::PluginSpec
+
+require_relative 'util/out_retag'
+
+describe Fluent::RetagOutput do
+  config = %[
+    type retag
+    tag  yyy
+  ]
+  driver = generate_driver(Fluent::RetagOutput, config)
+
+  it 'copy events' do
+    driver.run do |d|
+      t = Time.now.to_i
+      d.with('xxx', t) do |d|
+        d.pitch({"f1"=>"data1", "f2"=>"data2"})
+        d.pitch({"f1"=>"data1", "f2"=>"data2"})
+        d.pitch({"f1"=>"data1", "f2"=>"data2"})
+        d.pitch({"f1"=>"data1", "f2"=>"data2"})
+      end
+    end
+
+    expect(driver.events.keys.size).to eql(1)
+    expect(driver.events.keys.first).to eql('yyy')
+    expect(driver.events['yyy'].size).to eql(4)
+    driver.events['yyy'].each do |e|
+      expect(e.r).to eql({"f1"=>"data1", "f2"=>"data2"})
+    end
+
+    # p driver.instance.log.logs
+    expect(driver.instance.log.logs.size).to eql(4)
+  end
+end

data/spec/util/out_retag.rb

@@ -0,0 +1,22 @@
+require 'fluent/output'
+
+module Fluent::PluginSpecUser; end
+defined?(using) and using Fluent::PluginSpecUser
+
+module Fluent
+  class RetagOutput < Output
+    Plugin.register_output('retag', self)
+
+    config_param :tag, :string
+
+    def emit(tag, time, record)
+      log.info('emit')
+      Fluent::Engine.emit(@tag, time, record)
+    end
+
+    def emits(tag, es)
+      log.debug('emits')
+      Fluent::Engine.emits(@tag, es)
+    end
+  end
+end

metadata

@@ -0,0 +1,113 @@
+--- !ruby/object:Gem::Specification
+name: fluent-helper-plugin-spec
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- TAGOMORI Satoshi
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-03-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: fluentd
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: RSpec helper to develop Fluentd plugin with rspec, instead of Fluentd
+  default test/unit. This spec helper requires Ruby 2.1.
+email:
+- tagomoris@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- fluent-helper-plugin-spec.gemspec
+- lib/fluent-helper-plugin-spec.rb
+- lib/fluent/helper/plugin_spec.rb
+- spec/out_retag_spec.rb
+- spec/util/out_retag.rb
+homepage: https://github.com/tagomoris/fluent-helper-plugin-spec
+licenses:
+- APLv2
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: RSpec helper for Fluentd plugin development
+test_files:
+- spec/out_retag_spec.rb
+- spec/util/out_retag.rb