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