vmfloaty 1.2.0 → 1.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d229737ed9cb959ec725227d7c344ad56c1af7fcd7a53a59502fdb5bf7c0c696
-  data.tar.gz: 4625d46bc08dc61e806beff43237adac120d509ae704c437b47d56a4ef5413bf
+  metadata.gz: cf8e6d210de6ae23fdd371025ace279b939768d1f197b81b2226f326263bc204
+  data.tar.gz: 7da421b68bb4377e31c4e5784e394ab672adb616ce8be4376e55f0006dd81849
 SHA512:
-  metadata.gz: 8763f1c3849bfa0ab7ad2f45cae9737ab16c4f96c7aa9ff9545126979bc7ab611cc40db1c5ace88d812a1dc7004eafa8b27210df92cbe316aff07480db9fe80a
-  data.tar.gz: eb5691d5fc84dc667abb0609c6ed9ce1222838e07cc3a5818c5d7294c888e869d28b8fd89300787e4691cfbf691b12356d01c2528d6c2235d832e7245b220dc3
+  metadata.gz: 846823d38e3b7dc5cfa066efcda72a6f58ad11ce875529a3ac6443551a138fbc3e05e262226e3dd756e93e8d31c9fa5c3bb4639f139158f5903a95c43bfb9b40
+  data.tar.gz: e693187229fb1b845e4a2b24f9bf9b22e7b0e4244887f8c1fc6042e64d6082638266b56421e04a46948b2efc92e4abd3e4d0ccdf28e345e30a89a77909872022

data/README.md

@@ -1,11 +1,9 @@
 # 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)
-[![Dependabot Status](https://api.dependabot.com/badges/status?host=github&repo=puppetlabs/vmfloaty)](https://dependabot.com)
+[![CI](https://github.com/puppetlabs/vmfloaty/actions/workflows/ci.yml/badge.svg)](https://github.com/puppetlabs/vmfloaty/actions/workflows/ci.yml)
 
-A CLI helper tool for [Puppet's vmpooler](https://github.com/puppetlabs/vmpooler) to help you stay afloat.
+A CLI helper tool for [Puppet's VMPooler](https://github.com/puppetlabs/vmpooler) to help you stay afloat.
 
 ![float image](float.jpg)
 
@@ -18,7 +16,7 @@ A CLI helper tool for [Puppet's vmpooler](https://github.com/puppetlabs/vmpooler
     - [Using backends besides VMPooler](#using-backends-besides-vmpooler)
     - [Valid config keys](#valid-config-keys)
   - [Tab Completion](#tab-completion)
-- [vmpooler API](#vmpooler-api)
+- [VMPooler API](#vmpooler-api)
 - [Using the Pooler class](#using-the-pooler-class)
   - [Example Projects](#example-projects)
 - [Special thanks](#special-thanks)
@@ -41,7 +39,7 @@ $ floaty --help
 
   DESCRIPTION:
 
-    A CLI helper tool for Puppet's vmpooler to help you stay afloat
+    A CLI helper tool for Puppet's VMPooler to help you stay afloat
 
   COMMANDS:
 
@@ -151,13 +149,13 @@ There is also tab completion for zsh:
 source $(floaty completion --shell zsh)
 ```
 
-## vmpooler API
+## VMPooler API
 
-This cli tool uses the [vmpooler API](https://github.com/puppetlabs/vmpooler/blob/master/API.md).
+This cli tool uses the [VMPooler API](https://github.com/puppetlabs/vmpooler/blob/master/API.md).
 
 ## Using the Pooler class
 
-vmfloaty providers a `Pooler` class that gives users the ability to make requests to vmpooler without having to write their own requests. It also provides an `Auth` class for managing vmpooler tokens within your application.
+vmfloaty providers a `Pooler` class that gives users the ability to make requests to VMPooler without having to write their own requests. It also provides an `Auth` class for managing VMPooler tokens within your application.
 
 ### Example Projects
 

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
 
@@ -248,20 +248,20 @@ class ABS
     conn = Http.get_conn(verbose, supported_abs_url(url))
     conn.headers['X-AUTH-TOKEN'] = token if token
 
-    if continue.nil?
-      saved_job_id = user + "-" + DateTime.now.strftime('%Q')
-    else
-      saved_job_id = continue
-    end
+    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
@@ -271,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
@@ -291,14 +292,12 @@ class ABS
 
     retries = 360
 
-    status = 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|
         res_body = check_queue(conn, saved_job_id, req_obj, verbose)
-        if res_body && res_body.is_a?(Array) # when we get a response with hostnames
-          return translated(res_body, saved_job_id)
-        end
+        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
@@ -317,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']] }
@@ -331,9 +330,9 @@ class ABS
     vmpooler_formatted_body
   end
 
-  def self.check_queue(conn, job_id, req_obj, verbose)
+  def self.check_queue(conn, _job_id, req_obj, verbose)
     res = conn.post 'request', req_obj.to_json
-    status = 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 res_body
@@ -353,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
 
@@ -405,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
@@ -19,22 +21,23 @@ class FloatyLogger < ::Logger
 
   def self.setlevel=(level)
     level = level.downcase
-    if level == "debug"
-      self.logger.level = ::Logger::DEBUG
-    elsif level == "info"
-      self.logger.level = ::Logger::INFO
-    elsif level == "error"
-      self.logger.level = ::Logger::ERROR
+    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")
+      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, _continue = 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)
@@ -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
@@ -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