services/api/app/models/container.rb

   1 require 'whitelist_update'
   2
   3 class Container < ArvadosModel
   4   include HasUuid
   5   include KindAndEtag
   6   include CommonApiTemplate
   7   include WhitelistUpdate
   8
   9   serialize :environment, Hash
  10   serialize :mounts, Hash
  11   serialize :runtime_constraints, Hash
  12   serialize :command, Array
  13
  14   before_validation :fill_field_defaults, :if => :new_record?
  15   before_validation :set_timestamps
  16   validates :command, :container_image, :output_path, :cwd, :priority, :presence => true
  17   validate :validate_state_change
  18   validate :validate_change
  19   validate :validate_lock
  20   after_validation :assign_auth
  21   after_save :handle_completed
  22
  23   has_many :container_requests, :foreign_key => :container_uuid, :class_name => 'ContainerRequest', :primary_key => :uuid
  24   belongs_to :auth, :class_name => 'ApiClientAuthorization', :foreign_key => :auth_uuid, :primary_key => :uuid
  25
  26   api_accessible :user, extend: :common do |t|
  27     t.add :command
  28     t.add :container_image
  29     t.add :cwd
  30     t.add :environment
  31     t.add :exit_code
  32     t.add :finished_at
  33     t.add :locked_by_uuid
  34     t.add :log
  35     t.add :mounts
  36     t.add :output
  37     t.add :output_path
  38     t.add :priority
  39     t.add :progress
  40     t.add :runtime_constraints
  41     t.add :started_at
  42     t.add :state
  43     t.add :auth_uuid
  44   end
  45
  46   # Supported states for a container
  47   States =
  48     [
  49      (Queued = 'Queued'),
  50      (Locked = 'Locked'),
  51      (Running = 'Running'),
  52      (Complete = 'Complete'),
  53      (Cancelled = 'Cancelled')
  54     ]
  55
  56   State_transitions = {
  57     nil => [Queued],
  58     Queued => [Locked, Cancelled],
  59     Locked => [Queued, Running, Cancelled],
  60     Running => [Complete, Cancelled]
  61   }
  62
  63   def state_transitions
  64     State_transitions
  65   end
  66
  67   def update_priority!
  68     if [Queued, Locked, Running].include? self.state
  69       # Update the priority of this container to the maximum priority of any of
  70       # its committed container requests and save the record.
  71       self.priority = ContainerRequest.
  72         where(container_uuid: uuid,
  73               state: ContainerRequest::Committed).
  74         maximum('priority')
  75       self.save!
  76     end
  77   end
  78
  79   def self.readable_by *users_list
  80     if users_list.select { |u| u.is_admin }.any?
  81       return self
  82     end
  83     user_uuids = users_list.map { |u| u.uuid }
  84     uuid_list = user_uuids + users_list.flat_map { |u| u.groups_i_can(:read) }
  85     permitted_uuids = "(SELECT head_uuid FROM links WHERE link_class='permission' AND tail_uuid IN (?))"
  86     joins(:container_requests).where("container_requests.uuid IN #{permitted_uuids} OR container_requests.owner_uuid IN (?)",
  87                                      uuid_list, uuid_list)
  88   end
  89
  90   protected
  91
  92   def fill_field_defaults
  93     self.state ||= Queued
  94     self.environment ||= {}
  95     self.runtime_constraints ||= {}
  96     self.mounts ||= {}
  97     self.cwd ||= "."
  98     self.priority ||= 1
  99   end
 100
 101   def permission_to_create
 102     current_user.andand.is_admin
 103   end
 104
 105   def permission_to_update
 106     current_user.andand.is_admin
 107   end
 108
 109   def set_timestamps
 110     if self.state_changed? and self.state == Running
 111       self.started_at ||= db_current_time
 112     end
 113
 114     if self.state_changed? and [Complete, Cancelled].include? self.state
 115       self.finished_at ||= db_current_time
 116     end
 117   end
 118
 119   def validate_change
 120     permitted = [:state]
 121
 122     if self.new_record?
 123       permitted.push(:owner_uuid, :command, :container_image, :cwd,
 124                      :environment, :mounts, :output_path, :priority,
 125                      :runtime_constraints)
 126     end
 127
 128     case self.state
 129     when Queued, Locked
 130       permitted.push :priority
 131
 132     when Running
 133       permitted.push :priority, :progress
 134       if self.state_changed?
 135         permitted.push :started_at
 136       end
 137
 138     when Complete
 139       if self.state_was == Running
 140         permitted.push :finished_at, :output, :log, :exit_code
 141       end
 142
 143     when Cancelled
 144       case self.state_was
 145       when Running
 146         permitted.push :finished_at, :output, :log
 147       when Queued, Locked
 148         permitted.push :finished_at
 149       end
 150
 151     else
 152       # The state_transitions check will add an error message for this
 153       return false
 154     end
 155
 156     check_update_whitelist permitted
 157   end
 158
 159   def validate_lock
 160     # If the Container is already locked by someone other than the
 161     # current api_client_auth, disallow all changes -- except
 162     # priority, which needs to change to reflect max(priority) of
 163     # relevant ContainerRequests.
 164     if locked_by_uuid_was
 165       if locked_by_uuid_was != Thread.current[:api_client_authorization].uuid
 166         check_update_whitelist [:priority]
 167       end
 168     end
 169
 170     if [Locked, Running].include? self.state
 171       # If the Container was already locked, locked_by_uuid must not
 172       # changes. Otherwise, the current auth gets the lock.
 173       need_lock = locked_by_uuid_was || Thread.current[:api_client_authorization].uuid
 174     else
 175       need_lock = nil
 176     end
 177
 178     # The caller can provide a new value for locked_by_uuid, but only
 179     # if it's exactly what we expect. This allows a caller to perform
 180     # an update like {"state":"Unlocked","locked_by_uuid":null}.
 181     if self.locked_by_uuid_changed?
 182       if self.locked_by_uuid != need_lock
 183         return errors.add :locked_by_uuid, "can only change to #{need_lock}"
 184       end
 185     end
 186     self.locked_by_uuid = need_lock
 187   end
 188
 189   def assign_auth
 190     if self.auth_uuid_changed?
 191       return errors.add :auth_uuid, 'is readonly'
 192     end
 193     if not [Locked, Running].include? self.state
 194       # don't need one
 195       self.auth.andand.update_attributes(expires_at: db_current_time)
 196       self.auth = nil
 197       return
 198     elsif self.auth
 199       # already have one
 200       return
 201     end
 202     cr = ContainerRequest.
 203       where('container_uuid=? and priority>0', self.uuid).
 204       order('priority desc').
 205       first
 206     if !cr
 207       return errors.add :auth_uuid, "cannot be assigned because priority <= 0"
 208     end
 209     self.auth = ApiClientAuthorization.
 210       create!(user_id: User.find_by_uuid(cr.modified_by_user_uuid).id,
 211               api_client_id: 0)
 212   end
 213
 214   def handle_completed
 215     # This container is finished so finalize any associated container requests
 216     # that are associated with this container.
 217     if self.state_changed? and [Complete, Cancelled].include? self.state
 218       act_as_system_user do
 219         # Notify container requests associated with this container
 220         ContainerRequest.where(container_uuid: uuid,
 221                                :state => ContainerRequest::Committed).each do |cr|
 222           cr.container_completed!
 223         end
 224
 225         # Try to cancel any outstanding container requests made by this container.
 226         ContainerRequest.where(requesting_container_uuid: uuid,
 227                                :state => ContainerRequest::Committed).each do |cr|
 228           cr.priority = 0
 229           cr.save
 230         end
 231       end
 232     end
 233   end
 234
 235 end