vmpooler 2.4.0 → 3.0.0

data/lib/vmpooler/api/v2.rb

@@ -1,505 +0,0 @@
-# frozen_string_literal: true
-
-require 'vmpooler/api/v1'
-
-module Vmpooler
-  class API
-    class V2 < Vmpooler::API::V1
-      api_version = '2'
-      api_prefix  = "/api/v#{api_version}"
-
-      def full_config
-        Vmpooler::API.settings.config
-      end
-
-      def get_template_aliases(template)
-        tracer.in_span("Vmpooler::API::V2.#{__method__}") do
-          result = []
-          aliases = Vmpooler::API.settings.config[:alias]
-          if aliases
-            result += aliases[template] if aliases[template].is_a?(Array)
-            template_backends << aliases[template] if aliases[template].is_a?(String)
-          end
-          result
-        end
-      end
-
-      # Fetch a single vm from a pool
-      #
-      # @param [String] template
-      #   The template that the vm should be created from
-      #
-      # @return [Tuple] vmname, vmpool, vmtemplate
-      #   Returns a tuple containing the vm's name, the pool it came from, and
-      #   what template was used, if successful. Otherwise the tuple contains.
-      #   nil values.
-      def fetch_single_vm(template)
-        tracer.in_span("Vmpooler::API::V2.#{__method__}") do
-          template_backends = [template]
-          aliases = Vmpooler::API.settings.config[:alias]
-          if aliases
-            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
-              end
-            end
-
-            if weighted_pools.count == template_backends.count
-              pickup = Pickup.new(weighted_pools)
-              selection = pickup.pick
-              template_backends.delete(selection)
-              template_backends.unshift(selection)
-            else
-              first = template_backends.sample
-              template_backends.delete(first)
-              template_backends.unshift(first)
-            end
-          end
-
-          checkoutlock.synchronize do
-            template_backends.each do |template_backend|
-              vms = backend.smembers("vmpooler__ready__#{template_backend}")
-              next if vms.empty?
-
-              vm = vms.pop
-              smoved = backend.smove("vmpooler__ready__#{template_backend}", "vmpooler__running__#{template_backend}", vm)
-              if smoved
-                return [vm, template_backend, template]
-              end
-            end
-            [nil, nil, nil]
-          end
-        end
-      end
-
-      # The domain in the result body will be set to the one associated with the
-      # last vm added. The part of the response is only being retained for
-      # backwards compatibility as the hostnames are now fqdn's instead of bare
-      # hostnames. This change is a result of now being able to specify a domain
-      # per pool. If no vm's in the result had a domain sepcified then the
-      # domain key will be omitted similar to how it was previously omitted if
-      # the global option domain wasn't specified.
-      def atomically_allocate_vms(payload)
-        tracer.in_span("Vmpooler::API::V2.#{__method__}") do |span|
-          result = { 'ok' => false }
-          failed = false
-          vms = [] # vmpool, vmname, vmtemplate
-
-          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
-                account_for_starting_vm(vmpool, vmname)
-                vms << [vmpool, vmname, vmtemplate]
-                metrics.increment("checkout.success.#{vmpool}")
-                update_user_metrics('allocate', vmname) if Vmpooler::API.settings.config[:config]['usage_stats']
-              else
-                failed = true
-                metrics.increment("checkout.empty.#{requested}")
-                break
-              end
-            end
-          end
-
-          if failed
-            vms.each do |(vmpool, vmname, _vmtemplate)|
-              return_vm_to_ready_state(vmpool, vmname)
-            end
-            span.add_event('error', attributes: {
-              'error.type' => 'Vmpooler::API::V2.atomically_allocate_vms',
-              'error.message' => '503 due to failing to allocate one or more vms'
-            })
-            status 503
-          else
-            vm_names = []
-            vms.each do |(vmpool, vmname, vmtemplate)|
-              vmdomain = Parsing.get_domain_for_pool(full_config, vmpool)
-              if vmdomain
-                vmfqdn = "#{vmname}.#{vmdomain}"
-                update_result_hosts(result, vmtemplate, vmfqdn)
-                vm_names.append(vmfqdn)
-              else
-                update_result_hosts(result, vmtemplate, vmname)
-                vm_names.append(vmname)
-              end
-            end
-
-            span.set_attribute('vmpooler.vm_names', vm_names.join(',')) unless vm_names.empty?
-
-            result['ok'] = true
-          end
-
-          result
-        end
-      end
-
-      def generate_ondemand_request(payload)
-        tracer.in_span("Vmpooler::API::V2.#{__method__}") do |span|
-          result = { 'ok': false }
-
-          requested_instances = payload.reject { |k, _v| k == 'request_id' }
-          if too_many_requested?(requested_instances)
-            e_message = "requested amount of instances exceeds the maximum #{config['max_ondemand_instances_per_request']}"
-            result['message'] = e_message
-            status 403
-            span.add_event('error', attributes: {
-              'error.type' => 'Vmpooler::API::V2.generate_ondemand_request',
-              'error.message' => "403 due to #{e_message}"
-            })
-            return result
-          end
-
-          score = Time.now.to_i
-          request_id = payload['request_id']
-          request_id ||= generate_request_id
-          result['request_id'] = request_id
-          span.set_attribute('vmpooler.request_id', request_id)
-
-          if backend.exists?("vmpooler__odrequest__#{request_id}")
-            e_message = "request_id '#{request_id}' has already been created"
-            result['message'] = e_message
-            status 409
-            span.add_event('error', attributes: {
-              'error.type' => 'Vmpooler::API::V2.generate_ondemand_request',
-              'error.message' => "409 due to #{e_message}"
-            })
-            metrics.increment('ondemandrequest_generate.duplicaterequests')
-            return result
-          end
-
-          status 201
-
-          platforms_with_aliases = []
-          requested_instances.each do |poolname, count|
-            selection = evaluate_template_aliases(poolname, count)
-            selection.map { |selected_pool, selected_pool_count| platforms_with_aliases << "#{poolname}:#{selected_pool}:#{selected_pool_count}" }
-          end
-          platforms_string = platforms_with_aliases.join(',')
-
-          return result unless backend.zadd('vmpooler__provisioning__request', score, request_id)
-
-          backend.hset("vmpooler__odrequest__#{request_id}", 'requested', platforms_string)
-          if Vmpooler::API.settings.config[:auth] and has_token?
-            token_token = request.env['HTTP_X_AUTH_TOKEN']
-            token_user = backend.hget("vmpooler__token__#{token_token}", 'user')
-            backend.hset("vmpooler__odrequest__#{request_id}", 'token:token', token_token)
-            backend.hset("vmpooler__odrequest__#{request_id}", 'token:user', token_user)
-            span.set_attribute('enduser.id', token_user)
-          end
-
-          result[:ok] = true
-          metrics.increment('ondemandrequest_generate.success')
-          result
-        end
-      end
-
-      # Endpoints that use overridden methods
-
-      post "#{api_prefix}/vm/?" do
-        content_type :json
-        result = { 'ok' => false }
-        metrics.increment('http_requests_vm_total.post.vm.checkout')
-
-        payload = JSON.parse(request.body.read)
-
-        if payload
-          invalid = invalid_templates(payload)
-          if invalid.empty?
-            result = atomically_allocate_vms(payload)
-          else
-            invalid.each do |bad_template|
-              metrics.increment("checkout.invalid.#{bad_template}")
-            end
-            status 404
-          end
-        else
-          metrics.increment('checkout.invalid.unknown')
-          status 404
-        end
-
-        JSON.pretty_generate(result)
-      end
-
-      post "#{api_prefix}/vm/:template/?" do
-        content_type :json
-        result = { 'ok' => false }
-        metrics.increment('http_requests_vm_total.get.vm.template')
-
-        payload = extract_templates_from_query_params(params[:template])
-
-        if payload
-          invalid = invalid_templates(payload)
-          if invalid.empty?
-            result = atomically_allocate_vms(payload)
-          else
-            invalid.each do |bad_template|
-              metrics.increment("checkout.invalid.#{bad_template}")
-            end
-            status 404
-          end
-        else
-          metrics.increment('checkout.invalid.unknown')
-          status 404
-        end
-
-        JSON.pretty_generate(result)
-      end
-
-      get "#{api_prefix}/vm/:hostname/?" do
-        content_type :json
-        metrics.increment('http_requests_vm_total.get.vm.hostname')
-
-        result = {}
-
-        status 404
-        result['ok'] = false
-
-        params[:hostname] = hostname_shorten(params[:hostname], nil)
-
-        rdata = backend.hgetall("vmpooler__vm__#{params[:hostname]}")
-        unless rdata.empty?
-          status 200
-          result['ok'] = true
-
-          result[params[:hostname]] = {}
-
-          result[params[:hostname]]['template'] = rdata['template']
-          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) 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)
-            result[params[:hostname]]['remaining'] = ((Time.parse(rdata['checkout']) + rdata['lifetime'].to_i*60*60 - Time.now) / 60 / 60).round(2)
-            result[params[:hostname]]['start_time'] = Time.parse(rdata['checkout']).to_datetime.rfc3339
-            result[params[:hostname]]['end_time'] = (Time.parse(rdata['checkout']) + rdata['lifetime'].to_i*60*60).to_datetime.rfc3339
-            result[params[:hostname]]['state'] = 'running'
-          elsif rdata['check']
-            result[params[:hostname]]['state'] = 'ready'
-          else
-            result[params[:hostname]]['state'] = 'pending'
-          end
-
-          rdata.keys.each do |key|
-            if key.match('^tag\:(.+?)$')
-              result[params[:hostname]]['tags'] ||= {}
-              result[params[:hostname]]['tags'][$1] = rdata[key]
-            end
-
-            if key.match('^snapshot\:(.+?)$')
-              result[params[:hostname]]['snapshots'] ||= []
-              result[params[:hostname]]['snapshots'].push($1)
-            end
-          end
-
-          if rdata['disk']
-            result[params[:hostname]]['disk'] = rdata['disk'].split(':')
-          end
-
-          # Look up IP address of the hostname
-          begin
-            ipAddress = TCPSocket.gethostbyname(params[:hostname])[3]
-          rescue StandardError
-            ipAddress = ""
-          end
-
-          result[params[:hostname]]['ip'] = ipAddress
-
-          if rdata['pool']
-            vmdomain = Parsing.get_domain_for_pool(full_config, rdata['pool'])
-            if vmdomain
-              result[params[:hostname]]['fqdn'] = "#{params[:hostname]}.#{vmdomain}"
-            end
-          end
-
-          result[params[:hostname]]['host'] = rdata['host'] if rdata['host']
-          result[params[:hostname]]['migrated'] = rdata['migrated'] if rdata['migrated']
-
-        end
-
-        JSON.pretty_generate(result)
-      end
-
-      post "#{api_prefix}/ondemandvm/?" do
-        content_type :json
-        metrics.increment('http_requests_vm_total.post.ondemand.requestid')
-
-        need_token! if Vmpooler::API.settings.config[:auth]
-
-        result = { 'ok' => false }
-
-        begin
-          payload = JSON.parse(request.body.read)
-
-          if payload
-            invalid = invalid_templates(payload.reject { |k, _v| k == 'request_id' })
-            if invalid.empty?
-              result = generate_ondemand_request(payload)
-            else
-              result[:bad_templates] = invalid
-              invalid.each do |bad_template|
-                metrics.increment("ondemandrequest_fail.invalid.#{bad_template}")
-              end
-              status 404
-            end
-          else
-            metrics.increment('ondemandrequest_fail.invalid.unknown')
-            status 404
-          end
-        rescue JSON::ParserError
-          span = OpenTelemetry::Trace.current_span
-          span.status = OpenTelemetry::Trace::Status.error('JSON payload could not be parsed')
-          status 400
-          result = {
-            'ok' => false,
-            'message' => 'JSON payload could not be parsed'
-          }
-        end
-
-        JSON.pretty_generate(result)
-      end
-
-      post "#{api_prefix}/ondemandvm/:template/?" do
-        content_type :json
-        result = { 'ok' => false }
-        metrics.increment('http_requests_vm_total.delete.ondemand.template')
-
-        need_token! if Vmpooler::API.settings.config[:auth]
-
-        payload = extract_templates_from_query_params(params[:template])
-
-        if payload
-          invalid = invalid_templates(payload.reject { |k, _v| k == 'request_id' })
-          if invalid.empty?
-            result = generate_ondemand_request(payload)
-          else
-            result[:bad_templates] = invalid
-            invalid.each do |bad_template|
-              metrics.increment("ondemandrequest_fail.invalid.#{bad_template}")
-            end
-            status 404
-          end
-        else
-          metrics.increment('ondemandrequest_fail.invalid.unknown')
-          status 404
-        end
-
-        JSON.pretty_generate(result)
-      end
-
-      get "#{api_prefix}/ondemandvm/:requestid/?" do
-        content_type :json
-        metrics.increment('http_requests_vm_total.get.ondemand.request')
-
-        status 404
-        result = check_ondemand_request(params[:requestid])
-
-        JSON.pretty_generate(result)
-      end
-
-      def check_ondemand_request(request_id)
-        tracer.in_span("Vmpooler::API::V2.#{__method__}") do |span|
-          span.set_attribute('vmpooler.request_id', request_id)
-          result = { 'ok' => false }
-          request_hash = backend.hgetall("vmpooler__odrequest__#{request_id}")
-          if request_hash.empty?
-            e_message = "no request found for request_id '#{request_id}'"
-            result['message'] = e_message
-            span.add_event('error', attributes: {
-              'error.type' => 'Vmpooler::API::V2.check_ondemand_request',
-              'error.message' => e_message
-            })
-            return result
-          end
-
-          result['request_id'] = request_id
-          result['ready'] = false
-          result['ok'] = true
-          status 202
-
-          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}")
-              domain = Parsing.get_domain_for_pool(full_config, pool)
-              instances.map! { |instance| instance.concat(".#{domain}") } if domain
-
-              if result.key?(platform_alias)
-                result[platform_alias][:hostname] = result[platform_alias][:hostname] + instances
-              else
-                result[platform_alias] = { 'hostname': instances }
-              end
-            end
-            status 200
-          when 'failed'
-            result['message'] = "The request failed to provision instances within the configured ondemand_request_ttl '#{config['ondemand_request_ttl']}'"
-            status 200
-          when 'deleted'
-            result['message'] = 'The request has been deleted'
-            status 200
-          else
-            Parsing.get_platform_pool_count(request_hash['requested']) do |platform_alias, pool, count|
-              instance_count = backend.scard("vmpooler__#{request_id}__#{platform_alias}__#{pool}")
-              instances_pending = count.to_i - instance_count.to_i
-
-              if result.key?(platform_alias) && result[platform_alias].key?(:ready)
-                result[platform_alias][:ready] = (result[platform_alias][:ready].to_i + instance_count).to_s
-                result[platform_alias][:pending] = (result[platform_alias][:pending].to_i + instances_pending).to_s
-              else
-                result[platform_alias] = {
-                  'ready': instance_count.to_s,
-                  'pending': instances_pending.to_s
-                }
-              end
-            end
-          end
-
-          result
-        end
-      end
-
-      # Endpoints that only use bits from the V1 api are called here
-      # Note that traces will be named based on the route used in the V1 api
-      # but the http.url trace attribute will still have the actual requested url in it
-
-      delete "#{api_prefix}/*" do
-        versionless_path_info = request.path_info.delete_prefix("#{api_prefix}/")
-        request.path_info = "/api/v1/#{versionless_path_info}"
-        call env
-      end
-
-      get "#{api_prefix}/*" do
-        versionless_path_info = request.path_info.delete_prefix("#{api_prefix}/")
-        request.path_info = "/api/v1/#{versionless_path_info}"
-        call env
-      end
-
-      post "#{api_prefix}/*" do
-        versionless_path_info = request.path_info.delete_prefix("#{api_prefix}/")
-        request.path_info = "/api/v1/#{versionless_path_info}"
-        call env
-      end
-
-      put "#{api_prefix}/*" do
-        versionless_path_info = request.path_info.delete_prefix("#{api_prefix}/")
-        request.path_info = "/api/v1/#{versionless_path_info}"
-        call env
-      end
-    end
-  end
-end