vmfloaty 1.1.1 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cfd72279e6067194457cfff7e798bffb6c3f7e516a215ab25507836a35918dfa
-  data.tar.gz: e5f63b9b99f8969e557cf14993d89063353b2b8d2201e2945204375f4c8599f1
+  metadata.gz: 622a0112e8e8c09fd70d5c2d2b0f31e89032a907db86aebd84ce019238c3e4f5
+  data.tar.gz: 38f82e6bbf28d2669219b8f856af7876864ecdcef54e46f44c4d9dab8c09e56d
 SHA512:
-  metadata.gz: 57500a3436d64a3edc4aa8a11bcfc5590a05788268fb7c556d70816a0dede112225298f657a762c8a5eec3b829117f91599e286115237e5e039dfe5554d9d2c2
-  data.tar.gz: 288ded1bca5cfe6bff06be880b17264ddd49a10674649a1424515af7a48d646eb0b693123aee0ec353b6bb57424f209ca7cd653e1fd3287831b137593ebfe50b
+  metadata.gz: 47f457eeda161702eedd0246ea1d4e7fd146044d00d98334009746ae1dc3ab7ee1f5b80e27287ba1c4f330ee07ccdd889348362ede637503265b1b68ae3bd5b6
+  data.tar.gz: adc9ac4bf7ce2ab2ef4080b7ffc702866aa7a58177c9e6b1ab948d371e51e3deb9e6a0293dda83762633267376db831f0b4eaa036b4a0dc672268ffe51471306

data/README.md

@@ -1,8 +1,8 @@
 # vmfloaty
 
 [![Gem Version](https://badge.fury.io/rb/vmfloaty.svg)](https://badge.fury.io/rb/vmfloaty)
-[![Build Status](https://travis-ci.com/puppetlabs/vmfloaty.svg?branch=master)](https://travis-ci.com/puppetlabs/vmfloaty)
-[![Coverage Status](https://coveralls.io/repos/github/puppetlabs/vmfloaty/badge.svg?branch=master)](https://coveralls.io/github/puppetlabs/vmfloaty?branch=master)
+[![Build Status](https://github.com/puppetlabs/vmfloaty/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/puppetlabs/vmfloaty/actions/workflows/ci.yml)
+[![Coverage Status](https://github.com/puppetlabs/vmfloaty/badge.svg?branch=main)](https://coveralls.io/github/puppetlabs/vmfloaty?branch=main)
 [![Dependabot Status](https://api.dependabot.com/badges/status?host=github&repo=puppetlabs/vmfloaty)](https://dependabot.com)
 
 A CLI helper tool for [Puppet's vmpooler](https://github.com/puppetlabs/vmpooler) to help you stay afloat.

data/lib/vmfloaty/abs.rb

@@ -53,10 +53,10 @@ class ABS
   def self.list_active(verbose, url, _token, user)
     hosts = []
     get_active_requests(verbose, url, user).each do |req_hash|
-      if req_hash.key?('allocated_resources')
-        req_hash['allocated_resources'].each do |onehost|
-          hosts.push(onehost['hostname'])
-        end
+      next unless req_hash.key?('allocated_resources')
+
+      req_hash['allocated_resources'].each do |onehost|
+        hosts.push(onehost['hostname'])
       end
     end
 
@@ -116,7 +116,7 @@ class ABS
     ret_status = {}
     hosts.each do |host|
       ret_status[host] = {
-        'ok' => false,
+        'ok' => false
       }
     end
 
@@ -132,7 +132,7 @@ class ABS
         if hosts.include? vm_name['hostname']
           if all_job_resources_accounted_for(req_hash['allocated_resources'], hosts)
             ret_status[vm_name['hostname']] = {
-              'ok' => true,
+              'ok' => true
             }
             jobs_to_delete.push(req_hash)
           else
@@ -147,7 +147,7 @@ class ABS
     jobs_to_delete.each do |job|
       req_obj = {
         'job_id' => job['request']['job']['id'],
-        'hosts'  => job['allocated_resources'],
+        'hosts' => job['allocated_resources']
       }
 
       FloatyLogger.info "Deleting #{req_obj}" if verbose
@@ -172,11 +172,11 @@ class ABS
       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
+        os_list += if res_body['vmpooler_platforms'].is_a?(String)
+                     JSON.parse(res_body['vmpooler_platforms']) # legacy ABS had another JSON string always-be-scheduling/pull/306
+                   else
+                     res_body['vmpooler_platforms']
+                   end
       end
     end
 
@@ -200,11 +200,11 @@ class ABS
       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
+        os_list += if res_body['nspooler_platforms'].is_a?(String)
+                     JSON.parse(res_body['nspooler_platforms']) # legacy ABS had another JSON string always-be-scheduling/pull/306
+                   else
+                     res_body['nspooler_platforms']
+                   end
       end
     end
 
@@ -214,11 +214,11 @@ class ABS
       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
+        os_list += if res_body['aws_platforms'].is_a?(String)
+                     JSON.parse(res_body['aws_platforms']) # legacy ABS had another JSON string always-be-scheduling/pull/306
+                   else
+                     res_body['aws_platforms']
+                   end
       end
     end
 
@@ -228,7 +228,7 @@ class ABS
   end
 
   # Retrieve an OS from ABS.
-  def self.retrieve(verbose, os_types, token, url, user, config, _ondemand = nil)
+  def self.retrieve(verbose, os_types, token, url, user, config, _ondemand = nil, continue = nil)
     #
     # Contents of post must be like:
     #
@@ -248,15 +248,20 @@ class ABS
     conn = Http.get_conn(verbose, supported_abs_url(url))
     conn.headers['X-AUTH-TOKEN'] = token if token
 
-    saved_job_id = user + "-" + DateTime.now.strftime('%Q')
+    saved_job_id = if continue.nil?
+                     "#{user}-#{DateTime.now.strftime('%Q')}"
+                   else
+                     continue
+                   end
+
     req_obj = {
-      :resources => os_types,
-      :job       => {
-        :id   => saved_job_id,
-        :tags => {
-          :user => user,
-        },
-      },
+      resources: os_types,
+      job: {
+        id: saved_job_id,
+        tags: {
+          user: user
+        }
+      }
     }
 
     if config['vmpooler_fallback'] # optional and not available as cli flag
@@ -266,11 +271,12 @@ class ABS
     end
 
     if config['priority']
-      req_obj[:priority] = if config['priority'] == 'high'
+      req_obj[:priority] = case config['priority']
+                           when 'high'
                              1
-                           elsif config['priority'] == 'medium'
+                           when 'medium'
                              2
-                           elsif config['priority'] == 'low'
+                           when 'low'
                              3
                            else
                              config['priority'].to_i
@@ -281,26 +287,26 @@ class ABS
 
     # os_string = os_type.map { |os, num| Array(os) * num }.flatten.join('+')
     # raise MissingParamError, 'No operating systems provided to obtain.' if os_string.empty?
-    FloatyLogger.info "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
 
-    validate_queue_status_response(res.status, res.body, "Initial request", verbose)
+    status = validate_queue_status_response(res.status, res.body, 'Initial request', verbose)
 
     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
+        res_body = check_queue(conn, saved_job_id, req_obj, verbose)
+        return translated(res_body, saved_job_id) if res_body.is_a?(Array) # when we get a response with hostnames
 
         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})"
+        FloatyLogger.info "Waiting #{sleep_seconds}s (x#{i}) #{res_body.strip}"
 
         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}`"
+      FloatyLogger.info "\n\nFloaty interrupted, you can resume polling with\n1) `floaty get [same arguments] and adding the flag --continue #{saved_job_id}` or query the state of the queue via\n2) `floaty query #{saved_job_id}` or delete it via\n3) `floaty delete #{saved_job_id}`"
       exit 1
     end
     nil
@@ -310,10 +316,10 @@ 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, job_id)
-    vmpooler_formatted_body = {'job_id' => 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
+      if vmpooler_formatted_body[host['type']] && vmpooler_formatted_body[host['type']]['hostname'].instance_of?(Array)
         vmpooler_formatted_body[host['type']]['hostname'] << host['hostname']
       else
         vmpooler_formatted_body[host['type']] = { 'hostname' => [host['hostname']] }
@@ -324,23 +330,14 @@ class ABS
     vmpooler_formatted_body
   end
 
-  def self.check_queue(conn, job_id, req_obj, verbose)
-    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}"
-      return [nil, nil]
-    end
-
+  def self.check_queue(conn, _job_id, req_obj, verbose)
     res = conn.post 'request', req_obj.to_json
-    validate_queue_status_response(res.status, res.body, "Check queue request", verbose)
-
+    status = validate_queue_status_response(res.status, res.body, 'Check queue request', verbose)
     unless res.body.empty? || !valid_json?(res.body)
       res_body = JSON.parse(res.body)
-      return queue_info['queue_place'], res_body
+      return res_body
     end
-    [queue_info['queue_place'], nil]
+    res.body
   end
 
   def self.snapshot(_verbose, _url, _hostname, _token)
@@ -355,7 +352,7 @@ class ABS
     res.body == 'OK'
   end
 
-  def self.summary(verbose, url)
+  def self.summary(_verbose, _url)
     raise NoMethodError, 'summary is not defined for ABS'
   end
 
@@ -407,17 +404,17 @@ class ABS
 
   def self.valid_json?(json)
     JSON.parse(json)
-    return true
+    true
   rescue TypeError, JSON::ParserError => e
-    return false
+    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)
+    expected_ending = 'api/v2'
+    unless url.include?(expected_ending)
       # add a slash if missing
-      expected_ending = "/#{expected_ending}" if url[-1] != "/"
+      expected_ending = "/#{expected_ending}" if url[-1] != '/'
       url = "#{url}#{expected_ending}"
     end
     url

data/lib/vmfloaty/http.rb

@@ -21,13 +21,11 @@ class Http
 
     url = "https://#{url}" unless url?(url)
 
-    conn = Faraday.new(:url => url, :ssl => { :verify => false }) do |faraday|
+    Faraday.new(url: url, ssl: { verify: false }) do |faraday|
       faraday.request :url_encoded
       faraday.response :logger if verbose
       faraday.adapter Faraday.default_adapter
     end
-
-    conn
   end
 
   def self.get_conn_with_auth(verbose, url, user, password)
@@ -37,13 +35,11 @@ class Http
 
     url = "https://#{url}" unless url?(url)
 
-    conn = Faraday.new(:url => url, :ssl => { :verify => false }) do |faraday|
+    Faraday.new(url: url, ssl: { verify: false }) do |faraday|
       faraday.request :url_encoded
       faraday.request :basic_auth, user, password
       faraday.response :logger if verbose
       faraday.adapter Faraday.default_adapter
     end
-
-    conn
   end
 end

data/lib/vmfloaty/logger.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'logger'
 
 class FloatyLogger < ::Logger
@@ -17,11 +19,25 @@ class FloatyLogger < ::Logger
     FloatyLogger.logger.error msg
   end
 
+  def self.setlevel=(level)
+    level = level.downcase
+    case level
+    when 'debug'
+      logger.level = ::Logger::DEBUG
+    when 'info'
+      logger.level = ::Logger::INFO
+    when 'error'
+      logger.level = ::Logger::ERROR
+    else
+      error('set loglevel to debug, info or error')
+    end
+  end
+
   def initialize
-    super(STDERR)
+    super($stderr)
     self.level = ::Logger::INFO
-    self.formatter = proc do |severity, datetime, progname, msg|
-        "#{msg}\n"
+    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, ondemand = nil)
+  def self.retrieve(verbose, os_type, token, url, _user, _options, _ondemand = nil, _continue = nil)
     conn = Http.get_conn(verbose, url)
     conn.headers['X-AUTH-TOKEN'] = token if token
 
@@ -46,7 +46,8 @@ class NonstandardPooler
     raise TokenError, 'Token provided was nil; Request cannot be made to modify VM' if token.nil?
 
     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
+      raise ModifyError, "Configured service type does not support modification of #{key}" unless %i[reason
+                                                                                                     reserved_for_reason].include? key
     end
 
     if modify_hash[:reason]

data/lib/vmfloaty/pooler.rb

@@ -12,13 +12,11 @@ class Pooler
     response = conn.get 'vm'
     response_body = JSON.parse(response.body)
 
-    hosts = if os_filter
-              response_body.select { |i| i[/#{os_filter}/] }
-            else
-              response_body
-            end
-
-    hosts
+    if os_filter
+      response_body.select { |i| i[/#{os_filter}/] }
+    else
+      response_body
+    end
   end
 
   def self.list_active(verbose, url, token, _user)
@@ -28,7 +26,7 @@ class Pooler
     vms
   end
 
-  def self.retrieve(verbose, os_type, token, url, _user, _options, ondemand = nil)
+  def self.retrieve(verbose, os_type, token, url, _user, _options, ondemand = nil, _continue = nil)
     # NOTE:
     #   Developers can use `Utils.generate_os_hash` to
     #   generate the os_type param.
@@ -50,7 +48,10 @@ class Pooler
     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}" unless ondemand
+      unless ondemand
+        raise "HTTP #{response.status}: Failed to obtain VMs from the pooler at #{url}/vm/#{os_string}. #{res_body}"
+      end
+
       raise "HTTP #{response.status}: Failed to obtain VMs from the pooler at #{url}/ondemandvm/#{os_string}. #{res_body}"
     end
   end
@@ -63,7 +64,7 @@ class Pooler
       FloatyLogger.info "waiting for request #{request_id} to be fulfilled"
       sleep 5
     end
-    FloatyLogger.info "The request has been fulfilled"
+    FloatyLogger.info 'The request has been fulfilled'
     check_ondemandvm(verbose, request_id, url)
   end
 
@@ -84,8 +85,9 @@ class Pooler
   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|
-      raise ModifyError, "Configured service type does not support modification of #{key}." unless %i[tags lifetime disk].include? key
+    modify_hash.each_key do |key|
+      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)
@@ -120,8 +122,7 @@ class Pooler
 
     response = conn.post "vm/#{hostname}/disk/#{disk}"
 
-    res_body = JSON.parse(response.body)
-    res_body
+    JSON.parse(response.body)
   end
 
   def self.delete(verbose, url, hosts, token, _user)
@@ -146,25 +147,21 @@ class Pooler
     conn = Http.get_conn(verbose, url)
 
     response = conn.get '/status'
-    res_body = JSON.parse(response.body)
-    res_body
+    JSON.parse(response.body)
   end
 
   def self.summary(verbose, url)
     conn = Http.get_conn(verbose, url)
 
     response = conn.get '/summary'
-    res_body = JSON.parse(response.body)
-    res_body
+    JSON.parse(response.body)
   end
 
   def self.query(verbose, url, hostname)
     conn = Http.get_conn(verbose, url)
 
     response = conn.get "vm/#{hostname}"
-    res_body = JSON.parse(response.body)
-
-    res_body
+    JSON.parse(response.body)
   end
 
   def self.snapshot(verbose, url, hostname, token)
@@ -174,8 +171,7 @@ class Pooler
     conn.headers['X-AUTH-TOKEN'] = token
 
     response = conn.post "vm/#{hostname}/snapshot"
-    res_body = JSON.parse(response.body)
-    res_body
+    JSON.parse(response.body)
   end
 
   def self.revert(verbose, url, hostname, token, snapshot_sha)
@@ -187,7 +183,6 @@ class Pooler
     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)
-    res_body
+    JSON.parse(response.body)
   end
 end

data/lib/vmfloaty/service.rb

@@ -39,7 +39,7 @@ class Service
   def user
     unless @config['user']
       FloatyLogger.info "Enter your #{@config['url']} service username:"
-      @config['user'] = STDIN.gets.chomp
+      @config['user'] = $stdin.gets.chomp
     end
     @config['user']
   end
@@ -77,10 +77,10 @@ class Service
     @service_object.list_active verbose, url, token, user
   end
 
-  def retrieve(verbose, os_types, use_token = true, ondemand = nil)
+  def retrieve(verbose, os_types, use_token = true, ondemand = nil, continue = 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, ondemand
+    @service_object.retrieve verbose, os_types, token_value, url, user, @config, ondemand, continue
   end
 
   def wait_for_request(verbose, requestid)
@@ -140,8 +140,8 @@ class Service
   # some methods do not exist for ABS, and if possible should target the Pooler service
   def maybe_use_vmpooler
     if @service_object == ABS # this is not an instance
-      if !self.silent
-        FloatyLogger.info "The service in use is ABS, but the requested method should run against vmpooler directly, using fallback_vmpooler config from ~/.vmfloaty.yml"
+      unless silent
+        FloatyLogger.info 'The service in use is ABS, but the requested method should run against vmpooler directly, using fallback_vmpooler config from ~/.vmfloaty.yml'
         self.silent = true
       end