jobmanager 1.0.1 → 1.1.0

data/lib/jobmanager/applicationconfig.rb

@@ -13,13 +13,13 @@ module JobManager
   #
   class ApplicationConfig < ConfigToolkit::BaseConfig
 
-    EMAIL_CONDITIONS = [ :always, :never, :on_failure ]
+    EMAIL_CONDITIONS = [ :always, :never, :on_failure, :on_job_output_or_failure ]
     CENTRAL_LOG_MODES = [ :syslog, :file ]
 
     add_required_param(:command, String)
     
     add_required_param(:job_name, String)
-
+    
     add_required_param(:job_logs_directory, Pathname)
     
     add_optional_param(:email_condition, Symbol, :on_failure) do |value|
@@ -71,9 +71,21 @@ module JobManager
                        "jobmanager results for <%=job_name%> on <%=host_name%> : <%=result%>")
     
     add_optional_param(:email_from_address, String)
-
+    
     add_optional_param(:email_to_address, String)
     
+    add_optional_param(:rotate_job_log, ConfigToolkit::Boolean, true)
+    
+    add_optional_param(:job_log_prepend_date_time, ConfigToolkit::Boolean, false)
+    
+    add_optional_param(:job_log_prepend_date_time_format, String, '%F_%T') do |value|
+      begin
+        DateTime.now.strftime(value)
+      rescue => e
+        raise_error("Invalid format #{e.message}")
+      end
+    end
+    
     def validate_all_values()
       if (self.central_log_mode == :file && !self.central_log_file?)
         raise_error("If central_log_mode is set to file, central_log_file must be specified.")

data/lib/jobmanager/applicationoptionparser.rb

@@ -22,7 +22,7 @@ module JobManager
     #      The command line arguments.
     # ====Returns:
     # A hash of the command line options and arugments.
-    #    
+    # 
     def self.parse(program_name, args)
       options = {}
       opts = OptionParser.new 
@@ -89,9 +89,23 @@ module JobManager
               "Timeout (in seconds) after which the script is killed.") do |timeout|
         options["timeout"] = timeout
       end
-            
+      
+      opts.on("-p", "--[no-]job_log_prepend_date_time", 
+              "Whether to prepend the date/time to each line of the job log file.") do |value|
+        options["job_log_prepend_date_time"] = value
+      end
+
+      opts.on("-g", "--job_log_prepend_date_time_format FORMAT",
+              "The format of the date/time to be prepended to each line of the job log file.") do |format|
+        options["job_log_prepend_date_time_format"] = format
+      end
+      
+      opts.on("-b", "--[no-]rotate_job_log", 
+              "Whether the job log file should be rotated.") do |value|
+        options["rotate_job_log"] = value
+      end
+      
       opts.on("-e", "--email_settings_file PATH",
-              String,
               "The configuration file for the simpleemail gem.",
               "Note: If a relative path is specified, it will be considered to be relative to the",
               "location of the configuration file.") do |file|
@@ -102,8 +116,8 @@ module JobManager
               "The email address from which jobmanager sends results.") do |address|
         options["email_from_address"] = address
       end
-
-      opts.on("-o", "--email_to_address ADDRESS", 
+      
+      opts.on("-u", "--email_to_address ADDRESS", 
               "The email address to which jobmanager sends results.") do |address|
         options["email_to_address"] = address
       end

data/lib/jobmanager/openonfirstwritefile.rb

@@ -0,0 +1,65 @@
+module JobManager
+
+  #
+  # This class represents a stream that wraps a file stream.
+  # Its only purpose is to defer the opening of the file to
+  # first write.  Thus, if the file is never written to, it
+  # is never created!
+  #
+  class OpenOnFirstWriteFile
+    
+    def initialize(file_name, mode_string)
+      @file_name = file_name
+      @mode_string = mode_string
+      @stream = nil
+    end
+    
+    def close()
+      # This method needs to be explicitly defined.  If it wasn't,
+      # method_missing would create the file in order to close it,
+      # defeating the purpose of this class.
+
+      if (@stream)
+        @stream.close()
+      end
+    end
+
+    def flush()
+      # This method needs to be explicitly defined.  If it wasn't,
+      # method_missing would create the file in order to flush it,
+      # defeating the purpose of this class.
+
+      if (@stream)
+        @stream.flush()
+      end
+    end
+    
+    #
+    # ====Description: 
+    # This method first opens the file (if not already opened), and then
+    # forwards the call to the file stream.
+    #
+    def method_missing(*args, &block)
+      method = args.shift
+      
+      if (!@stream)
+        directory = File.dirname(@file_name)
+        begin
+          FileUtils.mkdir_p(directory)
+        rescue => e
+          raise "Failed to create directory #{directory}, Error (#{e.class}): #{e.message}"
+        end
+
+        begin
+          @stream = File.new(@file_name, @mode_string)
+        rescue => e
+          raise "Failed to open file #{@file_name}, Error (#{e.class}): #{e.message}"
+        end
+      end
+      
+      @stream.send(method, *args)
+    end
+  end
+  
+end
+

data/lib/jobmanager/system.rb

@@ -62,6 +62,7 @@ module JobManager
       read_pipe, write_pipe = IO.pipe
       original_time = Time.now()
       success = false
+      job_log_write_success = true
       timeout = optional_args[:timeout]
       env_path = optional_args[:command_path] ? optional_args[:command_path] : ENV["PATH"]
 
@@ -122,7 +123,12 @@ module JobManager
           end
           
           if (bytes.length() > 0)
-            log_stream << bytes
+            begin
+              log_stream << bytes
+            rescue => e
+              logger.error("Error writing to job log: #{e.message}")
+              job_log_write_success = false
+            end
           end
         end
         
@@ -133,20 +139,21 @@ module JobManager
           if (Process.waitpid(child_pid, Process::WNOHANG))
             
             # success? will return nil if the child didn't exit normally
-            success = $CHILD_STATUS.success?() ? true : false;
+            child_success = $CHILD_STATUS.success?() ? true : false;
             pid = $CHILD_STATUS.pid()
             
-            if (success)
-              logger.info("Exited successfully")
+            if (child_success)
+              logger.info("Job exited successfully")
             else
               if ($CHILD_STATUS.exited?())
-                logger.error("Failed! - exited normally with exit code: #{$CHILD_STATUS.exitstatus()}.")
+                logger.error("Failed! - Job exited normally with exit code: #{$CHILD_STATUS.exitstatus()}.")
               elsif ($CHILD_STATUS.signaled?())
-                logger.error("Failed! - exited abnormally due to signal: #{$CHILD_STATUS.termsig()}.")
+                logger.error("Failed! - Job exited abnormally due to signal: #{$CHILD_STATUS.termsig()}.")
               else
-                logger.error("Failed! - exited abnormally: #{$CHILD_STATUS.inspect()}")
+                logger.error("Failed! - Job exited abnormally: #{$CHILD_STATUS.inspect()}")
               end
             end
+            success = child_success && job_log_write_success
             
             break
           else
@@ -213,7 +220,7 @@ module JobManager
         exit(1)
       end
     end
-
+    
 
     # 
     # ====Description: 

data/lib/jobmanager/teestream.rb

@@ -6,8 +6,10 @@ module JobManager
   # This class represents a stream whose only purpose is to forward
   # messages on to a list of configured streams.
   #
-  class TeeStream < IO
+  class TeeStream
     
+    attr_reader :streams
+
     # 
     # ====Description: 
     # This method creates an TeeStream instance initialized with the
@@ -30,49 +32,29 @@ module JobManager
     #      The name of the stream requested.
     # ====Returns:
     # The associated stream if it exists, nil otherwise
-    def get_stream(name)
+    def stream(name)
       @streams[name]
     end
     
-    # 
-    # ====Description: 
-    # This method forwards the string message to all configured
-    # streams.  Note: This class is derived from IO, and thus only
-    # needs to implement the write method in order for all of the
-    # write-related methods (<<, print, puts, putc, etc) to work free
-    # of charge, as all of these methods call write.
-    # ====Parameters:
-    # [str]
-    #      The string to be written.
-    # ====Returns:
-    # The length of the string.
-    #
-    def write(str)
-      @streams.each_value do |stream|
-        stream.write(str)
-      end   
+    def method_missing(*args, &block)
+      is_exception_saved = false
+      saved_name = nil
       
-      str.length
+      saved_e = nil
+      @streams.each do |name, stream|
+        begin
+          stream.send(*args)
+        rescue => saved_e
+          is_exception_saved = true
+          saved_name = name
+        end
+      end
+      
+      if (is_exception_saved)
+        @streams.delete(saved_name)
+        raise "Caught exception on stream #{saved_name}, Error (#{saved_e.class}): #{saved_e.message}"
+      end
     end
 
-    # 
-    # ====Description: 
-    # Flush all the configured streams.
-    #
-    def flush
-      @streams.each_value do |stream|
-        stream.flush()
-      end   
-    end
-    
-    # 
-    # ====Description: 
-    # Close all the configured streams.
-    #
-    def close
-      @streams.each_value do |stream|
-        stream.close()
-      end   
-    end
   end
 end

data/lib/jobmanager/timestampedstream.rb

@@ -0,0 +1,89 @@
+#!/usr/bin/env ruby
+
+require 'date'
+
+module JobManager
+
+  #
+  # This class represents a stream whose only purpose is to forward
+  # messages on to a list of configured streams.
+  #
+  class TimestampedStream < IO
+    
+    attr_reader :stream
+    # 
+    # ====Description: 
+    # This method creates an TeeStream instance initialized with the
+    # hash of streams passed in.  When a message is written to this
+    # stream, it will be forwarded to all hash values passed in.
+    # ====Parameters:
+    # [streams]
+    #      A hash table of stream name to stream.
+    #
+    def initialize(stream,
+                   date_time_format = "%F_%T")
+      @stream = stream
+      @date_time_format = date_time_format
+      @is_start_of_line = true
+    end
+    
+    # 
+    # ====Description: 
+    # This method forwards the string message to all configured
+    # streams.  Note: This class is derived from IO, and thus only
+    # needs to implement the write method in order for all of the
+    # write-related methods (<<, print, puts, putc, etc) to work free
+    # of charge, as all of these methods call write.
+    # ====Parameters:
+    # [str]
+    #      The string to be written.
+    # ====Returns:
+    # The length of the string.
+    #
+    def write(str)
+      if (str.length() == 0)
+        return 0
+      end
+      
+      str = str.dup()
+      now = DateTime.now().strftime(@date_time_format)
+      
+      # if string ends with a new line, strip it off and save it.
+      if (str.sub!(/\n\z/, ""))
+        ends_with_new_line = true
+      end
+      
+      # replace all of the new lines with a new line followed by the
+      # current date/time.
+      str.gsub!(/\n/, "\n#{now} ")
+      
+      if (@is_start_of_line)
+        str = "#{now} #{str}"
+        @is_start_of_line = false
+      end
+      
+      if (ends_with_new_line)
+        str += "\n"
+        @is_start_of_line = true
+      end
+
+      @stream.write(str)
+    end
+    
+    # 
+    # ====Description: 
+    # Flush all the configured streams.
+    #
+    def flush
+      @stream.flush()
+    end
+    
+    # 
+    # ====Description: 
+    # Close all the configured streams.
+    #
+    def close
+      @stream.close()
+    end
+  end
+end

data/test/configs/all_values.yaml

@@ -30,4 +30,10 @@ command: "echo hello"
 
 email_from_address: "sender_address@gmail.com"
 
-email_to_address: "receiver_address@gmail.com"
+email_to_address: "receiver_address@gmail.com"
+
+rotate_job_log: false
+
+job_log_prepend_date_time: true
+
+job_log_prepend_date_time_format: '%F'

data/test/configs/jobmanager_4_bad_job_logs_directory_1.yaml

@@ -4,6 +4,6 @@ central_log_mode: file
 
 central_log_file: temp/logs/jobmanager.log
 
-email_condition: on_failure
+email_condition: on_job_output_or_failure
 
 email_settings_file: email_settings.rb

data/test/configs/jobmanager_6.yaml

@@ -0,0 +1,9 @@
+job_logs_directory: temp/logs
+
+central_log_mode: file
+
+central_log_file: temp/logs/jobmanager.log
+
+email_condition: on_job_output_or_failure
+
+email_settings_file: email_settings.rb

data/test/configs/jobmanager_7_no_log_rotation.yaml

@@ -0,0 +1,15 @@
+job_logs_directory: temp/logs
+
+central_log_mode: file
+
+central_log_file: temp/logs/jobmanager.log
+
+rotate_job_log: false
+
+email_condition: on_job_output_or_failure
+
+email_settings_file: email_settings.rb
+
+job_log_prepend_date_time: true
+
+job_log_prepend_date_time_format: '%F'

data/test/test_applicationlogger.rb

@@ -1,5 +1,8 @@
 require 'jobmanager/applicationlogger.rb'
 
+require 'rubygems'
+require 'relative'
+
 require 'test/unit'
 require_relative('mock_syslog')
 require_relative('helpers')

data/test/test_config.rb

@@ -51,6 +51,9 @@ class ConfigTest < Test::Unit::TestCase
     assert_equal("echo hello", config.command)
     assert_equal("sender_address@gmail.com", config.email_from_address)
     assert_equal("receiver_address@gmail.com", config.email_to_address)
+    assert_equal(false, config.rotate_job_log)
+    assert_equal(true, config.job_log_prepend_date_time)
+    assert_equal("%F", config.job_log_prepend_date_time_format)
 
     result = 'Success'
     host_name = "jackfruit"
@@ -77,11 +80,13 @@ class ConfigTest < Test::Unit::TestCase
     assert_equal(nil, config.central_log_file)
     assert_equal("jobmanager results for <%=job_name%> on <%=host_name%> : <%=result%>", 
                  config.email_subject)
-        assert_equal(ENV['PATH'], config.command_path)
-
+    assert_equal(ENV['PATH'], config.command_path)
     assert_equal(nil, config.timeout)
     assert_equal(nil, config.email_to_address)
     assert_equal(nil, config.email_from_address)
+    assert_equal(true, config.rotate_job_log)
+    assert_equal(false, config.job_log_prepend_date_time)
+    assert_equal("%F_%T", config.job_log_prepend_date_time_format)    
   end
 
   def test_good_configs
@@ -101,7 +106,7 @@ class ConfigTest < Test::Unit::TestCase
     confirm_bad_config_throws_error("bad_number_of_job_logs.yaml", msg)
     
     msg = "error setting email_condition with value invalid: "
-    msg << "email_condition must be one of the following values: always, never, on_failure."
+    msg << "email_condition must be one of the following values: always, never, on_failure, on_job_output_or_failure."
     confirm_bad_config_throws_error("bad_email_condition.yaml", msg)
     
     msg = "JobManager::ApplicationConfig#validate_all_values error: "
@@ -140,25 +145,28 @@ class ConfigTest < Test::Unit::TestCase
     
     # match the config specified in all_values.yaml
     email_subject = "jobmanager results for <%=job_name%> on <%=host_name%> : <%=result%>"
-    args = [ "--job_name",                 "ze_echoer",
-             "--job_logs_directory",       "temp/logs",
-             "--email_condition",               "always",
-             "--central_log_mode",              "file",
-             "--central_log_file",              "temp/logs/jobmanager.log",
-             "--number_of_job_logs",       "4",
+    args = [ "--job_name",                         "ze_echoer",
+             "--job_logs_directory",               "temp/logs",
+             "--email_condition",                  "always",
+             "--central_log_mode",                 "file",
+             "--central_log_file",                 "temp/logs/jobmanager.log",
+             "--number_of_job_logs",               "4",
              "--date_time_extension",
-             "--date_time_extension_format",    "%F",
+             "--date_time_extension_format",       "%F",
              "--zip_rotated_log_file",
-             "--timeout",                       "1800",
-             "--email_settings_file",           "email_settings.rb",
-             "--email_from_address",            "sender_address@gmail.com",
-             "--email_to_address",              "receiver_address@gmail.com",
-             "--command_path",                  "/usr/designingpatterns/bin",
-             "--email_subject",                 email_subject,
+             "--timeout",                          "1800",
+             "--email_settings_file",              "email_settings.rb",
+             "--email_from_address",               "sender_address@gmail.com",
+             "--email_to_address",                 "receiver_address@gmail.com",
+             "--command_path",                     "/usr/designingpatterns/bin",
+             "--email_subject",                    email_subject,
+             "--no-rotate_job_log",
+             "--job_log_prepend_date_time",
+             "--job_log_prepend_date_time_format", "%F",
              "--debug",
              "echo hello"
            ]
-
+    
     hash = JobManager::ApplicationOptionParser.parse(program_name, args)
     config = JobManager::ApplicationConfig.load(ConfigToolkit::HashReader.new(hash))
     confirm_all_values(config)
@@ -185,12 +193,15 @@ class ConfigTest < Test::Unit::TestCase
     config_file = File.join(CONFIG_DIR, "incomplete_1.yaml")
     yaml_reader = ConfigToolkit::YAMLReader.new(config_file)
     
-    args = [ "--job_name",                 "ze_echoer",
-             "--email_to_address",              "receiver_address@gmail.com",
-             "--central_log_file",              "temp/logs/jobmanager.log",
-             "--email_settings_file",           "email_settings.rb",
-             "--timeout",                       "1800",
+    args = [ "--job_name",                         "ze_echoer",
+             "--email_to_address",                 "receiver_address@gmail.com",
+             "--central_log_file",                 "temp/logs/jobmanager.log",
+             "--email_settings_file",              "email_settings.rb",
+             "--timeout",                          "1800",
              "--zip_rotated_log_file",
+             "--no-rotate_job_log",
+             "--job_log_prepend_date_time",
+             "--job_log_prepend_date_time_format", "%F",
              "--debug",
              "echo hello" 
            ]