fluent-format 0.2.1 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 60872a23fdf2060c3e94c301c8b6f5e1e3eb3a66
-  data.tar.gz: 155f128a5bd00841a294aa2beeb4b3f6718d96ca
+  metadata.gz: 495a2bd0d34f9a30ff0ac8be3700d5e361cf6150
+  data.tar.gz: 01554a964c734cedf4f7c2cfb0e915e3c608a158
 SHA512:
-  metadata.gz: d852f71daed2299560ba8b8bbbdce60eb2ec6d09d27d15fcc455390b79cbf6bc89fb422dc418169e0778ec21a1d6219c4a05f083340fdf610bb813d751230258
-  data.tar.gz: f0c342aebc5a321dd7e59196200a91b5b0a19cee46d4cadb551c91ce01f8f99fdde936b0480e46e17e3c1fc40b49ea2abf0c950090f5601ed22f8fd95a925261
+  metadata.gz: 2e5e950a92c5fb60dd20e86cebe99946c0b6410f1e7c20a55100a54fa0ac6923237b67bccd155d6859e48e59d0a5f9e5f2ef350da16325f2fa28bb3d467e27e1
+  data.tar.gz: 36673c63cfd92f6e12c3aebc294b64132e37bed1c59780266066ea529ff29f827e75e7c2e122a7e5be3e828c997a9f8a6fef16cc6119d51ad1e7e58d1f35488a

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+## 0.2.2 (2014/02/08)
+
+Enhancement:
+
+* Define specifications of STDERR output
+
 ## 0.2.1 (2014/02/05)
 
 Enhancement:

data/README.md

@@ -1,4 +1,4 @@
-# fluent-format
+# fluent-format  [![Build Status](https://secure.travis-ci.org/sonots/fluent-format.png?branch=master)](http://travis-ci.org/sonots/fluent-format)
 
 A command line utility to format fluentd configuration beautifully
 
@@ -34,7 +34,7 @@ require 'fluent-format'
 
 File.open(path) {|config|
   puts Fluent::Format.format(config) # formatted string
-  puts Fluent::Format.check(config, plugin_dir) #=> true: success false: failure
+  Fluent::Format.check(config, plugin_dir) #=> Fluent::ConfigParseError or Fluent::ConfigError if failed
 }
 ```
 

data/example/out_example.rb

@@ -0,0 +1,15 @@
+class Fluent::ExampleOutput < Fluent::Output
+  Fluent::Plugin.register_output('example', self)
+
+  config_param :param, :string, :default => nil
+
+  def configure(conf)
+    super
+
+    raise Fluent::ConfigError, "bad param" if @param == "bad"
+  end
+
+  def emit(tag, es, chain)
+    chain.next
+  end
+end

data/example/param_error.conf

@@ -0,0 +1,4 @@
+<match **>
+  type example
+  param bad
+</match>

data/lib/fluent/format.rb

@@ -1,4 +1,4 @@
-$log = Fluent::Log.new(STDERR, Fluent::Log::LEVEL_WARN)
+$log = Fluent::Log.new($stderr, Fluent::Log::LEVEL_WARN)
 
 module Fluent
   class Format

data/lib/fluent/format/check.rb

@@ -30,12 +30,14 @@ module Fluent
       # @raise Fluent::ConfigError      if plugin raises config error
       # @return true if success
       def run
-        Fluent::Supervisor.new(@opts).ext_dry_run
+        Fluent::Supervisor.new(@opts).extended_dry_run
       end
     end
   end
 end
 
+# lib/fluent/supervisor.rb
+# Open the existing class and define new methods
 module Fluent
   class Supervisor
     # Extended to accept IO object
@@ -43,8 +45,8 @@ module Fluent
     # @raise Fluent::ConfigParseError if conf has syntax errors
     # @raise Fluent::ConfigError      if plugin raises config error
     # @return true if success
-    def ext_dry_run
-      ext_read_config
+    def extended_dry_run
+      extended_read_config
       change_privilege
       init_engine
       install_main_process_signal_handlers
@@ -53,7 +55,7 @@ module Fluent
     end
 
     # Extended to accept IO object
-    def ext_read_config
+    def extended_read_config
       if @config_path.respond_to?(:read) # IO object
         @config_data = @config_path.read
       else

data/lib/fluent/format/cli.rb

@@ -11,7 +11,7 @@ module Fluent
         config = @options[:config]
         taputs Fluent::Format.format(config)
       rescue => e
-        $log.error "#{e.class}: #{e}"
+        $stderr.puts "#{e.class} #{e.message} #{e.backtrace.first}"
         exit 1
       end
 
@@ -23,7 +23,7 @@ module Fluent
         plugin = @options[:plugin]
         Fluent::Format.check(config, plugin)
       rescue => e
-        $log.error "#{e.class}: #{e}"
+        $stderr.puts "#{e.class} #{e.message} #{e.backtrace.first}"
         exit 1
       end
 

data/lib/fluent/format/format.rb

@@ -13,32 +13,14 @@ module Fluent
       # @raise Fluent::ConfigParseError if conf has syntax errors
       # @return [String] the formatted config
       def run
-        config = read_config(@config_dev)
-        indent_config(config)
+        config = Fluent::ExtConfig.read(@config_dev)
+        indent(config)
       end
 
       private
 
-      # partial copy from lib/fluent/config.rb
-      def read_config(dev)
-        if dev.respond_to?(:read) # IO object
-          parse_config(dev, '-', '-')
-        else
-          File.open(dev) {|io| parse_config(io, File.basename(dev), File.dirname(dev)) }
-        end
-      end
-
-      # partial copy from lib/fluent/config.rb
-      def parse_config(io, fname, basepath=Dir.pwd)
-        if fname =~ /\.rb$/
-          Fluent::Config::DSL::Parser.parse(io, File.join(basepath, fname))
-        else
-          Fluent::Config.parse(io, fname, basepath)
-        end
-      end
-
       # hmm, ugly workaround
-      def indent_config(conf)
+      def indent(conf)
         lines = conf.to_s.split("\n")[1..-2] # remove <ROOT> and </ROOT>
         lines = lines.map {|line| line[2..-1] } # remove heading 2 white spaces
         lines.join("\n")
@@ -46,3 +28,34 @@ module Fluent
     end
   end
 end
+
+# lib/fluent/config.rb
+module Fluent
+  module ExtConfig
+    # Extended to accept IO object
+    #
+    # @raise Fluent::ConfigParseError if conf has syntax errors
+    # @raise Fluent::ConfigError      if plugin raises config error
+    # @return [String] parsed config string
+    def self.read(dev)
+      if dev.respond_to?(:read) # IO object
+        parse(dev, '-', '-')
+      else
+        File.open(dev) {|io| parse(io, File.basename(dev), File.dirname(dev)) }
+      end
+    end
+
+    # Extended to accept config dsl
+    #
+    # @raise Fluent::ConfigParseError if conf has syntax errors
+    # @raise Fluent::ConfigError      if plugin raises config error
+    # @return [String] parsed config string
+    def self.parse(io, fname, basepath=Dir.pwd)
+      if fname =~ /\.rb$/
+        Fluent::Config::DSL::Parser.parse(io, File.join(basepath, fname))
+      else
+        Fluent::Config.parse(io, fname, basepath)
+      end
+    end
+  end
+end

data/lib/fluent/format/version.rb

@@ -1,5 +1,5 @@
 module Fluent
   class Format
-    VERSION = "0.2.1"
+    VERSION = "0.2.2"
   end
 end

data/spec/fluent/format/check_spec.rb

@@ -1,7 +1,8 @@
 require 'spec_helper'
 
 describe Fluent::Format::Check do
-  let(:subject) { Fluent::Format.check(config) }
+  let(:plugin_dir) { File.expand_path('../../../example', File.dirname(__FILE__)) }
+  let(:subject) { Fluent::Format.check(config, plugin_dir) }
 
   context "valid" do
     let(:config) { StringIO.new(%[<match>\ntype stdout\n</match>]) }
@@ -17,5 +18,10 @@ describe Fluent::Format::Check do
     let(:config) { StringIO.new(%[<match>\ntype foobar\n</match>]) }
     it { expect { subject }.to raise_error(Fluent::ConfigError) }
   end
+
+  context "param error" do
+    let(:config) { StringIO.new(%[<match>\ntype example\nparam bad\n</match>]) }
+    it { expect { subject }.to raise_error(Fluent::ConfigError) }
+  end
 end
 

data/spec/fluent/format/cli_spec.rb

@@ -4,16 +4,29 @@ require 'fluent/format/cli'
 describe Fluent::Format::CLI do
   let(:cli) { Fluent::Format::CLI.new }
 
+  def capture_stderr
+    $stderr = StringIO.new
+    begin
+      yield
+    rescue SystemExit
+    end
+    return $stderr.string
+  ensure
+    $stderr = STDERR
+  end
+
   context "#format" do
     let(:subject) { cli.invoke(:format, [], opts) }
 
     context "success" do
       let(:opts) { {config: "fluent.conf"} }
+      it { capture_stderr { subject }.should == "" }
       it { expect { subject }.not_to raise_error }
     end
 
     context "failure" do
       let(:opts) { {config: "unknown.conf"} }
+      it { capture_stderr { subject }.should include "No such file or directory" }
       it { expect { subject }.to raise_error(SystemExit) }
     end
   end
@@ -23,11 +36,25 @@ describe Fluent::Format::CLI do
 
     context "success" do
       let(:opts) { {config: "fluent.conf"} }
+      it { capture_stderr { subject }.should == "" }
       it { expect { subject }.not_to raise_error }
     end
 
-    context "failure" do
-      let(:opts) { {config: "unknown.conf"} }
+    context "syntax error" do
+      let(:opts) { {config: "example/syntax_error.conf"} }
+      it { capture_stderr { subject }.should include("parse error") }
+      it { expect { subject }.to raise_error(SystemExit) }
+    end
+
+    context "plugin error" do
+      let(:opts) { {config: "example/plugin_error.conf"} }
+      it { capture_stderr { subject }.should include("Unknown input plugin") }
+      it { expect { subject }.to raise_error(SystemExit) }
+    end
+
+    context "param error" do
+      let(:opts) { {config: "example/param_error.conf", plugin: "example"} }
+      it { capture_stderr { subject }.should include("out_example.rb") }
       it { expect { subject }.to raise_error(SystemExit) }
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fluent-format
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.2
 platform: ruby
 authors:
 - Naotoshi Seo
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-05 00:00:00.000000000 Z
+date: 2014-02-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -111,8 +111,10 @@ files:
 - README.md
 - Rakefile
 - bin/fluent-format
+- example/out_example.rb
+- example/param_error.conf
+- example/plugin_error.conf
 - example/syntax_error.conf
-- example/unknown_plugin.conf
 - fluent-format.gemspec
 - fluent.conf
 - lib/fluent-format.rb