fluent-format 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 969f4553fc32823ac426e1f1aa7f8acd1b99c94f
-  data.tar.gz: c3a78502cd9a2592db22a8db7edc8c414c9457ce
+  metadata.gz: 885cab275f6fb1fd2c3985502fe7c4af090e04f3
+  data.tar.gz: 7bed0b502af72155bec463042b4c76897478cc93
 SHA512:
-  metadata.gz: 18bb1683805a0e7dfa9297c44ca66949b279844eb9c0bee0fd31c30808add30d8af31f574c5b18c45a4aaade41f40791536360c15faf07a252f9fc72beaa62cb
-  data.tar.gz: 5bd3024ab31d88d630100a356fd71272a2c4cab4f22b2d91712b97d71ea5488b64d27c302e32e3ae5b7bfc64bee4457cf28060553847b7a5d0900ecbe81a652f
+  metadata.gz: 97d236a5c5afa4a85d568856f254f35c991e0def0721651e776ed543c8492ea9e84921dc03ce006ff10556d5c169311e7e6ce49c3354743960dda61cd07e975d
+  data.tar.gz: abf9334f02803e4a628711c6fb639f2d0470720c519be167e87c830a908f806ed8b5feefbbae84d2ad042bdbd553552e033c09f4faa0fc09db72880f545d49c8

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+## 0.2.0 (2014/02/05)
+
+Enhancement:
+
+* Add `check` command
+
 ## 0.1.1 (2013/12/04)
 
 First version
+

data/README.md

@@ -16,9 +16,27 @@ Or install it yourself as:
 
     $ gem install fluent-format
 
-Run as
+## Command Line Interface
 
-    $ fluent-format -c fluentd.conf
+Format fluent.conf
+
+    $ fluent-format -c fluent.conf
+
+Check fluent.conf
+
+    $ fluent-format check -c fluent.conf -p plugin_dir
+    $ echo $? # 0: success 1: failure
+
+## As a library
+
+```ruby
+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
+}
+```
 
 ## ToDo
 

data/example/syntax_error.conf

@@ -0,0 +1,3 @@
+<source>
+  type forward
+</match>

data/example/unknown_plugin.conf

@@ -0,0 +1,3 @@
+<source>
+  type foobar
+</source>

data/lib/fluent/format/check.rb

@@ -0,0 +1,68 @@
+require 'fluent/supervisor'
+
+module Fluent
+  class Format
+    class Check
+      # Initialize
+      #
+      # @param [IO|String] config_dev
+      # @param [String] plugin_dir the plugin directory
+      def initialize(config_dev, plugin_dir = nil)
+        @opts = {
+          :config_path => config_dev, # Fluent::DEFAULT_CONFIG_PATH,
+          :plugin_dirs => [Fluent::DEFAULT_PLUGIN_DIR],
+          :log_level => Fluent::Log::LEVEL_INFO,
+          :log_path => nil,
+          :daemonize => false,
+          :libs => [],
+          :setup_path => nil,
+          :chuser => nil,
+          :chgroup => nil,
+          :suppress_interval => 0,
+          :suppress_repeated_stacktrace => false,
+        }
+        @opts[:plugin_dirs] << plugin_dir if plugin_dir
+      end
+
+      # Check config file
+      #
+      # @return [Boolean]
+      def run
+        Fluent::Supervisor.new(@opts).ext_dry_run
+      end
+    end
+  end
+end
+
+module Fluent
+  class Supervisor
+    # Extended to accept IO object
+    def ext_dry_run
+      ext_read_config
+      change_privilege
+      init_engine
+      install_main_process_signal_handlers
+      run_configure
+      true
+    rescue => e
+      false
+    end
+
+    # Extended to accept IO object
+    def ext_read_config
+      if @config_path.respond_to?(:read) # IO object
+        @config_data = @config_path.read
+      else
+        $log.info "reading config file", :path=>@config_path
+        @config_fname = File.basename(@config_path)
+        @config_basedir = File.dirname(@config_path)
+        @config_data = File.read(@config_path)
+      end
+      if @inline_config == '-'
+        @config_data << "\n" << STDIN.read
+      elsif @inline_config
+        @config_data << "\n" << @inline_config.gsub("\\n","\n")
+      end
+    end
+  end
+end

data/lib/fluent/format/cli.rb

@@ -4,13 +4,24 @@ require_relative '../../fluent-format'
 module Fluent
   class Format
     class CLI < Thor
-      default_command :start
-      desc "start", "Start fluent-format"
+      default_command :format
+      desc "format", "Format fluent.conf"
       option :config, :aliases => ["-c"], :type => :string, :default => 'fluent.conf', :desc => 'Fluentd configuration file'
-      def start
+      def format
         config = @options[:config]
-        $log = Fluent::Log.new(STDERR, Fluent::Log::LEVEL_WARN)
-        puts Fluent::Format.format_config(config)
+        puts Fluent::Format.format(config)
+      rescue => e
+        $log.error "#{e.class}: #{e}"
+        exit 1
+      end
+
+      desc "check", "Check fluent.conf"
+      option :config, :aliases => ["-c"], :type => :string, :default => 'fluent.conf', :desc => 'Fluentd configuration file'
+      option :plugin, :aliases => ["-p"], :type => :string, :desc => 'Fluentd plugin directory'
+      def check
+        config = @options[:config]
+        plugin = @options[:plugin]
+        Fluent::Format.check(config, plugin) || exit(1)
       rescue => e
         $log.error "#{e.class}: #{e}"
         exit 1

data/lib/fluent/format/format.rb

@@ -0,0 +1,47 @@
+module Fluent
+  class Format
+    class Format
+      # Initialize
+      #
+      # @param [IO|String] config_dev
+      def initialize(config_dev)
+        @config_dev = config_dev
+      end
+
+      # Format config
+      #
+      # @return [String] the formatted config
+      def run
+        config = read_config(@config_dev)
+        indent_config(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)
+        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")
+      end
+    end
+  end
+end

data/lib/fluent/format/version.rb

@@ -1,5 +1,5 @@
 module Fluent
   class Format
-    VERSION = "0.1.1"
+    VERSION = "0.2.0"
   end
 end

data/lib/fluent/format.rb

@@ -1,42 +1,22 @@
-require 'fluent/load'
+$log = Fluent::Log.new(STDERR, Fluent::Log::LEVEL_WARN)
 
 module Fluent
   class Format
-    class << self
-      def format_config(dev)
-        config =
-          if dev.respond_to?(:read) # IO object
-            parse_config(dev, '-', '-')
-          else
-            read_config(dev)
-          end
-        indent_config(config)
-      end
-
-    private
-
-      # partial copy from lib/fluent/config.rb
-      def read_config(path)
-        File.open(path) {|io|
-          parse_config(io, File.basename(path), File.dirname(path))
-        }
-      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
+    # Format config file
+    #
+    # @param [IO|String] config_dev
+    # @return [String] the formatted config
+    def self.format(config_dev)
+      Fluent::Format::Format.new(config_dev).run
+    end
 
-      # hmm, ugly workaround
-      def indent_config(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")
-      end
+    # Check config file
+    #
+    # @param [IO|String] config_dev
+    # @param [String] plugin_dir the plugin directory
+    # @return [Boolean]
+    def self.check(config_dev, plugin_dir = nil)
+      Fluent::Format::Check.new(config_dev, plugin_dir).run
     end
   end
 end

data/lib/fluent-format.rb

@@ -1,2 +1,5 @@
 require_relative 'fluent/format/version'
+require 'fluent/load'
+require_relative 'fluent/format/format'
+require_relative 'fluent/format/check'
 require_relative 'fluent/format'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fluent-format
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Naotoshi Seo
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-12-04 00:00:00.000000000 Z
+date: 2014-02-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -111,11 +111,15 @@ files:
 - README.md
 - Rakefile
 - bin/fluent-format
+- example/syntax_error.conf
+- example/unknown_plugin.conf
 - fluent-format.gemspec
 - fluent.conf
 - lib/fluent-format.rb
 - lib/fluent/format.rb
+- lib/fluent/format/check.rb
 - lib/fluent/format/cli.rb
+- lib/fluent/format/format.rb
 - lib/fluent/format/version.rb
 homepage: https://github.com/sonots/fluent-format
 licenses: