services/api/app/models/container_request.rb

   1 require 'whitelist_update'
   2
   3 class ContainerRequest < ArvadosModel
   4   include HasUuid
   5   include KindAndEtag
   6   include CommonApiTemplate
   7   include WhitelistUpdate
   8
   9   serialize :properties, Hash
  10   serialize :environment, Hash
  11   serialize :mounts, Hash
  12   serialize :runtime_constraints, Hash
  13   serialize :command, Array
  14
  15   before_validation :fill_field_defaults, :if => :new_record?
  16   validates :command, :container_image, :output_path, :cwd, :presence => true
  17   validate :validate_change
  18
  19   api_accessible :user, extend: :common do |t|
  20     t.add :command
  21     t.add :container_count_max
  22     t.add :container_image
  23     t.add :container_uuid
  24     t.add :cwd
  25     t.add :description
  26     t.add :environment
  27     t.add :expires_at
  28     t.add :filters
  29     t.add :mounts
  30     t.add :name
  31     t.add :output_path
  32     t.add :priority
  33     t.add :properties
  34     t.add :requesting_container_uuid
  35     t.add :runtime_constraints
  36     t.add :state
  37   end
  38
  39   # Supported states for a container request
  40   States =
  41     [
  42      (Uncommitted = 'Uncommitted'),
  43      (Committed = 'Committed'),
  44      (Final = 'Final'),
  45     ]
  46
  47   protected
  48
  49   def fill_field_defaults
  50     self.state ||= Uncommitted
  51     self.environment ||= {}
  52     self.runtime_constraints ||= {}
  53     self.mounts ||= {}
  54     self.cwd ||= "."
  55     self.priority ||= 1
  56   end
  57
  58   def validate_change
  59     permitted = [:owner_uuid]
  60
  61     case self.state
  62     when Uncommitted
  63       # Permit updating most fields
  64       permitted.push :command, :container_count_max,
  65                      :container_image, :cwd, :description, :environment,
  66                      :filters, :mounts, :name, :output_path, :priority,
  67                      :properties, :requesting_container_uuid, :runtime_constraints,
  68                      :state
  69
  70       if self.container_uuid_changed? and (current_user.andand.is_admin or self.container_uuid.nil?)
  71         permitted.push :container_uuid
  72       end
  73
  74     when Committed
  75       # Can only update priority, container count.
  76       permitted.push :priority, :container_count_max
  77
  78       if self.state_changed?
  79         if self.state_was == Uncommitted
  80           permitted.push :state
  81         else
  82           errors.add :state, "Can only go from Uncommitted to Committed"
  83         end
  84       end
  85
  86       if self.container_uuid_changed? and current_user.andand.is_admin
  87         permitted.push :container_uuid
  88       end
  89
  90     when Final
  91       if self.state_changed?
  92         if self.state_was == Committed
  93           permitted.push :state
  94         else
  95           errors.add :state, "Can only go from Committed to Final"
  96         end
  97       else
  98         errors.add "Cannot update record in Final state"
  99       end
 100
 101     else
 102       errors.add :state, "Invalid state #{self.state}"
 103     end
 104
 105     check_update_whitelist permitted
 106   end
 107
 108 end