Merge branch '9674-cwl-initialworkdir' closes #9674
[arvados.git] / services / api / test / unit / container_request_test.rb
1 require 'test_helper'
2
3 class ContainerRequestTest < ActiveSupport::TestCase
4   def create_minimal_req! attrs={}
5     defaults = {
6       command: ["echo", "foo"],
7       container_image: links(:docker_image_collection_tag).name,
8       cwd: "/tmp",
9       environment: {},
10       mounts: {"/out" => {"kind" => "tmp", "capacity" => 1000000}},
11       output_path: "/out",
12       runtime_constraints: {"vcpus" => 1, "ram" => 2},
13       name: "foo",
14       description: "bar",
15     }
16     cr = ContainerRequest.create!(defaults.merge(attrs))
17     cr.reload
18     return cr
19   end
20
21   def check_bogus_states cr
22     [nil, "Flubber"].each do |state|
23       assert_raises(ActiveRecord::RecordInvalid) do
24         cr.state = state
25         cr.save!
26       end
27       cr.reload
28     end
29   end
30
31   test "Container request create" do
32     set_user_from_auth :active
33     cr = create_minimal_req!
34
35     assert_nil cr.container_uuid
36     assert_nil cr.priority
37
38     check_bogus_states cr
39
40     # Ensure we can modify all attributes
41     cr.command = ["echo", "foo3"]
42     cr.container_image = "img3"
43     cr.cwd = "/tmp3"
44     cr.environment = {"BUP" => "BOP"}
45     cr.mounts = {"BAR" => "BAZ"}
46     cr.output_path = "/tmp4"
47     cr.priority = 2
48     cr.runtime_constraints = {"vcpus" => 4}
49     cr.name = "foo3"
50     cr.description = "bar3"
51     cr.save!
52
53     assert_nil cr.container_uuid
54   end
55
56   [
57     {"vcpus" => 1},
58     {"vcpus" => 1, "ram" => nil},
59     {"vcpus" => 0, "ram" => 123},
60     {"vcpus" => "1", "ram" => "123"}
61   ].each do |invalid_constraints|
62     test "Create with #{invalid_constraints}" do
63       set_user_from_auth :active
64       assert_raises(ActiveRecord::RecordInvalid) do
65         cr = create_minimal_req!(state: "Committed",
66                                  priority: 1,
67                                  runtime_constraints: invalid_constraints)
68         cr.save!
69       end
70     end
71
72     test "Update with #{invalid_constraints}" do
73       set_user_from_auth :active
74       cr = create_minimal_req!(state: "Uncommitted", priority: 1)
75       cr.save!
76       assert_raises(ActiveRecord::RecordInvalid) do
77         cr = ContainerRequest.find_by_uuid cr.uuid
78         cr.update_attributes!(state: "Committed",
79                               runtime_constraints: invalid_constraints)
80       end
81     end
82   end
83
84   test "Update from fixture" do
85     set_user_from_auth :active
86     cr = ContainerRequest.find_by_uuid(container_requests(:running).uuid)
87     cr.update_attributes!(description: "New description")
88     assert_equal "New description", cr.description
89   end
90
91   test "Update with valid runtime constraints" do
92       set_user_from_auth :active
93       cr = create_minimal_req!(state: "Uncommitted", priority: 1)
94       cr.save!
95       cr = ContainerRequest.find_by_uuid cr.uuid
96       cr.update_attributes!(state: "Committed",
97                             runtime_constraints: {"vcpus" => 1, "ram" => 23})
98       assert_not_nil cr.container_uuid
99   end
100
101   test "Container request priority must be non-nil" do
102     set_user_from_auth :active
103     cr = create_minimal_req!(priority: nil)
104     cr.state = "Committed"
105     assert_raises(ActiveRecord::RecordInvalid) do
106       cr.save!
107     end
108   end
109
110   test "Container request commit" do
111     set_user_from_auth :active
112     cr = create_minimal_req!(runtime_constraints: {"vcpus" => 2, "ram" => 30})
113
114     assert_nil cr.container_uuid
115
116     cr.reload
117     cr.state = "Committed"
118     cr.priority = 1
119     cr.save!
120
121     cr.reload
122
123     assert_not_nil cr.container_uuid
124     c = Container.find_by_uuid cr.container_uuid
125     assert_not_nil c
126     assert_equal ["echo", "foo"], c.command
127     assert_equal collections(:docker_image).portable_data_hash, c.container_image
128     assert_equal "/tmp", c.cwd
129     assert_equal({}, c.environment)
130     assert_equal({"/out" => {"kind"=>"tmp", "capacity"=>1000000}}, c.mounts)
131     assert_equal "/out", c.output_path
132     assert_equal({"vcpus" => 2, "ram" => 30}, c.runtime_constraints)
133     assert_equal 1, c.priority
134
135     assert_raises(ActiveRecord::RecordInvalid) do
136       cr.priority = nil
137       cr.save!
138     end
139
140     cr.priority = 0
141     cr.save!
142
143     cr.reload
144     c.reload
145     assert_equal 0, cr.priority
146     assert_equal 0, c.priority
147   end
148
149
150   test "Container request max priority" do
151     set_user_from_auth :active
152     cr = create_minimal_req!(priority: 5, state: "Committed")
153
154     c = Container.find_by_uuid cr.container_uuid
155     assert_equal 5, c.priority
156
157     cr2 = create_minimal_req!
158     cr2.priority = 10
159     cr2.state = "Committed"
160     cr2.container_uuid = cr.container_uuid
161     act_as_system_user do
162       cr2.save!
163     end
164
165     # cr and cr2 have priority 5 and 10, and are being satisfied by
166     # the same container c, so c's priority should be
167     # max(priority)=10.
168     c.reload
169     assert_equal 10, c.priority
170
171     cr2.update_attributes!(priority: 0)
172
173     c.reload
174     assert_equal 5, c.priority
175
176     cr.update_attributes!(priority: 0)
177
178     c.reload
179     assert_equal 0, c.priority
180   end
181
182
183   test "Independent container requests" do
184     set_user_from_auth :active
185     cr1 = create_minimal_req!(command: ["foo", "1"], priority: 5, state: "Committed")
186     cr2 = create_minimal_req!(command: ["foo", "2"], priority: 10, state: "Committed")
187
188     c1 = Container.find_by_uuid cr1.container_uuid
189     assert_equal 5, c1.priority
190
191     c2 = Container.find_by_uuid cr2.container_uuid
192     assert_equal 10, c2.priority
193
194     cr1.update_attributes!(priority: 0)
195
196     c1.reload
197     assert_equal 0, c1.priority
198
199     c2.reload
200     assert_equal 10, c2.priority
201   end
202
203   test "Request is finalized when its container is cancelled" do
204     set_user_from_auth :active
205     cr = create_minimal_req!(priority: 1, state: "Committed")
206
207     act_as_system_user do
208       Container.find_by_uuid(cr.container_uuid).
209         update_attributes!(state: Container::Cancelled)
210     end
211
212     cr.reload
213     assert_equal "Final", cr.state
214   end
215
216   test "Request is finalized when its container is completed" do
217     set_user_from_auth :active
218     cr = create_minimal_req!(priority: 1, state: "Committed")
219
220     c = act_as_system_user do
221       c = Container.find_by_uuid(cr.container_uuid)
222       c.update_attributes!(state: Container::Locked)
223       c.update_attributes!(state: Container::Running)
224       c
225     end
226
227     cr.reload
228     assert_equal "Committed", cr.state
229
230     act_as_system_user do
231       c.update_attributes!(state: Container::Complete)
232     end
233
234     cr.reload
235     assert_equal "Final", cr.state
236   end
237
238   test "Container makes container request, then is cancelled" do
239     set_user_from_auth :active
240     cr = create_minimal_req!(priority: 5, state: "Committed")
241
242     c = Container.find_by_uuid cr.container_uuid
243     assert_equal 5, c.priority
244
245     cr2 = create_minimal_req!(priority: 10, state: "Committed", requesting_container_uuid: c.uuid)
246
247     c2 = Container.find_by_uuid cr2.container_uuid
248     assert_equal 10, c2.priority
249
250     act_as_system_user do
251       c.state = "Cancelled"
252       c.save!
253     end
254
255     cr.reload
256     assert_equal "Final", cr.state
257
258     cr2.reload
259     assert_equal 0, cr2.priority
260
261     c2.reload
262     assert_equal 0, c2.priority
263   end
264
265   [
266     ['active', 'zzzzz-dz642-runningcontainr'],
267     ['active_no_prefs', nil],
268   ].each do |token, expected|
269     test "create as #{token} and expect requesting_container_uuid to be #{expected}" do
270       set_user_from_auth token
271       cr = ContainerRequest.create(container_image: "img", output_path: "/tmp", command: ["echo", "foo"])
272       assert_not_nil cr.uuid, 'uuid should be set for newly created container_request'
273       assert_equal expected, cr.requesting_container_uuid
274     end
275   end
276
277   [[{"vcpus" => [2, nil]},
278     lambda { |resolved| resolved["vcpus"] == 2 }],
279    [{"vcpus" => [3, 7]},
280     lambda { |resolved| resolved["vcpus"] == 3 }],
281    [{"vcpus" => 4},
282     lambda { |resolved| resolved["vcpus"] == 4 }],
283    [{"ram" => [1000000000, 2000000000]},
284     lambda { |resolved| resolved["ram"] == 1000000000 }],
285    [{"ram" => [1234234234]},
286     lambda { |resolved| resolved["ram"] == 1234234234 }],
287   ].each do |rc, okfunc|
288     test "resolve runtime constraint range #{rc} to values" do
289       cr = ContainerRequest.new(runtime_constraints: rc)
290       resolved = cr.send :runtime_constraints_for_container
291       assert(okfunc.call(resolved),
292              "container runtime_constraints was #{resolved.inspect}")
293     end
294   end
295
296   [[{"/out" => {
297         "kind" => "collection",
298         "uuid" => "zzzzz-4zz18-znfnqtbbv4spc3w",
299         "path" => "/foo"}},
300     lambda do |resolved|
301       resolved["/out"] == {
302         "portable_data_hash" => "1f4b0bc7583c2a7f9102c395f4ffc5e3+45",
303         "kind" => "collection",
304         "path" => "/foo",
305       }
306     end],
307    [{"/out" => {
308         "kind" => "collection",
309         "uuid" => "zzzzz-4zz18-znfnqtbbv4spc3w",
310         "portable_data_hash" => "1f4b0bc7583c2a7f9102c395f4ffc5e3+45",
311         "path" => "/foo"}},
312     lambda do |resolved|
313       resolved["/out"] == {
314         "portable_data_hash" => "1f4b0bc7583c2a7f9102c395f4ffc5e3+45",
315         "kind" => "collection",
316         "path" => "/foo",
317       }
318     end],
319   ].each do |mounts, okfunc|
320     test "resolve mounts #{mounts.inspect} to values" do
321       set_user_from_auth :active
322       cr = ContainerRequest.new(mounts: mounts)
323       resolved = cr.send :mounts_for_container
324       assert(okfunc.call(resolved),
325              "mounts_for_container returned #{resolved.inspect}")
326     end
327   end
328
329   test 'mount unreadable collection' do
330     set_user_from_auth :spectator
331     m = {
332       "/foo" => {
333         "kind" => "collection",
334         "uuid" => "zzzzz-4zz18-znfnqtbbv4spc3w",
335         "path" => "/foo",
336       },
337     }
338     cr = ContainerRequest.new(mounts: m)
339     assert_raises(ActiveRecord::RecordNotFound) do
340       cr.send :mounts_for_container
341     end
342   end
343
344   test 'mount collection with mismatched UUID and PDH' do
345     set_user_from_auth :active
346     m = {
347       "/foo" => {
348         "kind" => "collection",
349         "uuid" => "zzzzz-4zz18-znfnqtbbv4spc3w",
350         "portable_data_hash" => "fa7aeb5140e2848d39b416daeef4ffc5+45",
351         "path" => "/foo",
352       },
353     }
354     cr = ContainerRequest.new(mounts: m)
355     assert_raises(ArgumentError) do
356       cr.send :mounts_for_container
357     end
358   end
359
360   ['arvados/apitestfixture:latest',
361    'arvados/apitestfixture',
362    'd8309758b8fe2c81034ffc8a10c36460b77db7bc5e7b448c4e5b684f9d95a678',
363   ].each do |tag|
364     test "container_image_for_container(#{tag.inspect})" do
365       set_user_from_auth :active
366       cr = ContainerRequest.new(container_image: tag)
367       resolved = cr.send :container_image_for_container
368       assert_equal resolved, collections(:docker_image).portable_data_hash
369     end
370   end
371
372   test "container_image_for_container(pdh)" do
373     set_user_from_auth :active
374     pdh = collections(:docker_image).portable_data_hash
375     cr = ContainerRequest.new(container_image: pdh)
376     resolved = cr.send :container_image_for_container
377     assert_equal resolved, pdh
378   end
379
380   ['acbd18db4cc2f85cedef654fccc4a4d8+3',
381    'ENOEXIST',
382    'arvados/apitestfixture:ENOEXIST',
383   ].each do |img|
384     test "container_image_for_container(#{img.inspect}) => 404" do
385       set_user_from_auth :active
386       cr = ContainerRequest.new(container_image: img)
387       assert_raises(ActiveRecord::RecordNotFound) do
388         cr.send :container_image_for_container
389       end
390     end
391   end
392 end