priteau-vizir 0.2.2 → 0.2.3

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.rubyforge_project = "vizir"
     gem.add_dependency "eventmachine"
     gem.add_dependency "growlnotifier"
     gem.add_dependency "json"
@@ -17,6 +18,7 @@ begin
     # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
   end
 
+  Jeweler::RubyforgeTasks.new
 rescue LoadError
   puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
 end
@@ -24,7 +26,7 @@ end
 require 'rake/testtask'
 Rake::TestTask.new(:test) do |test|
   test.libs << 'lib' << 'test'
-  test.pattern = 'test/**/*_test.rb'
+  test.pattern = 'test/**/test_*.rb'
   test.verbose = true
 end
 
@@ -32,7 +34,7 @@ begin
   require 'rcov/rcovtask'
   Rcov::RcovTask.new do |test|
     test.libs << 'test'
-    test.pattern = 'test/**/*_test.rb'
+    test.pattern = 'test/**/test_*.rb'
     test.verbose = true
   end
 rescue LoadError

data/VERSION

@@ -1 +1 @@
-0.2.2
+0.2.3

data/bin/vizir

@@ -4,43 +4,13 @@ $:.unshift File.join(File.dirname(__FILE__), "..", "lib")
 
 require 'eventmachine'
 require 'growl'
-require 'json'
 require 'net/ssh/gateway'
 require 'optparse'
 require 'rest_client'
 require 'vizir'
 
-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 ]'
-  exit 1
-end
-
-def get(api, uri)
-  begin
-    return JSON.parse(api[uri + '?structure=simple'].get(:accept => 'application/json'))
-  rescue RestClient::RequestTimeout => e
-    # This should really be elsewhere, but will do for now
-    # Were we querying a specific site? If yes, remove it from $sites
-    if uri =~ /\/sites\/(\w+)/
-      $sites.delete_if { |site| site['site'] == "#{$1}" }
-    else
-      raise e
-    end    
-  rescue => e
-    if e.respond_to?('http_code')
-      puts "Error: #{e.http_code}:\n #{e.response.body}"
-      return nil
-    else
-      puts e.inspect
-      exit 1
-    end
-  end
-end
+$alert_period = 60
+$refresh_period = 3600
 
 def setup_ssh_tunnel
   gateway = Net::SSH::Gateway.new('access.grenoble.grid5000.fr', $login)
@@ -58,87 +28,47 @@ def setup_growl
 end
 
 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 get_remaining_time(time)
-  return  (time - Time.now).round
+  $growl.notify('Job ending soon', 'OAR job terminating soon', "Job #{jobid} in #{site_name} ending in #{time} #{time_unit}.", :sticky => true)
 end
 
 $login = nil
-opts = OptionParser.new
-opts.on('-h', '--help') { usage }
-opts.on('-l', '--login STRING', String) { |str| $login = str }
-opts.parse(ARGV)
-
-if $login == nil
-  usage
-end
 
-gateway, port = setup_ssh_tunnel
-api = RestClient::Resource.new(apiuri(port))
-setup_growl
+opts = OptionParser.new do |opts|
+  opts.banner = "Usage: vizir [options]"
+  opts.separator("")
 
-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
-    end
+  opts.separator("Options:")
+  opts.on('-a', '--alert-period TIME', Integer, "Job alert period (seconds), default: #{$alert_period}") { |t| $alert_period = t }
+  opts.on('-h', '--help', 'Print help') do
+    puts opts
+    exit
   end
+  opts.on('-l', '--login LOGIN', String, "User login on Grid\'5000") { |str| $login = str }
+  opts.on('-m', '--min-job-time TIME', Integer, "Minimum job time (seconds), default: #{$refresh_period}") { |t| $refresh_period = t }
 end
 
-def first_ending_job
-  $jobs.sort{|a,b| a[1].end_time <=> b[1].end_time}.first
-end
+opts.parse!(ARGV)
 
-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
+if $login == nil
+  puts opts
+  exit
 end
 
+gateway, port = setup_ssh_tunnel
+api = Vizir.get_api(apiuri(port))
+setup_growl
+
 # Learn the Grid'5000 sites
 $jobs = Hash.new
-$sites = get(api, '/sites')
+$sites = Vizir.learn_sites(api, Vizir::IGNORED_SITES)
 exit 1 if $sites == nil
 
-learn_new_jobs(api)
-alert_jobs(api)
+Vizir.learn_new_jobs(api)
+Vizir.alert_jobs(api)
 
 EventMachine::run {
-  EventMachine::PeriodicTimer.new(REFRESH_TIME) { learn_new_jobs(api) }
-  EventMachine::PeriodicTimer.new(ALERT_PERIOD) { alert_jobs(api) }
+  EventMachine::PeriodicTimer.new($refresh_period) { Vizir.learn_new_jobs(api) }
+  EventMachine::PeriodicTimer.new($alert_period) { Vizir.alert_jobs(api) }
 }
 
 gateway.shutdown!

data/lib/vizir.rb

@@ -1,4 +1,11 @@
+require 'json'
+require 'restclient'
+
 module Vizir
+  APIURL = "https://localhost:8080/oargridapi"
+  IGNORED_SITES = ['grenoble-exp', 'grenoble-ext', 'grenoble-obs', 'luxembourg', 'portoalegre']
+  FIRST_ALERT_TIME = 600
+
   def Vizir.humanize_time(time)
     fail "Can't humanize negative period" if time < 0
 
@@ -17,6 +24,90 @@ module Vizir
     return remaining_time, remaining_time_unit
   end
 
+  def Vizir.get_remaining_time(end_time, now)
+    return  (end_time - now).round
+  end
+
+  def Vizir.get(api, uri)
+    begin
+      return JSON.parse(api[uri + '?structure=simple'].get(:accept => 'application/json'))
+    rescue RestClient::RequestTimeout => e
+      # This should really be elsewhere, but will do for now
+      # Were we querying a specific site? If yes, remove it from $sites
+      if uri =~ /\/sites\/(\w+)/
+        $sites.delete_if { |site| site['site'] == "#{$1}" }
+        return nil
+      else
+        raise e
+      end
+    rescue => e
+      if e.respond_to?('http_code')
+        puts "Error: #{e.http_code}:\n #{e.response.body}"
+        return nil
+      else
+        puts e.inspect
+        exit 1
+      end
+    end
+  end
+
+  def Vizir.learn_sites(api, ignored_sites)
+    return get(api, '/sites').delete_if { |hash| ignored_sites.include?(hash["site"]) }
+  end
+
+  def Vizir.get_api(uri)
+    return RestClient::Resource.new(uri, :timeout => 15)
+  end
+
+  def Vizir.learn_new_jobs_on_site(api, site)
+    site_name = site['site']
+    jobs = Vizir.get(api, "#{site['uri']}/jobs")
+    return if jobs.nil?
+    jobs.each do |job|
+      if job['owner'] == $login
+        job_details = Vizir.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
+  end
+
+  def Vizir.learn_new_jobs(api)
+    $sites.each do |site|
+      Vizir.learn_new_jobs_on_site(api, site)
+    end
+  end
+
+  def Vizir.first_ending_job
+    $jobs.sort{|a,b| a[1].end_time <=> b[1].end_time}.first
+  end
+
+  def Vizir.alert_jobs(api)
+    $jobs.each do |jobid, job|
+      if job.should_be_ending?
+        # Check if the job still exists before sending a notification
+        if job.is_ended?(api)
+          # Job is not running anymore, remove it from the hash
+          $jobs.delete(jobid)
+          next
+        end
+        remaining_sec = Vizir.get_remaining_time(job.end_time, Time.now)
+        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
+
   class Job
     attr_reader :id, :end_time, :site_name
 
@@ -25,5 +116,23 @@ module Vizir
       @end_time = end_time
       @site_name = site_name
     end
+
+    def Job.create_from_json(json, site_name)
+      return Job.new(json['Job_Id'], Time.at(Integer(json['startTime']) + Integer(json['walltime'])), site_name.capitalize)
+    end
+
+    def fetch_details(api)
+      return Vizir.get(api, "/sites/#{@site_name.downcase}/jobs/#{@id}")
+    end
+
+    def should_be_ending?(time=Time.now())
+      return Vizir.get_remaining_time(self.end_time, time) <= Vizir::FIRST_ALERT_TIME
+    end
+
+    def is_ended?(api)
+      updatedjob = self.fetch_details(api)
+      return updatedjob['state'] != 'Running'
+    end
+
   end
 end

data/test/test_helper.rb

@@ -1,8 +1,11 @@
 require 'rubygems'
 require 'test/unit'
+require 'shoulda'
+
+require 'fakeweb'
 
-$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 $LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 require 'vizir'
 
 class Test::Unit::TestCase

data/test/test_vizir.rb

@@ -0,0 +1,99 @@
+require 'test_helper'
+
+class VizirTest < Test::Unit::TestCase
+  TIMES = [
+    [0,   [0,   "second"]],
+    [1,   [1,   "second"]],
+    [30,  [30,  "seconds"]],
+    [59,  [59,  "seconds"]],
+    [60,  [1,   "minute"]],
+    [119, [1,   "minute"]],
+    [120, [2,   "minutes"]]
+  ]
+  def test_humanize_time
+    TIMES.each do |seconds, result|
+      assert_equal(result, Vizir.humanize_time(seconds))
+    end
+    e = assert_raise(RuntimeError) { Vizir.humanize_time(-1) }
+    assert_equal("Can't humanize negative period", e.message)
+  end
+
+  def test_learn_sites
+    FakeWeb.allow_net_connect = false
+    o = [
+      {
+        "site" => "nancy",
+        "uri" => "/sites/nancy"
+      },
+      {
+        "site" => "rennes",
+        "uri" => "/sites/rennes"
+      },
+      {
+        "site" => "luxembourg",
+        "uri" => "/sites/luxembourg"
+      }]
+    json = JSON.generate(o)
+    FakeWeb.register_uri(:get, "#{Vizir::APIURL}/sites?structure=simple", :string => json)
+    api = Vizir.get_api(Vizir::APIURL)
+    sites = o.delete_if { |hash| hash["site"] == "luxembourg" }
+    ignored_sites = ["luxembourg", "portoalegre"]
+    assert_equal(sites, Vizir.learn_sites(api, ignored_sites))
+  end
+
+  context "A Job instance" do
+    setup do
+      @job_endtime = Time.at(123456789)
+      @job = Vizir::Job.new('1234', @job_endtime, 'Rennes')
+    end
+
+    context 'ending in FIRST_ALERT_TIME seconds' do
+      setup do
+        @now = Time.at(Integer(@job_endtime) - Integer(Vizir::FIRST_ALERT_TIME))
+      end
+
+      should 'be considered as ending soon' do
+        assert_equal true, @job.should_be_ending?(@now)
+      end
+    end
+
+    context 'ending in more than FIRST_ALERT_TIME seconds' do
+      setup do
+        @now = Time.at(Integer(@job_endtime) - Integer(Vizir::FIRST_ALERT_TIME + 1))
+      end
+
+      should 'not be considered as ending soon' do
+        assert_equal false, @job.should_be_ending?(@now)
+      end
+    end
+  end
+
+  context 'A site-specific query' do
+    setup do
+      @uri = "#{Vizir::APIURL}/sites/rennes/jobs?structure=simple"
+    end
+
+    context 'which timeouts' do
+      setup do
+        FakeWeb.register_uri(:get, @uri, :exception => Timeout::Error)
+        @api = Vizir.get_api(Vizir::APIURL)
+      end
+
+      should 'remove the site from the sites list' do
+        $sites = [
+          {
+            "site" => "nancy",
+            "uri" => "/sites/nancy"
+          },
+          {
+            "site" => "rennes",
+            "uri" => "/sites/rennes"
+          }
+        ]
+        Vizir.learn_new_jobs_on_site(@api, $sites[1])
+        assert_equal [{ "site" => "nancy", "uri" => "/sites/nancy" }], $sites
+      end
+    end
+  end
+
+end

data/vizir.gemspec

@@ -2,11 +2,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{vizir}
-  s.version = "0.2.2"
+  s.version = "0.2.3"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Pierre Riteau"]
-  s.date = %q{2009-06-02}
+  s.date = %q{2009-06-18}
   s.default_executable = %q{vizir}
   s.email = %q{pierre.riteau@gmail.com}
   s.executables = ["vizir"]
@@ -24,18 +24,19 @@ Gem::Specification.new do |s|
      "bin/vizir",
      "lib/vizir.rb",
      "test/test_helper.rb",
-     "test/vizir_test.rb",
+     "test/test_vizir.rb",
      "vizir.gemspec"
   ]
   s.has_rdoc = true
   s.homepage = %q{http://github.com/priteau/vizir}
   s.rdoc_options = ["--charset=UTF-8"]
   s.require_paths = ["lib"]
+  s.rubyforge_project = %q{vizir}
   s.rubygems_version = %q{1.3.1}
   s.summary = %q{Growl notifications for Grid'5000 jobs}
   s.test_files = [
     "test/test_helper.rb",
-     "test/vizir_test.rb"
+     "test/test_vizir.rb"
   ]
 
   if s.respond_to? :specification_version then

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: priteau-vizir
 version: !ruby/object:Gem::Version 
-  version: 0.2.2
+  version: 0.2.3
 platform: ruby
 authors: 
 - Pierre Riteau
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-06-02 00:00:00 -07:00
+date: 2009-06-18 00:00:00 -07:00
 default_executable: vizir
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -81,7 +81,7 @@ files:
 - bin/vizir
 - lib/vizir.rb
 - test/test_helper.rb
-- test/vizir_test.rb
+- test/test_vizir.rb
 - vizir.gemspec
 has_rdoc: true
 homepage: http://github.com/priteau/vizir
@@ -104,11 +104,11 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   version: 
 requirements: []
 
-rubyforge_project: 
+rubyforge_project: vizir
 rubygems_version: 1.2.0
 signing_key: 
 specification_version: 2
 summary: Growl notifications for Grid'5000 jobs
 test_files: 
 - test/test_helper.rb
-- test/vizir_test.rb
+- test/test_vizir.rb

data/test/vizir_test.rb

@@ -1,17 +0,0 @@
-require 'test_helper'
-
-class VizirTest < Test::Unit::TestCase
-  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