ruby-cute 0.3 → 0.4

data/lib/cute/extensions.rb

@@ -36,3 +36,19 @@ class String
   end
 
 end
+
+module Cute
+
+  class OARSSHopts < Hash
+
+    def initialize(opts={})
+
+      raise "The argument must be a Hash" unless opts.is_a?(Hash)
+    self.merge!({:user => "oar", :keys => ["~/my_ssh_jobkey"], :port => 6667 })
+    self.merge!(opts)
+
+    end
+
+  end
+
+end

data/lib/cute/g5k_api.rb

@@ -211,7 +211,9 @@ module Cute
 
         machine =`uname -ov`.chop
         @user_agent = "ruby-cute/#{VERSION} (#{machine}) Ruby #{RUBY_VERSION}"
-        @api = RestClient::Resource.new(@endpoint, :timeout => 30)
+        @api = RestClient::Resource.new(@endpoint, :timeout => 30,:verify_ssl => false)
+        # some versions of restclient do not verify by default SSL certificates , :verify_ssl => true)
+        # SSL verify is disabled due to Grid'5000 API certificate problem
         @on_error = on_error
         test_connection
       end
@@ -280,6 +282,12 @@ module Cute
 
       # Issues a Cute::G5K exception according to the http status code
       def handle_exception(e)
+
+        unless e.respond_to? :http_code
+          raise e
+        end
+
+        # Handling G5k API errors
         case e.http_code
         when 500
           # This part deals with bug: https://intranet.grid5000.fr/bugzilla/show_bug.cgi?id=5912
@@ -484,8 +492,8 @@ module Cute
       # @option params [String] :conf_file Path for configuration file
       # @option params [String] :uri REST API URI to contact
       # @option params [String] :version Version of the REST API to use
-      # @option params [String] :user Username to access the REST API
-      # @option params [String] :pass Password to access the REST API
+      # @option params [String] :username Username to access the REST API
+      # @option params [String] :password Password to access the REST API
       # @option params [Symbol] :on_error Set to :ignore if you want to ignore {Cute::G5K::RequestFailed ResquestFailed} exceptions.
       def initialize(params={})
         config = {}
@@ -495,16 +503,20 @@ module Cute
           params[:conf_file] =  default_file if File.exist?(default_file)
         end
 
+        params[:username] ||= params[:user]
+        params[:password] ||= params[:pass] # backward compatibility
+
         config = YAML.load(File.open(params[:conf_file],'r')) unless params[:conf_file].nil?
-        @user = params[:user] || config["username"]
-        @pass = params[:pass] || config["password"]
+        @user = params[:username] || config["username"]
+        @pass = params[:password] || config["password"]
         @uri = params[:uri] || config["uri"]
         @api_version = params[:version] || config["version"] || "sid"
         @logger = nil
 
         begin
           @g5k_connection = G5KRest.new(@uri,@api_version,@user,@pass,params[:on_error])
-        rescue
+        rescue => e
+
           msg_create_file = ""
           if (not File.exist?(default_file)) && params[:conf_file].nil? then
             msg_create_file = "Please create the file: ~/.grid5000_api.yml and
@@ -512,7 +524,9 @@ module Cute
                           :conf_file to indicate another file for the credentials"
           end
           raise "Unable to authorize against the Grid'5000 API.
-               #{msg_create_file}"
+                #{e.message}
+                #{msg_create_file}"
+
 
         end
       end
@@ -656,7 +670,8 @@ module Cute
             .map { |x| "#{x}.#{site}.grid5000.fr"}
           switch['nodes'] = nodes
         }
-        return items.select { |it| it.key?('nodes') }
+
+        return items
       end
 
       # @return [Hash] information of a specific switch available in a given Grid'5000 site.
@@ -668,6 +683,37 @@ module Cute
         return s
       end
 
+      # Returns information using the Metrology API.
+      #
+      # = Example
+      #
+      # You can get detailed information of available metrics in a given site:
+      #    get_metric("rennes")
+      #
+      # If you are only interested in the names of the available metrics:
+      #   get_metric("rennes").uids #=> ["cpu_nice", "boottime", "bytes_in", ...]
+      #
+      # Then, you can get information about the probes available for a specific metric:
+      #    get_metric("rennes",:metric => "network_in")
+      #
+      # Finally, you can query on a specific probe:
+      #    get_metric("rennes",:metric => "network_in",:query => {:from => 1450374553, :to => 1450374553, :only => "parasilo-11-eth0"})
+      #
+      # @return [Array] information of a specific metric in a given Grid'5000 site.
+      # @param site [String] a valid Grid'5000 site name
+      # @param [Hash] opts  Options for metric query
+      # @option opts [String] :metric specific metric to query on
+      # @option opts [Hash] :query timeseries parameters (e.g. only, resolution, from, to)
+
+      def get_metric(site,opts ={})
+        params = opts[:metric].nil? ? "" : "/#{opts[:metric]}/timeseries"
+        if opts[:query]
+          params+="?"
+          opts[:query].each{ |k,v| params+="#{k}=#{v}&"}
+        end
+        @g5k_connection.get_json(api_uri("sites/#{site}/metrics#{params}")).items
+      end
+
       # Returns information of all my jobs submitted in a given site.
       # By default it only shows the jobs in state *running*.
       # You can specify another state like this:
@@ -835,6 +881,7 @@ module Cute
       # @option opts [String] :name Reservation name
       # @option opts [String] :cmd The command to execute when the job starts (e.g. ./my-script.sh).
       # @option opts [String] :cluster Valid Grid'5000 cluster
+      # @option opts [String] :queue A specific job queue
       # @option opts [Array]  :subnets 1) prefix_size, 2) number of subnets
       # @option opts [String] :env Environment name for {http://kadeploy3.gforge.inria.fr/ Kadeploy}
       # @option opts [Symbol] :vlan Vlan type: :routed, :local, :global
@@ -847,7 +894,8 @@ module Cute
 
         # checking valid options
         valid_opts = [:site, :cluster, :switches, :cpus, :cores, :nodes, :walltime, :cmd,
-                      :type, :name, :subnets, :env, :vlan, :properties, :resources, :reservation, :wait, :keys]
+                      :type, :name, :subnets, :env, :vlan, :properties, :resources,
+                      :reservation, :wait, :keys, :queue, :env_user]
         unre_opts = opts.keys - valid_opts
         raise ArgumentError, "Unrecognized option #{unre_opts}" unless unre_opts.empty?
 
@@ -868,6 +916,7 @@ module Cute
         resources = opts.fetch(:resources, "")
         type = :deploy if opts[:env]
         keys = opts[:keys]
+        queue = opts[:queue]
 
         vlan_opts = {:routed => "kavlan",:global => "kavlan-global",:local => "kavlan-local"}
         vlan = nil
@@ -881,11 +930,11 @@ module Cute
 
         raise 'At least nodes, time and site must be given'  if [nodes, walltime, site].any? { |x| x.nil? }
 
+        raise 'nodes should be an integer or a string containing either ALL or BEST' unless (nodes.is_a?(Fixnum) or ["ALL","BEST"].include?(nodes))
+
         secs = walltime.to_secs
         walltime = walltime.to_time
 
-        raise 'Nodes must be an integer.' unless nodes.is_a?(Integer)
-
         command = "sleep #{secs}" if command.nil?
         type = type.to_sym unless type.nil?
 
@@ -911,6 +960,7 @@ module Cute
 
         payload['properties'] = properties unless properties.nil?
         payload['types'] = [ type.to_s ] unless type.nil?
+        payload['queue'] = queue if queue
 
         if not type == :deploy
           if opts[:keys]
@@ -930,8 +980,7 @@ module Cute
           # The request has to be redirected to the OAR API given that Grid'5000 API
           # does not support some OAR options.
           if payload['import-job-key-from-file'] then
-            # Adding double quotes otherwise we have a syntax error from OAR API
-            payload["resources"] = "\"#{payload["resources"]}\""
+
             temp = @g5k_connection.post_json(api_uri("sites/#{site}/internal/oarapi/jobs"),payload)
             sleep 1 # This is for being sure that our job appears on the list
             r = get_my_jobs(site,nil).select{ |j| j["uid"] == temp["id"] }.first
@@ -1035,7 +1084,8 @@ module Cute
 
         # checking valid options, same as reserve option even though some option dont make any sense
         valid_opts = [:site, :cluster, :switches, :cpus, :cores, :nodes, :walltime, :cmd,
-                      :type, :name, :subnets, :env, :vlan, :properties, :resources, :reservation, :wait, :keys]
+                      :type, :name, :subnets, :env, :vlan, :properties, :resources,
+                      :reservation, :wait, :keys, :queue, :env_user]
 
         unre_opts = opts.keys - valid_opts
         raise ArgumentError, "Unrecognized option #{unre_opts}" unless unre_opts.empty?
@@ -1069,6 +1119,8 @@ module Cute
           info "Found VLAN with uid = #{vlan}"
         end
 
+        payload['user'] = opts[:env_user] unless opts[:env_user].nil?
+
         info "Creating deployment"
 
         begin
@@ -1135,9 +1187,10 @@ module Cute
       #
       #    g5k = Cute::G5K::API.new()
       #
-      #    job = g5k.reserve(:nodes => 1, :site => 'lyon', :env => 'wheezy-x64-base')
+      #    job = g5k.reserve(:nodes => 1, :site => 'lyon', :type => :deploy)
       #
       #    begin
+      #      g5k.deploy(job,:env => 'wheezy-x64-base')
       #      g5k.wait_for_deploy(job,:wait_time => 100)
       #      rescue  Cute::G5K::EventTimeout
       #      puts "We waited too long let's release the job"
@@ -1171,6 +1224,20 @@ module Cute
 
       end
 
+      # It returns an array of machines that did not deploy successfully
+      # = Example
+      # It can be used to try a new deploy:
+      #
+      #    badnodes = g5k.check_deployment(job["deploy"].last)
+      #    g5k.deploy(job,:nodes => badnodes, :env => 'wheezy-x64-base')
+      #    g5k.wait_for_deploy(job)
+      #
+      # @return [Array] machines that did not deploy successfully
+      # @param deploy_info [Hash] deployment structure information
+      def check_deployment(deploy_info)
+        deploy_info["result"].select{ |p,v|  v["state"] == "KO"}.keys
+      end
+
       private
       # Handles the output of messages within the module
       # @param msg [String] message to show

data/lib/cute/synchronization.rb

@@ -34,7 +34,7 @@ module Cute
       def release(n = 1)
         @lock.synchronize {
           @used -= n
-          @cond.signal
+          @cond.broadcast
         }
       end
     end

data/lib/cute/version.rb

@@ -1,3 +1,3 @@
 module Cute
-  VERSION = "0.3"
+  VERSION = "0.4"
 end

data/spec/g5k_api_spec.rb

@@ -73,6 +73,10 @@ describe Cute::G5K::API do
 #    expect{ subject.reserve(:site => @rand_site, :resources =>"{ib30g='YES'}/nodes=2")}.to raise_error(Cute::G5K::BadRequest)
   end
 
+  it "raises a bad request using OAR API" do
+    expect{subject.reserve(:site => @rand_site, :resources =>"nodes=1",:keys => "~/jobkey_nonexisting")}.to raise_error(Cute::G5K::BadRequest)
+  end
+
   it "raises an exception at deploying" do
     expect{ subject.reserve(:site => @rand_site, :nodes => 1, :env => "nonsense")}.to raise_error(Cute::G5K::RequestFailed)
   end
@@ -126,7 +130,7 @@ describe Cute::G5K::API do
   end
 
   it "performs an advanced reservation" do
-    time_schedule = Time.now + 60*20
+    time_schedule = Time.now + 60*10
     job =subject.reserve(:site => @rand_site, :nodes => 1, :reservation => time_schedule.strftime("%Y-%m-%d %H:%M:%S"))
     subject.release(job)
   end
@@ -137,7 +141,6 @@ describe Cute::G5K::API do
     subject.release(job)
   end
 
-
   it "does not deploy immediately" do
     job = subject.reserve(:site => @rand_site, :type => :deploy )
     expect(job).to include("types" => ["deploy"])

data/spec/spec_helper.rb

@@ -3,6 +3,8 @@ require 'webmock/rspec'
 
 SimpleCov.start
 # The SimpleCov.start must be issued before any of the application code is required!
+# SimpleCov hacks $:, so it needs to be re-configured here, before cute is loaded.
+$:.unshift File.expand_path("../../lib", __FILE__)
 require 'cute'
 
 # Disabling all external requests
@@ -57,6 +59,10 @@ RSpec.configure do |config|
       with(:body => hash_including("resources" => "/slash_22=1+{nonsense},walltime=01:00")).
       to_return(:status => 400, :body => "Oarsub failed: please verify your request syntax")
 
+    stub_request(:post, /^https:\/\/.*\:.*@api.grid5000.fr\/.*/).
+      with(:body => hash_including("import-job-key-from-file" => [ File.expand_path("~/jobkey_nonexisting") ])).
+      to_return(:status => 400, :body => "Oarsub failed: please verify your request syntax")
+
     stub_request(:post, /^https:\/\/.*\:.*@api.grid5000.fr\/.*/).
       with(:body => hash_including("environment" => "nonsense")).
       to_return(:status => 500, :body => "Invalid environment specification")

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby-cute
 version: !ruby/object:Gem::Version
-  version: '0.3'
+  version: '0.4'
 platform: ruby
 authors:
 - Algorille team
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-13 00:00:00.000000000 Z
+date: 2016-01-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -191,6 +191,7 @@ files:
 - debian/source/format
 - debian/watch
 - examples/distem-bootstrap
+- examples/g5k-tutorial.md
 - examples/g5k_exp1.rb
 - examples/g5k_exp_virt.rb
 - lib/cute.rb
@@ -231,7 +232,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.6
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.5.1
 signing_key: 
 specification_version: 4
 summary: Critically Useful Tools for Experiments