tengine_support 0.3.0 → 0.3.3

data/lib/tengine/support/config/definition/optparse_visitor.rb

@@ -0,0 +1,66 @@
+# -*- coding: utf-8 -*-
+require 'tengine/support/config/definition'
+
+require 'optparse' # ここ以外でrequireしないし、関係するクラスを記述しません。
+
+class Tengine::Support::Config::Definition::OptparseVisitor
+
+  attr_reader :option_parser
+  def initialize(suite)
+    @option_parser = OptionParser.new
+    @suite = suite
+  end
+
+  alias_method :o, :option_parser
+
+  def visit(d)
+    case d
+    when Tengine::Support::Config::Definition::Suite then
+      option_parser.banner = d.banner
+      d.children.each{|child| child.accept_visitor(self)}
+    when Tengine::Support::Config::Definition::Group then
+      if d.children.any?{|c| c.is_a?(Tengine::Support::Config::Definition::Field)}
+        o.separator ""
+        o.separator "#{d.__name__}:"
+      end
+      d.children.each{|child| child.accept_visitor(self)}
+    when Tengine::Support::Config::Definition then
+      o.separator ""
+      o.separator "#{d.__name__}:"
+      d.children.each{|child| child.accept_visitor(self)}
+    when Tengine::Support::Config::Definition::Field then
+      desc = d.description_value
+      desc_str  = desc.respond_to?(:call) ? desc.call : desc
+      long_opt = d.long_opt
+      args = [d.short_opt, long_opt, desc_str].compact
+      case d.__type__
+      when :action then
+        obj = eval("self", d.__block__.binding)
+        (class << obj; self; end).module_eval do
+          attr_accessor :option_parser
+        end
+        obj.option_parser = option_parser
+        o.on(*args, &d.__block__)
+      when :separator then
+        o.separator(d.description)
+      else
+        case d.type
+        when :boolean then
+          o.on(*args){d.__parent__.send("#{d.__name__}=", true)}
+        when :load_config then
+          long_opt << "=VAL"
+          o.on(*args){|f| d.__parent__.send("#{d.__name__}=", f) }
+        else
+          long_opt << "=VAL"
+          if default_value = d.default_value
+            desc_str << " default: #{default_value.inspect}"
+          end
+          o.on(*args){|val| d.__parent__.send("#{d.__name__}=", val)}
+        end
+      end
+    else
+      raise "Unsupported definition class #{d.class.name}"
+    end
+
+  end
+end

data/lib/tengine/support/config/definition/suite.rb

@@ -0,0 +1,42 @@
+# -*- coding: utf-8 -*-
+require 'tengine/support/config/definition'
+
+require 'tengine/support/yaml_with_erb'
+
+class Tengine::Support::Config::Definition::Suite
+  include Tengine::Support::Config::Definition::HasManyChildren
+
+  def mapping(mapping = nil)
+    @mapping = mapping if mapping
+    @mapping
+  end
+
+  def parent; nil; end
+  def root; self; end
+
+  def load_file(filepath)
+    load(YAML.load_file(filepath))
+  end
+
+  def banner(banner = nil)
+    @banner = banner if banner
+    @banner
+  end
+
+  def parse!(argv)
+    v = Tengine::Support::Config::Definition::OptparseVisitor.new(self)
+    self.accept_visitor(v)
+    if load_config = children.detect{|child| child.type == :load_config}
+      opts = v.option_parser.getopts(argv.dup) # このdup重要。もう一度parseに使用する場合に中身が空にならないように。
+      if filepath = opts[load_config.__name__.to_s]
+        load_file(filepath)
+      end
+    end
+    v.option_parser.parse(argv.dup)
+  end
+
+  def name_array
+    []
+  end
+
+end

data/lib/tengine/support/config/logger.rb

@@ -0,0 +1,23 @@
+require 'tengine/support/config'
+
+class Tengine::Support::Config::Logger
+  include Tengine::Support::Config::Definition
+
+  field :output, 'file path or "STDOUT" / "STDERR".', :type => :string
+  field :rotation, 'rotation file count or daily,weekly,monthly.', :type => :string
+  field :rotation_size, 'number of max log file size.', :type => :integer
+  field :level, 'debug/info/warn/error/fatal.', :type => :string
+
+  def new_logger
+    case output
+    when "STDOUT" then dev = STDOUT
+    when "STDERR" then dev = STDERR
+    else dev = output
+    end
+    shift_age = (rotation =~ /\A\d+\Z/) ? rotation.to_i : rotation
+    result = Logger.new(dev, shift_age, rotation_size)
+    result.level = Logger.const_get(level.upcase)
+    result
+  end
+
+end

data/lib/tengine/support/config/mongoid.rb

@@ -0,0 +1,14 @@
+require 'tengine/support/config'
+
+module Tengine::Support::Config::Mongoid
+
+  class Connection
+    include Tengine::Support::Config::Definition
+    field :host    , 'hostname to connect db.', :default => 'localhost', :type => :string
+    field :port    , "port to connect db.", :default => 27017, :type => :integer
+    field :username, 'username to connect db.', :type => :string
+    field :password, 'password to connect db.', :type => :string
+    field :database, 'database name to connect db.', :type => :string
+  end
+
+end

data/spec/support/app1.rb

@@ -0,0 +1,27 @@
+module App1
+  class ProcessConfig
+    include Tengine::Support::Config::Definition
+    field :daemon, "process works on background.", :type => :boolean
+    field :pid_dir, "path/to/dir for PID created.", :type => :directory
+  end
+
+  class LoggerConfig < Tengine::Support::Config::Logger
+    parameter :logger_name
+    depends :process_config
+    depends :log_common
+    field :output,
+      :default => proc{
+        process_config.daemon ?
+        "./log/#{logger_name}.log" : "STDOUT" },
+      :default_description => proc{"if daemon process then \"./log/#{logger_name}.log\" else \"STDOUT\""}
+    field :rotation,
+      :default => proc{ log_common.rotation },
+      :default_description => proc{"value of #{log_common.long_opt}-rotation"}
+    field :rotation_size,
+      :default => proc{ log_common.rotation_size },
+      :default_description => proc{"value of #{log_common.long_opt}-rotation-size"}
+    field :level,
+      :default => proc{ log_common.level },
+      :default_description => proc{"value of #{log_common.long_opt}-level"}
+  end
+end

data/spec/support/suite.rb

@@ -0,0 +1,49 @@
+def build_suite1
+  Tengine::Support::Config.suite do
+    banner <<EOS
+Usage: config_test [-k action] [-f path_to_config]
+         [-H db_host] [-P db_port] [-U db_user] [-S db_pass] [-B db_database]
+
+EOS
+
+    field(:action, "test|load|start|enable|stop|force-stop|status|activate", :type => :string, :default => "start")
+    load_config(:config, "path/to/config_file", :type => :string)
+    add(:process, App1::ProcessConfig)
+    add(:db, Tengine::Support::Config::Mongoid::Connection, :defaults => {:database => "tengine_production"})
+    group(:event_queue) do
+      add(:connection, Tengine::Support::Config::Amqp::Connection)
+      add(:exchange  , Tengine::Support::Config::Amqp::Exchange, :defaults => {:name => 'tengine_event_exchange'})
+      add(:queue     , Tengine::Support::Config::Amqp::Queue   , :defaults => {:name => 'tengine_event_queue'})
+    end
+    add(:log_common, Tengine::Support::Config::Logger,
+      :defaults => {
+        :rotation      => 3          ,
+        :rotation_size => 1024 * 1024,
+        :level         => 'info'     ,
+      })
+    add(:application_log, App1::LoggerConfig,
+      :logger_name => "application",
+      :dependencies => { :process_config => :process, :log_common => :log_common,})
+    add(:process_stdout_log, App1::LoggerConfig,
+      :logger_name => "#{File.basename($PROGRAM_NAME)}_stdout",
+      :dependencies => { :process_config => :process, :log_common => :log_common,})
+    add(:process_stderr_log, App1::LoggerConfig,
+      :logger_name => "#{File.basename($PROGRAM_NAME)}_stderr",
+      :dependencies => { :process_config => :process, :log_common => :log_common,})
+    separator("\nGeneral:")
+    __action__(:version, "show version"){ STDOUT.puts "1.1.1"; exit }
+    __action__(:help   , "show this help message"){ STDOUT.puts option_parser.help; exit }
+
+    mapping({
+        [:action] => :k,
+        [:config] => :f,
+        [:process, :daemon] => :D,
+        [:db, :host] => :O,
+        [:db, :port] => :P,
+        [:db, :username] => :U,
+        [:db, :password] => :S,
+      })
+  end
+
+end
+

data/spec/tengine_support/config/amqp_spec.rb

@@ -0,0 +1,24 @@
+# -*- coding: utf-8 -*-
+require File.expand_path(File.dirname(__FILE__) + '/../../spec_helper')
+
+describe 'Tengine::Support::Config::Amqp' do
+
+  context "static" do
+    describe Tengine::Support::Config::Amqp::Connection.host do
+      it { subject.should be_a(Tengine::Support::Config::Definition::Field)}
+      its(:type){ should == :string }
+      its(:__name__){ should == :host }
+      its(:description){ should == 'hostname to connect queue.'}
+      its(:default){ should == 'localhost'}
+    end
+
+    describe Tengine::Support::Config::Amqp::Connection.port do
+      it { subject.should be_a(Tengine::Support::Config::Definition::Field)}
+      its(:type){ should == :integer }
+      its(:__name__){ should == :port }
+      its(:description){ should == 'port to connect queue.'}
+      its(:default){ should == 5672}
+    end
+  end
+
+end

data/spec/tengine_support/config/logger_spec.rb

@@ -0,0 +1,86 @@
+# -*- coding: utf-8 -*-
+require File.expand_path(File.dirname(__FILE__) + '/../../spec_helper')
+
+require 'logger'
+require 'tempfile'
+
+describe 'Tengine::Support::Config::Logger' do
+
+  context "static" do
+
+    describe Tengine::Support::Config::Logger.output do
+      it { subject.should be_a(Tengine::Support::Config::Definition::Field)}
+      its(:type){ should == :string }
+      its(:__name__){ should == :output }
+      its(:description){ should == 'file path or "STDOUT" / "STDERR".'}
+      its(:default){ should == nil}
+    end
+  end
+
+  describe :new_logger do
+    it "STDOUTの場合" do
+      config = Tengine::Support::Config::Logger.new
+      config.output = "STDOUT"
+      config.level = "warn"
+      config.rotation = nil
+      config.rotation_size = nil
+      config.output.should == "STDOUT"
+      config.level.should == "warn"
+      config.rotation.should == nil
+      config.rotation_size.should == nil
+
+      logger = Logger.new(STDOUT, nil, nil)
+      Logger.should_receive(:new).with(STDOUT, nil, nil).and_return(logger)
+      logger.should_receive(:level=).with(Logger::WARN)
+      config.new_logger.should == logger
+    end
+
+    it "STDERRの場合" do
+      config = Tengine::Support::Config::Logger.new
+      config.output = "STDERR"
+      config.level = "warn"
+      config.rotation = nil
+      config.rotation_size = nil
+      logger = Logger.new(STDERR, nil, nil)
+      Logger.should_receive(:new).with(STDERR, nil, nil).and_return(logger)
+      logger.should_receive(:level=).with(Logger::WARN)
+      config.new_logger.should == logger
+    end
+
+    context "ファイル名の場合" do
+      before do
+        @filepath = Tempfile.new("test.log")
+      end
+      after do
+        @filepath.close
+      end
+
+      %w[daily weekly monthly].each do |shift_age|
+        it "shift_age が #{shift_age}" do
+          config = Tengine::Support::Config::Logger.new
+          config.output = @filepath
+          config.level = "info"
+          config.rotation = shift_age
+          config.rotation_size = nil
+          logger = Logger.new(@filepath, shift_age, nil)
+          Logger.should_receive(:new).with(@filepath, shift_age, nil).and_return(logger)
+          logger.should_receive(:level=).with(Logger::INFO)
+          config.new_logger.should == logger
+        end
+      end
+
+      it "shift_ageが整数値" do
+        config = Tengine::Support::Config::Logger.new
+        config.output = @filepath
+        config.level = "info"
+        config.rotation = "3"
+        config.rotation_size = 10 * 1024 * 1024 # 10MB
+        logger = Logger.new(@filepath, 3, 10 * 1024 * 1024)
+        Logger.should_receive(:new).with(@filepath, 3, 10 * 1024 * 1024).and_return(logger)
+        logger.should_receive(:level=).with(Logger::INFO)
+        config.new_logger.should == logger
+      end
+    end
+  end
+
+end

data/spec/tengine_support/config/mongoid_spec.rb

@@ -0,0 +1,24 @@
+# -*- coding: utf-8 -*-
+require File.expand_path(File.dirname(__FILE__) + '/../../spec_helper')
+
+describe 'Tengine::Support::Config::Mongoid' do
+
+  context "static" do
+    describe Tengine::Support::Config::Mongoid::Connection.host do
+      it { subject.should be_a(Tengine::Support::Config::Definition::Field)}
+      its(:type){ should == :string }
+      its(:__name__){ should == :host }
+      its(:description){ should == 'hostname to connect db.'}
+      its(:default){ should == 'localhost'}
+    end
+
+    describe Tengine::Support::Config::Mongoid::Connection.port do
+      it { subject.should be_a(Tengine::Support::Config::Definition::Field)}
+      its(:type){ should == :integer }
+      its(:__name__){ should == :port }
+      its(:description){ should == 'port to connect db.'}
+      its(:default){ should == 27017}
+    end
+  end
+
+end

data/spec/tengine_support/config_spec.rb

@@ -0,0 +1,190 @@
+# -*- coding: utf-8 -*-
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe "config" do
+
+  context "app1 setting" do
+    context "static" do
+
+      describe App1::ProcessConfig.daemon do
+        it { subject.should be_a(Tengine::Support::Config::Definition::Field)}
+        its(:type){ should == :boolean }
+        its(:__name__){ should == :daemon }
+        its(:description){ should == 'process works on background.'}
+        its(:default){ should == nil}
+      end
+
+      describe App1::ProcessConfig.pid_dir do
+        it { subject.should be_a(Tengine::Support::Config::Definition::Field)}
+        its(:type){ should == :directory }
+        its(:__name__){ should == :pid_dir }
+        its(:description){ should == 'path/to/dir for PID created.'}
+        its(:default){ should == nil}
+      end
+    end
+
+    context "dynamic" do
+      before(:all) do
+        @suite = build_suite1
+      end
+
+      subject do
+        @suite
+      end
+
+      describe "accessors" do
+        it { subject.action.should == nil}
+        it { subject.config.should == nil}
+        it { subject.process.should be_a(App1::ProcessConfig) }
+        it { subject.process.daemon.should == nil}
+        it { subject.process.pid_dir.should == nil}
+        it { subject.db.should be_a(Tengine::Support::Config::Mongoid::Connection) }
+        it { subject.db.host.should == "localhost"}
+        it { subject.db.port.should == 27017}
+        it { subject.db.username.should == nil}
+        it { subject.db.password.should == nil}
+        it { subject.db.database.should == "tengine_production"}
+        it { subject.event_queue.connection.host.should == "localhost"}
+        it { subject.event_queue.connection.port.should == 5672}
+        it { subject.event_queue.exchange.name.should == "tengine_event_exchange"}
+        it { subject.event_queue.exchange.type.should == 'direct'}
+        it { subject.event_queue.exchange.durable.should == true}
+        it { subject.event_queue.queue.name.should == "tengine_event_queue"}
+        it { subject.event_queue.queue.durable.should == true}
+        it { subject.log_common.output.should == nil}
+        it { subject.log_common.rotation.should == 3}
+        it { subject.log_common.rotation_size.should == 1024 * 1024}
+        it { subject.log_common.level.should == "info"}
+        it { subject.application_log.output.should == "STDOUT"}
+        it { subject.application_log.rotation.should == 3}
+        it { subject.application_log.rotation_size.should == 1024 * 1024}
+        it { subject.application_log.level.should == "info"}
+      end
+
+      it :to_hash do
+        subject.to_hash.should == {
+          :action => 'start',
+          :config => nil,
+          :process => {
+            :daemon => nil,
+            :pid_dir => nil,
+          },
+          :db => {
+            :host => 'localhost',
+            :port => 27017,
+            :username => nil,
+            :password => nil,
+            :database => 'tengine_production'
+          },
+          :event_queue => {
+            :connection => {
+              :host => 'localhost',
+              :port => 5672,
+              :vhost => nil,
+              :user  => nil,
+              :pass  => nil,
+            },
+            :exchange => {
+              :name => 'tengine_event_exchange',
+              :type => 'direct',
+              :durable => true,
+            },
+            :queue => {
+              :name => 'tengine_event_queue',
+              :durable => true,
+            },
+          },
+
+          :log_common => {
+            :output        => nil        ,
+            :rotation      => 3          ,
+            :rotation_size => 1024 * 1024,
+            :level         => 'info'     ,
+          }.freeze,
+
+          :application_log => {
+            :output        => "STDOUT",
+            :rotation=>3, :rotation_size=>1048576, :level=>"info"
+          }.freeze,
+
+          :process_stdout_log => {
+            :output        => "STDOUT",
+            :rotation=>3, :rotation_size=>1048576, :level=>"info"
+          }.freeze,
+
+          :process_stderr_log => {
+            :output        => "STDOUT",
+            :rotation=>3, :rotation_size=>1048576, :level=>"info"
+          }.freeze,
+        }
+      end
+
+      it "suite has children" do
+        subject.children.map(&:__name__).should == [
+          :action, :config,
+          :process, :db, :event_queue, :log_common,
+          :application_log, :process_stdout_log, :process_stderr_log, :separator10, :version, :help]
+      end
+
+      context "suite returns child by name" do
+        {
+          :process => App1::ProcessConfig,
+          :db => Tengine::Support::Config::Mongoid::Connection,
+          :event_queue => Tengine::Support::Config::Definition::Group,
+          [:event_queue, :connection] => NilClass,
+          [:event_queue, :exchange  ] => NilClass,
+          [:event_queue, :queue     ] => NilClass,
+          :log_common => Tengine::Support::Config::Logger,
+          :application_log => App1::LoggerConfig,
+          :process_stdout_log => App1::LoggerConfig,
+          :process_stderr_log => App1::LoggerConfig,
+        }.each do |name, klass|
+          it{ subject.child_by_name(name).should be_a(klass) }
+        end
+
+        {
+          :process => App1::ProcessConfig,
+          :db => Tengine::Support::Config::Mongoid::Connection,
+          :event_queue => Tengine::Support::Config::Definition::Group,
+          [:event_queue, :connection] => Tengine::Support::Config::Amqp::Connection,
+          [:event_queue, :exchange  ] => Tengine::Support::Config::Amqp::Exchange,
+          [:event_queue, :queue     ] => Tengine::Support::Config::Amqp::Queue,
+          :log_common => Tengine::Support::Config::Logger,
+          :application_log => App1::LoggerConfig,
+          :process_stdout_log => App1::LoggerConfig,
+          :process_stderr_log => App1::LoggerConfig,
+        }.each do |name_array, klass|
+          it{ subject.find(name_array).should be_a(klass) }
+        end
+      end
+
+      context "parent and children" do
+        it do
+          log_common = subject.find(:log_common)
+          application_log = subject.find(:application_log)
+          log_common.should_not == application_log
+          log_common.children.each do |log_common_child|
+            application_log_child = application_log.child_by_name(log_common_child.__name__)
+            application_log_child.should_not be_nil
+            application_log_child.__name__.should == log_common_child.__name__
+            application_log_child.object_id.should_not == log_common_child.object_id
+            application_log_child.__parent__.should == application_log
+            log_common_child.__parent__.should == log_common
+          end
+        end
+      end
+
+      context "dependencies" do
+        it do
+          application_log = subject.find(:application_log)
+          application_log.process_config.should_not be_nil
+          application_log.process_config.should be_a(App1::ProcessConfig)
+          application_log.log_common.should_not be_nil
+          application_log.log_common.should be_a(Tengine::Support::Config::Logger)
+        end
+      end
+
+    end
+  end
+
+end