3187: Migration to add started_at and finished_at to job_tasks and pipeline_instances.

[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 ad96b771a4de32c0c3ab00741ccc2becfae73fb6..752391862a3d2e25c9cfe26a85913496bd5145a6 100644 (file)
--- a/services/api/app/models/pipeline_instance.rb
+++ b/services/api/app/models/pipeline_instance.rb
@@ -1,30 +1,69 @@
 class PipelineInstance < ArvadosModel
-  include AssignUuid
+  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 :update_state
+  before_validation :verify_status
+  before_create :set_state_before_save
+  before_save :set_state_before_save
 
   api_accessible :user, extend: :common do |t|
     t.add :pipeline_template_uuid
     t.add :pipeline_template, :if => :pipeline_template
     t.add :name
     t.add :components
-    t.add :success
-    t.add :active
     t.add :dependencies
     t.add :properties
+    t.add :state
+    t.add :components_summary
+    t.add :started_at
+    t.add :finished_at
   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
@@ -41,7 +80,7 @@ class PipelineInstance < ArvadosModel
         else
           row << 0.0
           if step['failed']
-            self.success = false
+            self.state = Failed
           end
         end
         row << (step['warehousejob']['id'] rescue nil)
@@ -62,19 +101,19 @@ class PipelineInstance < ArvadosModel
   end
 
   def self.queue
-    self.where('active = true')
+    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
 
-  def update_success
+  def update_state
     if components and progress_ratio == 1.0
-      self.success = true
+      self.state = Complete
     end
   end
 
@@ -101,4 +140,29 @@ class PipelineInstance < ArvadosModel
       {}
     end
   end
+
+  def verify_status
+    changed_attributes = self.changed
+
+    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.components_look_ready? && (!self.state || self.state == New)
+      self.state = Ready
+    end
+  end
+
 end