vmfloaty 0.9.0 → 0.11.1

data/lib/vmfloaty/abs.rb

@@ -68,7 +68,7 @@ class ABS
 
         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 line returned from abs/status/queue: "
       end
     end
 
@@ -85,7 +85,7 @@ class ABS
     conn = Http.get_conn(verbose, 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 = []
@@ -100,6 +100,11 @@ class ABS
     requests.each do |req_hash|
       next unless req_hash['state'] == 'allocated' || req_hash['state'] == 'filled'
 
+      if hosts.include? req_hash['request']['job']['id']
+        jobs_to_delete.push(req_hash)
+        next
+      end
+
       req_hash['allocated_resources'].each do |vm_name, _i|
         if hosts.include? vm_name['hostname']
           if all_job_resources_accounted_for(req_hash['allocated_resources'], hosts)
@@ -108,7 +113,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
@@ -122,7 +127,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|
@@ -145,6 +150,14 @@ class ABS
     os_list << '*** VMPOOLER Pools ***'
     os_list += JSON.parse(res_body['vmpooler_platforms'])
 
+    res = conn.get 'status/platforms/ondemand_vmpooler'
+    res_body = JSON.parse(res.body)
+    unless res_body['ondemand_vmpooler_platforms'] == '[]'
+      os_list << ''
+      os_list << '*** VMPOOLER ONDEMAND Pools ***'
+      os_list += JSON.parse(res_body['ondemand_vmpooler_platforms'])
+    end
+
     res = conn.get 'status/platforms/nspooler'
     res_body = JSON.parse(res.body)
     os_list << ''
@@ -163,7 +176,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, options, _ondemand = nil)
     #
     # Contents of post must be like:
     #
@@ -207,24 +220,24 @@ class ABS
                            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)
+      queue_place, res_body = check_queue(conn, saved_job_id, req_obj, verbose)
       return translated(res_body) 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})"
+      FloatyLogger.info "Waiting #{sleep_seconds} seconds to check if ABS request has been filled.  Queue Position: #{queue_place}... (x#{i})"
 
       sleep(sleep_seconds)
     end
@@ -249,11 +262,12 @@ 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)
 
     res = conn.post 'request', req_obj.to_json
+    validate_queue_status_response(res.status, res.body, "Check queue request", verbose)
 
     unless res.body.empty?
       res_body = JSON.parse(res.body)
@@ -263,7 +277,7 @@ 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)"
+    FloatyLogger.info "Can't snapshot with ABS, use '--service vmpooler' (even for vms checked out with ABS)"
   end
 
   def self.status(verbose, url)
@@ -284,10 +298,39 @@ class ABS
   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)"
+    FloatyLogger.info "For vmpooler/snapshot information, use '--service vmpooler' (even for vms checked out with ABS)"
     conn = Http.get_conn(verbose, url)
 
     res = conn.get "host/#{hostname}"
     JSON.parse(res.body)
   end
+
+  def self.modify(_verbose, _url, _hostname, _token, _modify_hash)
+    raise NoMethodError, 'modify is not defined for ABS'
+  end
+
+  def self.disk(_verbose, _url, _hostname, _token, _disk)
+    raise NoMethodError, 'disk is not defined for ABS'
+  end
+
+  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
 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"
+      FloatyLogger.warn "WARNING: There was no config file at #{Dir.home}/.vmfloaty.yml"
     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
 
@@ -77,7 +77,7 @@ class NonstandardPooler
     raise ModifyError, 'Configured service type does not support snapshots'
   end
 
-  def self.delete(verbose, url, hosts, token)
+  def self.delete(verbose, url, hosts, token, _user)
     raise TokenError, 'Token provided was nil; Request cannot be made to delete VM' if token.nil?
 
     conn = Http.get_conn(verbose, url)

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?
 
@@ -94,7 +124,7 @@ class Pooler
     res_body
   end
 
-  def self.delete(verbose, url, hosts, token)
+  def self.delete(verbose, url, hosts, token, _user)
     raise TokenError, 'Token provided was nil. Request cannot be made to delete vm' if token.nil?
 
     conn = Http.get_conn(verbose, url)

data/lib/vmfloaty/service.rb

@@ -36,7 +36,7 @@ class Service
 
   def user
     unless @config['user']
-      puts "Enter your #{@config['url']} service username:"
+      FloatyLogger.info "Enter your #{@config['url']} service username:"
       @config['user'] = STDIN.gets.chomp
     end
     @config['user']
@@ -44,7 +44,7 @@ class Service
 
   def token
     unless @config['token']
-      puts 'No token found. Retrieving a token...'
+      FloatyLogger.info 'No token found. Retrieving a token...'
       @config['token'] = get_new_token(nil)
     end
     @config['token']
@@ -75,10 +75,14 @@ class Service
     @service_object.list_active verbose, url, token, user
   end
 
-  def retrieve(verbose, os_types, use_token = true)
-    puts 'Requesting a vm without a token...' unless use_token
+  def retrieve(verbose, os_types, use_token = true, ondemand = nil)
+    FloatyLogger.info 'Requesting a vm without a token...' unless use_token
     token_value = use_token ? token : nil
-    @service_object.retrieve verbose, os_types, token_value, url, user, @config
+    @service_object.retrieve verbose, os_types, token_value, url, user, @config, ondemand
+  end
+
+  def wait_for_request(verbose, requestid)
+    @service_object.wait_for_request verbose, requestid, url
   end
 
   def ssh(verbose, host_os, use_token = true)
@@ -87,20 +91,11 @@ class Service
       begin
         token_value = token || get_new_token(verbose)
       rescue TokenError => e
-        STDERR.puts e
-        STDERR.puts 'Could not get token... requesting vm without a token anyway...'
+        FloatyLogger.error e
+        FloatyLogger.info 'Could not get token... requesting vm without a token anyway...'
       end
     end
-    Ssh.ssh(verbose, host_os, token_value, url)
-  end
-
-  def pretty_print_running(verbose, hostnames = [])
-    if hostnames.empty?
-      puts 'You have no running VMs.'
-    else
-      puts 'Running VMs:'
-      @service_object.pretty_print_hosts(verbose, hostnames, url)
-    end
+    Ssh.ssh(verbose, self, host_os, token_value)
   end
 
   def query(verbose, hostname)

data/lib/vmfloaty/ssh.rb

@@ -14,21 +14,27 @@ class Ssh
     nil
   end
 
-  def self.ssh(verbose, host_os, token, url)
+  def self.command_string(verbose, service, host_os, use_token)
     ssh_path = which('ssh')
     raise 'Could not determine path to ssh' unless ssh_path
 
     os_types = {}
     os_types[host_os] = 1
 
-    response = Pooler.retrieve(verbose, os_types, token, url)
-    raise "Could not get vm from vmpooler:\n #{response}" unless response['ok']
+    response = service.retrieve(verbose, os_types, use_token)
+    raise "Could not get vm from #{service.type}:\n #{response}" unless response['ok']
 
     user = /win/.match?(host_os) ? 'Administrator' : 'root'
 
-    hostname = "#{response[host_os]['hostname']}.#{response['domain']}"
-    cmd = "#{ssh_path} #{user}@#{hostname}"
+    hostname = response[host_os]['hostname']
+    hostname = response[host_os]['hostname'][0] if response[host_os]['hostname'].is_a?(Array)
+    hostname = "#{hostname}.#{response['domain']}" unless hostname.end_with?('puppetlabs.net')
 
+    "#{ssh_path} #{user}@#{hostname}"
+  end
+
+  def self.ssh(verbose, service, host_os, use_token)
+    cmd = command_string(verbose, service, host_os, use_token)
     # TODO: Should this respect more ssh settings? Can it be configured
     #       by users ssh config and does this respect those settings?
     Kernel.exec(cmd)

data/lib/vmfloaty/utils.rb

@@ -45,7 +45,8 @@ class Utils
 
     result = {}
 
-    response_body.each do |os, value|
+    filtered_response_body = response_body.reject { |key, _| key == 'request_id' || key == 'ready' }
+    filtered_response_body.each do |os, value|
       hostnames = Array(value['hostname'])
       hostnames.map! { |host| "#{host}.#{domain}" } if domain
       result[os] = hostnames
@@ -77,41 +78,63 @@ class Utils
     os_types
   end
 
-  def self.pretty_print_hosts(verbose, service, hostnames = [])
+  def self.pretty_print_hosts(verbose, service, hostnames = [], print_to_stderr = false)
+    fetched_data = self.get_host_data(verbose, service, hostnames)
+    fetched_data.each do |hostname, host_data|
+      case service.type
+      when 'ABS'
+      # For ABS, 'hostname' variable is the jobID
+        host_data['allocated_resources'].each do |vm_name, _i|
+          puts "- [JobID:#{host_data['request']['job']['id']}] #{vm_name['hostname']} (#{vm_name['type']}) <#{host_data['state']}>"
+        end
+      when 'Pooler'
+        tag_pairs = []
+        tag_pairs = host_data['tags'].map { |key, value| "#{key}: #{value}" } unless host_data['tags'].nil?
+        duration = "#{host_data['running']}/#{host_data['lifetime']} hours"
+        metadata = [host_data['template'], duration, *tag_pairs]
+        puts "- #{hostname}.#{host_data['domain']} (#{metadata.join(', ')})"
+      when 'NonstandardPooler'
+        line = "- #{host_data['fqdn']} (#{host_data['os_triple']}"
+        line += ", #{host_data['hours_left_on_reservation']}h remaining"
+        line += ", reason: #{host_data['reserved_for_reason']}" unless host_data['reserved_for_reason'].empty?
+        line += ')'
+        puts line
+      else
+        raise "Invalid service type #{service.type}"
+      end
+    end
+  end
+
+  def self.get_host_data(verbose, service, hostnames = [])
+    result = {}
     hostnames = [hostnames] unless hostnames.is_a? Array
     hostnames.each do |hostname|
       begin
         response = service.query(verbose, hostname)
         host_data = response[hostname]
-
-        case service.type
-        when 'ABS'
-          # For ABS, 'hostname' variable is the jobID
-          if host_data['state'] == 'allocated' || host_data['state'] == 'filled'
-            host_data['allocated_resources'].each do |vm_name, _i|
-              puts "- [JobID:#{host_data['request']['job']['id']}] #{vm_name['hostname']} (#{vm_name['type']}) <#{host_data['state']}>"
+        if block_given?
+          yield host_data result
+        else
+          case service.type
+          when 'ABS'
+            # For ABS, 'hostname' variable is the jobID
+            if host_data['state'] == 'allocated' || host_data['state'] == 'filled'
+              result[hostname] = host_data
             end
+          when 'Pooler'
+            result[hostname] = host_data
+          when 'NonstandardPooler'
+            result[hostname] = host_data
+          else
+            raise "Invalid service type #{service.type}"
           end
-        when 'Pooler'
-          tag_pairs = []
-          tag_pairs = host_data['tags'].map { |key, value| "#{key}: #{value}" } unless host_data['tags'].nil?
-          duration = "#{host_data['running']}/#{host_data['lifetime']} hours"
-          metadata = [host_data['template'], duration, *tag_pairs]
-          puts "- #{hostname}.#{host_data['domain']} (#{metadata.join(', ')})"
-        when 'NonstandardPooler'
-          line = "- #{host_data['fqdn']} (#{host_data['os_triple']}"
-          line += ", #{host_data['hours_left_on_reservation']}h remaining"
-          line += ", reason: #{host_data['reserved_for_reason']}" unless host_data['reserved_for_reason'].empty?
-          line += ')'
-          puts line
-        else
-          raise "Invalid service type #{service.type}"
         end
       rescue StandardError => e
-        STDERR.puts("Something went wrong while trying to gather information on #{hostname}:")
-        STDERR.puts(e)
+        FloatyLogger.error("Something went wrong while trying to gather information on #{hostname}:")
+        FloatyLogger.error(e)
       end
     end
+    result
   end
 
   def self.pretty_print_status(verbose, service)
@@ -133,7 +156,7 @@ class Utils
           char = 'o'
           puts "#{name.ljust(width)} #{(char * ready).green}#{(char * pending).yellow}#{(char * missing).red}"
         rescue StandardError => e
-          puts "#{name.ljust(width)} #{e.red}"
+          FloatyLogger.error "#{name.ljust(width)} #{e.red}"
         end
       end
       puts message.colorize(status_response['status']['ok'] ? :default : :red)
@@ -152,11 +175,11 @@ class Utils
           char = 'o'
           puts "#{name.ljust(width)} #{(char * ready).green}#{(char * pending).yellow}#{(char * missing).red}"
         rescue StandardError => e
-          puts "#{name.ljust(width)} #{e.red}"
+          FloatyLogger.error "#{name.ljust(width)} #{e.red}"
         end
       end
     when 'ABS'
-      puts 'ABS Not OK'.red unless status_response
+      FloatyLogger.error 'ABS Not OK' unless status_response
       puts 'ABS is OK'.green if status_response
     else
       raise "Invalid service type #{service.type}"
@@ -205,6 +228,9 @@ class Utils
         # If the service is configured but some values are missing, use the top-level defaults to fill them in
         service_config.merge! config['services'][options.service]
       end
+    # No config file but service is declared on command line
+    elsif !config['services'] && options.service
+      service_config['type'] = options.service
     end
 
     # Prioritize an explicitly specified url, user, or token if the user provided one