vmpooler 0.10.3 → 0.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e1235ece5040bd685dafa1fb0d1d4a63b0002d80e58e2890d83b126d8a9ba51b
-  data.tar.gz: d9d623741face3692fc412b07737f29d5f0b727821d80e19277aa90c6936f504
+  metadata.gz: eb4bf5469c97ce1d8a7a7a68f5241d70ea77f392f389bba5a640de020d9851a8
+  data.tar.gz: 089dd8a8a4369275858f40529a3e669b853ae4ff1fdd65009a7da7051388e9ff
 SHA512:
-  metadata.gz: 409abfb3eb3e438a9e4d87a4fb95137b776d31a3d0ccad79b052589da56b052fad6df924a8fbf34eec5d2998878b409f149dfa8bd3d5665e490e3744af1f8fee
-  data.tar.gz: bcc2e4db8092b9b2c31bfb0327ee1394fa92f87d513dcee2488e114203bedd72f6a2cc8ef7dd99675014acc5cf6b72305fc21ac7a614bc57bf0dda9dbecc8835
+  metadata.gz: b094cac19b6a36afb1f1f5c43bf7c000116034169ef9a7d43a821ab595eb7feb6f799673b669f1d1acf19bde2f52b9ae96513a5f0bce96021719a0825a2effc0
+  data.tar.gz: 0b68695a5916fe1a013470f868f1d2cf6955d0f6ad14efb50530d9fb339fae2a488ec756cb2b76d4d81d19401e4f525e9693545b70f36215d2e14515e5b23343

data/bin/vmpooler

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 require 'vmpooler'
 
@@ -49,6 +50,4 @@ if ENV['VMPOOLER_DEBUG']
   end
 end
 
-torun_threads.each do |th|
-  th.join
-end
+torun_threads.each(&:join)

data/lib/vmpooler/api/dashboard.rb

@@ -1,7 +1,8 @@
+# frozen_string_literal: true
+
 module Vmpooler
   class API
     class Dashboard < Sinatra::Base
-
       helpers do
         include Vmpooler::API::Helpers
       end
@@ -21,9 +22,11 @@ module Vmpooler
 
         if config[:graphs]
           return false unless config[:graphs]['server']
+
           @graph_server = config[:graphs]['server']
         elsif config[:graphite]
           return false unless config[:graphite]['server']
+
           @graph_server = config[:graphite]['server']
         else
           false
@@ -36,9 +39,11 @@ module Vmpooler
 
         if config[:graphs]
           return 'vmpooler' unless config[:graphs]['prefix']
+
           @graph_prefix = config[:graphs]['prefix']
         elsif config[:graphite]
           return false unless config[:graphite]['prefix']
+
           @graph_prefix = config[:graphite]['prefix']
         else
           false
@@ -48,12 +53,14 @@ module Vmpooler
       # what is the base URL for viewable graphs?
       def graph_url
         return false unless graph_server && graph_prefix
+
         @graph_url ||= "http://#{graph_server}/render?target=#{graph_prefix}"
       end
 
       # return a full URL to a viewable graph for a given metrics target (graphite syntax)
       def graph_link(target = '')
         return '' unless graph_url
+
         graph_url + target
       end
 
@@ -76,7 +83,7 @@ module Vmpooler
             history ||= {}
 
             begin
-              buffer = open(graph_link('.ready.*&from=-1hour&format=json')).read
+              buffer = URI.parse(graph_link('.ready.*&from=-1hour&format=json')).read
               history = JSON.parse(buffer)
 
               history.each do |pool|
@@ -100,7 +107,7 @@ module Vmpooler
                   end
                 end
               end
-            rescue
+            rescue StandardError
             end
           else
             pools.each do |pool|
@@ -129,7 +136,7 @@ module Vmpooler
         if params[:history]
           if graph_url
             begin
-              buffer = open(graph_link('.running.*&from=-1hour&format=json')).read
+              buffer = URI.parse(graph_link('.running.*&from=-1hour&format=json')).read
               JSON.parse(buffer).each do |pool|
                 if pool['target'] =~ /.*\.(.*)$/
                   pool['name'] = Regexp.last_match[1]
@@ -147,7 +154,7 @@ module Vmpooler
                   end
                 end
               end
-            rescue
+            rescue StandardError
             end
           end
         end

data/lib/vmpooler/api/helpers.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Vmpooler
 
   class API
@@ -71,43 +73,44 @@ module Vmpooler
         )
 
         return true if ldap.bind
+
         return false
       end
 
       def authenticate(auth, username_str, password_str)
         case auth['provider']
-          when 'dummy'
-            return (username_str != password_str)
-          when 'ldap'
-            ldap_base = auth[:ldap]['base']
-            ldap_port = auth[:ldap]['port'] || 389
-
-            if ldap_base.is_a? Array
-              ldap_base.each do |search_base|
-                result = authenticate_ldap(
-                  ldap_port,
-                  auth[:ldap]['host'],
-                  auth[:ldap]['user_object'],
-                  search_base,
-                  username_str,
-                  password_str,
-                )
-                return true if result == true
-              end
-            else
+        when 'dummy'
+          return (username_str != password_str)
+        when 'ldap'
+          ldap_base = auth[:ldap]['base']
+          ldap_port = auth[:ldap]['port'] || 389
+
+          if ldap_base.is_a? Array
+            ldap_base.each do |search_base|
               result = authenticate_ldap(
                 ldap_port,
                 auth[:ldap]['host'],
                 auth[:ldap]['user_object'],
-                ldap_base,
+                search_base,
                 username_str,
-                password_str,
+                password_str
               )
-              return result
+              return true if result == true
             end
-
-            return false
+          else
+            result = authenticate_ldap(
+              ldap_port,
+              auth[:ldap]['host'],
+              auth[:ldap]['user_object'],
+              ldap_base,
+              username_str,
+              password_str
+            )
+            return result
           end
+
+          return false
+        end
       end
 
       def export_tags(backend, hostname, tags)
@@ -124,6 +127,7 @@ module Vmpooler
 
         tags.each_pair do |tag, value|
           next unless filter = Vmpooler::API.settings.config[:tagfilter][tag]
+
           tags[tag] = value.match(filter).captures.join if value.match(filter)
         end
 
@@ -161,7 +165,7 @@ module Vmpooler
             backend.scard(key + pool['name'])
           end
         end
-        res.inject(0){ |m, x| m+x }.to_i
+        res.inject(0) { |m, x| m + x }.to_i
       end
 
       # Takes the pools and a key to run scard on
@@ -201,18 +205,18 @@ module Vmpooler
       def get_capacity_metrics(pools, backend)
         capacity = {
             current: 0,
-            total:   0,
+            total: 0,
             percent: 0
         }
 
         pools.each do |pool|
-          capacity[:total]   += pool['size'].to_i
+          capacity[:total] += pool['size'].to_i
         end
 
         capacity[:current] = get_total_across_pools_redis_scard(pools, 'vmpooler__ready__', backend)
 
         if capacity[:total] > 0
-          capacity[:percent] = ((capacity[:current].to_f / capacity[:total].to_f) * 100.0).round(1)
+          capacity[:percent] = (capacity[:current].fdiv(capacity[:total]) * 100.0).round(1)
         end
 
         capacity
@@ -220,16 +224,16 @@ module Vmpooler
 
       def get_queue_metrics(pools, backend)
         queue = {
-            pending:   0,
-            cloning:   0,
-            booting:   0,
-            ready:     0,
-            running:   0,
+            pending: 0,
+            cloning: 0,
+            booting: 0,
+            ready: 0,
+            running: 0,
             completed: 0,
-            total:     0
+            total: 0
         }
 
-        queue[:pending]   = get_total_across_pools_redis_scard(pools,'vmpooler__pending__', backend)
+        queue[:pending]   = get_total_across_pools_redis_scard(pools, 'vmpooler__pending__', backend)
         queue[:ready]     = get_total_across_pools_redis_scard(pools, 'vmpooler__ready__', backend)
         queue[:running]   = get_total_across_pools_redis_scard(pools, 'vmpooler__running__', backend)
         queue[:completed] = get_total_across_pools_redis_scard(pools, 'vmpooler__completed__', backend)
@@ -306,11 +310,11 @@ module Vmpooler
         task = {
             duration: {
                 average: 0,
-                min:     0,
-                max:     0,
-                total:   0
+                min: 0,
+                max: 0,
+                total: 0
             },
-            count:    {
+            count: {
                 total: 0
             }
         }
@@ -450,7 +454,7 @@ module Vmpooler
       def pool_index(pools)
         pools_hash = {}
         index = 0
-        for pool in pools
+        pools.each do |pool|
           pools_hash[pool['name']] = index
           index += 1
         end
@@ -461,13 +465,14 @@ module Vmpooler
         prepared_template = backend.hget('vmpooler__template__prepared', pool['name'])
         return false if prepared_template.nil?
         return true if pool['template'] == prepared_template
+
         return false
       end
 
       def is_integer?(x)
         Integer(x)
         true
-      rescue
+      rescue StandardError
         false
       end
 
@@ -487,7 +492,7 @@ module Vmpooler
       def vm_ready?(vm_name, domain = nil)
         begin
           open_socket(vm_name, domain)
-        rescue => _err
+        rescue StandardError => _e
           return false
         end
 

data/lib/vmpooler/api/reroute.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Vmpooler
   class API
     class Reroute < Sinatra::Base

data/lib/vmpooler/api/v1.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Vmpooler
   class API
   class V1 < Sinatra::Base
@@ -37,22 +39,24 @@ module Vmpooler
     end
 
     def checkoutlock
-      Vmpooler::API::settings.checkoutlock
+      Vmpooler::API.settings.checkoutlock
     end
 
     def fetch_single_vm(template)
       template_backends = [template]
       aliases = Vmpooler::API.settings.config[:alias]
       if aliases
-        template_backends = template_backends + aliases[template] if aliases[template].is_a?(Array)
+        template_backends += aliases[template] if aliases[template].is_a?(Array)
         template_backends << aliases[template] if aliases[template].is_a?(String)
         pool_index = pool_index(pools)
         weighted_pools = {}
         template_backends.each do |t|
           next unless pool_index.key? t
+
           index = pool_index[t]
           clone_target = pools[index]['clone_target'] || config['clone_target']
           next unless config.key?('backend_weight')
+
           weight = config['backend_weight'][clone_target]
           if weight
             weighted_pools[t] = weight
@@ -75,6 +79,7 @@ module Vmpooler
         template_backends.each do |template_backend|
           vms = backend.smembers("vmpooler__ready__#{template_backend}")
           next if vms.empty?
+
           vms.reverse.each do |vm|
             ready = vm_ready?(vm, config['domain'])
             if ready
@@ -104,7 +109,7 @@ module Vmpooler
 
         backend.hset('vmpooler__vm__' + vm, 'token:token', request.env['HTTP_X_AUTH_TOKEN'])
         backend.hset('vmpooler__vm__' + vm, 'token:user',
-          backend.hget('vmpooler__token__' + request.env['HTTP_X_AUTH_TOKEN'], 'user')
+                     backend.hget('vmpooler__token__' + request.env['HTTP_X_AUTH_TOKEN'], 'user')
         )
 
         if config['vm_lifetime_auth'].to_i > 0
@@ -136,14 +141,14 @@ module Vmpooler
             metrics.increment('checkout.empty.' + requested)
             break
           else
-            vms << [ vmpool, vmname, vmtemplate ]
+            vms << [vmpool, vmname, vmtemplate]
             metrics.increment('checkout.success.' + vmtemplate)
           end
         end
       end
 
       if failed
-        vms.each do |(vmpool, vmname, vmtemplate)|
+        vms.each do |(vmpool, vmname, _vmtemplate)|
           return_vm_to_ready_state(vmpool, vmname)
         end
         status 503
@@ -203,7 +208,7 @@ module Vmpooler
     def reset_pool(payload)
       result = { 'ok' => false }
 
-      payload.each do |poolname, count|
+      payload.each do |poolname, _count|
         backend.sadd('vmpooler__poolreset', poolname)
       end
       status 201
@@ -220,7 +225,7 @@ module Vmpooler
 
       payload.each do |poolname, clone_target|
         unless pools[pool_index[poolname]]['clone_target'] == clone_target
-          pools[pool_index[poolname]]['clone_target'] == clone_target
+          pools[pool_index[poolname]]['clone_target'] = clone_target
           backend.hset('vmpooler__config__clone_target', poolname, clone_target)
           pools_updated += 1
           status 201
@@ -234,42 +239,36 @@ module Vmpooler
     def sync_pool_templates
       pool_index = pool_index(pools)
       template_configs = backend.hgetall('vmpooler__config__template')
-      unless template_configs.nil?
-        template_configs.each do |poolname, template|
+      template_configs&.each do |poolname, template|
           if pool_index.include? poolname
             unless pools[pool_index[poolname]]['template'] == template
               pools[pool_index[poolname]]['template'] = template
             end
           end
-        end
       end
     end
 
     def sync_pool_sizes
       pool_index = pool_index(pools)
       poolsize_configs = backend.hgetall('vmpooler__config__poolsize')
-      unless poolsize_configs.nil?
-        poolsize_configs.each do |poolname, size|
+      poolsize_configs&.each do |poolname, size|
           if pool_index.include? poolname
             unless pools[pool_index[poolname]]['size'] == size.to_i
               pools[pool_index[poolname]]['size'] == size.to_i
             end
           end
-        end
       end
     end
 
     def sync_clone_targets
       pool_index = pool_index(pools)
       clone_target_configs = backend.hgetall('vmpooler__config__clone_target')
-      unless clone_target_configs.nil?
-        clone_target_configs.each do |poolname, clone_target|
+      clone_target_configs&.each do |poolname, clone_target|
           if pool_index.include? poolname
             unless pools[pool_index[poolname]]['clone_target'] == clone_target
               pools[pool_index[poolname]]['clone_target'] == clone_target
-              end
+            end
           end
-        end
       end
     end
 
@@ -368,36 +367,38 @@ module Vmpooler
       pending_hash = get_list_across_pools_redis_scard(pools, 'vmpooler__pending__', backend)
       lastBoot_hash = get_list_across_pools_redis_hget(pools, 'vmpooler__lastboot', backend)
 
-      pools.each do |pool|
-        # REMIND: move this out of the API and into the back-end
-        ready    = ready_hash[pool['name']]
-        running  = running_hash[pool['name']]
-        pending  = pending_hash[pool['name']]
-        max      = pool['size']
-        lastBoot = lastBoot_hash[pool['name']]
-        aka      = pool['alias']
-
-        result[:pools][pool['name']] = {
-          ready:    ready,
-          running:  running,
-          pending:  pending,
-          max:      max,
-          lastBoot: lastBoot
-        }
+      unless views and not views.include?("pools")
+        pools.each do |pool|
+          # REMIND: move this out of the API and into the back-end
+          ready    = ready_hash[pool['name']]
+          running  = running_hash[pool['name']]
+          pending  = pending_hash[pool['name']]
+          max      = pool['size']
+          lastBoot = lastBoot_hash[pool['name']]
+          aka      = pool['alias']
+
+          result[:pools][pool['name']] = {
+            ready: ready,
+            running: running,
+            pending: pending,
+            max: max,
+            lastBoot: lastBoot
+          }
 
-        if aka
-          result[:pools][pool['name']][:alias] = aka
-        end
+          if aka
+            result[:pools][pool['name']][:alias] = aka
+          end
 
-        # for backwards compatibility, include separate "empty" stats in "status" block
-        if ready == 0
-          result[:status][:empty] ||= []
-          result[:status][:empty].push(pool['name'])
+          # for backwards compatibility, include separate "empty" stats in "status" block
+          if ready == 0
+            result[:status][:empty] ||= []
+            result[:status][:empty].push(pool['name'])
 
-          result[:status][:ok] = false
-          result[:status][:message] = "Found #{result[:status][:empty].length} empty pools."
+            result[:status][:ok] = false
+            result[:status][:message] = "Found #{result[:status][:empty].length} empty pools."
+          end
         end
-      end unless views and not views.include?("pools")
+      end
 
       result[:status][:uptime] = (Time.now - Vmpooler::API.settings.config[:uptime]).round(1) if Vmpooler::API.settings.config[:uptime]
 
@@ -442,7 +443,6 @@ module Vmpooler
         if aka
           result[:pools][pool['name']][:alias] = aka
         end
-
       end
 
       ready_hash = get_list_across_pools_redis_scard(poolscopy, 'vmpooler__ready__', backend)
@@ -456,7 +456,7 @@ module Vmpooler
     get "#{api_prefix}/totalrunning/?" do
       content_type :json
       queue = {
-          running:   0,
+          running: 0
       }
 
       queue[:running] = get_total_across_pools_redis_scard(pools, 'vmpooler__running__', backend)
@@ -753,7 +753,7 @@ module Vmpooler
 
     def invalid_pool(payload)
       invalid = []
-      payload.each do |pool, clone_target|
+      payload.each do |pool, _clone_target|
         invalid << pool unless pool_exists?(pool)
       end
       invalid
@@ -837,7 +837,7 @@ module Vmpooler
         # Look up IP address of the hostname
         begin
           ipAddress = TCPSocket.gethostbyname(params[:hostname])[3]
-        rescue
+        rescue StandardError
           ipAddress = ""
         end
 
@@ -893,7 +893,7 @@ module Vmpooler
       if backend.exists('vmpooler__vm__' + params[:hostname])
         begin
           jdata = JSON.parse(request.body.read)
-        rescue
+        rescue StandardError
           halt 400, JSON.pretty_generate(result)
         end
 
@@ -936,7 +936,7 @@ module Vmpooler
           end
         end
 
-        if failure.size > 0
+        if !failure.empty?
           status 400
           result['failure'] = failure
         else

data/lib/vmpooler/api.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Vmpooler
   class API < Sinatra::Base
     def initialize

data/lib/vmpooler/dashboard.rb

@@ -1,6 +1,7 @@
+# frozen_string_literal: true
+
 module Vmpooler
   class Dashboard < Sinatra::Base
-
     def config
       Vmpooler.config
     end

data/lib/vmpooler/dummy_statsd.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Vmpooler
   class DummyStatsd
     attr_reader :server, :port, :prefix

data/lib/vmpooler/generic_connection_pool.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'connection_pool'
 
 module Vmpooler
@@ -20,15 +22,15 @@ module Vmpooler
             start = Time.now
             conn = checkout(options)
             timespan_ms = ((Time.now - start) * 1000).to_i
-            @metrics.gauge(@metric_prefix + '.available', @available.length) unless @metrics.nil?
-            @metrics.timing(@metric_prefix + '.waited', timespan_ms) unless @metrics.nil?
+            @metrics&.gauge(@metric_prefix + '.available', @available.length)
+            @metrics&.timing(@metric_prefix + '.waited', timespan_ms)
             begin
               Thread.handle_interrupt(Exception => :immediate) do
                 yield conn
               end
             ensure
               checkin
-              @metrics.gauge(@metric_prefix + '.available', @available.length) unless @metrics.nil?
+              @metrics&.gauge(@metric_prefix + '.available', @available.length)
             end
           end
         end
@@ -38,13 +40,13 @@ module Vmpooler
           start = Time.now
           conn = checkout(options)
           timespan_ms = ((Time.now - start) * 1000).to_i
-          @metrics.gauge(@metric_prefix + '.available', @available.length) unless @metrics.nil?
-          @metrics.timing(@metric_prefix + '.waited', timespan_ms) unless @metrics.nil?
+          @metrics&.gauge(@metric_prefix + '.available', @available.length)
+          @metrics&.timing(@metric_prefix + '.waited', timespan_ms)
           begin
             yield conn
           ensure
             checkin
-            @metrics.gauge(@metric_prefix + '.available', @available.length) unless @metrics.nil?
+            @metrics&.gauge(@metric_prefix + '.available', @available.length)
           end
         end
       end

data/lib/vmpooler/graphite.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rubygems' unless defined?(Gem)
 
 module Vmpooler
@@ -5,9 +7,7 @@ module Vmpooler
     attr_reader :server, :port, :prefix
 
     def initialize(params = {})
-      if params['server'].nil? || params['server'].empty?
-        raise ArgumentError, "Graphite server is required. Config: #{params.inspect}"
-      end
+      raise ArgumentError, "Graphite server is required. Config: #{params.inspect}" if params['server'].nil? || params['server'].empty?
 
       @server = params['server']
       @port   = params['port'] || 2003
@@ -35,8 +35,8 @@ module Vmpooler
           socket.close
         end
       end
-    rescue => err
-      $stderr.puts "Failure logging #{path} to graphite server [#{server}:#{port}]: #{err}"
+    rescue StandardError => e
+      warn "Failure logging #{path} to graphite server [#{server}:#{port}]: #{e}"
     end
   end
 end

data/lib/vmpooler/logger.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rubygems' unless defined?(Gem)
 
 module Vmpooler
@@ -14,7 +16,7 @@ module Vmpooler
 
       puts "[#{stamp}] #{string}" if ENV['VMPOOLER_DEBUG']
 
-      open(@file, 'a') do |f|
+      File.open(@file, 'a') do |f|
         f.puts "[#{stamp}] #{string}"
       end
     end