services/api/app/models/job.rb

   1 class Job < ArvadosModel
   2   include HasUuid
   3   include KindAndEtag
   4   include CommonApiTemplate
   5   attr_protected :docker_image_locator
   6   serialize :script_parameters, Hash
   7   serialize :runtime_constraints, Hash
   8   serialize :tasks_summary, Hash
   9   before_create :ensure_unique_submit_id
  10   after_commit :trigger_crunch_dispatch_if_cancelled, :on => :update
  11   before_validation :set_priority
  12   validate :ensure_script_version_is_commit
  13   validate :find_docker_image_locator
  14
  15   has_many :commit_ancestors, :foreign_key => :descendant, :primary_key => :script_version
  16
  17   class SubmitIdReused < StandardError
  18   end
  19
  20   api_accessible :user, extend: :common do |t|
  21     t.add :submit_id
  22     t.add :priority
  23     t.add :script
  24     t.add :script_parameters
  25     t.add :script_version
  26     t.add :cancelled_at
  27     t.add :cancelled_by_client_uuid
  28     t.add :cancelled_by_user_uuid
  29     t.add :started_at
  30     t.add :finished_at
  31     t.add :output
  32     t.add :success
  33     t.add :running
  34     t.add :is_locked_by_uuid
  35     t.add :log
  36     t.add :runtime_constraints
  37     t.add :tasks_summary
  38     t.add :dependencies
  39     t.add :nondeterministic
  40     t.add :repository
  41     t.add :supplied_script_version
  42     t.add :docker_image_locator
  43     t.add :description
  44   end
  45
  46   def assert_finished
  47     update_attributes(finished_at: finished_at || Time.now,
  48                       success: success.nil? ? false : success,
  49                       running: false)
  50   end
  51
  52   def self.queue
  53     self.where('started_at is ? and is_locked_by_uuid is ? and cancelled_at is ? and success is ?',
  54                nil, nil, nil, nil).
  55       order('priority desc, created_at')
  56   end
  57
  58   def self.running
  59     self.where('running = ?', true).
  60       order('priority desc, created_at')
  61   end
  62
  63   protected
  64
  65   def foreign_key_attributes
  66     super + %w(output log)
  67   end
  68
  69   def skip_uuid_read_permission_check
  70     super + %w(cancelled_by_client_uuid)
  71   end
  72
  73   def skip_uuid_existence_check
  74     super + %w(output log)
  75   end
  76
  77   def set_priority
  78     if self.priority.nil?
  79       self.priority = 0
  80     end
  81     true
  82   end
  83
  84   def ensure_script_version_is_commit
  85     if self.is_locked_by_uuid and self.started_at
  86       # Apparently client has already decided to go for it. This is
  87       # needed to run a local job using a local working directory
  88       # instead of a commit-ish.
  89       return true
  90     end
  91     if new_record? or script_version_changed?
  92       sha1 = Commit.find_commit_range(current_user, self.repository, nil, self.script_version, nil)[0] rescue nil
  93       if sha1
  94         self.supplied_script_version = self.script_version if self.supplied_script_version.nil? or self.supplied_script_version.empty?
  95         self.script_version = sha1
  96       else
  97         self.errors.add :script_version, "#{self.script_version} does not resolve to a commit"
  98         return false
  99       end
 100     end
 101   end
 102
 103   def ensure_unique_submit_id
 104     if !submit_id.nil?
 105       if Job.where('submit_id=?',self.submit_id).first
 106         raise SubmitIdReused.new
 107       end
 108     end
 109     true
 110   end
 111
 112   def find_docker_image_locator
 113     # Find the Collection that holds the Docker image specified in the
 114     # runtime constraints, and store its locator in docker_image_locator.
 115     unless runtime_constraints.is_a? Hash
 116       # We're still in validation stage, so we can't assume
 117       # runtime_constraints isn't something horrible like an array or
 118       # a string. Treat those cases as "no docker image supplied";
 119       # other validations will fail anyway.
 120       self.docker_image_locator = nil
 121       return true
 122     end
 123     image_search = runtime_constraints['docker_image']
 124     image_tag = runtime_constraints['docker_image_tag']
 125     if image_search.nil?
 126       self.docker_image_locator = nil
 127       true
 128     elsif coll = Collection.for_latest_docker_image(image_search, image_tag)
 129       self.docker_image_locator = coll.portable_data_hash
 130       true
 131     else
 132       errors.add(:docker_image_locator, "not found for #{image_search}")
 133       false
 134     end
 135   end
 136
 137   def dependencies
 138     deps = {}
 139     queue = self.script_parameters.values
 140     while not queue.empty?
 141       queue = queue.flatten.compact.collect do |v|
 142         if v.is_a? Hash
 143           v.values
 144         elsif v.is_a? String
 145           v.match(/^(([0-9a-f]{32})\b(\+[^,]+)?,?)*$/) do |locator|
 146             deps[locator.to_s] = true
 147           end
 148           nil
 149         end
 150       end
 151     end
 152     deps.keys
 153   end
 154
 155   def permission_to_update
 156     if is_locked_by_uuid_was and !(current_user and
 157                                    (current_user.uuid == is_locked_by_uuid_was or
 158                                     current_user.uuid == system_user.uuid))
 159       if script_changed? or
 160           script_parameters_changed? or
 161           script_version_changed? or
 162           (!cancelled_at_was.nil? and
 163            (cancelled_by_client_uuid_changed? or
 164             cancelled_by_user_uuid_changed? or
 165             cancelled_at_changed?)) or
 166           started_at_changed? or
 167           finished_at_changed? or
 168           running_changed? or
 169           success_changed? or
 170           output_changed? or
 171           log_changed? or
 172           tasks_summary_changed?
 173         logger.warn "User #{current_user.uuid if current_user} tried to change protected job attributes on locked #{self.class.to_s} #{uuid_was}"
 174         return false
 175       end
 176     end
 177     if !is_locked_by_uuid_changed?
 178       super
 179     else
 180       if !current_user
 181         logger.warn "Anonymous user tried to change lock on #{self.class.to_s} #{uuid_was}"
 182         false
 183       elsif is_locked_by_uuid_was and is_locked_by_uuid_was != current_user.uuid
 184         logger.warn "User #{current_user.uuid} tried to steal lock on #{self.class.to_s} #{uuid_was} from #{is_locked_by_uuid_was}"
 185         false
 186       elsif !is_locked_by_uuid.nil? and is_locked_by_uuid != current_user.uuid
 187         logger.warn "User #{current_user.uuid} tried to lock #{self.class.to_s} #{uuid_was} with uuid #{is_locked_by_uuid}"
 188         false
 189       else
 190         super
 191       end
 192     end
 193   end
 194
 195   def update_modified_by_fields
 196     if self.cancelled_at_changed?
 197       # Ensure cancelled_at cannot be set to arbitrary non-now times,
 198       # or changed once it is set.
 199       if self.cancelled_at and not self.cancelled_at_was
 200         self.cancelled_at = Time.now
 201         self.cancelled_by_user_uuid = current_user.uuid
 202         self.cancelled_by_client_uuid = current_api_client.andand.uuid
 203         @need_crunch_dispatch_trigger = true
 204       else
 205         self.cancelled_at = self.cancelled_at_was
 206         self.cancelled_by_user_uuid = self.cancelled_by_user_uuid_was
 207         self.cancelled_by_client_uuid = self.cancelled_by_client_uuid_was
 208       end
 209     end
 210     super
 211   end
 212
 213   def trigger_crunch_dispatch_if_cancelled
 214     if @need_crunch_dispatch_trigger
 215       File.open(Rails.configuration.crunch_refresh_trigger, 'wb') do
 216         # That's all, just create/touch a file for crunch-job to see.
 217       end
 218     end
 219   end
 220 end