vmfloaty 1.3.0 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3250656d33ed86eadaeded7da8f91b1c320f38ee9e8637d657273b43dab897f4
-  data.tar.gz: 1b78092a62379ee36ce7c78dc52a0f7920366dc15e3795edc4c2be3a33a53f15
+  metadata.gz: 7dde0d683f0fd9ba231b9441473e3b501fc45979de87256403809c68e03c1b43
+  data.tar.gz: 79e88b4ff40d432fcea114b82b2cd8ef952d74e8b4bb6a3bcf047be345d54be6
 SHA512:
-  metadata.gz: 3f0bab1c9aeda1ecc76b0246faac85267528ae2cc9708bf9ca430134e1535af701d565be9a1a4f32566d4d07d21d6a02e73d4d9f3188183206a6bbcb1274796d
-  data.tar.gz: 020e1ffbc61da0d7784e453229e82c737939ff864d0c9a7a36d4ed563827a01a2328681d5832a808f0dd0613e26fd4f07b81f9769df3be72a5dd85111cd4505f
+  metadata.gz: b6c470d8d4c369f5e39b8a42d031ae4378165278e44bd00cacfbdfc7dc7aabafdf8a8bb1291fe33ab081be7c1c45195e10567708e45a0c34d2ff40340338b8e3
+  data.tar.gz: 2f7305e4f363dbb71ae45d1d14a38ddbde7289e6c5d0d58c72faef01c6840ae39ad76eacde81b638387dc12fcdcf446ad5225f0dad8d4f87c346ba57a8e587a9

data/lib/vmfloaty.rb

@@ -20,7 +20,8 @@ class Vmfloaty
 
   def run # rubocop:disable Metrics/AbcSize
     program :version, Vmfloaty::VERSION
-    program :description, "A CLI helper tool for Puppet's vmpooler to help you stay afloat.\n\nConfiguration may be placed in a ~/.vmfloaty.yml file."
+    program :description,
+            "A CLI helper tool for Puppet's vmpooler to help you stay afloat.\n\nConfiguration may be placed in a ~/.vmfloaty.yml file."
 
     config = Conf.read_config
 
@@ -43,9 +44,7 @@ class Vmfloaty
       c.option '--loglevel STRING', String, 'the log level to use (debug, info, error)'
       c.action do |args, options|
         verbose = options.verbose || config['verbose']
-        if options.loglevel
-          FloatyLogger.setlevel = options.loglevel
-        end
+        FloatyLogger.setlevel = options.loglevel if options.loglevel
         service = Service.new(options, config)
         use_token = !options.notoken
         force = options.force
@@ -100,21 +99,19 @@ class Vmfloaty
       c.option '--loglevel STRING', String, 'the log level to use (debug, info, error)'
       c.action do |args, options|
         verbose = options.verbose || config['verbose']
-        if options.loglevel
-          FloatyLogger.setlevel = options.loglevel
-        end
+        FloatyLogger.setlevel = options.loglevel if options.loglevel
 
         service = Service.new(options, config)
         filter = args[0]
 
         if options.active
           # list active vms
-          if service.type == "ABS"
-            # this is actually job_ids
-            running_vms = service.list_active_job_ids(verbose, service.url, service.user)
-          else
-            running_vms = service.list_active(verbose)
-          end
+          running_vms = if service.type == 'ABS'
+                          # this is actually job_ids
+                          service.list_active_job_ids(verbose, service.url, service.user)
+                        else
+                          service.list_active(verbose)
+                        end
           host = URI.parse(service.url).host
           if running_vms.empty?
             if options.json
@@ -122,17 +119,15 @@ class Vmfloaty
             else
               FloatyLogger.info "You have no running VMs on #{host}"
             end
-          else
-            if options.json
-              puts Utils.get_host_data(verbose, service, running_vms).to_json
-            elsif options.hostnameonly
-              Utils.get_host_data(verbose, service, running_vms).each do |hostname, host_data|
-                Utils.print_fqdn_for_host(service, hostname, host_data)
-              end
-            else
-              puts "Your VMs on #{host}:"
-              Utils.pretty_print_hosts(verbose, service, running_vms)
+          elsif options.json
+            puts Utils.get_host_data(verbose, service, running_vms).to_json
+          elsif options.hostnameonly
+            Utils.get_host_data(verbose, service, running_vms).each do |hostname, host_data|
+              Utils.print_fqdn_for_host(service, hostname, host_data)
             end
+          else
+            puts "Your VMs on #{host}:"
+            Utils.pretty_print_hosts(verbose, service, running_vms)
           end
         else
           # list available vms from pooler
@@ -164,7 +159,8 @@ class Vmfloaty
       c.syntax = 'floaty modify hostname [options]'
       c.summary = 'Modify a VM\'s tags, time to live, disk space, or reservation reason'
       c.description = 'This command makes modifications to the virtual machines state in the pooler service. You can either append tags to the vm, increase how long it stays active for, or increase the amount of disk space.'
-      c.example 'Modifies myhost1 to have a TTL of 12 hours and adds a custom tag', 'floaty modify myhost1 --lifetime 12 --url https://myurl --token mytokenstring --tags \'{"tag":"myvalue"}\''
+      c.example 'Modifies myhost1 to have a TTL of 12 hours and adds a custom tag',
+                'floaty modify myhost1 --lifetime 12 --url https://myurl --token mytokenstring --tags \'{"tag":"myvalue"}\''
       c.option '--verbose', 'Enables verbose output'
       c.option '--service STRING', String, 'Configured pooler service name'
       c.option '--url STRING', String, 'URL of pooler service'
@@ -185,18 +181,18 @@ class Vmfloaty
           exit 1
         end
         running_vms =
-            if modify_all
-              service.list_active(verbose)
-            else
-              hostname.split(',')
-            end
+          if modify_all
+            service.list_active(verbose)
+          else
+            hostname.split(',')
+          end
 
         tags = options.tags ? JSON.parse(options.tags) : nil
         modify_hash = {
-          :lifetime => options.lifetime,
-          :disk     => options.disk,
-          :tags     => tags,
-          :reason   => options.reason,
+          lifetime: options.lifetime,
+          disk: options.disk,
+          tags: tags,
+          reason: options.reason
         }
         modify_hash.delete_if { |_, value| value.nil? }
 
@@ -204,12 +200,10 @@ class Vmfloaty
           ok = true
           modified_hash = {}
           running_vms.each do |vm|
-            begin
-              modified_hash[vm] = service.modify(verbose, vm, modify_hash)
-            rescue ModifyError => e
-              FloatyLogger.error e
-              ok = false
-            end
+            modified_hash[vm] = service.modify(verbose, vm, modify_hash)
+          rescue ModifyError => e
+            FloatyLogger.error e
+            ok = false
           end
           if ok
             if modify_all
@@ -241,9 +235,7 @@ class Vmfloaty
       c.option '--loglevel STRING', String, 'the log level to use (debug, info, error)'
       c.action do |args, options|
         verbose = options.verbose || config['verbose']
-        if options.loglevel
-          FloatyLogger.setlevel = options.loglevel
-        end
+        FloatyLogger.setlevel = options.loglevel if options.loglevel
 
         service = Service.new(options, config)
         hostnames = args[0]
@@ -254,17 +246,17 @@ class Vmfloaty
         successes = []
 
         if delete_all
-          if service.type == "ABS"
-            # this is actually job_ids
-            running_vms = service.list_active_job_ids(verbose, service.url, service.user)
-          else
-            running_vms = service.list_active(verbose)
-          end
+          running_vms = if service.type == 'ABS'
+                          # this is actually job_ids
+                          service.list_active_job_ids(verbose, service.url, service.user)
+                        else
+                          service.list_active(verbose)
+                        end
           if running_vms.empty?
             if options.json
               puts {}.to_json
             else
-              FloatyLogger.info "You have no running VMs."
+              FloatyLogger.info 'You have no running VMs.'
             end
           else
             confirmed = true
@@ -328,7 +320,8 @@ class Vmfloaty
       c.syntax = 'floaty snapshot hostname [options]'
       c.summary = 'Takes a snapshot of a given vm'
       c.description = 'Will request a snapshot be taken of the given hostname in the pooler service. This command is known to take a while depending on how much load is on the pooler service.'
-      c.example 'Takes a snapshot for a given host', 'floaty snapshot myvm.example.com --url http://vmpooler.example.com --token a9znth9dn01t416hrguu56ze37t790bl'
+      c.example 'Takes a snapshot for a given host',
+                'floaty snapshot myvm.example.com --url http://vmpooler.example.com --token a9znth9dn01t416hrguu56ze37t790bl'
       c.option '--verbose', 'Enables verbose output'
       c.option '--service STRING', String, 'Configured pooler service name'
       c.option '--url STRING', String, 'URL of pooler service'
@@ -354,7 +347,8 @@ class Vmfloaty
       c.syntax = 'floaty revert hostname snapshot [options]'
       c.summary = 'Reverts a vm to a specified snapshot'
       c.description = 'Given a snapshot SHA, vmfloaty will request a revert to the pooler service to go back to a previous snapshot.'
-      c.example 'Reverts to a snapshot for a given host', 'floaty revert myvm.example.com n4eb4kdtp7rwv4x158366vd9jhac8btq --url http://vmpooler.example.com --token a9znth9dn01t416hrguu56ze37t790bl'
+      c.example 'Reverts to a snapshot for a given host',
+                'floaty revert myvm.example.com n4eb4kdtp7rwv4x158366vd9jhac8btq --url http://vmpooler.example.com --token a9znth9dn01t416hrguu56ze37t790bl'
       c.option '--verbose', 'Enables verbose output'
       c.option '--service STRING', String, 'Configured pooler service name'
       c.option '--url STRING', String, 'URL of pooler service'
@@ -366,7 +360,9 @@ class Vmfloaty
         hostname = args[0]
         snapshot_sha = args[1] || options.snapshot
 
-        FloatyLogger.info "Two snapshot arguments were given....using snapshot #{snapshot_sha}" if args[1] && options.snapshot
+        if args[1] && options.snapshot
+          FloatyLogger.info "Two snapshot arguments were given....using snapshot #{snapshot_sha}"
+        end
 
         begin
           revert_req = service.revert(verbose, hostname, snapshot_sha)
@@ -391,9 +387,7 @@ class Vmfloaty
       c.option '--loglevel STRING', String, 'the log level to use (debug, info, error)'
       c.action do |_, options|
         verbose = options.verbose || config['verbose']
-        if options.loglevel
-          FloatyLogger.setlevel = options.loglevel
-        end
+        FloatyLogger.setlevel = options.loglevel if options.loglevel
         service = Service.new(options, config)
         if options.json
           pp service.status(verbose)
@@ -527,7 +521,7 @@ class Vmfloaty
       c.example 'Print a list of the valid service types', 'floaty service types'
       c.example 'Print a sample config file with multiple services', 'floaty service examples'
       c.example 'list vms from the service named "nspooler-prod"', 'floaty list --service nspooler-prod'
-      c.action do |args, options|
+      c.action do |args, _options|
         action = args.first
 
         example_config = Utils.strip_heredoc(<<-CONFIG)

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