vmpooler 0.16.3 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 30fe7f5b64e7bd0311ba0bd442b59537b0f84e5917f3bab7e4bd59194666fd27
-  data.tar.gz: e62ca6fd7e50e224eb22da2ffbc16dc245ba68c2f4bf3253fc0efd876a19d8da
+  metadata.gz: 277212a5ca26187ed46a4e6d0ef0716511a3b63097deab1485908c95bb437c5e
+  data.tar.gz: 36272bc0744f943d88ca3eb0a33a070268f2a0fa45e130a7ee8abb04d4d0243e
 SHA512:
-  metadata.gz: 5d4396514a7ac21d826ca604654ebe52996f44193ef0fa59832668b0dd0721b13ec671ccd63ecd50359cbb8e958ce87da2f9b9c2f86efbb68d057bb19ff85a98
-  data.tar.gz: fe85f3d77e106c8dcc1802d8cbe6d59482fc4b486b9477a1ad175328093a5ec410b54c6621fc7fc287b5894f3ea7fe88e24d1c4c8332576198a9494ce8695a49
+  metadata.gz: 8bb11603444163deb47713be137b1da3234096c60c59cbedda58b35d5dafeef80a2f6f733ccd1c1d0eb4db39959f189183937a712139346ccd673a8d1ea7f8d0
+  data.tar.gz: 4502d6509ac75fc693ca24c9defdb401fc00aff14f3cba2d39143786efe3b0aef6eed0bc3ab6a1adb9cdd925684aa39f8e84c999dbbdd88d121efc052ba6fd84

data/lib/vmpooler.rb

@@ -16,7 +16,6 @@ module Vmpooler
   require 'yaml'
 
   # Dependencies for tracing
-  require 'opentelemetry-api'
   require 'opentelemetry-instrumentation-concurrent_ruby'
   require 'opentelemetry-instrumentation-redis'
   require 'opentelemetry-instrumentation-sinatra'
@@ -53,17 +52,13 @@ module Vmpooler
 
     # Bail out if someone attempts to start vmpooler with dummy authentication
     # without enbaling debug mode.
-    if parsed_config.key? :auth
-      if parsed_config[:auth]['provider'] == 'dummy'
-        unless ENV['VMPOOLER_DEBUG']
-          warning = [
-            'Dummy authentication should not be used outside of debug mode',
-            'please set environment variable VMPOOLER_DEBUG to \'true\' if you want to use dummy authentication'
-          ]
-
-          raise warning.join(";\s")
-        end
-      end
+    if parsed_config.key?(:auth) && parsed_config[:auth]['provider'] == 'dummy' && !ENV['VMPOOLER_DEBUG']
+      warning = [
+        'Dummy authentication should not be used outside of debug mode',
+        'please set environment variable VMPOOLER_DEBUG to \'true\' if you want to use dummy authentication'
+      ]
+
+      raise warning.join(";\s")
     end
 
     # Set some configuration defaults
@@ -140,14 +135,14 @@ module Vmpooler
       parsed_config[:pool_names] << pool['name']
       pool['ready_ttl'] ||= parsed_config[:config]['ready_ttl']
       if pool['alias']
-        if pool['alias'].is_a?(Array)
+        if pool['alias'].instance_of?(Array)
           pool['alias'].each do |pool_alias|
             parsed_config[:alias] ||= {}
             parsed_config[:alias][pool_alias] = [pool['name']] unless parsed_config[:alias].key? pool_alias
             parsed_config[:alias][pool_alias] << pool['name'] unless parsed_config[:alias][pool_alias].include? pool['name']
             parsed_config[:pool_names] << pool_alias
           end
-        elsif pool['alias'].is_a?(String)
+        elsif pool['alias'].instance_of?(String)
           parsed_config[:alias][pool['alias']] = pool['name']
           parsed_config[:pool_names] << pool['alias']
         end

data/lib/vmpooler/api/dashboard.rb

@@ -128,34 +128,32 @@ module Vmpooler
 
         pools.each do |pool|
           running = running_hash[pool['name']]
-          pool['major'] = Regexp.last_match[1] if pool['name'] =~ /^(\w+)\-/
+          pool['major'] = Regexp.last_match[1] if pool['name'] =~ /^(\w+)-/
           result[pool['major']] ||= {}
           result[pool['major']]['running'] = result[pool['major']]['running'].to_i + running.to_i
         end
 
-        if params[:history]
-          if graph_url
-            begin
-              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]
-                  pool['major'] = Regexp.last_match[1] if pool['name'] =~ /^(\w+)\-/
-                  result[pool['major']]['history'] ||= []
-
-                  for i in 0..pool['datapoints'].length
-                    if pool['datapoints'][i] && pool['datapoints'][i][0]
-                      pool['last'] = pool['datapoints'][i][0]
-                      result[pool['major']]['history'][i] ||= 0
-                      result[pool['major']]['history'][i] = result[pool['major']]['history'][i].to_i + pool['datapoints'][i][0].to_i
-                    else
-                      result[pool['major']]['history'][i] = result[pool['major']]['history'][i].to_i + pool['last'].to_i
-                    end
+        if params[:history] && graph_url
+          begin
+            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]
+                pool['major'] = Regexp.last_match[1] if pool['name'] =~ /^(\w+)-/
+                result[pool['major']]['history'] ||= []
+
+                for i in 0..pool['datapoints'].length
+                  if pool['datapoints'][i] && pool['datapoints'][i][0]
+                    pool['last'] = pool['datapoints'][i][0]
+                    result[pool['major']]['history'][i] ||= 0
+                    result[pool['major']]['history'][i] = result[pool['major']]['history'][i].to_i + pool['datapoints'][i][0].to_i
+                  else
+                    result[pool['major']]['history'][i] = result[pool['major']]['history'][i].to_i + pool['last'].to_i
                   end
                 end
               end
-            rescue StandardError
             end
+          rescue StandardError
           end
         end
         JSON.pretty_generate(result)

data/lib/vmpooler/api/helpers.rb

@@ -13,12 +13,12 @@ module Vmpooler
       def valid_token?(backend)
         return false unless has_token?
 
-        backend.exists?('vmpooler__token__' + request.env['HTTP_X_AUTH_TOKEN']) ? true : false
+        backend.exists?("vmpooler__token__#{request.env['HTTP_X_AUTH_TOKEN']}") ? true : false
       end
 
       def validate_token(backend)
         if valid_token?(backend)
-          backend.hset('vmpooler__token__' + request.env['HTTP_X_AUTH_TOKEN'], 'last', Time.now)
+          backend.hset("vmpooler__token__#{request.env['HTTP_X_AUTH_TOKEN']}", 'last', Time.now)
 
           return true
         end
@@ -114,11 +114,13 @@ module Vmpooler
       end
 
       def export_tags(backend, hostname, tags)
-        tags.each_pair do |tag, value|
-          next if value.nil? or value.empty?
+        backend.pipelined do
+          tags.each_pair do |tag, value|
+            next if value.nil? or value.empty?
 
-          backend.hset('vmpooler__vm__' + hostname, 'tag:' + tag, value)
-          backend.hset('vmpooler__tag__' + Date.today.to_s, hostname + ':' + tag, value)
+            backend.hset("vmpooler__vm__#{hostname}", "tag:#{tag}", value)
+            backend.hset("vmpooler__tag__#{Date.today}", "#{hostname}:#{tag}", value)
+          end
         end
       end
 
@@ -145,7 +147,7 @@ module Vmpooler
 
       def hostname_shorten(hostname, domain=nil)
         if domain && hostname =~ /^[\w-]+\.#{domain}$/
-          hostname = hostname[/[^\.]+/]
+          hostname = hostname[/[^.]+/]
         end
 
         hostname
@@ -251,17 +253,15 @@ module Vmpooler
 
         tags = {}
 
-        backend.hgetall('vmpooler__tag__' + date_str).each do |key, value|
+        backend.hgetall("vmpooler__tag__#{date_str}").each do |key, value|
           hostname = 'unknown'
           tag = 'unknown'
 
-          if key =~ /\:/
+          if key =~ /:/
             hostname, tag = key.split(':', 2)
           end
 
-          if opts[:only]
-            next unless tag == opts[:only]
-          end
+          next if opts[:only] && tag != opts[:only]
 
           tags[tag] ||= {}
           tags[tag][value] ||= 0
@@ -319,7 +319,7 @@ module Vmpooler
             }
         }
 
-        task[:count][:total] = backend.hlen('vmpooler__' + task_str + '__' + date_str).to_i
+        task[:count][:total] = backend.hlen("vmpooler__#{task_str}__#{date_str}").to_i
 
         if task[:count][:total] > 0
           if opts[:bypool] == true
@@ -328,11 +328,11 @@ module Vmpooler
             task[:count][:pool]    = {}
             task[:duration][:pool] = {}
 
-            backend.hgetall('vmpooler__' + task_str + '__' + date_str).each do |key, value|
+            backend.hgetall("vmpooler__#{task_str}__#{date_str}").each do |key, value|
               pool     = 'unknown'
               hostname = 'unknown'
 
-              if key =~ /\:/
+              if key =~ /:/
                 pool, hostname = key.split(':')
               else
                 hostname = key

data/lib/vmpooler/api/v1.rb

@@ -163,24 +163,25 @@ module Vmpooler
     end
 
     def return_vm_to_ready_state(template, vm)
+      backend.srem("vmpooler__migrating__#{template}", vm)
+      backend.hdel("vmpooler__active__#{template}", vm)
+      backend.hdel("vmpooler__vm__#{vm}", 'checkout', 'token:token', 'token:user')
       backend.smove("vmpooler__running__#{template}", "vmpooler__ready__#{template}", vm)
     end
 
     def account_for_starting_vm(template, vm)
+      user = backend.hget("vmpooler__token__#{request.env['HTTP_X_AUTH_TOKEN']}", 'user')
+      has_token_result = has_token?
       backend.sadd("vmpooler__migrating__#{template}", vm)
       backend.hset("vmpooler__active__#{template}", vm, Time.now)
       backend.hset("vmpooler__vm__#{vm}", 'checkout', Time.now)
 
-      if Vmpooler::API.settings.config[:auth] and has_token?
-        validate_token(backend)
-
-        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')
-        )
+      if Vmpooler::API.settings.config[:auth] and has_token_result
+        backend.hset("vmpooler__vm__#{vm}", 'token:token', request.env['HTTP_X_AUTH_TOKEN'])
+        backend.hset("vmpooler__vm__#{vm}", 'token:user', user)
 
         if config['vm_lifetime_auth'].to_i > 0
-          backend.hset('vmpooler__vm__' + vm, 'lifetime', config['vm_lifetime_auth'].to_i)
+          backend.hset("vmpooler__vm__#{vm}", 'lifetime', config['vm_lifetime_auth'].to_i)
         end
       end
     end
@@ -200,16 +201,19 @@ module Vmpooler
       failed = false
       vms = []
 
+      validate_token(backend) if Vmpooler::API.settings.config[:auth] and has_token?
+
       payload.each do |requested, count|
         count.to_i.times do |_i|
           vmname, vmpool, vmtemplate = fetch_single_vm(requested)
-          if !vmname
+          if vmname
+            account_for_starting_vm(vmpool, vmname)
+            vms << [vmpool, vmname, vmtemplate]
+            metrics.increment("checkout.success.#{vmpool}")
+          else
             failed = true
-            metrics.increment('checkout.empty.' + requested)
+            metrics.increment("checkout.empty.#{requested}")
             break
-          else
-            vms << [vmpool, vmname, vmtemplate]
-            metrics.increment('checkout.success.' + vmtemplate)
           end
         end
       end
@@ -220,8 +224,7 @@ module Vmpooler
         end
         status 503
       else
-        vms.each do |(vmpool, vmname, vmtemplate)|
-          account_for_starting_vm(vmpool, vmname)
+        vms.each do |(_vmpool, vmname, vmtemplate)|
           update_result_hosts(result, vmtemplate, vmname)
         end
 
@@ -337,7 +340,7 @@ module Vmpooler
       payload&.each do |poolname, count|
         next unless count.to_i > config['max_ondemand_instances_per_request']
 
-        metrics.increment('ondemandrequest_fail.toomanyrequests.' + poolname)
+        metrics.increment("ondemandrequest_fail.toomanyrequests.#{poolname}")
         return true
       end
       false
@@ -380,7 +383,7 @@ module Vmpooler
       if Vmpooler::API.settings.config[:auth] and has_token?
         backend.hset("vmpooler__odrequest__#{request_id}", 'token:token', request.env['HTTP_X_AUTH_TOKEN'])
         backend.hset("vmpooler__odrequest__#{request_id}", 'token:user',
-                     backend.hget('vmpooler__token__' + request.env['HTTP_X_AUTH_TOKEN'], 'user'))
+                     backend.hget("vmpooler__token__#{request.env['HTTP_X_AUTH_TOKEN']}", 'user'))
       end
 
       result['domain'] = config['domain'] if config['domain']
@@ -542,9 +545,9 @@ module Vmpooler
           if subpool.include?(p['name'])
             true
           elsif !p['alias'].nil?
-            if p['alias'].is_a?(Array)
+            if p['alias'].instance_of?(Array)
               (p['alias'] & subpool).any?
-            elsif p['alias'].is_a?(String)
+            elsif p['alias'].instance_of?(String)
               subpool.include?(p['alias'])
             end
           end
@@ -727,14 +730,14 @@ module Vmpooler
       result = { 'ok' => false }
 
       if Vmpooler::API.settings.config[:auth]
-        token = backend.hgetall('vmpooler__token__' + params[:token])
+        token = backend.hgetall("vmpooler__token__#{params[:token]}")
 
         if not token.nil? and not token.empty?
           status 200
 
           pools.each do |pool|
-            backend.smembers('vmpooler__running__' + pool['name']).each do |vm|
-              if backend.hget('vmpooler__vm__' + vm, 'token:token') == params[:token]
+            backend.smembers("vmpooler__running__#{pool['name']}").each do |vm|
+              if backend.hget("vmpooler__vm__#{vm}", 'token:token') == params[:token]
                 token['vms'] ||= {}
                 token['vms']['running'] ||= []
                 token['vms']['running'].push(vm)
@@ -760,7 +763,7 @@ module Vmpooler
 
         need_auth!
 
-        if backend.del('vmpooler__token__' + params[:token]).to_i > 0
+        if backend.del("vmpooler__token__#{params[:token]}").to_i > 0
           status 200
           result['ok'] = true
         end
@@ -783,8 +786,8 @@ module Vmpooler
         o = [('a'..'z'), ('0'..'9')].map(&:to_a).flatten
         result['token'] = o[rand(25)] + (0...31).map { o[rand(o.length)] }.join
 
-        backend.hset('vmpooler__token__' + result['token'], 'user', @auth.username)
-        backend.hset('vmpooler__token__' + result['token'], 'created', Time.now)
+        backend.hset("vmpooler__token__#{result['token']}", 'user', @auth.username)
+        backend.hset("vmpooler__token__#{result['token']}", 'created', Time.now)
 
         status 200
         result['ok'] = true
@@ -823,7 +826,7 @@ module Vmpooler
           else
             result[:bad_templates] = invalid
             invalid.each do |bad_template|
-              metrics.increment('ondemandrequest_fail.invalid.' + bad_template)
+              metrics.increment("ondemandrequest_fail.invalid.#{bad_template}")
             end
             status 404
           end
@@ -858,7 +861,7 @@ module Vmpooler
         else
           result[:bad_templates] = invalid
           invalid.each do |bad_template|
-            metrics.increment('ondemandrequest_fail.invalid.' + bad_template)
+            metrics.increment("ondemandrequest_fail.invalid.#{bad_template}")
           end
           status 404
         end
@@ -904,7 +907,7 @@ module Vmpooler
           result = atomically_allocate_vms(payload)
         else
           invalid.each do |bad_template|
-            metrics.increment('checkout.invalid.' + bad_template)
+            metrics.increment("checkout.invalid.#{bad_template}")
           end
           status 404
         end
@@ -980,7 +983,8 @@ module Vmpooler
       result['ok'] = true
       status 202
 
-      if request_hash['status'] == 'ready'
+      case request_hash['status']
+      when 'ready'
         result['ready'] = true
         Parsing.get_platform_pool_count(request_hash['requested']) do |platform_alias, pool, _count|
           instances = backend.smembers("vmpooler__#{request_id}__#{platform_alias}__#{pool}")
@@ -993,10 +997,10 @@ module Vmpooler
         end
         result['domain'] = config['domain'] if config['domain']
         status 200
-      elsif request_hash['status'] == 'failed'
+      when 'failed'
         result['message'] = "The request failed to provision instances within the configured ondemand_request_ttl '#{config['ondemand_request_ttl']}'"
         status 200
-      elsif request_hash['status'] == 'deleted'
+      when 'deleted'
         result['message'] = 'The request has been deleted'
         status 200
       else
@@ -1059,7 +1063,7 @@ module Vmpooler
           result = atomically_allocate_vms(payload)
         else
           invalid.each do |bad_template|
-            metrics.increment('checkout.invalid.' + bad_template)
+            metrics.increment("checkout.invalid.#{bad_template}")
           end
           status 404
         end
@@ -1082,7 +1086,7 @@ module Vmpooler
 
       params[:hostname] = hostname_shorten(params[:hostname], config['domain'])
 
-      rdata = backend.hgetall('vmpooler__vm__' + params[:hostname])
+      rdata = backend.hgetall("vmpooler__vm__#{params[:hostname]}")
       unless rdata.empty?
         status 200
         result['ok'] = true
@@ -1093,7 +1097,7 @@ module Vmpooler
         result[params[:hostname]]['lifetime'] = (rdata['lifetime'] || config['vm_lifetime']).to_i
 
         if rdata['destroy']
-          result[params[:hostname]]['running'] = ((Time.parse(rdata['destroy']) - Time.parse(rdata['checkout'])) / 60 / 60).round(2)
+          result[params[:hostname]]['running'] = ((Time.parse(rdata['destroy']) - Time.parse(rdata['checkout'])) / 60 / 60).round(2) if rdata['checkout']
           result[params[:hostname]]['state'] = 'destroyed'
         elsif rdata['checkout']
           result[params[:hostname]]['running'] = ((Time.now - Time.parse(rdata['checkout'])) / 60 / 60).round(2)
@@ -1155,12 +1159,12 @@ module Vmpooler
 
       params[:hostname] = hostname_shorten(params[:hostname], config['domain'])
 
-      rdata = backend.hgetall('vmpooler__vm__' + params[:hostname])
+      rdata = backend.hgetall("vmpooler__vm__#{params[:hostname]}")
       unless rdata.empty?
         need_token! if rdata['token:token']
 
-        if backend.srem('vmpooler__running__' + rdata['template'], params[:hostname])
-          backend.sadd('vmpooler__completed__' + rdata['template'], params[:hostname])
+        if backend.srem("vmpooler__running__#{rdata['template']}", params[:hostname])
+          backend.sadd("vmpooler__completed__#{rdata['template']}", params[:hostname])
 
           status 200
           result['ok'] = true
@@ -1184,7 +1188,7 @@ module Vmpooler
 
       params[:hostname] = hostname_shorten(params[:hostname], config['domain'])
 
-      if backend.exists?('vmpooler__vm__' + params[:hostname])
+      if backend.exists?("vmpooler__vm__#{params[:hostname]}")
         begin
           jdata = JSON.parse(request.body.read)
         rescue StandardError
@@ -1212,13 +1216,8 @@ module Vmpooler
               end
 
             when 'tags'
-              unless arg.is_a?(Hash)
-                failure.push("You provided tags (#{arg}) as something other than a hash.")
-              end
-
-              if config['allowed_tags']
-                failure.push("You provided unsuppored tags (#{arg}).") if not (arg.keys - config['allowed_tags']).empty?
-              end
+              failure.push("You provided tags (#{arg}) as something other than a hash.") unless arg.is_a?(Hash)
+              failure.push("You provided unsuppored tags (#{arg}).") if config['allowed_tags'] && !(arg.keys - config['allowed_tags']).empty?
             else
               failure.push("Unknown argument #{arg}.")
           end
@@ -1235,7 +1234,7 @@ module Vmpooler
 
                 arg = arg.to_i
 
-                backend.hset('vmpooler__vm__' + params[:hostname], param, arg)
+                backend.hset("vmpooler__vm__#{params[:hostname]}", param, arg)
               when 'tags'
                 filter_tags(arg)
                 export_tags(backend, params[:hostname], arg)
@@ -1261,11 +1260,11 @@ module Vmpooler
 
       params[:hostname] = hostname_shorten(params[:hostname], config['domain'])
 
-      if ((params[:size].to_i > 0 )and (backend.exists?('vmpooler__vm__' + params[:hostname])))
+      if ((params[:size].to_i > 0 )and (backend.exists?("vmpooler__vm__#{params[:hostname]}")))
         result[params[:hostname]] = {}
         result[params[:hostname]]['disk'] = "+#{params[:size]}gb"
 
-        backend.sadd('vmpooler__tasks__disk', params[:hostname] + ':' + params[:size])
+        backend.sadd('vmpooler__tasks__disk', "#{params[:hostname]}:#{params[:size]}")
 
         status 202
         result['ok'] = true
@@ -1285,13 +1284,13 @@ module Vmpooler
 
       params[:hostname] = hostname_shorten(params[:hostname], config['domain'])
 
-      if backend.exists?('vmpooler__vm__' + params[:hostname])
+      if backend.exists?("vmpooler__vm__#{params[:hostname]}")
         result[params[:hostname]] = {}
 
         o = [('a'..'z'), ('0'..'9')].map(&:to_a).flatten
         result[params[:hostname]]['snapshot'] = o[rand(25)] + (0...31).map { o[rand(o.length)] }.join
 
-        backend.sadd('vmpooler__tasks__snapshot', params[:hostname] + ':' + result[params[:hostname]]['snapshot'])
+        backend.sadd('vmpooler__tasks__snapshot', "#{params[:hostname]}:#{result[params[:hostname]]['snapshot']}")
 
         status 202
         result['ok'] = true
@@ -1311,8 +1310,8 @@ module Vmpooler
 
       params[:hostname] = hostname_shorten(params[:hostname], config['domain'])
 
-      unless backend.hget('vmpooler__vm__' + params[:hostname], 'snapshot:' + params[:snapshot]).to_i.zero?
-        backend.sadd('vmpooler__tasks__snapshot-revert', params[:hostname] + ':' + params[:snapshot])
+      unless backend.hget("vmpooler__vm__#{params[:hostname]}", "snapshot:#{params[:snapshot]}").to_i.zero?
+        backend.sadd('vmpooler__tasks__snapshot-revert', "#{params[:hostname]}:#{params[:snapshot]}")
 
         status 202
         result['ok'] = true