1 # Copyright (C) The Arvados Authors. All rights reserved.
3 # SPDX-License-Identifier: AGPL-3.0
5 require 'whitelist_update'
7 class ContainerRequest < ArvadosModel
10 include CommonApiTemplate
11 include WhitelistUpdate
13 serialize :properties, Hash
14 serialize :environment, Hash
15 serialize :mounts, Hash
16 serialize :runtime_constraints, Hash
17 serialize :command, Array
18 serialize :scheduling_parameters, Hash
20 before_validation :fill_field_defaults, :if => :new_record?
21 before_validation :validate_runtime_constraints
22 before_validation :validate_scheduling_parameters
23 before_validation :set_container
24 validates :command, :container_image, :output_path, :cwd, :presence => true
25 validates :output_ttl, numericality: { only_integer: true, greater_than_or_equal_to: 0 }
26 validate :validate_state_change
27 validate :check_update_whitelist
28 after_save :update_priority
29 after_save :finalize_if_needed
30 before_create :set_requesting_container_uuid
32 api_accessible :user, extend: :common do |t|
34 t.add :container_count
35 t.add :container_count_max
36 t.add :container_image
52 t.add :requesting_container_uuid
53 t.add :runtime_constraints
54 t.add :scheduling_parameters
59 # Supported states for a container request
62 (Uncommitted = 'Uncommitted'),
63 (Committed = 'Committed'),
68 nil => [Uncommitted, Committed],
69 Uncommitted => [Committed],
73 AttrsPermittedAlways = [:owner_uuid, :state, :name, :description]
74 AttrsPermittedBeforeCommit = [:command, :container_count_max,
75 :container_image, :cwd, :environment, :filters, :mounts,
76 :output_path, :priority, :properties, :requesting_container_uuid,
77 :runtime_constraints, :state, :container_uuid, :use_existing,
78 :scheduling_parameters, :output_name, :output_ttl]
80 def self.limit_index_columns_read
88 def skip_uuid_read_permission_check
89 # XXX temporary until permissions are sorted out.
90 %w(modified_by_client_uuid container_uuid requesting_container_uuid)
93 def finalize_if_needed
94 if state == Committed && Container.find_by_uuid(container_uuid).final?
102 # Finalize the container request after the container has
103 # finished/cancelled.
107 c = Container.find_by_uuid(container_uuid)
108 ['output', 'log'].each do |out_type|
109 pdh = c.send(out_type)
111 coll_name = "Container #{out_type} for request #{uuid}"
113 if out_type == 'output'
115 coll_name = self.output_name
117 if self.output_ttl > 0
118 trash_at = db_current_time + self.output_ttl
121 manifest = Collection.unscoped do
122 Collection.where(portable_data_hash: pdh).first.manifest_text
125 coll = Collection.new(owner_uuid: owner_uuid,
126 manifest_text: manifest,
127 portable_data_hash: pdh,
133 'container_request' => uuid,
135 coll.save_with_unique_name!
136 if out_type == 'output'
142 update_attributes!(state: Final, output_uuid: out_coll, log_uuid: log_coll)
145 def self.full_text_searchable_columns
151 def fill_field_defaults
152 self.state ||= Uncommitted
153 self.environment ||= {}
154 self.runtime_constraints ||= {}
157 self.container_count_max ||= Rails.configuration.container_count_max
158 self.scheduling_parameters ||= {}
159 self.output_ttl ||= 0
163 if (container_uuid_changed? and
164 not current_user.andand.is_admin and
165 not container_uuid.nil?)
166 errors.add :container_uuid, "can only be updated to nil."
169 if state_changed? and state == Committed and container_uuid.nil?
170 self.container_uuid = Container.resolve(self).uuid
172 if self.container_uuid != self.container_uuid_was
173 if self.container_count_changed?
174 errors.add :container_count, "cannot be updated directly."
177 self.container_count += 1
182 def validate_runtime_constraints
187 ['keep_cache_ram', false]].each do |k, required|
188 if !required && !runtime_constraints.include?(k)
191 v = runtime_constraints[k]
192 unless (v.is_a?(Integer) && v > 0)
193 errors.add(:runtime_constraints,
194 "[#{k}]=#{v.inspect} must be a positive integer")
200 def validate_scheduling_parameters
201 if self.state == Committed
202 if scheduling_parameters.include? 'partitions' and
203 (!scheduling_parameters['partitions'].is_a?(Array) ||
204 scheduling_parameters['partitions'].reject{|x| !x.is_a?(String)}.size !=
205 scheduling_parameters['partitions'].size)
206 errors.add :scheduling_parameters, "partitions must be an array of strings"
211 def check_update_whitelist
212 permitted = AttrsPermittedAlways.dup
214 if self.new_record? || self.state_was == Uncommitted
215 # Allow create-and-commit in a single operation.
216 permitted.push *AttrsPermittedBeforeCommit
221 permitted.push :priority, :container_count_max, :container_uuid
223 if self.container_uuid.nil?
224 self.errors.add :container_uuid, "has not been resolved to a container."
227 if self.priority.nil?
228 self.errors.add :priority, "cannot be nil"
231 # Allow container count to increment by 1
232 if (self.container_uuid &&
233 self.container_uuid != self.container_uuid_was &&
234 self.container_count == 1 + (self.container_count_was || 0))
235 permitted.push :container_count
239 if self.state_changed? and not current_user.andand.is_admin
240 self.errors.add :state, "of container request can only be set to Final by system."
243 if self.state_was == Committed
244 permitted.push :output_uuid, :log_uuid
253 if self.state_changed? or
254 self.priority_changed? or
255 self.container_uuid_changed?
256 act_as_system_user do
259 [self.container_uuid_was, self.container_uuid].compact).
260 map(&:update_priority!)
265 def set_requesting_container_uuid
266 return !new_record? if self.requesting_container_uuid # already set
268 token_uuid = current_api_client_authorization.andand.uuid
269 container = Container.where('auth_uuid=?', token_uuid).order('created_at desc').first
270 self.requesting_container_uuid = container.uuid if container