2762: Merge branch 'master' into 2762-owner-uuid-integrity

[arvados.git] / services / api / app / models / pipeline_instance.rb

diff --git a/services/api/app/models/pipeline_instance.rb b/services/api/app/models/pipeline_instance.rb
index 6de861d00547297688fdba19aee5c72d2d05e83e..7bb814c60d4a902d15a61485952ead0437a96cbe 100644 (file)
--- a/services/api/app/models/pipeline_instance.rb
+++ b/services/api/app/models/pipeline_instance.rb
@@ -1,16 +1,19 @@
-class PipelineInstance < OrvosModel
-  include AssignUuid
+class PipelineInstance < ArvadosModel
+  include HasUuid
   include KindAndEtag
   include CommonApiTemplate
   serialize :components, Hash
   serialize :properties, Hash
+  serialize :components_summary, Hash
   belongs_to :pipeline_template, :foreign_key => :pipeline_template_uuid, :primary_key => :uuid
-  attr_accessor :pipeline_template
 
   before_validation :bootstrap_components
   before_validation :update_success
+  before_validation :verify_status
+  before_create :set_state_before_save
+  before_save :set_state_before_save
 
-  api_accessible :superuser, :extend => :common do |t|
+  api_accessible :user, extend: :common do |t|
     t.add :pipeline_template_uuid
     t.add :pipeline_template, :if => :pipeline_template
     t.add :name
@@ -18,12 +21,49 @@ class PipelineInstance < OrvosModel
     t.add :success
     t.add :active
     t.add :dependencies
+    t.add :properties
+    t.add :state
+    t.add :components_summary
   end
 
+  # Supported states for a pipeline instance
+  States =
+    [
+     (New = 'New'),
+     (Ready = 'Ready'),
+     (RunningOnServer = 'RunningOnServer'),
+     (RunningOnClient = 'RunningOnClient'),
+     (Paused = 'Paused'),
+     (Failed = 'Failed'),
+     (Complete = 'Complete'),
+    ]
+
   def dependencies
     dependency_search(self.components).keys
   end
 
+  # if all components have input, the pipeline is Ready
+  def components_look_ready?
+    if !self.components || self.components.empty?
+      return false
+    end
+
+    all_components_have_input = true
+    self.components.each do |name, component|
+      component['script_parameters'].andand.each do |parametername, parameter|
+        parameter = { 'value' => parameter } unless parameter.is_a? Hash
+        if parameter['value'].nil? and parameter['required']
+          if parameter['output_of']
+            next
+          end
+          all_components_have_input = false
+          break
+        end
+      end
+    end
+    return all_components_have_input
+  end
+
   def progress_table
     begin
       # v0 pipeline format
@@ -60,10 +100,14 @@ class PipelineInstance < OrvosModel
     t.collect { |r| r[2] }.inject(0.0) { |sum,a| sum += a } / t.size
   end
 
+  def self.queue
+    self.where("state = 'RunningOnServer'")
+  end
+
   protected
   def bootstrap_components
     if pipeline_template and (!components or components.empty?)
-      self.components = pipeline_template.components
+      self.components = pipeline_template.components.deep_dup
     end
   end
 
@@ -96,4 +140,84 @@ class PipelineInstance < OrvosModel
       {}
     end
   end
+
+  def verify_status
+    changed_attributes = self.changed
+
+    if 'state'.in? changed_attributes
+      case self.state
+      when New, Ready, Paused
+        self.active = nil
+        self.success = nil
+      when RunningOnServer
+        self.active = true
+        self.success = nil
+      when RunningOnClient
+        self.active = nil
+        self.success = nil
+      when Failed
+        self.active = false
+        self.success = false
+        self.state = Failed   # before_validation will fail if false is returned in the previous line
+      when Complete
+        self.active = false
+        self.success = true
+      else
+        return false
+      end
+    elsif 'success'.in? changed_attributes
+      logger.info "pipeline_instance changed_attributes has success for #{self.uuid}"
+      if self.success
+        self.active = false
+        self.state = Complete
+      else
+        self.active = false
+        self.state = Failed
+      end
+    elsif 'active'.in? changed_attributes
+      logger.info "pipeline_instance changed_attributes has active for #{self.uuid}"
+      if self.active
+        if self.state.in? [New, Ready, Paused]
+          self.state = RunningOnServer
+        end
+      else
+        if self.state == RunningOnServer # state was RunningOnServer
+          self.active = nil
+          self.state = Paused
+        elsif self.components_look_ready?
+          self.state = Ready
+        else
+          self.state = New
+        end
+      end
+    elsif new_record? and self.state.nil?
+      # No state, active, or success given
+      self.state = New
+    end
+
+    if new_record? or 'components'.in? changed_attributes
+      self.state ||= New
+      if self.state == New and self.components_look_ready?
+        self.state = Ready
+      end
+    end
+
+    if self.state.in?(States)
+      true
+    else
+      errors.add :state, "'#{state.inspect} must be one of: [#{States.join ', '}]"
+      false
+    end
+  end
+
+  def set_state_before_save
+    if !self.state || self.state == New || self.state == Ready || self.state == Paused
+      if self.active
+        self.state = RunningOnServer
+      elsif self.components_look_ready? && (!self.state || self.state == New)
+        self.state = Ready
+      end
+    end
+  end
+
 end