vmfloaty 0.8.1 → 0.10.0

data/lib/vmfloaty/nonstandard_pooler.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'vmfloaty/errors'
 require 'vmfloaty/http'
 require 'faraday'
@@ -15,27 +17,17 @@ class NonstandardPooler
     os_filter ? os_list.select { |i| i[/#{os_filter}/] } : os_list
   end
 
-  def self.list_active(verbose, url, token)
+  def self.list_active(verbose, url, token, _user)
     status = Auth.token_status(verbose, url, token)
     status['reserved_hosts'] || []
   end
 
-  def self.retrieve(verbose, os_type, token, url)
+  def self.retrieve(verbose, os_type, token, url, _user, _options)
     conn = Http.get_conn(verbose, url)
     conn.headers['X-AUTH-TOKEN'] = token if token
 
-    os_string = ''
-    os_type.each do |os, num|
-      num.times do |_i|
-        os_string << os + '+'
-      end
-    end
-
-    os_string = os_string.chomp('+')
-
-    if os_string.empty?
-      raise MissingParamError, 'No operating systems provided to obtain.'
-    end
+    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 "host/#{os_string}"
 
@@ -51,14 +43,10 @@ class NonstandardPooler
   end
 
   def self.modify(verbose, url, hostname, token, modify_hash)
-    if token.nil?
-      raise TokenError, 'Token provided was nil; Request cannot be made to modify VM'
-    end
+    raise TokenError, 'Token provided was nil; Request cannot be made to modify VM' if token.nil?
 
-    modify_hash.each do |key, value|
-      unless [:reason, :reserved_for_reason].include? key
-        raise ModifyError, "Configured service type does not support modification of #{key}"
-      end
+    modify_hash.each do |key, _value|
+      raise ModifyError, "Configured service type does not support modification of #{key}" unless %i[reason reserved_for_reason].include? key
     end
 
     if modify_hash[:reason]
@@ -77,22 +65,20 @@ class NonstandardPooler
     response.body.empty? ? {} : JSON.parse(response.body)
   end
 
-  def self.disk(verbose, url, hostname, token, disk)
+  def self.disk(_verbose, _url, _hostname, _token, _disk)
     raise ModifyError, 'Configured service type does not support modification of disk space'
   end
 
-  def self.snapshot(verbose, url, hostname, token)
+  def self.snapshot(_verbose, _url, _hostname, _token)
     raise ModifyError, 'Configured service type does not support snapshots'
   end
 
-  def self.revert(verbose, url, hostname, token, snapshot_sha)
+  def self.revert(_verbose, _url, _hostname, _token, _snapshot_sha)
     raise ModifyError, 'Configured service type does not support snapshots'
   end
 
-  def self.delete(verbose, url, hosts, token)
-    if token.nil?
-      raise TokenError, 'Token provided was nil; Request cannot be made to delete VM'
-    end
+  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)
 
@@ -100,9 +86,7 @@ class NonstandardPooler
 
     response_body = {}
 
-    unless hosts.is_a? Array
-      hosts = hosts.split(',')
-    end
+    hosts = hosts.split(',') unless hosts.is_a? Array
     hosts.each do |host|
       response = conn.delete "host/#{host}"
       res_body = JSON.parse(response.body)

data/lib/vmfloaty/pooler.rb

@@ -1,77 +1,91 @@
+# frozen_string_literal: true
+
 require 'faraday'
 require 'vmfloaty/http'
 require 'json'
 require 'vmfloaty/errors'
 
 class Pooler
-  def self.list(verbose, url, os_filter=nil)
+  def self.list(verbose, url, os_filter = nil)
     conn = Http.get_conn(verbose, url)
 
     response = conn.get 'vm'
     response_body = JSON.parse(response.body)
 
-    if os_filter
-      hosts = response_body.select { |i| i[/#{os_filter}/] }
-    else
-      hosts = response_body
-    end
+    hosts = if os_filter
+              response_body.select { |i| i[/#{os_filter}/] }
+            else
+              response_body
+            end
 
     hosts
   end
 
-  def self.list_active(verbose, url, token)
+  def self.list_active(verbose, url, token, _user)
     status = Auth.token_status(verbose, url, token)
     vms = []
-    if status[token] && status[token]['vms']
-      vms = status[token]['vms']['running']
-    end
+    vms = status[token]['vms']['running'] if status[token] && status[token]['vms']
     vms
   end
 
-  def self.retrieve(verbose, os_type, token, url)
+  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.
     conn = Http.get_conn(verbose, url)
-    if token
-      conn.headers['X-AUTH-TOKEN'] = token
-    end
+    conn.headers['X-AUTH-TOKEN'] = token if token
 
-    os_string = ""
-    os_type.each do |os,num|
-      num.times do |i|
-        os_string << os+"+"
-      end
-    end
-
-    os_string = os_string.chomp("+")
-
-    if os_string.size == 0
-      raise MissingParamError, "No operating systems provided to obtain."
-    end
+    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)
 
-    if res_body["ok"]
+    if res_body['ok']
       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.modify(verbose, url, hostname, token, modify_hash)
-    if token.nil?
-      raise TokenError, "Token provided was nil. Request cannot be made to modify vm"
+  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
+
+      STDOUT.puts "waiting for request #{request_id} to be fulfilled"
+      sleep 5
     end
+    STDOUT.puts "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?
 
     modify_hash.keys.each do |key|
-      unless [:tags, :lifetime, :disk].include? key
-        raise ModifyError, "Configured service type does not support modification of #{key}."
-      end
+      raise ModifyError, "Configured service type does not support modification of #{key}." unless %i[tags lifetime disk].include? key
     end
 
     conn = Http.get_conn(verbose, url)
@@ -88,13 +102,18 @@ class Pooler
     end
 
     res_body = JSON.parse(response.body)
-    res_body
+
+    if res_body['ok']
+      res_body
+    elsif response.status == 401
+      raise AuthError, "HTTP #{response.status}: The token provided could not authenticate to the pooler.\n#{res_body}"
+    else
+      raise ModifyError, "HTTP #{response.status}: Failed to modify VMs from the pooler vm/#{hostname}. #{res_body}"
+    end
   end
 
   def self.disk(verbose, url, hostname, token, disk)
-    if token.nil?
-      raise TokenError, "Token provided was nil. Request cannot be made to modify vm"
-    end
+    raise TokenError, 'Token provided was nil. Request cannot be made to modify vm' if token.nil?
 
     conn = Http.get_conn(verbose, url)
     conn.headers['X-AUTH-TOKEN'] = token
@@ -105,16 +124,12 @@ class Pooler
     res_body
   end
 
-  def self.delete(verbose, url, hosts, token)
-    if token.nil?
-      raise TokenError, "Token provided was nil. Request cannot be made to delete vm"
-    end
+  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)
 
-    if token
-      conn.headers['X-AUTH-TOKEN'] = token
-    end
+    conn.headers['X-AUTH-TOKEN'] = token if token
 
     response_body = {}
 
@@ -153,9 +168,7 @@ class Pooler
   end
 
   def self.snapshot(verbose, url, hostname, token)
-    if token.nil?
-      raise TokenError, "Token provided was nil. Request cannot be made to snapshot vm"
-    end
+    raise TokenError, 'Token provided was nil. Request cannot be made to snapshot vm' if token.nil?
 
     conn = Http.get_conn(verbose, url)
     conn.headers['X-AUTH-TOKEN'] = token
@@ -166,16 +179,12 @@ class Pooler
   end
 
   def self.revert(verbose, url, hostname, token, snapshot_sha)
-    if token.nil?
-      raise TokenError, "Token provided was nil. Request cannot be made to revert vm"
-    end
+    raise TokenError, 'Token provided was nil. Request cannot be made to revert vm' if token.nil?
 
     conn = Http.get_conn(verbose, url)
     conn.headers['X-AUTH-TOKEN'] = token
 
-    if snapshot_sha.nil?
-      raise "Snapshot SHA provided was nil, could not revert #{hostname}"
-    end
+    raise "Snapshot SHA provided was nil, could not revert #{hostname}" if snapshot_sha.nil?
 
     response = conn.post "vm/#{hostname}/snapshot/#{snapshot_sha}"
     res_body = JSON.parse(response.body)

data/lib/vmfloaty/service.rb

@@ -1,10 +1,11 @@
+# frozen_string_literal: true
+
 require 'commander/user_interaction'
 require 'commander/command'
 require 'vmfloaty/utils'
 require 'vmfloaty/ssh'
 
 class Service
-
   attr_reader :config
 
   def initialize(options, config_hash = {})
@@ -13,14 +14,18 @@ class Service
     @service_object = Utils.get_service_object @config['type']
   end
 
-  def method_missing(m, *args, &block)
-    if @service_object.respond_to? m
-      @service_object.send(m, *args, &block)
+  def method_missing(method_name, *args, &block)
+    if @service_object.respond_to?(method_name)
+      @service_object.send(method_name, *args, &block)
     else
       super
     end
   end
 
+  def respond_to_missing?(method_name, *)
+    @service_object.respond_to?(method_name) || super
+  end
+
   def url
     @config['url']
   end
@@ -31,7 +36,7 @@ class Service
 
   def user
     unless @config['user']
-      puts "Enter your pooler service username:"
+      puts "Enter your #{@config['url']} service username:"
       @config['user'] = STDIN.gets.chomp
     end
     @config['user']
@@ -39,7 +44,7 @@ class Service
 
   def token
     unless @config['token']
-      puts "No token found. Retrieving a token..."
+      puts 'No token found. Retrieving a token...'
       @config['token'] = get_new_token(nil)
     end
     @config['token']
@@ -47,13 +52,13 @@ class Service
 
   def get_new_token(verbose)
     username = user
-    pass = Commander::UI::password "Enter your pooler service password:", '*'
+    pass = Commander::UI.password "Enter your #{@config['url']} service password:", '*'
     Auth.get_token(verbose, url, username, pass)
   end
 
   def delete_token(verbose, token_value = @config['token'])
     username = user
-    pass = Commander::UI::password "Enter your pooler service password:", '*'
+    pass = Commander::UI.password "Enter your #{@config['url']} service password:", '*'
     Auth.delete_token(verbose, url, username, pass, token_value)
   end
 
@@ -67,13 +72,17 @@ class Service
   end
 
   def list_active(verbose)
-    @service_object.list_active verbose, url, token
+    @service_object.list_active verbose, url, token, user
   end
 
-  def retrieve(verbose, os_types, use_token = true)
+  def retrieve(verbose, os_types, use_token = true, ondemand = nil)
     puts 'Requesting a vm without a token...' unless use_token
     token_value = use_token ? token : nil
-    @service_object.retrieve verbose, os_types, token_value, url
+    @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)
@@ -86,14 +95,14 @@ class Service
         STDERR.puts 'Could not get token... requesting vm without a token anyway...'
       end
     end
-    Ssh.ssh(verbose, host_os, token_value, url)
+    Ssh.ssh(verbose, self, host_os, token_value)
   end
 
   def pretty_print_running(verbose, hostnames = [])
     if hostnames.empty?
-      puts "You have no running VMs."
+      puts 'You have no running VMs.'
     else
-      puts "Running VMs:"
+      puts 'Running VMs:'
       @service_object.pretty_print_hosts(verbose, hostnames, url)
     end
   end
@@ -107,7 +116,7 @@ class Service
   end
 
   def delete(verbose, hosts)
-    @service_object.delete verbose, url, hosts, token
+    @service_object.delete verbose, url, hosts, token, user
   end
 
   def status(verbose)
@@ -129,5 +138,4 @@ class Service
   def disk(verbose, hostname, disk)
     @service_object.disk(verbose, url, hostname, token, disk)
   end
-
-end
+end

data/lib/vmfloaty/ssh.rb

@@ -1,43 +1,43 @@
-class Ssh
+# frozen_string_literal: true
 
+class Ssh
   def self.which(cmd)
     # Gets path of executable for given command
 
     exts = ENV['PATHEXT'] ? ENV['PATHEXT'].split(';') : ['']
     ENV['PATH'].split(File::PATH_SEPARATOR).each do |path|
-      exts.each { |ext|
+      exts.each do |ext|
         exe = File.join(path, "#{cmd}#{ext}")
         return exe if File.executable?(exe) && !File.directory?(exe)
-      }
+      end
     end
-    return nil
+    nil
   end
 
-  def self.ssh(verbose, host_os, token, url)
-    ssh_path = which("ssh")
-    if !ssh_path
-      raise "Could not determine path to ssh"
-    end
+  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)
-    if response["ok"] == true
-      if host_os =~ /win/
-        user = "Administrator"
-      else
-        user = "root"
-      end
+    response = service.retrieve(verbose, os_types, use_token)
+    raise "Could not get vm from #{service.type}:\n #{response}" unless response['ok']
 
-      hostname = "#{response[host_os]["hostname"]}.#{response["domain"]}"
-      cmd = "#{ssh_path} #{user}@#{hostname}"
+    user = /win/.match?(host_os) ? 'Administrator' : 'root'
 
-      # TODO: Should this respect more ssh settings? Can it be configured
-      #       by users ssh config and does this respect those settings?
-      Kernel.exec(cmd)
-    else
-      raise "Could not get vm from vmpooler:\n #{response}"
-    end
-    return
+    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)
+    nil
   end
 end