vmfloaty 0.9.2 → 1.1.1

data/lib/vmfloaty/abs.rb

@@ -2,6 +2,7 @@
 
 require 'vmfloaty/errors'
 require 'vmfloaty/http'
+require 'vmfloaty/utils'
 require 'faraday'
 require 'json'
 
@@ -36,39 +37,61 @@ class ABS
   #       }
   #     }
   #
-
   @active_hostnames = {}
 
-  def self.list_active(verbose, url, _token, user)
-    all_jobs = []
+  def self.list_active_job_ids(verbose, url, user)
+    all_job_ids = []
     @active_hostnames = {}
+    get_active_requests(verbose, url, user).each do |req_hash|
+      @active_hostnames[req_hash['request']['job']['id']] = req_hash # full hash saved for later retrieval
+      all_job_ids.push(req_hash['request']['job']['id'])
+    end
+
+    all_job_ids
+  end
 
+  def self.list_active(verbose, url, _token, user)
+    hosts = []
     get_active_requests(verbose, url, user).each do |req_hash|
-      all_jobs.push(req_hash['request']['job']['id'])
-      @active_hostnames[req_hash['request']['job']['id']] = req_hash
+      if req_hash.key?('allocated_resources')
+        req_hash['allocated_resources'].each do |onehost|
+          hosts.push(onehost['hostname'])
+        end
+      end
     end
 
-    all_jobs
+    hosts
   end
 
   def self.get_active_requests(verbose, url, user)
-    conn = Http.get_conn(verbose, url)
+    conn = Http.get_conn(verbose, supported_abs_url(url))
     res = conn.get 'status/queue'
-    requests = JSON.parse(res.body)
+    if valid_json?(res.body)
+      requests = JSON.parse(res.body)
+    else
+      FloatyLogger.warn "Warning: couldn't parse body returned from abs/status/queue"
+    end
 
     ret_val = []
 
     requests.each do |req|
       next if req == 'null'
 
-      req_hash = JSON.parse(req)
+      if valid_json?(req) # legacy ABS had another JSON string always-be-scheduling/pull/306
+        req_hash = JSON.parse(req)
+      elsif req.is_a?(Hash)
+        req_hash = req
+      else
+        FloatyLogger.warn "Warning: couldn't parse request returned from abs/status/queue"
+        next
+      end
 
       begin
         next unless user == req_hash['request']['job']['user']
 
         ret_val.push(req_hash)
       rescue NoMethodError
-        puts "Warning: couldn't parse line returned from abs/status/queue: ".yellow
+        FloatyLogger.warn "Warning: couldn't parse user returned from abs/status/queue: "
       end
     end
 
@@ -82,10 +105,10 @@ class ABS
 
   def self.delete(verbose, url, hosts, token, user)
     # In ABS terms, this is a "returned" host.
-    conn = Http.get_conn(verbose, url)
+    conn = Http.get_conn(verbose, supported_abs_url(url))
     conn.headers['X-AUTH-TOKEN'] = token if token
 
-    puts "Trying to delete hosts #{hosts}" if verbose
+    FloatyLogger.info "Trying to delete hosts #{hosts}" if verbose
     requests = get_active_requests(verbose, url, user)
 
     jobs_to_delete = []
@@ -113,7 +136,7 @@ class ABS
             }
             jobs_to_delete.push(req_hash)
           else
-            puts "When using ABS you must delete all vms that you requested at the same time: Can't delete #{req_hash['request']['job']['id']}: #{hosts} does not include all of #{req_hash['allocated_resources']}"
+            FloatyLogger.info "When using ABS you must delete all vms that you requested at the same time: Can't delete #{req_hash['request']['job']['id']}: #{hosts} does not include all of #{req_hash['allocated_resources']}"
           end
         end
       end
@@ -127,7 +150,7 @@ class ABS
         'hosts'  => job['allocated_resources'],
       }
 
-      puts "Deleting #{req_obj}" if verbose
+      FloatyLogger.info "Deleting #{req_obj}" if verbose
 
       return_result = conn.post 'return', req_obj.to_json
       req_obj['hosts'].each do |host|
@@ -140,27 +163,64 @@ class ABS
 
   # List available VMs in ABS
   def self.list(verbose, url, os_filter = nil)
-    conn = Http.get_conn(verbose, url)
+    conn = Http.get_conn(verbose, supported_abs_url(url))
 
     os_list = []
 
     res = conn.get 'status/platforms/vmpooler'
+    if valid_json?(res.body)
+      res_body = JSON.parse(res.body)
+      if res_body.key?('vmpooler_platforms')
+        os_list << '*** VMPOOLER Pools ***'
+        if res_body['vmpooler_platforms'].is_a?(String)
+          os_list += JSON.parse(res_body['vmpooler_platforms']) # legacy ABS had another JSON string always-be-scheduling/pull/306
+        else
+          os_list += res_body['vmpooler_platforms']
+        end
+      end
+    end
 
-    res_body = JSON.parse(res.body)
-    os_list << '*** VMPOOLER Pools ***'
-    os_list += JSON.parse(res_body['vmpooler_platforms'])
+    res = conn.get 'status/platforms/ondemand_vmpooler'
+    if valid_json?(res.body)
+      res_body = JSON.parse(res.body)
+      if res_body.key?('ondemand_vmpooler_platforms') && res_body['ondemand_vmpooler_platforms'] != '[]'
+        os_list << ''
+        os_list << '*** VMPOOLER ONDEMAND Pools ***'
+        if res_body['ondemand_vmpooler_platforms'].is_a?(String)
+          os_list += JSON.parse(res_body['ondemand_vmpooler_platforms']) # legacy ABS had another JSON string always-be-scheduling/pull/306
+        else
+          os_list += res_body['ondemand_vmpooler_platforms']
+        end
+      end
+    end
 
     res = conn.get 'status/platforms/nspooler'
-    res_body = JSON.parse(res.body)
-    os_list << ''
-    os_list << '*** NSPOOLER Pools ***'
-    os_list += JSON.parse(res_body['nspooler_platforms'])
+    if valid_json?(res.body)
+      res_body = JSON.parse(res.body)
+      if res_body.key?('nspooler_platforms')
+        os_list << ''
+        os_list << '*** NSPOOLER Pools ***'
+        if res_body['nspooler_platforms'].is_a?(String)
+          os_list += JSON.parse(res_body['nspooler_platforms']) # legacy ABS had another JSON string always-be-scheduling/pull/306
+        else
+          os_list += res_body['nspooler_platforms']
+        end
+      end
+    end
 
     res = conn.get 'status/platforms/aws'
-    res_body = JSON.parse(res.body)
-    os_list << ''
-    os_list << '*** AWS Pools ***'
-    os_list += JSON.parse(res_body['aws_platforms'])
+    if valid_json?(res.body)
+      res_body = JSON.parse(res.body)
+      if res_body.key?('aws_platforms')
+        os_list << ''
+        os_list << '*** AWS Pools ***'
+        if res_body['aws_platforms'].is_a?(String)
+          os_list += JSON.parse(res_body['aws_platforms']) # legacy ABS had another JSON string always-be-scheduling/pull/306
+        else
+          os_list += res_body['aws_platforms']
+        end
+      end
+    end
 
     os_list.delete 'ok'
 
@@ -168,7 +228,7 @@ class ABS
   end
 
   # Retrieve an OS from ABS.
-  def self.retrieve(verbose, os_types, token, url, user, options)
+  def self.retrieve(verbose, os_types, token, url, user, config, _ondemand = nil)
     #
     # Contents of post must be like:
     #
@@ -185,11 +245,10 @@ class ABS
     #   }
     # }
 
-    conn = Http.get_conn(verbose, url)
+    conn = Http.get_conn(verbose, supported_abs_url(url))
     conn.headers['X-AUTH-TOKEN'] = token if token
 
-    saved_job_id = DateTime.now.strftime('%Q')
-
+    saved_job_id = user + "-" + DateTime.now.strftime('%Q')
     req_obj = {
       :resources => os_types,
       :job       => {
@@ -200,38 +259,49 @@ class ABS
       },
     }
 
-    if options['priority']
-      req_obj[:priority] = if options['priority'] == 'high'
+    if config['vmpooler_fallback'] # optional and not available as cli flag
+      vmpooler_config = Utils.get_vmpooler_service_config(config['vmpooler_fallback'])
+      # request with this token, on behalf of this user
+      req_obj[:vm_token] = vmpooler_config['token']
+    end
+
+    if config['priority']
+      req_obj[:priority] = if config['priority'] == 'high'
                              1
-                           elsif options['priority'] == 'medium'
+                           elsif config['priority'] == 'medium'
                              2
-                           elsif options['priority'] == 'low'
+                           elsif config['priority'] == 'low'
                              3
                            else
-                             options['priority'].to_i
+                             config['priority'].to_i
                            end
     end
 
-    puts "Posting to ABS #{req_obj.to_json}" if verbose
+    FloatyLogger.info "Posting to ABS #{req_obj.to_json}" if verbose
 
     # os_string = os_type.map { |os, num| Array(os) * num }.flatten.join('+')
     # raise MissingParamError, 'No operating systems provided to obtain.' if os_string.empty?
-    puts "Requesting VMs with job_id: #{saved_job_id}.  Will retry for up to an hour."
+    FloatyLogger.info "Requesting VMs with job_id: #{saved_job_id}.  Will retry for up to an hour."
     res = conn.post 'request', req_obj.to_json
 
     retries = 360
 
-    raise AuthError, "HTTP #{res.status}: The token provided could not authenticate to the pooler.\n#{res_body}" if res.status == 401
+    validate_queue_status_response(res.status, res.body, "Initial request", verbose)
 
-    (1..retries).each do |i|
-      queue_place, res_body = check_queue(conn, saved_job_id, req_obj)
-      return translated(res_body) if res_body
+    begin
+      (1..retries).each do |i|
+        queue_place, res_body = check_queue(conn, saved_job_id, req_obj, verbose)
+        return translated(res_body, saved_job_id) if res_body
 
-      sleep_seconds = 10 if i >= 10
-      sleep_seconds = i if i < 10
-      puts "Waiting #{sleep_seconds} seconds to check if ABS request has been filled.  Queue Position: #{queue_place}... (x#{i})"
+        sleep_seconds = 10 if i >= 10
+        sleep_seconds = i if i < 10
+        FloatyLogger.info "Waiting #{sleep_seconds} seconds to check if ABS request has been filled.  Queue Position: #{queue_place}... (x#{i})"
 
-      sleep(sleep_seconds)
+        sleep(sleep_seconds)
+      end
+    rescue SystemExit, Interrupt
+      FloatyLogger.info "\n\nFloaty interrupted, you can query the state of your request via\n1) `floaty query #{saved_job_id}` or delete it via\n2) `floaty delete #{saved_job_id}`"
+      exit 1
     end
     nil
   end
@@ -239,8 +309,8 @@ class ABS
   #
   # We should fix the ABS API to be more like the vmpooler or nspooler api, but for now
   #
-  def self.translated(res_body)
-    vmpooler_formatted_body = {}
+  def self.translated(res_body, job_id)
+    vmpooler_formatted_body = {'job_id' => job_id}
 
     res_body.each do |host|
       if vmpooler_formatted_body[host['type']] && vmpooler_formatted_body[host['type']]['hostname'].class == Array
@@ -254,13 +324,19 @@ class ABS
     vmpooler_formatted_body
   end
 
-  def self.check_queue(conn, job_id, req_obj)
+  def self.check_queue(conn, job_id, req_obj, verbose)
     queue_info_res = conn.get "status/queue/info/#{job_id}"
-    queue_info = JSON.parse(queue_info_res.body)
+    if valid_json?(queue_info_res.body)
+      queue_info = JSON.parse(queue_info_res.body)
+    else
+      FloatyLogger.warn "Could not parse the status/queue/info/#{job_id}"
+      return [nil, nil]
+    end
 
     res = conn.post 'request', req_obj.to_json
+    validate_queue_status_response(res.status, res.body, "Check queue request", verbose)
 
-    unless res.body.empty?
+    unless res.body.empty? || !valid_json?(res.body)
       res_body = JSON.parse(res.body)
       return queue_info['queue_place'], res_body
     end
@@ -268,11 +344,11 @@ class ABS
   end
 
   def self.snapshot(_verbose, _url, _hostname, _token)
-    puts "Can't snapshot with ABS, use '--service vmpooler' (even for vms checked out with ABS)"
+    raise NoMethodError, "Can't snapshot with ABS, use '--service vmpooler' (even for vms checked out with ABS)"
   end
 
   def self.status(verbose, url)
-    conn = Http.get_conn(verbose, url)
+    conn = Http.get_conn(verbose, supported_abs_url(url))
 
     res = conn.get 'status'
 
@@ -280,20 +356,24 @@ class ABS
   end
 
   def self.summary(verbose, url)
-    conn = Http.get_conn(verbose, url)
-
-    res = conn.get 'summary'
-    JSON.parse(res.body)
+    raise NoMethodError, 'summary is not defined for ABS'
   end
 
-  def self.query(verbose, url, hostname)
-    return @active_hostnames if @active_hostnames
-
-    puts "For vmpooler/snapshot information, use '--service vmpooler' (even for vms checked out with ABS)"
-    conn = Http.get_conn(verbose, url)
+  def self.query(verbose, url, job_id)
+    # return saved hostnames from the last time list_active was run
+    # preventing having to query the API again.
+    # This works as long as query is called after list_active
+    return @active_hostnames if @active_hostnames && !@active_hostnames.empty?
 
-    res = conn.get "host/#{hostname}"
-    JSON.parse(res.body)
+    # If using the cli query job_id
+    conn = Http.get_conn(verbose, supported_abs_url(url))
+    queue_info_res = conn.get "status/queue/info/#{job_id}"
+    if valid_json?(queue_info_res.body)
+      queue_info = JSON.parse(queue_info_res.body)
+    else
+      FloatyLogger.warn "Could not parse the status/queue/info/#{job_id}"
+    end
+    queue_info
   end
 
   def self.modify(_verbose, _url, _hostname, _token, _modify_hash)
@@ -307,4 +387,39 @@ class ABS
   def self.revert(_verbose, _url, _hostname, _token, _snapshot_sha)
     raise NoMethodError, 'revert is not defined for ABS'
   end
+
+  # Validate the http code returned during a queue status request.
+  #
+  # Return a success message that can be displayed if the status code is
+  # success, otherwise raise an error.
+  def self.validate_queue_status_response(status_code, body, request_name, verbose)
+    case status_code
+    when 200
+      "#{request_name} returned success (Code 200)" if verbose
+    when 202
+      "#{request_name} returned accepted, processing (Code 202)" if verbose
+    when 401
+      raise AuthError, "HTTP #{status_code}: The token provided could not authenticate.\n#{body}"
+    else
+      raise "HTTP #{status_code}: #{request_name} request to ABS failed!\n#{body}"
+    end
+  end
+
+  def self.valid_json?(json)
+    JSON.parse(json)
+    return true
+  rescue TypeError, JSON::ParserError => e
+    return false
+  end
+
+  # when missing, adds the required api/v2 in the url
+  def self.supported_abs_url(url)
+    expected_ending = "api/v2"
+    if !url.include?(expected_ending)
+      # add a slash if missing
+      expected_ending = "/#{expected_ending}" if url[-1] != "/"
+      url = "#{url}#{expected_ending}"
+    end
+    url
+  end
 end

data/lib/vmfloaty/conf.rb

@@ -8,7 +8,7 @@ class Conf
     begin
       conf = YAML.load_file("#{Dir.home}/.vmfloaty.yml")
     rescue StandardError
-      STDERR.puts "WARNING: There was no config file at #{Dir.home}/.vmfloaty.yml"
+      # ignore
     end
     conf
   end

data/lib/vmfloaty/logger.rb

@@ -0,0 +1,27 @@
+require 'logger'
+
+class FloatyLogger < ::Logger
+  def self.logger
+    @@logger ||= FloatyLogger.new
+  end
+
+  def self.info(msg)
+    FloatyLogger.logger.info msg
+  end
+
+  def self.warn(msg)
+    FloatyLogger.logger.warn msg
+  end
+
+  def self.error(msg)
+    FloatyLogger.logger.error msg
+  end
+
+  def initialize
+    super(STDERR)
+    self.level = ::Logger::INFO
+    self.formatter = proc do |severity, datetime, progname, msg|
+        "#{msg}\n"
+    end
+  end
+end

data/lib/vmfloaty/nonstandard_pooler.rb

@@ -22,7 +22,7 @@ class NonstandardPooler
     status['reserved_hosts'] || []
   end
 
-  def self.retrieve(verbose, os_type, token, url, _user, _options)
+  def self.retrieve(verbose, os_type, token, url, _user, _options, ondemand = nil)
     conn = Http.get_conn(verbose, url)
     conn.headers['X-AUTH-TOKEN'] = token if token
 

data/lib/vmfloaty/pooler.rb

@@ -28,7 +28,7 @@ class Pooler
     vms
   end
 
-  def self.retrieve(verbose, os_type, token, url, _user, _options)
+  def self.retrieve(verbose, os_type, token, url, _user, _options, ondemand = nil)
     # NOTE:
     #   Developers can use `Utils.generate_os_hash` to
     #   generate the os_type param.
@@ -38,7 +38,8 @@ class Pooler
     os_string = os_type.map { |os, num| Array(os) * num }.flatten.join('+')
     raise MissingParamError, 'No operating systems provided to obtain.' if os_string.empty?
 
-    response = conn.post "vm/#{os_string}"
+    response = conn.post "vm/#{os_string}" unless ondemand
+    response ||= conn.post "ondemandvm/#{os_string}"
 
     res_body = JSON.parse(response.body)
 
@@ -46,11 +47,40 @@ class Pooler
       res_body
     elsif response.status == 401
       raise AuthError, "HTTP #{response.status}: The token provided could not authenticate to the pooler.\n#{res_body}"
+    elsif response.status == 403
+      raise "HTTP #{response.status}: Failed to obtain VMs from the pooler at #{url}/vm/#{os_string}. Request exceeds the configured per pool maximum. #{res_body}"
     else
-      raise "HTTP #{response.status}: Failed to obtain VMs from the pooler at #{url}/vm/#{os_string}. #{res_body}"
+      raise "HTTP #{response.status}: Failed to obtain VMs from the pooler at #{url}/vm/#{os_string}. #{res_body}" unless ondemand
+      raise "HTTP #{response.status}: Failed to obtain VMs from the pooler at #{url}/ondemandvm/#{os_string}. #{res_body}"
     end
   end
 
+  def self.wait_for_request(verbose, request_id, url, timeout = 300)
+    start_time = Time.now
+    while check_ondemandvm(verbose, request_id, url) == false
+      return false if (Time.now - start_time).to_i > timeout
+
+      FloatyLogger.info "waiting for request #{request_id} to be fulfilled"
+      sleep 5
+    end
+    FloatyLogger.info "The request has been fulfilled"
+    check_ondemandvm(verbose, request_id, url)
+  end
+
+  def self.check_ondemandvm(verbose, request_id, url)
+    conn = Http.get_conn(verbose, url)
+
+    response = conn.get "ondemandvm/#{request_id}"
+    res_body = JSON.parse(response.body)
+    return res_body if response.status == 200
+
+    return false if response.status == 202
+
+    raise "HTTP #{response.status}: The request cannot be found, or an unknown error occurred" if response.status == 404
+
+    false
+  end
+
   def self.modify(verbose, url, hostname, token, modify_hash)
     raise TokenError, 'Token provided was nil. Request cannot be made to modify vm' if token.nil?