vizir 0.2.2

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,5 @@
+*.sw?
+.DS_Store
+coverage
+rdoc
+pkg

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Pierre Riteau
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,36 @@
+= Vizir
+
+    Disconnected from OAR job 960063
+
+Ever been disconnected from Grid'5000 machines with a message like this, losing part or all of your work?
+
+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.
+
+== 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
+
+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 Vizir in the background, using the <tt>--login</tt> switch with your Grid'5000 login name.
+
+    $ vizir --login priteau &
+
+== Getting the source
+
+Clone it from GitHub:
+
+    $ git clone git://github.com/priteau/vizir.git
+
+== Copyright
+
+Copyright (c) 2009 Pierre Riteau. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,63 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "vizir"
+    gem.summary = "Growl notifications for Grid'5000 jobs"
+    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"
+    gem.add_dependency "net-ssh-gateway"
+    gem.add_dependency "rest-client"
+    # 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
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/test_*.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  if File.exist?('VERSION.yml')
+    config = YAML.load(File.read('VERSION.yml'))
+    version = "#{config[:major]}.#{config[:minor]}.#{config[:patch]}"
+  else
+    version = ""
+  end
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "vizir #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+

data/VERSION

@@ -0,0 +1 @@
+0.2.2

data/bin/vizir

@@ -0,0 +1,66 @@
+#!/usr/bin/env ruby
+
+$:.unshift File.join(File.dirname(__FILE__), "..", "lib")
+
+require 'eventmachine'
+require 'growl'
+require 'net/ssh/gateway'
+require 'optparse'
+require 'rest_client'
+require 'vizir'
+
+ALERT_PERIOD = 60
+REFRESH_TIME = 3600
+
+def usage
+  puts 'usage: vizir [ -h | --help ] [ -l | --login login_name ]'
+  exit 1
+end
+
+def setup_ssh_tunnel
+  gateway = Net::SSH::Gateway.new('access.grenoble.grid5000.fr', $login)
+  port = gateway.open('api.grenoble.grid5000.fr', 443)
+  return gateway, port
+end
+
+def apiuri(port)
+  return "https://localhost:#{port}/oargridapi"
+end
+
+def setup_growl
+  $growl = Growl::Notifier.sharedInstance
+  $growl.register('Vizir', ['Job ending soon'])
+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}.", :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 = Vizir.get_api(apiuri(port))
+setup_growl
+
+# Learn the Grid'5000 sites
+$jobs = Hash.new
+$sites = Vizir.learn_sites(api, Vizir::IGNORED_SITES)
+exit 1 if $sites == nil
+
+Vizir.learn_new_jobs(api)
+Vizir.alert_jobs(api)
+
+EventMachine::run {
+  EventMachine::PeriodicTimer.new(REFRESH_TIME) { Vizir.learn_new_jobs(api) }
+  EventMachine::PeriodicTimer.new(ALERT_PERIOD) { Vizir.alert_jobs(api) }
+}
+
+gateway.shutdown!

data/lib/vizir.rb

@@ -0,0 +1,138 @@
+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
+
+    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
+
+  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
+
+    def initialize(id, end_time, site_name)
+      @id = id
+      @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

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

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

@@ -0,0 +1,66 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{vizir}
+  s.version = "0.2.2"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Pierre Riteau"]
+  s.date = %q{2009-06-10}
+  s.default_executable = %q{vizir}
+  s.email = %q{pierre.riteau@gmail.com}
+  s.executables = ["vizir"]
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "bin/vizir",
+     "lib/vizir.rb",
+     "test/test_helper.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/test_vizir.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    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<growlnotifier>, [">= 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"])
+    else
+      s.add_dependency(%q<eventmachine>, [">= 0"])
+      s.add_dependency(%q<growlnotifier>, [">= 0"])
+      s.add_dependency(%q<json>, [">= 0"])
+      s.add_dependency(%q<net-ssh-gateway>, [">= 0"])
+      s.add_dependency(%q<rest-client>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<eventmachine>, [">= 0"])
+    s.add_dependency(%q<growlnotifier>, [">= 0"])
+    s.add_dependency(%q<json>, [">= 0"])
+    s.add_dependency(%q<net-ssh-gateway>, [">= 0"])
+    s.add_dependency(%q<rest-client>, [">= 0"])
+  end
+end

metadata

@@ -0,0 +1,114 @@
+--- !ruby/object:Gem::Specification 
+name: vizir
+version: !ruby/object:Gem::Version 
+  version: 0.2.2
+platform: ruby
+authors: 
+- Pierre Riteau
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-06-10 00:00:00 +02: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: growlnotifier
+  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
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: net-ssh-gateway
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: rest-client
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: 
+email: pierre.riteau@gmail.com
+executables: 
+- vizir
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- bin/vizir
+- lib/vizir.rb
+- test/test_helper.rb
+- test/test_vizir.rb
+- vizir.gemspec
+has_rdoc: true
+homepage: http://github.com/priteau/vizir
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: vizir
+rubygems_version: 1.3.1
+signing_key: 
+specification_version: 2
+summary: Growl notifications for Grid'5000 jobs
+test_files: 
+- test/test_helper.rb
+- test/test_vizir.rb