jobmanager 1.0.1 → 1.1.0

data/test/test_jobmanager.rb

@@ -20,7 +20,7 @@ require 'jobmanager'
 
 require 'test/unit'
 require_relative('helpers')
-require 'mock_syslog'
+require_relative('mock_syslog')
 
 #
 # This class essentially tests the bin/jobmanager application since
@@ -60,7 +60,8 @@ class TestJobManager < Test::Unit::TestCase
   # echo command.  Confirm the output logs produced (the job log file
   # and the central log file).  Also, confirm that the job logs are
   # properly rotated.
-  def test_jobmanager_1
+  def test_jobmanager_1_rotate_logs
+    
     config_file = File.join(CONFIG_DIR, "jobmanager_1.yaml")
     config = File.open(config_file) { |fs| YAML::load(fs) }
     
@@ -89,7 +90,7 @@ class TestJobManager < Test::Unit::TestCase
       print jobmanager_log_contents, "\n"
       
       lines = jobmanager_log_contents.split("\n")
-      assert_match(/^I, .* INFO .* \[#{USER_NAME}, echo\] Exited successfully$/, lines[1])
+      assert_match(/^I, .* INFO .* \[#{USER_NAME}, echo\] Job exited successfully$/, lines[1])
       
       lines.each { |line| assert_no_match(/^ERROR/, line) }
       
@@ -117,7 +118,8 @@ class TestJobManager < Test::Unit::TestCase
   # log central log information via syslog, which has been mocked out
   # for testing purposes.  Confirm the email generated is correct, and
   # that the job log is properly rotated and zipped.
-  def test_jobmanager_2
+  def test_jobmanager_2_syslog
+    
     config_file = File.join(CONFIG_DIR, "jobmanager_2.yaml")
     command_line_args = [ "-j", "ze_echoer",
                           "echo 1" 
@@ -127,7 +129,8 @@ class TestJobManager < Test::Unit::TestCase
     # JobManager::Application class will also load the configuration
     # separately).
     yaml_reader = ConfigToolkit::YAMLReader.new(config_file)
-    command_parameters_hash = JobManager::ApplicationOptionParser.parse(PROGRAM_NAME, command_line_args.dup())
+    command_parameters_hash = JobManager::ApplicationOptionParser.parse(PROGRAM_NAME, 
+                                                                        command_line_args.dup())
     hash_reader = ConfigToolkit::HashReader.new(command_parameters_hash)
     override_reader = ConfigToolkit::OverrideReader.new(yaml_reader, hash_reader)
     config = JobManager::ApplicationConfig.load(override_reader)
@@ -168,7 +171,7 @@ class TestJobManager < Test::Unit::TestCase
     print jobmanager_log_contents, "\n"
     
     lines = jobmanager_log_contents.split("\n")
-    assert_match(/INFO \[#{USER_NAME}, ze_echoer\] Exited successfully$/, lines[1])
+    assert_match(/INFO \[#{USER_NAME}, ze_echoer\] Job exited successfully$/, lines[1])
     lines.each { |line| assert_no_match(/ERROR/, line) }
     
     # confirm the correctness of the job log file.
@@ -194,7 +197,7 @@ class TestJobManager < Test::Unit::TestCase
 
     assert_equal("jobmanager results for job ze_echoer, command echo 1, user janet, host #{HOST_NAME}, result Success",
                  delivery.subject)
-    assert_match(/^INFO \[#{USER_NAME}, ze_echoer\] Exited successfully$/, delivery.body)
+    assert_match(/^INFO \[#{USER_NAME}, ze_echoer\] Job exited successfully$/, delivery.body)
   end
   
   # test config w/ email + date extensions, command that exists but fails
@@ -203,9 +206,9 @@ class TestJobManager < Test::Unit::TestCase
   # a bogus file, which will cause the command to fail.  Confirm the
   # output logs produced (the job log file and the central log) are
   # correct.  Confirm the email generated is correct.
-  def test_jobmanager_3
+  def test_jobmanager_3_job_failure
+
     config_file = File.join(CONFIG_DIR, "jobmanager_3.yaml")
-    config = File.open(config_file) { |fs| YAML::load(fs) }
     
     assert(JobManager::System.which("cat"))
     args = [ "cat #{TEMP_DIR}/no_file" ]
@@ -222,7 +225,7 @@ class TestJobManager < Test::Unit::TestCase
     print jobmanager_log_contents, "\n"
     
     lines = jobmanager_log_contents.split("\n")
-    assert_match(/^ERROR \[janet, cat\] Failed! - exited normally with exit code:/, jobmanager_log_contents)
+    assert_match(/^ERROR \[janet, cat\] Failed! - Job exited normally with exit code:/, jobmanager_log_contents)
     lines.each { |line| assert_no_match(/Exited successfully/, line) }
     
     # confirm the email generated is correct.
@@ -232,35 +235,111 @@ class TestJobManager < Test::Unit::TestCase
     delivery = deliveries[0]
     
     assert_equal("jobmanager results for cat : Failure", delivery.subject)
-    assert_match(/^ERROR \[#{USER_NAME}, cat\] Failed! - exited normally with exit code:/, 
-                 delivery.body)
-    
+    assert_match(/^ERROR \[#{USER_NAME}, cat\] Failed! - Job exited normally with exit code:/, 
+                 delivery.body)    
   end
 
   #
-  # Test the following error cases:
-  # 1) The central log file can't be created/opened.
-  # 2) The email results file can't be created/opened.
-  # 3) The job logs directory can't be created.
-  # 4) The job logs directory exists but is permissioned such that a file can't be created inside.
-  # 
+  # Test the following exception cases:
+  # 1) The central log file can't be created/opened (The job will not be started).
+  # 2) The email settings file can't be opened (The job will not be started).
+  #
   def test_jobmanager_exceptions()
     jobmanager_exception_bad_central_log_file()  
     teardown(); setup();
 
     jobmanager_exception_bad_email_settings_file()
     teardown(); setup();
+  end
 
-    jobmanager_exception_bad_job_logs_directory_1()
-    teardown(); setup();
+  #
+  # In this test case, the job produces no output and should complete successfully.
+  # 1) Verify that no job log file will be created.
+  # 2) Verify that no email will be sent (email_condition = on_job_output_or_failure).
+  #
+  def test_jobmanager_6_no_job_output()
+
+    config_file = File.join(CONFIG_DIR, "jobmanager_6.yaml")
+    
+    jobmanager = JobManager::Application.new(PROGRAM_NAME, 
+                                             args = [ "ls > /dev/null" ],
+                                             config_file,
+                                             INTERACTIVE_SHELL_OVERRIDE)
+      
+    jobmanager.run()
+    
+    jobmanager_log_contents = File.read("temp/logs/jobmanager.log")
+    
+    print "\nJob Manager Log Contents #6 (jobmanager_6.yaml):\n"
+    print jobmanager_log_contents, "\n"
+    
+    lines = jobmanager_log_contents.split("\n")
+    assert_match(/^I, .* : \[#{USER_NAME}, ls\] Job exited successfully/, 
+                 lines[1])
+    
+    # confirm that no job log files exist
+    assert_equal(0, Dir.glob("temp/logs/ls*").length)
+    
+    # confirm that no email was generated (as email_condition == on_job_output_or_failure)
+    deliveries = ActionMailer::Base.deliveries
+    assert_equal(0, deliveries.length)
+  end
+
+  #
+  # In this test, the job should succeed and produce output.  Test that
+  # 1) The job log is not rotated
+  # 2) No email is sent out (email_condition = on_job_output_or_failure, job_output is not empty)
+  #
+  def test_jobmanager_7_no_log_rotation()
+    config_file = File.join(CONFIG_DIR, "jobmanager_7_no_log_rotation.yaml")
+    
+    jobmanager = JobManager::Application.new(PROGRAM_NAME, 
+                                             args = [ "echo hello" ],
+                                             config_file,
+                                             INTERACTIVE_SHELL_OVERRIDE)
+      
+    jobmanager.run()
+    
+    jobmanager_log_contents = File.read("temp/logs/jobmanager.log")
+    
+    print "\nJob Manager Log Contents #7 (jobmanager_7_no_log_rotation.yaml):\n"
+    print jobmanager_log_contents, "\n"
+    
+    lines = jobmanager_log_contents.split("\n")
+    assert_match(/^I, .* : \[#{USER_NAME}, echo\] Job exited successfully/, 
+                 lines[1])
+    
+    # confirm that the job log file was not rotated
+    job_log_files = Dir.glob("temp/logs/echo*")
+    assert_equal(1, job_log_files.length)
+    expected_job_log_file = "temp/logs/echo.log"
+    assert_equal(expected_job_log_file, job_log_files[0])
+
+    job_log_contents = File.read(expected_job_log_file)
+    print "\nJob Log Contents:\n"
+    print job_log_contents, "\n"
 
-    jobmanager_exception_bad_job_logs_directory_2()
+    # confirm that the date was prepended to each line in the job log
+    job_log_contents.each do |line|
+      assert_match(/^\d{4}-\d{2}-\d{2} hello/, line)
+    end
+    
+    # confirm that an email was generated (email_condition == on_job_output_or_failure)
+    deliveries = ActionMailer::Base.deliveries
+    assert_equal(1, deliveries.length)
     
+    # confirm the contents of the email
   end
+
   
-  # In this test case, the job logs directory can't be created.
-  # Test that the error is properly raised, logged, and emailed.
-  def jobmanager_exception_bad_job_logs_directory_1()
+  #
+  # In this test case, the job logs directory can't be created.  The job will still be
+  # started.  Verify that 
+  # 1) the job runs to completion, exits successfully
+  # 2) the error is properly logged to the central log file
+  # 3) the error is properly reported via email (email_condition == on_job_output_or_failure, job_output == empty string)
+  #
+  def test_jobmanager_4_bad_job_logs_directory()
     
     # Permission the directory so that the central log file can't be created inside this directory.
     FileUtils.mkdir_p("#{TEMP_DIR}/permissioned_directory")
@@ -268,14 +347,12 @@ class TestJobManager < Test::Unit::TestCase
     
     config_file = File.join(CONFIG_DIR, "jobmanager_4_bad_job_logs_directory_1.yaml")
     
-    assert_raise_message("Error creating job_logs_directory", JobManager::Application::ComposedError) do
-      jobmanager = JobManager::Application.new(PROGRAM_NAME, 
-                                               args = [ "ls" ],
-                                               config_file,
-                                               INTERACTIVE_SHELL_OVERRIDE)
+    jobmanager = JobManager::Application.new(PROGRAM_NAME, 
+                                             args = [ "ls" ],
+                                             config_file,
+                                             INTERACTIVE_SHELL_OVERRIDE)
       
-      jobmanager.run()
-    end
+    jobmanager.run()
     
     # return the permissions
     FileUtils.chmod(0755, "#{TEMP_DIR}/permissioned_directory")
@@ -289,8 +366,8 @@ class TestJobManager < Test::Unit::TestCase
     print jobmanager_log_contents, "\n"
 
     lines = jobmanager_log_contents.split("\n")
-    assert_match(/^E, .* : \[#{USER_NAME}, ls\] Error creating job_logs_directory: Error \(Errno::EACCES\): Permission denied - temp\/permissioned_directory\/job_logs_directory/, 
-                 lines[0])
+    assert_match(/^E, .* : \[#{USER_NAME}, ls\] Error writing to job log: .* Failed to create directory temp\/permissioned_directory\/job_logs_directory/, 
+                 lines[1])
 
     # confirm the email generated is correct.
     deliveries = ActionMailer::Base.deliveries
@@ -299,30 +376,32 @@ class TestJobManager < Test::Unit::TestCase
     delivery = deliveries[0]
     
     assert_equal("jobmanager results for ls on #{HOST_NAME} : Failure", delivery.subject)
-    assert_match(/^E, .* : \[#{USER_NAME}, ls\] Error creating job_logs_directory: Error \(Errno::EACCES\): Permission denied - temp\/permissioned_directory\/job_logs_directory/,
+    
+    # confirm that the job completed successfully
+    assert_match(/: \[#{USER_NAME}, ls\] Job exited successfully/, delivery.body)
+    
+    # confirm that the failure to write to the job log file was recorded in the email
+    assert_match(/E, .* : \[#{USER_NAME}, ls\] Error writing to job log: .* Failed to create directory temp\/permissioned_directory\/job_logs_directory/,
                  delivery.body)
-
   end  
 
-
   # In this test case, the job logs directory exists but permissions prevent a job log from being created.
   # Test that the error is properly raised, logged, and emailed.
-  def jobmanager_exception_bad_job_logs_directory_2()
+  def test_jobmanager_5_bad_job_log_file()
     
     # Permission the directory so that the central log file can't be created inside this directory.
     FileUtils.mkdir_p("#{TEMP_DIR}/permissioned_directory")
     FileUtils.chmod(0000, "#{TEMP_DIR}/permissioned_directory")
     
-    config_file = File.join(CONFIG_DIR, "jobmanager_4_bad_job_logs_directory_2.yaml")
+    config_file = File.join(CONFIG_DIR, "jobmanager_5_bad_job_log_file.yaml")
     
-    assert_raise_message("Error opening job log file", JobManager::Application::ComposedError) do
-      jobmanager = JobManager::Application.new(PROGRAM_NAME, 
-                                               args = [ "ls" ],
-                                               config_file,
-                                               INTERACTIVE_SHELL_OVERRIDE)
-      
-      jobmanager.run()
-    end
+    args = [ "echo hello" ]
+    jobmanager = JobManager::Application.new(PROGRAM_NAME, 
+                                             args,
+                                             config_file,
+                                             INTERACTIVE_SHELL_OVERRIDE)
+    
+    jobmanager.run()
     
     # return the permissions
     FileUtils.chmod(0755, "#{TEMP_DIR}/permissioned_directory")
@@ -332,12 +411,12 @@ class TestJobManager < Test::Unit::TestCase
     
     jobmanager_log_contents = File.read("temp/logs/jobmanager.log")
     
-    print "\nJob Manager Log Contents #4 (jobmanager_4_bad_job_logs_directory_2.yaml):\n"
+    print "\nJob Manager Log Contents #5 (jobmanager_5_bad_job_log_file.yaml):\n"
     print jobmanager_log_contents, "\n"
-
+    
     lines = jobmanager_log_contents.split("\n")
-    assert_match(/^E, .* : \[#{USER_NAME}, ls\] Error opening job log file: Error \(Errno::EACCES\): Permission denied - temp\/permissioned_directory\/ls\.log/, 
-                 lines[0])
+    assert_match(/^E, .* : \[#{USER_NAME}, echo\] Error writing to job log: .* Failed to open file temp\/permissioned_directory\/echo.log/,
+                 lines[1])
 
     # confirm the email generated is correct.
     deliveries = ActionMailer::Base.deliveries
@@ -345,10 +424,10 @@ class TestJobManager < Test::Unit::TestCase
     
     delivery = deliveries[0]
     
-    assert_equal("jobmanager results for ls on #{HOST_NAME} : Failure", delivery.subject)
-    assert_match(/^E, .* : \[#{USER_NAME}, ls\] Error opening job log file: Error \(Errno::EACCES\): Permission denied - temp\/permissioned_directory\/ls\.log/,
+    assert_equal("jobmanager results for echo on #{HOST_NAME} : Failure", delivery.subject)
+    assert_match(/^E, .* : \[#{USER_NAME}, echo\] Error writing to job log: .* Failed to open file temp\/permissioned_directory\/echo.log/,
                  delivery.body)
-
+    
   end  
   
   
@@ -356,11 +435,6 @@ class TestJobManager < Test::Unit::TestCase
   # Test that the error is properly raised, logged, and not emailed.
   def jobmanager_exception_bad_email_settings_file()
     
-    # Permission the directory so that the central log file can't be
-    # created inside this directory.
-    FileUtils.mkdir_p("#{TEMP_DIR}/permissioned_directory")
-    FileUtils.chmod(0000, "#{TEMP_DIR}/permissioned_directory")
-    
     config_file = File.join(CONFIG_DIR, "jobmanager_4_bad_email_settings_file.yaml")
     
     assert(JobManager::System.which("cat"))
@@ -374,9 +448,6 @@ class TestJobManager < Test::Unit::TestCase
       jobmanager.run()
     end
 
-    # return the permissions
-    FileUtils.chmod(0755, "#{TEMP_DIR}/permissioned_directory")
-    
     # confirm correctness of syslog.
     jobmanager_log_contents = $test_syslog_logger.string()
     

data/test/test_openonfirstwritefile.rb

@@ -0,0 +1,71 @@
+#!/usr/bin/env ruby
+
+require 'jobmanager/openonfirstwritefile'
+
+require 'rubygems'
+require 'relative'
+require 'assertions'
+
+require 'test/unit'
+require_relative('helpers')
+
+class OpenOnFirstWriteFileTest < Test::Unit::TestCase
+  include TestHelpers
+
+  TEST_FILE = "#{TEMP_DIR}/test.dat"
+  def setup
+    teardown()
+    FileUtils.mkdir_p(TEMP_DIR)
+  end
+  
+  def teardown
+    FileUtils::rm_r(TEMP_DIR, :force => true)
+  end
+  
+  def test_success
+    # if the file stream isn't written to, the file should never be created
+    fs = JobManager::OpenOnFirstWriteFile.new(TEST_FILE, "w")
+    fs.flush()
+    fs.close()
+    assert_equal(false, File.file?(TEST_FILE))
+
+    # confirm that writing to the file works as expected
+    contents = "1.\n"
+    fs = JobManager::OpenOnFirstWriteFile.new(TEST_FILE, "w")
+    fs << contents
+    fs.close()
+    assert_equal(contents, File.read(TEST_FILE))    
+  end
+
+  def test_failure
+    # permission a directory such that files and directories can not be created 
+    # within it
+    permissioned_directory = "#{TEMP_DIR}/permissioned_directory"
+    FileUtils.mkdir_p(permissioned_directory)
+    FileUtils.chmod(0000, permissioned_directory)
+
+    # confirm that an exception is thrown if the file can not be created
+    test_file = File.join(permissioned_directory, "test.dat")
+    contents = "1.\n"
+    fs = JobManager::OpenOnFirstWriteFile.new(test_file, "w")
+
+    error_message = "Failed to open file temp/permissioned_directory/test.dat, Error (Errno::EACCES): Permission denied - temp/permissioned_directory/test.dat"
+    assert_raise_message(error_message, RuntimeError) do
+      fs << contents
+    end
+    
+    # confirm that an exception is thrown if the file's containing directory can
+    # not be created.
+    test_file = "#{permissioned_directory}/sub_dir/test.dat"
+    contents = "1.\n"
+    fs = JobManager::OpenOnFirstWriteFile.new(test_file, "w")
+    
+    error_message = "Failed to create directory temp/permissioned_directory/sub_dir, Error (Errno::EACCES): Permission denied - temp/permissioned_directory/sub_dir"
+    assert_raise_message(error_message, RuntimeError) do
+      fs << contents
+    end
+
+    # return the permissions
+    FileUtils.chmod(0755, "#{TEMP_DIR}/permissioned_directory")
+  end
+end

data/test/test_system.rb

@@ -98,7 +98,7 @@ class TestSystem < Test::Unit::TestCase
     
     assert_equal(false, success)
     
-    assert_match(/ERROR \[#{USER_NAME}, catter\] Failed! - exited normally with exit code:/,
+    assert_match(/ERROR \[#{USER_NAME}, catter\] Failed! - Job exited normally with exit code:/,
                  control_log_lines[-1])
   end
   
@@ -145,7 +145,7 @@ class TestSystem < Test::Unit::TestCase
     assert_equal(true, success)
     assert_equal(EXPECTED_SAMPLE_CONTENTS, log_stream.string())
     
-    assert_match(/INFO \[#{USER_NAME}, catter\] Exited successfully/,
+    assert_match(/INFO \[#{USER_NAME}, catter\] Job exited successfully/,
                  control_log_lines[-1])
   end
   
@@ -199,7 +199,7 @@ class TestSystem < Test::Unit::TestCase
     
     assert_equal(false, success)
     
-    assert_match(/ERROR \[#{USER_NAME}, catter\] Failed! - exited abnormally due to signal:/,
+    assert_match(/ERROR \[#{USER_NAME}, catter\] Failed! - Job exited abnormally due to signal:/,
                  control_log_lines[-1])
   end
 end

data/test/test_teestream.rb

@@ -5,12 +5,23 @@ require 'fileutils'
 
 require 'rubygems'
 require 'relative'
+require 'assertions'
 
 require 'jobmanager/teestream'
 
 require 'test/unit'
 require_relative('helpers')
 
+class BogusStream
+  def initialize(error_message)
+    @error_message = error_message
+  end
+  
+  def << (str)
+    raise @error_message
+  end
+end
+
 #
 # This class tests the JobManager::TeeStream class.
 #
@@ -28,7 +39,7 @@ class TestTeeStream < Test::Unit::TestCase
     FileUtils::rm_r(TEMP_DIR, :force => true)
   end
   
-  def test_case
+  def test_basic
     string_io = StringIO.new
     
     file_name = File.join(TEMP_DIR, "output.dat")
@@ -42,14 +53,46 @@ class TestTeeStream < Test::Unit::TestCase
     tee_stream.print "5\n"
     
     tee_stream.flush
+    
+    str_string_io = tee_stream.stream(:string_io).string
     tee_stream.close
     
-    str_string_io = string_io.string
     str_file = IO.read(file_name)
     expected = "1\n2\n3\n4\n5\n"
     
+    assert_equal(expected, string_io.string)
     assert_equal(expected, str_string_io)
     assert_equal(expected, str_file)
   end
+
+  def test_bad_stream
+    string_io = StringIO.new
+    bogus_stream_error = "Failed to Open Stream!"
+    bogus_stream = BogusStream.new(bogus_stream_error)
+    
+    tee_stream = JobManager::TeeStream.new(:string_io => string_io,
+                                           :bogus_stream => bogus_stream)
+    
+    1.upto(5) do |iteration|
+      
+      if (iteration == 1)
+        error_message = "Caught exception on stream bogus_stream, Error (RuntimeError): #{bogus_stream_error}"
+        assert_raise_message(error_message, RuntimeError) do
+          tee_stream << "#{iteration}\n"
+        end
+      else
+        tee_stream << "#{iteration}\n"
+      end
+      
+    end
+    tee_stream.flush
+    
+    str_string_io = tee_stream.stream(:string_io).string
+    tee_stream.close
+    
+    expected = "1\n2\n3\n4\n5\n"
+    assert_equal(tee_stream.streams().length(), 1)
+    assert_equal(expected, str_string_io)
+  end
   
 end