ManageIQ/manageiq

View on GitHub
app/models/miq_request_task/state_machine.rb

Summary

Maintainability
A
0 mins
Test Coverage
B
82%
module MiqRequestTask::StateMachine
  delegate :my_role, :to => :miq_request
  delegate :my_zone, :to => :source,      :allow_nil => true
  delegate :my_queue_name, :to => :miq_request

  def tracking_label_id
    "r#{miq_request_id}_#{self.class.base_model.name.underscore}_#{id}"
  end

  def signal_abort
    signal(:abort)
  end

  def signal(phase)
    return signal(:finish) if ![:finish, :provision_error].include?(phase.to_sym) && prematurely_finished?

    self.phase = phase.to_s
    $log.info("Starting Phase <#{self.phase}>")
    save

    begin
      send(phase)
    rescue => err
      if [:finish, :provision_error].include?(phase.to_sym)
        _log.error("[#{err.message}] encountered during [#{phase}]")
        _log.log_backtrace(err)
      else
        phase_context.delete(:error_message)

        # HACK: Psych is unable to deserialize an Exception that contains a
        #   NameError::message as its message.  When deserialized, it will raise
        #   "TypeError: allocator undefined for NameError::message".  Calling
        #   .message will dereference it and turn it into a String which is
        #   serializable.  For more information about NameError::message, see
        #   http://www.carboni.ca/blog/p/Ruby-Did-You-Know-That-5-NameErrormessage
        #
        #   In addition, backtrace information is not available, because it is
        #   not an instance variable, but is instead dynamically generated.
        #
        #   As such, we store the exception's components separately in the
        #   phase context.
        phase_context[:exception_class]     = err.class.name
        phase_context[:exception_message]   = err.message
        phase_context[:exception_backtrace] = err.backtrace
        phase_context[:error_phase]         = phase
        signal :provision_error
      end
    end
  end

  def signal_queue(phase)
    method_name, args = phase == :abort ? [:signal_abort, []] : [:signal, [phase]]
    MiqQueue.put(
      :class_name     => self.class.name,
      :instance_id    => id,
      :method_name    => method_name,
      :args           => args,
      :zone           => my_zone,
      :role           => my_role,
      :queue_name     => my_queue_name,
      :tracking_label => tracking_label_id
    )
  end

  def prematurely_finished?
    if state == 'finished' || status == 'Error'
      _log.warn("Task is prematurely finished in phase:<#{phase}> because state:<#{state}> and status:<#{status}>")
      return true
    end
    false
  end

  def requeue_phase
    mark_execution_servers
    save # Save current phase_context
    MiqQueue.put(
      :class_name     => self.class.name,
      :instance_id    => id,
      :method_name    => phase,
      :deliver_on     => 10.seconds.from_now.utc,
      :zone           => my_zone,
      :role           => my_role,
      :queue_name     => my_queue_name,
      :tracking_label => tracking_label_id,
      :miq_callback => {:class_name => self.class.name, :instance_id => id, :method_name => :execute_callback}
    )
  end

  def provision_error
    exception_class     = phase_context.delete(:exception_class).try(:constantize)
    exception_message   = phase_context.delete(:exception_message)
    exception_backtrace = phase_context.delete(:exception_backtrace)
    error_phase         = phase_context.delete(:error_phase)
    error_message       = phase_context.delete(:error_message) || "[#{exception_class}]: #{exception_message}"

    _log.error("[#{error_message}] encountered during phase [#{error_phase}]")
    $log.error(exception_backtrace.join("\n")) if exception_backtrace && exception_class && !(exception_class <= MiqException::MiqProvisionError)

    update_and_notify_parent(:state => "finished", :status => "Error", :message => error_message)
    signal :finish
  end
end