priteau-vizir 0.1.2 → 0.2.0

data/README.rdoc

@@ -7,21 +7,23 @@ Ever been disconnected from Grid'5000 machines with a message like this, losing
 Vizir is a simple Ruby script that monitors your interactive jobs on Grid'5000[http://www.grid5000.fr/].
 It triggers Growl[http://growl.info/] notifications when your reservations are going to terminate, allowing you to save your work and/or your deployed environments.
 
-Vizir only supports Mac OS X for now.
+Vizir only supports Mac OS X.
 
 == Getting Started
 
 Run the following if you haven't already:
+
     $ gem sources -a http://gems.github.com
 
 Install the gem:
+
     $ sudo gem install priteau-vizir
 
-Configure Growl to accept notifications. Go to the Growl preference panel, and in the Network options enable "Listen for incoming notifications" and "Allow remote application registration". Don't forget to setup a password.
+Vizir uses HotCocoa to trigger Growl notifications. HotCocoa is shipped with Mac OS X 10.5, so it should work out of the box on Leopard.
 
-Run it in the background, using the <tt>--login</tt> switch with your Grid'5000 login name and the <tt>--password</tt> switch with your Growl password.
+Run Vizir in the background, using the <tt>--login</tt> switch with your Grid'5000 login name.
 
-    $ vizir --login priteau --password mygrowlpassword &
+    $ vizir --login priteau &
 
 == Getting the source
 

data/Rakefile

@@ -9,6 +9,7 @@ begin
     gem.email = "pierre.riteau@gmail.com"
     gem.homepage = "http://github.com/priteau/vizir"
     gem.authors = ["Pierre Riteau"]
+    gem.add_dependency "eventmachine"
     gem.add_dependency "json"
     gem.add_dependency "net-ssh-gateway"
     gem.add_dependency "rest-client"

data/VERSION

@@ -1 +1 @@
-0.1.2
+0.2.0

data/bin/vizir

@@ -1,16 +1,22 @@
-#!/usr/bin/env ruby -w
+#!/usr/bin/env ruby
 
+$:.unshift File.join(File.dirname(__FILE__), "..", "lib")
+
+require 'eventmachine'
+require 'growl'
 require 'json'
 require 'net/ssh/gateway'
 require 'optparse'
 require 'rest_client'
-require 'ruby-growl'
+require 'vizir'
 
-ALERT_TIME = 600
+FIRST_ALERT_TIME = 600
+ALERT_PERIOD = 60
+REFRESH_TIME = 3600
 IGNORE_SITES = ['grenoble-exp', 'grenoble-ext', 'grenoble-obs', 'luxembourg', 'portoalegre']
 
 def usage
-  puts 'usage: vizir [ -h | --help ] [ -l | --login login_name ] [ -p | --password mygrowlpassword ]'
+  puts 'usage: vizir [ -h | --help ] [ -l | --login login_name ]'
   exit 1
 end
 
@@ -38,63 +44,50 @@ def apiuri(port)
   return "https://localhost:#{port}/oargridapi"
 end
 
-def notify_via_growl(jobid, site_name, time, time_unit)
-  g = Growl.new("localhost", "Vizir", ["Job ending soon"], nil, $password)
-  g.notify("Job ending soon", "OAR job terminating soon", "Job #{jobid} in #{site_name} ending in #{time} #{time_unit}.")
+def setup_growl
+  $growl = Growl::Notifier.sharedInstance
+  $growl.register('Vizir', ['Job ending soon'])
 end
 
-def get_remaining_time(starttime, walltime)
-  remaining_sec = (Time.at(starttime + walltime) - Time.now).round
+def notify_via_growl(jobid, site_name, time, time_unit)
+  $growl.notify('Job ending soon', 'OAR job terminating soon', "Job #{jobid} in #{site_name} ending in #{time} #{time_unit}.")
 end
 
-def humanize_time(time)
-  if time > 60 then
-    remaining_time = time / 60
-    remaining_time_unit = "minutes"
-  else
-    remaining_time = time
-    remaining_time_unit = "seconds"
-  end
-  return remaining_time, remaining_time_unit
+def get_remaining_time(time)
+  return  (time - Time.now).round
 end
 
 $login = nil
-$password = nil
 opts = OptionParser.new
 opts.on('-h', '--help') { usage }
 opts.on('-l', '--login STRING', String) { |str| $login = str }
-opts.on('-p', '--password STRING', String) { |str| $password = str }
 opts.parse(ARGV)
 
-if $login == nil or $password == nil
+if $login == nil
   usage
 end
 
 gateway, port = setup_ssh_tunnel
 api = RestClient::Resource.new(apiuri(port))
+setup_growl
 
-sites = get(api, '/sites')
-if sites == nil then
-  exit 1
-end
-sites.each do |site|
-  site_name = site['site']
-  unless IGNORE_SITES.include?(site_name)
-    jobs = get(api, "#{site['uri']}/jobs")
-    if jobs == nil then
-      break
-    end
-    jobs.each do |job|
-      if job['owner'] == $login then
-        job_details = get(api, "#{job['uri']}")
-        if job_details == nil then
-          break
-        end
-        if job_details['jobType'] == 'INTERACTIVE' then
-          remaining_sec = get_remaining_time(Integer(job_details['startTime']), Integer(job_details['walltime']))
-          if remaining_sec < ALERT_TIME then
-            remaining_time, remaining_time_unit = humanize_time(remaining_sec)
-            notify_via_growl(job_details['Job_Id'], site_name.capitalize, remaining_time, remaining_time_unit)
+def learn_new_jobs(api)
+  $sites.each do |site|
+    site_name = site['site']
+    unless IGNORE_SITES.include?(site_name)
+      jobs = get(api, "#{site['uri']}/jobs")
+      break if jobs == nil
+      jobs.each do |job|
+        if job['owner'] == $login
+          job_details = get(api, "#{job['uri']}")
+          break if job_details == nil
+          if job_details['jobType'] == 'INTERACTIVE'
+            jobid = job_details['Job_Id']
+
+            # If we don't yet know the job, record it in $jobs
+            if $jobs[jobid].nil?
+              $jobs[jobid] = Vizir::Job.new(jobid, Time.at(Integer(job_details['startTime']) + Integer(job_details['walltime'])), site_name.capitalize)
+            end
           end
         end
       end
@@ -102,4 +95,42 @@ sites.each do |site|
   end
 end
 
+def first_ending_job
+  $jobs.sort{|a,b| a[1].end_time <=> b[1].end_time}.first
+end
+
+def alert_jobs(api)
+  $jobs.each do |jobid, job|
+    remaining_sec = get_remaining_time(job.end_time)
+    if remaining_sec < FIRST_ALERT_TIME
+      # Check if the job still exists before sending a notification
+      updatedjob = get(api, "/sites/#{job.site_name.downcase}/jobs/#{job.id}")
+      if updatedjob['state'] != 'Running'
+        # Job is not running anymore, remove it from the hash
+        $jobs.delete(jobid)
+        next
+      end
+      if remaining_sec < 0
+        $stderr.puts "Error: negative time"
+        next
+      end
+      remaining_time, remaining_time_unit = Vizir.humanize_time(remaining_sec)
+      notify_via_growl(jobid, job.site_name, remaining_time, remaining_time_unit)
+    end
+  end
+end
+
+# Learn the Grid'5000 sites
+$jobs = Hash.new
+$sites = get(api, '/sites')
+exit 1 if $sites == nil
+
+learn_new_jobs(api)
+alert_jobs(api)
+
+EventMachine::run {
+  EventMachine::PeriodicTimer.new(REFRESH_TIME) { learn_new_jobs(api) }
+  EventMachine::PeriodicTimer.new(ALERT_PERIOD) { alert_jobs(api) }
+}
+
 gateway.shutdown!

data/lib/vizir.rb

@@ -0,0 +1,29 @@
+module Vizir
+  def Vizir.humanize_time(time)
+    fail "Can't humanize negative period" if time < 0
+
+    if time >= 60
+      remaining_time = time / 60
+      remaining_time_unit = "minute"
+    else
+      remaining_time = time
+      remaining_time_unit = "second"
+    end
+
+    if remaining_time > 1
+      remaining_time_unit += "s"
+    end
+
+    return remaining_time, remaining_time_unit
+  end
+
+  class Job
+    attr_reader :id, :end_time, :site_name
+
+    def initialize(id, end_time, site_name)
+      @id = id
+      @end_time = end_time
+      @site_name = site_name
+    end
+  end
+end

data/test/test_helper.rb

@@ -1,6 +1,5 @@
 require 'rubygems'
 require 'test/unit'
-require 'shoulda'
 
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 $LOAD_PATH.unshift(File.dirname(__FILE__))

data/test/vizir_test.rb

@@ -1,7 +1,17 @@
 require 'test_helper'
 
 class VizirTest < Test::Unit::TestCase
-  should "probably rename this file and start testing for real" do
-    flunk "hey buddy, you should probably rename this file and start testing for real"
+  TIMES = [
+    [1,   [1,   "second"]],
+    [30,  [30,  "seconds"]],
+    [59,  [59,  "seconds"]],
+    [60,  [1,   "minute"]],
+    [120, [2,   "minutes"]]
+  ]
+  def test_humanize_time
+    TIMES.each do |seconds, result|
+      assert_equal(result, Vizir.humanize_time(seconds))
+    end
+    assert_raise(RuntimeError) { Vizir.humanize_time(-1) }
   end
 end

data/vizir.gemspec

@@ -2,11 +2,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{vizir}
-  s.version = "0.1.2"
+  s.version = "0.2.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Pierre Riteau"]
-  s.date = %q{2009-05-29}
+  s.date = %q{2009-06-01}
   s.default_executable = %q{vizir}
   s.email = %q{pierre.riteau@gmail.com}
   s.executables = ["vizir"]
@@ -43,17 +43,20 @@ Gem::Specification.new do |s|
     s.specification_version = 2
 
     if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<eventmachine>, [">= 0"])
       s.add_runtime_dependency(%q<json>, [">= 0"])
       s.add_runtime_dependency(%q<net-ssh-gateway>, [">= 0"])
       s.add_runtime_dependency(%q<rest-client>, [">= 0"])
       s.add_runtime_dependency(%q<ruby-growl>, [">= 0"])
     else
+      s.add_dependency(%q<eventmachine>, [">= 0"])
       s.add_dependency(%q<json>, [">= 0"])
       s.add_dependency(%q<net-ssh-gateway>, [">= 0"])
       s.add_dependency(%q<rest-client>, [">= 0"])
       s.add_dependency(%q<ruby-growl>, [">= 0"])
     end
   else
+    s.add_dependency(%q<eventmachine>, [">= 0"])
     s.add_dependency(%q<json>, [">= 0"])
     s.add_dependency(%q<net-ssh-gateway>, [">= 0"])
     s.add_dependency(%q<rest-client>, [">= 0"])

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: priteau-vizir
 version: !ruby/object:Gem::Version 
-  version: 0.1.2
+  version: 0.2.0
 platform: ruby
 authors: 
 - Pierre Riteau
@@ -9,9 +9,19 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-05-29 00:00:00 -07:00
+date: 2009-06-01 00:00:00 -07:00
 default_executable: vizir
 dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: eventmachine
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
 - !ruby/object:Gem::Dependency 
   name: json
   type: :runtime