rbatch 2.0.0 → 2.1.0

data/doc/lib/rbatch/run_conf_rb.html

@@ -24,7 +24,7 @@
 	<div id="metadata">
 		<dl>
 			<dt class="modified-date">Last Modified</dt>
-			<dd class="modified-date">2013-12-28 14:13:02 +0900</dd>
+			<dd class="modified-date">2014-01-10 03:06:32 +0900</dd>
 
 			
 			<dt class="requires">Requires</dt>

data/doc/lib/rbatch/version_rb.html

@@ -24,7 +24,7 @@
 	<div id="metadata">
 		<dl>
 			<dt class="modified-date">Last Modified</dt>
-			<dd class="modified-date">2013-12-28 02:25:41 +0900</dd>
+			<dd class="modified-date">2014-01-02 01:41:28 +0900</dd>
 
 			
 			<dt class="requires">Requires</dt>

data/doc/lib/rbatch_rb.html

@@ -24,7 +24,7 @@
 	<div id="metadata">
 		<dl>
 			<dt class="modified-date">Last Modified</dt>
-			<dd class="modified-date">2013-12-28 14:03:07 +0900</dd>
+			<dd class="modified-date">2014-01-10 03:06:32 +0900</dd>
 
 			
 			<dt class="requires">Requires</dt>

data/lib/rbatch/common_config.rb

@@ -4,10 +4,6 @@ require 'pathname'
 module RBatch
 
   module_function
-
-  # Alias of RBatch::CommonConfig.new
-  def common_config ; CommonConfig.new end
-
   # Common-config Reader
   #
   # Read common config file and return hash opject. If the key does not exist in config file, raise RBatch::CommonConfig::Exception.
@@ -26,18 +22,48 @@ module RBatch
   #  => {"key" => "value", "array" => ["item1", "item2", "item3"]}
   class CommonConfig
     @path
-    @config
+    @hash
     def initialize
       file = RBatch.run_conf[:common_conf_name]
-      @path = File.join(RBatch.run_conf[:conf_dir].gsub("<home>",RBatch.home_dir),file)
-      @config = YAML::load_file(@path)
+      @path = File.join(RBatch.conf_dir,file)
+      begin
+        @hash = YAML::load_file(@path)
+      rescue Errno::ENOENT => e
+        @hash = nil
+      end
     end
     def[](key)
-      raise RBatch::CommonConfig::Exception, "Value of key=\"#{key}\" is nil" if @config[key].nil?
-      @config[key]
+      if @hash.nil?
+        raise RBatch::CommonConfig::Exception, "Common Config file \"#{@path}\" does not exist"
+      end
+      if @hash[key].nil?
+        if key.class == Symbol
+          raise RBatch::CommonConfig::Exception, "Value of key(:#{key} (Symbol)) is nil. By any chance, dou you mistake key class Symbol for String?"
+        elsif key.class == String
+          raise RBatch::CommonConfig::Exception, "Value of key(\"#{key}\" (String)) is nil"
+        else
+          raise RBatch::CommonConfig::Exception, "Value of key(#{key}) is nil"
+        end
+      else
+        @hash[key]
+      end
     end
     def path ; @path ; end
-    def to_s ; @config.to_s ;end
+    def exist? ; ! @hash.nil? ; end
+    def to_h
+      if @hash.nil?
+        raise RBatch::CommonConfig::Exception, "Common Config file \"#{@path}\" does not exist"
+      else
+        @hash
+      end
+    end
+    def to_s
+      if @hash.nil?
+        raise RBatch::CommonConfig::Exception, "Common Config file \"#{@path}\" does not exist"
+      else
+        @hash.to_s
+      end
+    end
   end
 
   class RBatch::CommonConfig::Exception < Exception; end

data/lib/rbatch/config.rb

@@ -4,10 +4,6 @@ require 'pathname'
 module RBatch
 
   module_function
-
-  # Alias of RBatch::Config.new
-  def config ; Config.new end
-
   # Config Reader
   #
   # Read config file and return hash opject. If the key does not exist in config file, raise RBatch::Config::Exception.
@@ -27,18 +23,48 @@ module RBatch
   #  => {"key" => "value", "array" => ["item1", "item2", "item3"]}
   class Config
     @path
-    @config
+    @hash
     def initialize
       file = Pathname(File.basename(RBatch.program_name)).sub_ext(".yaml").to_s
-      @path = File.join(RBatch.run_conf[:conf_dir].gsub("<home>",RBatch.home_dir),file)
-      @config = YAML::load_file(@path)
+      @path = File.join(RBatch.conf_dir,file)
+      begin
+        @hash = YAML::load_file(@path)
+      rescue Errno::ENOENT => e
+        @hash = nil
+      end
     end
     def[](key)
-      raise RBatch::Config::Exception, "Value of key=\"#{key}\" is nil" if @config[key].nil?
-      @config[key]
+      if @hash.nil?
+        raise RBatch::Config::Exception, "Config file \"#{@path}\" does not exist"
+      end
+      if @hash[key].nil?
+        if key.class == Symbol
+          raise RBatch::Config::Exception, "Value of key(:#{key} (Symbol)) is nil. By any chance, dou you mistake key class Symbol for String?"
+        elsif key.class == String
+          raise RBatch::Config::Exception, "Value of key(\"#{key}\" (String)) is nil"
+        else
+          raise RBatch::Config::Exception, "Value of key(#{key}) is nil."
+        end
+      else
+        @hash[key]
+      end
     end
     def path ; @path ; end
-    def to_s ; @config.to_s ;end
+    def exist? ; ! @hash.nil? ; end
+    def to_h
+      if @hash.nil?
+        raise RBatch::Config::Exception, "Config file \"#{@path}\" does not exist"
+      else
+        @hash
+      end
+    end
+    def to_s
+      if @hash.nil?
+        raise RBatch::Config::Exception, "Config file \"#{@path}\" does not exist"
+      else
+        @hash.to_s
+      end
+    end
   end
 
   class RBatch::Config::Exception < Exception; end

data/lib/rbatch/log.rb

@@ -126,9 +126,16 @@ module RBatch
         @stdout_log.level = @@log_level_map[@opt[:log_level]]
         @stdout_log.formatter = formatter
       end
-      RBatch.journal :info,"Start Logging. Log file: " + path
+      RBatch.journal :info,"Start Logging: \"#{path}\""
       # delete old log
       self.delete_old_log(@opt[:log_delete_old_log_date]) if @opt[:log_delete_old_log]
+      # Firstly write journal to log
+      if RBatch.run_conf[:mix_rbatch_msg_to_log]
+        RBatch.journals.each do |str|
+          self.journal(str)
+        end
+        RBatch.add_log(self)
+      end
       # Start logging
       if block_given?
         begin
@@ -170,6 +177,10 @@ module RBatch
       @log.debug(a)
     end
 
+    def journal(a)
+      @log.info(a)
+    end
+
     def close
       @stdout_log.close if @opt[:log_stdout]
       @log.close

data/lib/rbatch/run_conf.rb

@@ -8,6 +8,8 @@ module RBatch
     @@def_opt = {
       :conf_dir      => "<home>/conf",
       :common_conf_name => "common.yaml",
+      :lib_dir       => "<home>/lib",
+      :auto_lib_load => true,
       :forbid_double_run => false,
       :cmd_raise     => false,
       :cmd_timeout   => 0,
@@ -23,7 +25,8 @@ module RBatch
       :log_mail_to   => nil,
       :log_mail_from => "rbatch.localhost",
       :log_mail_server_host => "localhost",
-      :log_mail_server_port => 25
+      :log_mail_server_port => 25,
+      :mix_rbatch_msg_to_log => true
     }
     def initialize(run_conf_path,home_dir)
       @run_conf_path = run_conf_path

data/lib/rbatch/version.rb

@@ -1,3 +1,3 @@
 module RBatch
-  VERSION = "2.0.0"
+  VERSION = "2.1.0"
 end

data/lib/rbatch.rb

@@ -2,54 +2,108 @@ $LOAD_PATH.unshift(File.expand_path(File.dirname(__FILE__)))
 require 'yaml'
 
 module RBatch
-  @@program_name = $PROGRAM_NAME
-  @@program_base = File.basename($PROGRAM_NAME)
+  @@program_name = nil
+  @@program_base = nil
+  @@program_path = nil
   @@home_dir = nil
   @@run_conf_path = nil
+  @@run_conf_fpath = nil
   @@run_conf = nil
+  @@config = nil
+  @@common_config = nil
   @@journal_verbose = 3
   @@journal_verbose_map = { :error => 1, :warn => 2, :info => 3, :debug => 4}
+  @@journals = []
+  @@logs = []
   module_function
   def program_name  ; @@program_name ; end
   def program_base  ; @@program_base ; end
+  def program_path  ; @@program_path ; end
   def home_dir      ; @@home_dir ; end
   def run_conf_path ; @@run_conf_path ; end
   def run_conf      ; @@run_conf ; end
   def conf_dir      ; @@run_conf[:conf_dir].gsub("<home>",@@home_dir) ; end
   def log_dir       ; @@run_conf[:log_dir].gsub("<home>",@@home_dir) ; end
+  def lib_dir       ; @@run_conf[:lib_dir].gsub("<home>",@@home_dir) ; end
+  def config        ; @@config ; end
+  def common_config ; @@common_config ; end
+  def journals      ; @@journals ; end
+  def add_log(log)
+    @@logs << log
+  end
   def journal(level,str)
-    puts "[RBatch] " + str if @@journal_verbose_map[level] <= @@journal_verbose
+    if @@journal_verbose_map[level] <= @@journal_verbose
+      str = "[RBatch] " + str
+      puts str
+      @@journals << str
+      @@logs.each do |log|
+        if RBatch.run_conf[:mix_rbatch_msg_to_log]
+          log.journal(str)
+        end
+      end
+    end
   end
   def init
     @@journal_verbose = ENV["RB_VERBOSE"].to_i if ENV["RB_VERBOSE"]
+    RBatch.journal :info,"=== START RBatch === (PID=#{$$.to_s})"
+    @@program_name = $PROGRAM_NAME
+    @@program_base = File.basename($PROGRAM_NAME)
+    @@program_path = File.expand_path(@@program_name)
     if  ENV["RB_HOME"]
-      @@home_dir = ENV["RB_HOME"]
-      RBatch.journal :info,"RB_HOME : \"#{@@home_dir}\" (defined by $RB_HOME)"
+      @@home_dir = File.expand_path(ENV["RB_HOME"])
+      RBatch.journal :debug,"RB_HOME : \"#{@@home_dir}\" (defined by $RB_HOME)"
     else
-      @@home_dir =  File.join(File.dirname(@@program_name) , "..")
-      RBatch.journal :info,"RB_HOME : \"#{@@home_dir}\" (default)"
+      @@home_dir =  File.expand_path(File.join(File.dirname(@@program_name) , ".."))
+      RBatch.journal :debug,"RB_HOME : \"#{@@home_dir}\" (default)"
     end
     @@run_conf_path = File.join(@@home_dir,".rbatchrc")
-    RBatch.journal :info,"Run-Conf: \"#{@@run_conf_path}\""
-
+    RBatch.journal :info,"Load Run-Conf: \"#{@@run_conf_path}\""
     @@run_conf = RunConf.new(@@run_conf_path,@@home_dir)
     RBatch.journal :debug,"RBatch option : #{@@run_conf.inspect}"
+    @@common_config = RBatch::CommonConfig.new
+    RBatch.journal :info,"Load Config  : \"#{@@common_config.path}\"" if @@common_config.exist?
+    @@config = RBatch::Config.new
+    RBatch.journal :info,"Load Config  : \"#{@@config.path}\"" if @@config.exist?
+  end
+  def reload_config
+    begin
+      @@config = RBatch::Config.new
+      RBatch.journal :info, "Load Config  : \"#{@@config.path}\""
+    rescue Errno::ENOENT => e
+    end
+  end
+  def reload_common_config
+    begin
+      @@common_config = RBatch::CommonConfig.new
+      RBatch.journal :info,"Load Config  : \"#{@@common_config.path}\""
+    rescue Errno::ENOENT => e
+    end
   end
 end
 
 # main
 require 'rbatch/run_conf'
 require 'rbatch/double_run_checker'
+require 'rbatch/log'
+require 'rbatch/config'
+require 'rbatch/common_config'
+require 'rbatch/cmd'
 
 RBatch::init
+
 if ( RBatch.run_conf[:forbid_double_run] )
   RBatch::DoubleRunChecker.check(File.basename(RBatch.program_name)) #raise error if check is NG
   RBatch::DoubleRunChecker.make_lock_file(File.basename(RBatch.program_name))
 end
 
-require 'rbatch/log'
-require 'rbatch/config'
-require 'rbatch/common_config'
-require 'rbatch/cmd'
 
-RBatch.journal :info,"Start \"#{RBatch.program_name}\" under RBatch (PID=#{$$.to_s})"
+
+if RBatch.run_conf[:auto_lib_load] && Dir.exist?(RBatch.lib_dir)
+  Dir::foreach(RBatch.lib_dir) do |file|
+    if /.*rb/ =~ file
+      require File.join(RBatch.lib_dir,File.basename(file,".rb"))
+      RBatch.journal :info, "Load Library : \"#{File.join(RBatch.lib_dir,file)}\" "
+    end
+  end
+end
+RBatch.journal :info,"Start Script : \"#{RBatch.program_path}\""

data/sample/.rbatchrc

@@ -0,0 +1,127 @@
+# RBatch Run-Conf (.rbatchrc)
+#
+#   This format is YAML.
+#
+
+# -------------------
+# Global setting
+# -------------------
+
+# Conf Directory
+#
+#   Default is "<home>/conf"
+#
+#   <home> is replaced to ${RB_HOME}
+#
+#conf_dir: <home>/config
+#conf_dir: /etc/rbatch/
+
+# Common config file name
+#
+#   Default is "common.yaml"
+#
+#common_conf_name: share.yaml
+
+# Forbit Script Double Run
+#
+#   Default is false.
+#   If true, two same name scripts cannot run at the same time. 
+#
+#forbid_double_run: true
+#forbid_double_run: false
+
+# -------------------
+# Cmd setting
+# -------------------
+
+# Raise Exception
+#
+#   Default is false.
+#   If true, when command exit status is not 0, raise exception.
+#
+#cmd_raise : true
+#cmd_raise : false
+
+# Command Timeout
+#
+#   Default is 0 [sec].
+#
+#cmd_timeout: 5
+
+# -------------------
+# Log setting
+# -------------------
+
+# Log Directory
+#
+#   Default is "<home>/log"
+#   <home> is replaced to ${RB_HOME}
+#
+#log_dir: <home>/rb_log
+#log_dir: /var/log/rbatch/
+
+# Log File Name
+#
+#   Default is "<date>_<time>_<prog>.log".
+#   <data> is replaced to YYYYMMDD date string
+#   <time> is replaced to HHMMSS time string
+#   <prog> is replaced to Program file base name (except extention).
+#   <host> is replaced to Hostname.
+#
+#log_name : "<date>_<time>_<prog>.log"
+#log_name : "<date>_<prog>.log"
+
+# Append log or not
+#
+#   Default is ture.
+#
+#log_append : true
+#log_append : false
+
+# Log Level
+#
+#   Default is "info".
+#   Effective values are "debug","info","wran","error",and "fatal".
+#
+#log_level : "debug"
+#log_level : "info"
+#log_level : "warn"
+#log_level : "error"
+#log_level : "fatal"
+
+# Print log string both file and STDOUT
+#
+#   Default is false.
+#
+#log_stdout : true
+#log_stdout : false
+
+# Delete old log files
+#
+#   Default is false.
+#   If this is true, delete old log file when RBatch::Log.new is called.
+#   A log file to delete is a log file which was made by the RBatch::Log instance, 
+#   and log filename format include "<date>".
+#
+#log_delete_old_log: true
+#log_delete_old_log: false
+
+# The day of leaving log files
+#
+#   Default is 7.
+#
+#log_delete_old_log_date: 14
+
+# Send mail or not
+# 
+#   Default is false.
+#   When log.error(msg) or log.fatal(msg) called , send e-mail including "msg". 
+#
+#log_send_mail : true
+
+# Mail parameters
+#
+#log_mail_to   : "xxx@sample.com"
+#log_mail_from : "xxx@sample.com"
+#log_mail_server_host : "localhost"
+#log_mail_server_port : 25

data/spec/cmd_spec.rb

@@ -1,6 +1,4 @@
-require 'tmpdir'
-ENV["RB_VERBOSE"]="0"
-ENV["RB_HOME"]=Dir.tmpdir
+require File.expand_path(File.join( File.dirname(__FILE__), 'spec_helper'))
 
 require 'rbatch'
 
@@ -109,7 +107,7 @@ describe RBatch::Cmd do
 
   describe "option by config" do
     before :all do
-      @config_dir=File.join(RBatch.home_dir,"conf")
+      @config_dir=File.join(ENV["RB_HOME"],"conf")
       @config_file = File.join(@config_dir , "rbatch.yaml")
       Dir::mkdir @config_dir if ! Dir.exists? @config_dir
     end

data/spec/common_config_spec.rb

@@ -1,12 +1,10 @@
-require 'tmpdir'
-ENV["RB_VERBOSE"]="0"
-ENV["RB_HOME"]=Dir.tmpdir
+require File.expand_path(File.join( File.dirname(__FILE__), 'spec_helper'))
 
 require 'rbatch'
 
 describe RBatch::CommonConfig do
   before :all do
-    @config_dir=File.join(Dir.tmpdir,"conf")
+    @config_dir=File.join(ENV["RB_HOME"],"conf")
     @config_file = File.join(@config_dir , "common.yaml")
     Dir::mkdir @config_dir if ! Dir.exists? @config_dir
   end
@@ -23,32 +21,65 @@ describe RBatch::CommonConfig do
 
   it "read config" do
     open( @config_file  , "w" ){|f| f.write("key: value")}
+    RBatch.reload_common_config
     expect(RBatch.common_config["key"]).to eq "value"
   end
 
+  it "read config. Key is Symbol" do
+    open( @config_file  , "w" ){|f| f.write(":key: value")}
+    RBatch.reload_common_config
+    expect(RBatch.common_config[:key]).to eq "value"
+  end
+
   it "raise error when config does not exist" do
+    RBatch.reload_common_config
+    expect {
+      RBatch.common_config["hoge"]
+    }.to raise_error(RBatch::CommonConfig::Exception)
     expect {
-      RBatch.common_config
-    }.to raise_error(Errno::ENOENT)
+      RBatch.common_config.to_h
+    }.to raise_error(RBatch::CommonConfig::Exception)
+    expect {
+      RBatch.common_config.to_s
+    }.to raise_error(RBatch::CommonConfig::Exception)
   end
 
   it "read config twice" do
     open( @config_file  , "w" ){|f| f.write("key: value")}
+    RBatch.reload_common_config
     expect(RBatch.common_config["key"]).to eq "value"
     expect(RBatch.common_config["key"]).to eq "value"
   end
 
   it "raise error when read value which key does not exist" do
     open( @config_file  , "w" ){|f| f.write("key: value")}
+    RBatch.reload_common_config
     expect {
       RBatch.common_config["not_exist"]
     }.to raise_error(RBatch::CommonConfig::Exception)
   end
 
+  it "raise error when read value which key mistake String for Symbol" do
+    open( @config_file  , "w" ){|f| f.write(":key: value")}
+    RBatch.reload_common_config
+    expect {
+      RBatch.common_config["key"]
+    }.to raise_error(RBatch::CommonConfig::Exception)
+  end
+
+  it "raise error when read value which key mistake Symbol for String" do
+    open( @config_file  , "w" ){|f| f.write("key: value")}
+    RBatch.reload_common_config
+    expect {
+      RBatch.common_config[:key]
+    }.to raise_error(RBatch::CommonConfig::Exception)
+  end
+
   it "success when common_conf_name changed" do
-    conf=File.join(Dir.tmpdir,"global.yaml")
+    conf=File.join(RBatch.conf_dir,"global.yaml")
     open( conf  , "w" ){|f| f.write("key4: value4")}
     RBatch.run_conf[:common_conf_name]="global.yaml"
+    RBatch.reload_common_config
     expect(RBatch.common_config["key4"]).to eq "value4"
   end
 end

data/spec/config_spec.rb

@@ -1,12 +1,10 @@
-require 'tmpdir'
-ENV["RB_VERBOSE"]="0"
-ENV["RB_HOME"]=Dir.tmpdir
+require File.expand_path(File.join( File.dirname(__FILE__), 'spec_helper'))
 
 require 'rbatch'
 
 describe RBatch::Config do
   before :all do
-    @config_dir=File.join(Dir.tmpdir,"conf")
+    @config_dir=File.join(ENV["RB_HOME"],"conf")
     @config_file = File.join(@config_dir , "rspec.yaml")
     Dir::mkdir @config_dir if ! Dir.exists? @config_dir
   end
@@ -23,27 +21,59 @@ describe RBatch::Config do
 
   it "read config" do
     open( @config_file  , "w" ){|f| f.write("key: value")}
+    RBatch.reload_config
     expect(RBatch.config["key"]).to eq "value"
   end
 
+  it "read config. Key is Symbol" do
+    open( @config_file  , "w" ){|f| f.write(":key: value")}
+    RBatch.reload_config
+    expect(RBatch.config[:key]).to eq "value"
+  end
+
   it "raise error when config does not exist" do
+    RBatch.reload_config
+    expect {
+      RBatch.config["hoge"]
+    }.to raise_error(RBatch::Config::Exception)
     expect {
-      RBatch.config
-    }.to raise_error(Errno::ENOENT)
+      RBatch.config.to_h
+    }.to raise_error(RBatch::Config::Exception)
+    expect {
+      RBatch.config.to_s
+    }.to raise_error(RBatch::Config::Exception)
   end
 
   it "read config twice" do
     open( @config_file  , "w" ){|f| f.write("key: value")}
+    RBatch.reload_config
     expect(RBatch.config["key"]).to eq "value"
     expect(RBatch.config["key"]).to eq "value"
   end
 
   it "raise error when read value which key does not exist" do
     open( @config_file  , "w" ){|f| f.write("key: value")}
+    RBatch.reload_config
     expect {
       RBatch.config["not_exist"]
     }.to raise_error(RBatch::Config::Exception)
   end
 
+  it "raise error when read value which key mistake String for Symbol" do
+    open( @config_file  , "w" ){|f| f.write("key: value")}
+    RBatch.reload_config
+    expect {
+      RBatch.config[:key]
+    }.to raise_error(RBatch::Config::Exception)
+  end
+
+  it "raise error when read value which key mistake Symbol for String" do
+    open( @config_file  , "w" ){|f| f.write(":key: value")}
+    RBatch.reload_config
+    expect {
+      RBatch.config["key"]
+    }.to raise_error(RBatch::Config::Exception)
+  end
+
 
 end

data/spec/log_spec.rb

@@ -1,13 +1,11 @@
-require 'tmpdir'
-ENV["RB_VERBOSE"]="0"
-ENV["RB_HOME"]=Dir.tmpdir
+require File.expand_path(File.join( File.dirname(__FILE__), 'spec_helper'))
 
 require 'rbatch'
 
 describe RBatch::Log do
 
   before :all do
-    @dir = File.join(Dir.tmpdir,"log")
+    @dir = File.join(ENV["RB_HOME"],"log")
     Dir::mkdir(@dir)if ! Dir.exists? @dir
   end
 
@@ -84,7 +82,8 @@ describe RBatch::Log do
     end
 
     it "change log dir" do
-      @tmp = Dir.tmpdir
+      @tmp = File.join(ENV["RB_HOME"],"log3")
+      Dir.mkdir(@tmp)
       RBatch::Log.new({:name => "c.log", :dir=> @tmp }) do | log |
         log.info("hoge")
       end
@@ -282,7 +281,8 @@ describe RBatch::Log do
     end
 
     it "change log dir" do
-      @tmp = Dir.tmpdir
+      @tmp = File.join(ENV["RB_HOME"],"log2")
+      Dir.mkdir(@tmp)
       confstr = "log_name: c.log\nlog_dir: " + @tmp
       open( RBatch.run_conf_path  , "a" ){|f| f.write(confstr)}
       RBatch.run_conf.reload