tellmewhen 1.0.1 → 1.0.2

data/README.textile

@@ -1,6 +1,6 @@
 h1. tellmewhen
 
-Tell me when another program has finshed.  Show me when it started, when it finished and how long it took.  Show me the output and if it errored.
+Tell me when another program has finshed.  Tell me when it started, tell when it finished.  Tell me how long it took.  Tell me the output and if it failed.
 
 I created this utility because I had long running database scripts that I wanted a completion notification for - including a summary of the time and exit code.  I had done this various ways in the past by using bash and other shell utilities.  This program captures all of the features and behavior I wanted without having to script it from scratch again every time I needed it.
 
@@ -9,18 +9,31 @@ I created this utility because I had long running database scripts that I wanted
 * sends email
 * includes start/stop/elapsed timing
 * success/fail based on exit code
-* watch an already running process (by pid, by grep pattern over 'ps aux')
-* release as a gem so it's easy to use/install
+* watch an already running process (by pid)
+* released as a gem so it's easy to use/install
+
+h1. Installation
+
+   gem install tellmewhen 
 
 h1. Configuration
 
 Configuration Defaults:
 
+<pre>
+  --- 
+  notify-via: email
+  email: 
+    from: `echo $LOGNAME`@`hostname
+    to: `echo $LOGNAME`@`hostname
+</pre>
+
 Configuration is then merged from @$HOME/.tellmewhenrc@ if the file exists in @$HOME@.  Configuration is also merged from @./.tellmewhenrc@ in the current directory, if the file exists.  This allows you some flexibility in overriding settings.
 
 h1. Usage
 
-pre. Usage: ./tellmewhen command args...
+<pre>
+Usage: ./tellmewhen command args...
     -v, --[no-]verbose               Run Verbosely.
     -c, --config=file                Use alternate configuration file.
     -p, --pid=pid                    Wait for <pid> to terminate.
@@ -28,14 +41,90 @@ pre. Usage: ./tellmewhen command args...
     -m, --modified=file              Wait for <file> to be modified.
     -t, --timeout=seconds            Wait for up to <seconds> seconds for the command before sendin a 'pending' notification.
     -w, --write-config=file          Write [fully merged] configuration to <file> (NB: will not be clobber).
-
+</pre>
 
 h1. Examples
 
-pre.    ./tellmewhen 'sleep 3; ls'
+<pre>
+    ./tellmewhen 'sleep 3; ls'
     ./tellmewhen -p 12345
     ./tellmewhen -e some-file.txt    # await existance
     ./tellmewhen -m some-file.txt    # await update
+</pre>
+
+You can also have 'pending' notifications so that you know things are still going:
+
+<pre>
+    ./tellmewhen -t 2 'sleep 5; ls'
+</pre>
+
+Produces 2 emails.  The pending mail is:
+
+<pre>
+Subject: When! [NOT] I'm _still_ waiting for sleep...
+Body:
+
+Just wanted to let you know that:
+
+   sleep 5; ls
+
+Is _STILL_ running on your-host.com, it has not exited.  You did want me to let you know didn't you?
+
+I started the darn thing at Tue Jan 25 23:25:01 -0500 2011 (1296015901) and it has taken a total of 3 seconds so far.
+
+Just thought you'd like to know.  I'll continue to keep watching what you asked me to. (boor-ring!)
+
+Cordially,
+
+Tellmewhen
+
+P.S. stderr says:
+--
+
+--
+
+P.S. stdout says:
+--
+
+--
+</pre>
+
+
+And a final mail when it completed:
+
+<pre>
+Subject: When! SUCCESS for sleep...
+Body:
+
+Just wanted to let you know that:
+
+     sleep 5; ls
+
+completed on your-host.com, with an exit code of: 0
+
+It started at Tue Jan 25 23:25:01 -0500 2011 (1296015901), finished at Tue Jan 25 23:25:06 -0500 2011 (1296015906) and took a total of 5 seconds.
+
+May your day continue to be full of win.
+
+Sincerely,
+
+Tellmewhen
+
+P.S. stderr says:
+--
+
+--
+
+P.S. stdout says:
+--
+README.textile
+Rakefile
+bin
+foo
+tellmewhen.gemspec
+
+--
+</pre>
 
 h1. Authors
 

data/bin/tellmewhen

@@ -15,6 +15,11 @@ class TellMeWhen
     @stderr_file = Tempfile.new('tellmewhen.stdout').path
   end
 
+
+  def max_bytes_to_read_from_file
+    8 * 1024
+  end
+
   def hostname
     `hostname`.chomp
   end
@@ -102,8 +107,8 @@ class TellMeWhen
     exit app.run args
   end
 
-  def elapsed_time
-    Time.now.to_i - @start_time.to_i
+  def elapsed_time since
+    Time.now.to_i - since.to_i
   end
 
   def wait_timeout
@@ -112,10 +117,12 @@ class TellMeWhen
 
   def wait_on_command args
     puts "Do run: #{args}"
+    @current_command = args.to_s
     if args.to_s.empty?
       raise "Error: you must supply a command to execute"
     end
     child_pid = Kernel.fork
+    last_check_time = Time.now
     if child_pid.nil?
       # in child
       STDOUT.reopen(File.open(@stdout_file, 'w+'))
@@ -132,7 +139,8 @@ class TellMeWhen
           child_exited = true
         end
         sleep(0.250)
-        if elapsed_time > wait_timeout
+        if elapsed_time(last_check_time) > wait_timeout.to_i
+          last_check_time = Time.now
           puts "Exceeded timeout #{wait_timeout}, sending 'pending' notificaiton"
           send_pending_notification
         end
@@ -148,7 +156,7 @@ Just wanted to let you know that:
 
 completed on #{hostname}, with an exit code of: #{@exit_status}
 
-It started at #{@start_time.to_s} (#{@start_time.to_i}), finished at #{@end_time.to_s} (#{@end_time.to_i}) and took a total of #{elapsed_time} seconds.
+It started at #{@start_time.to_s} (#{@start_time.to_i}), finished at #{@end_time.to_s} (#{@end_time.to_i}) and took a total of #{elapsed_time(@start_time)} seconds.
 
 May your day continue to be full of win.
 
@@ -168,7 +176,7 @@ Just wanted to let you know that:
 
 FAILED! on #{hostname}, with an exit code of: #{@exit_status}
 
-It started at #{@start_time.to_s} (#{@start_time.to_i}), finished at #{@end_time.to_s} (#{@end_time.to_i}) and took a total of #{elapsed_time} seconds to collapse in a steaming heap of failure.
+It started at #{@start_time.to_s} (#{@start_time.to_i}), finished at #{@end_time.to_s} (#{@end_time.to_i}) and took a total of #{elapsed_time(@start_time)} seconds to collapse in a steaming heap of failure.
 
 Have a nice day.
 
@@ -187,11 +195,11 @@ BODY
     body = <<-BODY
 Just wanted to let you know that:
 
-    #{args.to_s}
+    #{@current_command}
 
 Is _STILL_ running on #{hostname}, it has not exited.  You did want me to let you know didn't you?
 
-I started the darn thing at #{@start_time.to_s} (#{@start_time.to_i}) and it has taken a total of #{elapsed_time} seconds so far.
+I started the darn thing at #{@start_time.to_s} (#{@start_time.to_i}) and it has taken a total of #{elapsed_time(@start_time)} seconds so far.
 
 Just thought you'd like to know.  I'll continue to keep watching what you asked me to. (boor-ring!)
 
@@ -202,19 +210,19 @@ Tellmewhen
 #{email_footer}
 BODY
 
-    send_email_notification "When! [NOT] I'm _still_ waiting for #{args.split.first}...", body
+    send_email_notification "When! [NOT] I'm _still_ waiting for #{@current_command.split.first}...", body
   end
 
   def email_footer
     return <<-END
 P.S. stderr says:
 --
-#{File.read(@stderr_file)}
+#{File.read(@stderr_file,max_bytes_to_read_from_file)}
 --
 
 P.S. stdout says:
 --
-#{File.read(@stdout_file)}
+#{File.read(@stdout_file,max_bytes_to_read_from_file)}
 --
     END
   end
@@ -226,13 +234,16 @@ P.S. stdout says:
 
   def wait_on_pid args
     # wait until pid exits
+    @current_command = "wait on pid: #{@options[:pid]}"
+    last_check_time = Time.now
     while pid_running? @options[:pid]
       sleep 0.250
-      if elapsed_time > wait_timeout
+      if elapsed_time(last_check_time) > wait_timeout
+        last_check_time = Time.now
         puts "Exceeded timeout #{wait_timeout}, sending 'pending' notificaiton"
         send_email_notification "When! [NOT] still awaiting pid:#{pid} to exit", <<-END
 
-I started watching #{pid} on #{hostname} at #{@start_time.to_s} (#{@start_time.to_i}), I've been watching 'em for  #{elapsed_time} seconds so far.
+I started watching #{pid} on #{hostname} at #{@start_time.to_s} (#{@start_time.to_i}), I've been watching 'em for  #{elapsed_time(@start_time)} seconds so far.
 
 Awaiting it's demise,
 
@@ -245,7 +256,7 @@ TellMeWhen
 
     send_email_notification "When! pid:#{@options[:pid]} has come to its end", <<-END
 
-I started watching #{@options[:pid]} on #{hostname} at #{@start_time.to_s} (#{@start_time.to_i}), and now, after #{elapsed_time} seconds it has finally gone bellly up.  #{@options[:pid]} will rest in peace as of #{@end_time.to_s} (#{@end_time.to_i})
+I started watching #{@options[:pid]} on #{hostname} at #{@start_time.to_s} (#{@start_time.to_i}), and now, after #{elapsed_time(@start_time)} seconds it has finally gone bellly up.  #{@options[:pid]} will rest in peace as of #{@end_time.to_s} (#{@end_time.to_i})
 
 #{@options[:pid]} will be missed, it was a good little process.  :,)
 
@@ -255,13 +266,16 @@ TellMeWhen
   end
 
   def wait_on_file_exists args
+    @current_command = "wait on file exists: #{@options[:trigger_file]}"
+    last_check_time = Time.now
     while !File.exist? @options[:trigger_file]
       sleep 0.250
-      if elapsed_time > wait_timeout
+      if elapsed_time(last_check_time) > wait_timeout
+        last_check_time = Time.now
         puts "Exceeded timeout #{wait_timeout}, sending 'pending' notificaiton"
         send_email_notification "When! [NOT] still awaiting #{@options[:trigger_file]} to exist", <<-END
 
-I started watching for #{@options[:trigger_file]} on #{hostname} at #{@start_time.to_s} (#{@start_time.to_i}), I've been watching for it #{elapsed_time} seconds so far.
+I started watching for #{@options[:trigger_file]} on #{hostname} at #{@start_time.to_s} (#{@start_time.to_i}), I've been watching for it #{elapsed_time(@start_time)} seconds so far.
 
 Awaiting it's arrival,
 
@@ -273,7 +287,7 @@ TellMeWhen
 
     send_email_notification "When! #{@options[:trigger_file]} now exists.", <<-END
 
-I started watching for #{@options[:trigger_file]} on #{hostname} at #{@start_time.to_s} (#{@start_time.to_i}), and now, after #{elapsed_time} seconds it has finally shown up as of #{@end_time.to_s} (#{@end_time.to_i})
+I started watching for #{@options[:trigger_file]} on #{hostname} at #{@start_time.to_s} (#{@start_time.to_i}), and now, after #{elapsed_time(@start_time)} seconds it has finally shown up as of #{@end_time.to_s} (#{@end_time.to_i})
 
 What is thy next bidding my master?
 
@@ -282,16 +296,19 @@ TellMeWhen
   end
 
   def wait_on_file_modified args
+    @current_command = "wait on file modified: #{@options[:trigger_file]}"
     trigger_file = @options[:trigger_file]
     initial_mtime = File.mtime trigger_file
 
+    last_check_time = Time.now
     while initial_mtime == File.mtime(trigger_file)
       sleep 0.250
-      if elapsed_time > wait_timeout
+      if elapsed_time(last_check_time) > wait_timeout
+        last_check_time = Time.now
         puts "Exceeded timeout #{wait_timeout}, sending 'pending' notificaiton"
         send_email_notification "When! [NOT] still awaiting #{@options[:trigger_file]} to change", <<-END
 
-I started watching for #{@options[:trigger_file]} to be updated on #{hostname} at #{@start_time.to_s} (#{@start_time.to_i}), I've been watching for it #{elapsed_time} seconds so far.
+I started watching for #{@options[:trigger_file]} to be updated on #{hostname} at #{@start_time.to_s} (#{@start_time.to_i}), I've been watching for it #{elapsed_time(@start_time)} seconds so far.
 
 Awaiting it's update,
 
@@ -304,7 +321,7 @@ TellMeWhen
 
     send_email_notification "When! #{@options[:trigger_file]} was updated.", <<-END
 
-I started watching for #{@options[:trigger_file]} to be updated on #{hostname} at #{@start_time.to_s} (#{@start_time.to_i}), and now, after #{elapsed_time} seconds it has finally been modified as of #{@end_time.to_s} (#{@end_time.to_i})
+I started watching for #{@options[:trigger_file]} to be updated on #{hostname} at #{@start_time.to_s} (#{@start_time.to_i}), and now, after #{elapsed_time(@start_time)} seconds it has finally been modified as of #{@end_time.to_s} (#{@end_time.to_i})
 
 POSIX is my zen,
 
@@ -321,11 +338,21 @@ TellMeWhen
   end
 
   def send_email_notification subject, body
+    if @settings["email"]["method"] == "smtp"
+      send_email_notification_via_smtp subject, body
+    elsif @settings["email"]["method"] == "mailtools"
+      send_email_notification_via_mailtools subject, body
+    else
+      send_email_notification_via_smtp subject, body
+    end
+  end
+
+  def send_email_notification_via_smtp subject, body
     # optionally send via /usr/bin/mail or sendmail binary if it exists...
-    puts "Sending email: from:#{@settings["email"]["from"]} to:#{@settings["email"]["to"]}"
+    puts "[SMTP] Sending email: from:#{@settings["email"]["from"]} to:#{@settings["email"]["to"]}"
     begin
       Net::SMTP.start(smtp_host, smtp_port) do |smtp|
-        smtp.open_message_stream('from_addr', @settings["email"]["to"].split(',')) do |f|
+        smtp.open_message_stream(@settings["email"]["from"], @settings["email"]["to"].split(',')) do |f|
           f.puts "From: #{@settings["email"]["from"]}"
           f.puts "To: #{@settings["email"]["to"]}"
           f.puts "Subject: #{subject}"
@@ -335,7 +362,12 @@ TellMeWhen
       end
     end
   rescue Errno::ECONNREFUSED => e
+    send_email_notification_via_mailtools subject, body
+  end
+
+  def send_email_notification_via_mailtools subject, body
     if File.exist? "/usr/sbin/sendmail"
+      puts "[mailtools/sendmail] Sending email: from:#{@settings["email"]["from"]} to:#{@settings["email"]["to"]}"
       body_file = Tempfile.new("tellmewhen.mail.body")
       File.open(body_file.path,"w") do |f|
         f.puts "From: #{@settings["email"]["from"]}"
@@ -344,9 +376,11 @@ TellMeWhen
         f.puts ""
         f.write body
       end
+      puts "[sendmail] /usr/sbin/sendmail -f #{@settings["email"]["from"]} '#{@settings["email"]["to"]}' < #{body_file.path}"
+      #require 'ruby-debug'; debugger; 1;
       system "/usr/sbin/sendmail -f #{@settings["email"]["from"]} '#{@settings["email"]["to"]}' < #{body_file.path}"
     elsif File.exist? "/usr/bin/mail"
-      raise "Implement sending via /usr/bin/mail"
+      puts "[mailtools/mail] Sending email: from:#{@settings["email"]["from"]} to:#{@settings["email"]["to"]}"
       body_file = Tempfile.new("tellmewhen.mail.body")
       File.open(body_file.path,"w") do |f|
         f.puts "From: #{@settings["email"]["from"]}"

data/tellmewhen.gemspec

@@ -3,7 +3,7 @@ require 'rubygems'
 
 SPEC = Gem::Specification.new do |s|
   s.name = "tellmewhen"
-  s.version = "1.0.1"
+  s.version = "1.0.2"
   s.author = "Kyle Burton"
   s.email = "kyle.burton@gmail.com"
   s.platform = Gem::Platform::RUBY

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: tellmewhen
 version: !ruby/object:Gem::Version 
-  hash: 21
+  hash: 19
   prerelease: 
   segments: 
   - 1
   - 0
-  - 1
-  version: 1.0.1
+  - 2
+  version: 1.0.2
 platform: ruby
 authors: 
 - Kyle Burton
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-01-25 00:00:00 -05:00
+date: 2011-01-26 00:00:00 -05:00
 default_executable: 
 dependencies: []
 
@@ -39,6 +39,7 @@ extra_rdoc_files: []
 files: 
 - bin/tellmewhen
 - pkg/tellmewhen-1.0.0.gem
+- pkg/tellmewhen-1.0.1.gem
 - Rakefile
 - README.textile
 - tellmewhen.gemspec