Contents

module Actions
  class Base < Dynflow::Action
    middleware.use ::Actions::Middleware::RailsExecutorWrap

    def task
      @task ||= ::ForemanTasks::Task::DynflowTask.where(:external_id => execution_plan_id).first!
    end

    # This method says what data form input gets into the task details in Rest API
    # By default, it sends the whole input there.
    def task_input
      input
    end

    # This method says what data form output gets into the task details in Rest API
    # It should aggregate the important data that are worth to propagate to Rest API,
    # perhaps also aggraget data from subactions if needed (using +all_actions+) method
    # of Dynflow::Action::Presenter
    def task_output
      output
    end

    # This method should return humanized description of the action, e.g. "Install package"
    def humanized_name
      self.class.name.demodulize.underscore.humanize
    end

    # This method should return String or Array<String> describing input for the task
    def humanized_input
      ''
    end

    # This method should return String describing output for the task.
    # It should aggregate the data from subactions as well and it's used for humanized
    # description of restuls of the action
    def humanized_output
      ''
    end

    # This method should return String or Array<String> describing the errors during the action
    def humanized_errors
      execution_plan.steps_in_state(:skipped, :skipping, :error).map do |step|
        step.error.message if step.error
      end.compact
    end

    def already_running?
      ForemanTasks::Task::DynflowTask.for_action(self.class)
                                     .running.where('external_id != ?', execution_plan_id).any?
    end

    def serializer_class
      ::Actions::Serializers::ActiveRecordSerializer
    end
  end
end

Version data entries

5 entries across 5 versions & 1 rubygems

Version	Path
foreman-tasks-0.14.6	app/lib/actions/base.rb
foreman-tasks-0.15.1	app/lib/actions/base.rb
foreman-tasks-0.15.0	app/lib/actions/base.rb
foreman-tasks-0.14.5	app/lib/actions/base.rb
foreman-tasks-0.14.4	app/lib/actions/base.rb