1 # Copyright (C) The Arvados Authors. All rights reserved.
3 # SPDX-License-Identifier: AGPL-3.0
6 require 'helpers/docker_migration_helper'
8 class ContainerRequestTest < ActiveSupport::TestCase
9 include DockerMigrationHelper
12 def create_minimal_req! attrs={}
14 command: ["echo", "foo"],
15 container_image: links(:docker_image_collection_tag).name,
18 mounts: {"/out" => {"kind" => "tmp", "capacity" => 1000000}},
20 runtime_constraints: {"vcpus" => 1, "ram" => 2},
24 cr = ContainerRequest.create!(defaults.merge(attrs))
29 def check_bogus_states cr
30 [nil, "Flubber"].each do |state|
31 assert_raises(ActiveRecord::RecordInvalid) do
39 test "Container request create" do
40 set_user_from_auth :active
41 cr = create_minimal_req!
43 assert_nil cr.container_uuid
44 assert_nil cr.priority
48 # Ensure we can modify all attributes
49 cr.command = ["echo", "foo3"]
50 cr.container_image = "img3"
52 cr.environment = {"BUP" => "BOP"}
53 cr.mounts = {"BAR" => "BAZ"}
54 cr.output_path = "/tmp4"
56 cr.runtime_constraints = {"vcpus" => 4}
58 cr.description = "bar3"
61 assert_nil cr.container_uuid
66 {"vcpus" => 1, "ram" => nil},
67 {"vcpus" => 0, "ram" => 123},
68 {"vcpus" => "1", "ram" => "123"}
69 ].each do |invalid_constraints|
70 test "Create with #{invalid_constraints}" do
71 set_user_from_auth :active
72 assert_raises(ActiveRecord::RecordInvalid) do
73 cr = create_minimal_req!(state: "Committed",
75 runtime_constraints: invalid_constraints)
80 test "Update with #{invalid_constraints}" do
81 set_user_from_auth :active
82 cr = create_minimal_req!(state: "Uncommitted", priority: 1)
84 assert_raises(ActiveRecord::RecordInvalid) do
85 cr = ContainerRequest.find_by_uuid cr.uuid
86 cr.update_attributes!(state: "Committed",
87 runtime_constraints: invalid_constraints)
92 test "Update from fixture" do
93 set_user_from_auth :active
94 cr = ContainerRequest.find_by_uuid(container_requests(:running).uuid)
95 cr.update_attributes!(description: "New description")
96 assert_equal "New description", cr.description
99 test "Update with valid runtime constraints" do
100 set_user_from_auth :active
101 cr = create_minimal_req!(state: "Uncommitted", priority: 1)
103 cr = ContainerRequest.find_by_uuid cr.uuid
104 cr.update_attributes!(state: "Committed",
105 runtime_constraints: {"vcpus" => 1, "ram" => 23})
106 assert_not_nil cr.container_uuid
109 test "Container request priority must be non-nil" do
110 set_user_from_auth :active
111 cr = create_minimal_req!(priority: nil)
112 cr.state = "Committed"
113 assert_raises(ActiveRecord::RecordInvalid) do
118 test "Container request commit" do
119 set_user_from_auth :active
120 cr = create_minimal_req!(runtime_constraints: {"vcpus" => 2, "ram" => 30})
122 assert_nil cr.container_uuid
125 cr.state = "Committed"
131 assert_equal({"vcpus" => 2, "ram" => 30}, cr.runtime_constraints)
133 assert_not_nil cr.container_uuid
134 c = Container.find_by_uuid cr.container_uuid
136 assert_equal ["echo", "foo"], c.command
137 assert_equal collections(:docker_image).portable_data_hash, c.container_image
138 assert_equal "/tmp", c.cwd
139 assert_equal({}, c.environment)
140 assert_equal({"/out" => {"kind"=>"tmp", "capacity"=>1000000}}, c.mounts)
141 assert_equal "/out", c.output_path
142 assert_equal({"keep_cache_ram"=>268435456, "vcpus" => 2, "ram" => 30}, c.runtime_constraints)
143 assert_equal 1, c.priority
145 assert_raises(ActiveRecord::RecordInvalid) do
155 assert_equal 0, cr.priority
156 assert_equal 0, c.priority
160 test "Container request max priority" do
161 set_user_from_auth :active
162 cr = create_minimal_req!(priority: 5, state: "Committed")
164 c = Container.find_by_uuid cr.container_uuid
165 assert_equal 5, c.priority
167 cr2 = create_minimal_req!
169 cr2.state = "Committed"
170 cr2.container_uuid = cr.container_uuid
171 act_as_system_user do
175 # cr and cr2 have priority 5 and 10, and are being satisfied by
176 # the same container c, so c's priority should be
179 assert_equal 10, c.priority
181 cr2.update_attributes!(priority: 0)
184 assert_equal 5, c.priority
186 cr.update_attributes!(priority: 0)
189 assert_equal 0, c.priority
193 test "Independent container requests" do
194 set_user_from_auth :active
195 cr1 = create_minimal_req!(command: ["foo", "1"], priority: 5, state: "Committed")
196 cr2 = create_minimal_req!(command: ["foo", "2"], priority: 10, state: "Committed")
198 c1 = Container.find_by_uuid cr1.container_uuid
199 assert_equal 5, c1.priority
201 c2 = Container.find_by_uuid cr2.container_uuid
202 assert_equal 10, c2.priority
204 cr1.update_attributes!(priority: 0)
207 assert_equal 0, c1.priority
210 assert_equal 10, c2.priority
213 test "Request is finalized when its container is cancelled" do
214 set_user_from_auth :active
215 cr = create_minimal_req!(priority: 1, state: "Committed", container_count_max: 1)
217 act_as_system_user do
218 Container.find_by_uuid(cr.container_uuid).
219 update_attributes!(state: Container::Cancelled)
223 assert_equal "Final", cr.state
226 test "Request is finalized when its container is completed" do
227 set_user_from_auth :active
228 project = groups(:private)
229 cr = create_minimal_req!(owner_uuid: project.uuid,
233 c = act_as_system_user do
234 c = Container.find_by_uuid(cr.container_uuid)
235 c.update_attributes!(state: Container::Locked)
236 c.update_attributes!(state: Container::Running)
241 assert_equal "Committed", cr.state
243 output_pdh = '1f4b0bc7583c2a7f9102c395f4ffc5e3+45'
244 log_pdh = 'fa7aeb5140e2848d39b416daeef4ffc5+45'
245 act_as_system_user do
246 c.update_attributes!(state: Container::Complete,
252 assert_equal "Final", cr.state
253 ['output', 'log'].each do |out_type|
254 pdh = Container.find_by_uuid(cr.container_uuid).send(out_type)
255 assert_equal(1, Collection.where(portable_data_hash: pdh,
256 owner_uuid: project.uuid).count,
257 "Container #{out_type} should be copied to #{project.uuid}")
259 assert_not_nil cr.output_uuid
260 assert_not_nil cr.log_uuid
261 output = Collection.find_by_uuid cr.output_uuid
262 assert_equal output_pdh, output.portable_data_hash
263 log = Collection.find_by_uuid cr.log_uuid
264 assert_equal log_pdh, log.portable_data_hash
267 test "Container makes container request, then is cancelled" do
268 set_user_from_auth :active
269 cr = create_minimal_req!(priority: 5, state: "Committed", container_count_max: 1)
271 c = Container.find_by_uuid cr.container_uuid
272 assert_equal 5, c.priority
274 cr2 = create_minimal_req!
275 cr2.update_attributes!(priority: 10, state: "Committed", requesting_container_uuid: c.uuid, command: ["echo", "foo2"], container_count_max: 1)
278 c2 = Container.find_by_uuid cr2.container_uuid
279 assert_equal 10, c2.priority
281 act_as_system_user do
282 c.state = "Cancelled"
287 assert_equal "Final", cr.state
290 assert_equal 0, cr2.priority
293 assert_equal 0, c2.priority
297 ['running_container_auth', 'zzzzz-dz642-runningcontainr'],
298 ['active_no_prefs', nil],
299 ].each do |token, expected|
300 test "create as #{token} and expect requesting_container_uuid to be #{expected}" do
301 set_user_from_auth token
302 cr = ContainerRequest.create(container_image: "img", output_path: "/tmp", command: ["echo", "foo"])
303 assert_not_nil cr.uuid, 'uuid should be set for newly created container_request'
304 assert_equal expected, cr.requesting_container_uuid
308 [[{"vcpus" => [2, nil]},
309 lambda { |resolved| resolved["vcpus"] == 2 }],
310 [{"vcpus" => [3, 7]},
311 lambda { |resolved| resolved["vcpus"] == 3 }],
313 lambda { |resolved| resolved["vcpus"] == 4 }],
314 [{"ram" => [1000000000, 2000000000]},
315 lambda { |resolved| resolved["ram"] == 1000000000 }],
316 [{"ram" => [1234234234]},
317 lambda { |resolved| resolved["ram"] == 1234234234 }],
318 ].each do |rc, okfunc|
319 test "resolve runtime constraint range #{rc} to values" do
320 resolved = Container.resolve_runtime_constraints(rc)
321 assert(okfunc.call(resolved),
322 "container runtime_constraints was #{resolved.inspect}")
327 "kind" => "collection",
328 "uuid" => "zzzzz-4zz18-znfnqtbbv4spc3w",
331 resolved["/out"] == {
332 "portable_data_hash" => "1f4b0bc7583c2a7f9102c395f4ffc5e3+45",
333 "kind" => "collection",
338 "kind" => "collection",
339 "uuid" => "zzzzz-4zz18-znfnqtbbv4spc3w",
340 "portable_data_hash" => "1f4b0bc7583c2a7f9102c395f4ffc5e3+45",
343 resolved["/out"] == {
344 "portable_data_hash" => "1f4b0bc7583c2a7f9102c395f4ffc5e3+45",
345 "kind" => "collection",
349 ].each do |mounts, okfunc|
350 test "resolve mounts #{mounts.inspect} to values" do
351 set_user_from_auth :active
352 resolved = Container.resolve_mounts(mounts)
353 assert(okfunc.call(resolved),
354 "Container.resolve_mounts returned #{resolved.inspect}")
358 test 'mount unreadable collection' do
359 set_user_from_auth :spectator
362 "kind" => "collection",
363 "uuid" => "zzzzz-4zz18-znfnqtbbv4spc3w",
367 assert_raises(ArvadosModel::UnresolvableContainerError) do
368 Container.resolve_mounts(m)
372 test 'mount collection with mismatched UUID and PDH' do
373 set_user_from_auth :active
376 "kind" => "collection",
377 "uuid" => "zzzzz-4zz18-znfnqtbbv4spc3w",
378 "portable_data_hash" => "fa7aeb5140e2848d39b416daeef4ffc5+45",
382 assert_raises(ArgumentError) do
383 Container.resolve_mounts(m)
387 ['arvados/apitestfixture:latest',
388 'arvados/apitestfixture',
389 'd8309758b8fe2c81034ffc8a10c36460b77db7bc5e7b448c4e5b684f9d95a678',
391 test "Container.resolve_container_image(#{tag.inspect})" do
392 set_user_from_auth :active
393 resolved = Container.resolve_container_image(tag)
394 assert_equal resolved, collections(:docker_image).portable_data_hash
398 test "Container.resolve_container_image(pdh)" do
399 set_user_from_auth :active
400 [[:docker_image, 'v1'], [:docker_image_1_12, 'v2']].each do |coll, ver|
401 Rails.configuration.docker_image_formats = [ver]
402 pdh = collections(coll).portable_data_hash
403 resolved = Container.resolve_container_image(pdh)
404 assert_equal resolved, pdh
408 ['acbd18db4cc2f85cedef654fccc4a4d8+3',
410 'arvados/apitestfixture:ENOEXIST',
412 test "container_image_for_container(#{img.inspect}) => 422" do
413 set_user_from_auth :active
414 assert_raises(ArvadosModel::UnresolvableContainerError) do
415 Container.resolve_container_image(img)
420 test "migrated docker image" do
421 Rails.configuration.docker_image_formats = ['v2']
422 add_docker19_migration_link
424 # Test that it returns only v2 images even though request is for v1 image.
426 set_user_from_auth :active
427 cr = create_minimal_req!(command: ["true", "1"],
428 container_image: collections(:docker_image).portable_data_hash)
429 assert_equal(Container.resolve_container_image(cr.container_image),
430 collections(:docker_image_1_12).portable_data_hash)
432 cr = create_minimal_req!(command: ["true", "2"],
433 container_image: links(:docker_image_collection_tag).name)
434 assert_equal(Container.resolve_container_image(cr.container_image),
435 collections(:docker_image_1_12).portable_data_hash)
438 test "use unmigrated docker image" do
439 Rails.configuration.docker_image_formats = ['v1']
440 add_docker19_migration_link
442 # Test that it returns only supported v1 images even though there is a
445 set_user_from_auth :active
446 cr = create_minimal_req!(command: ["true", "1"],
447 container_image: collections(:docker_image).portable_data_hash)
448 assert_equal(Container.resolve_container_image(cr.container_image),
449 collections(:docker_image).portable_data_hash)
451 cr = create_minimal_req!(command: ["true", "2"],
452 container_image: links(:docker_image_collection_tag).name)
453 assert_equal(Container.resolve_container_image(cr.container_image),
454 collections(:docker_image).portable_data_hash)
457 test "incompatible docker image v1" do
458 Rails.configuration.docker_image_formats = ['v1']
459 add_docker19_migration_link
461 # Don't return unsupported v2 image even if we ask for it directly.
462 set_user_from_auth :active
463 cr = create_minimal_req!(command: ["true", "1"],
464 container_image: collections(:docker_image_1_12).portable_data_hash)
465 assert_raises(ArvadosModel::UnresolvableContainerError) do
466 Container.resolve_container_image(cr.container_image)
470 test "incompatible docker image v2" do
471 Rails.configuration.docker_image_formats = ['v2']
472 # No migration link, don't return unsupported v1 image,
474 set_user_from_auth :active
475 cr = create_minimal_req!(command: ["true", "1"],
476 container_image: collections(:docker_image).portable_data_hash)
477 assert_raises(ArvadosModel::UnresolvableContainerError) do
478 Container.resolve_container_image(cr.container_image)
480 cr = create_minimal_req!(command: ["true", "2"],
481 container_image: links(:docker_image_collection_tag).name)
482 assert_raises(ArvadosModel::UnresolvableContainerError) do
483 Container.resolve_container_image(cr.container_image)
487 test "requestor can retrieve container owned by dispatch" do
488 assert_not_empty Container.readable_by(users(:admin)).where(uuid: containers(:running).uuid)
489 assert_not_empty Container.readable_by(users(:active)).where(uuid: containers(:running).uuid)
490 assert_empty Container.readable_by(users(:spectator)).where(uuid: containers(:running).uuid)
494 [{"var" => "value1"}, {"var" => "value1"}, nil],
495 [{"var" => "value1"}, {"var" => "value1"}, true],
496 [{"var" => "value1"}, {"var" => "value1"}, false],
497 [{"var" => "value1"}, {"var" => "value2"}, nil],
498 ].each do |env1, env2, use_existing|
499 test "Container request #{((env1 == env2) and (use_existing.nil? or use_existing == true)) ? 'does' : 'does not'} reuse container when committed#{use_existing.nil? ? '' : use_existing ? ' and use_existing == true' : ' and use_existing == false'}" do
500 common_attrs = {cwd: "test",
502 command: ["echo", "hello"],
504 runtime_constraints: {"vcpus" => 4,
505 "ram" => 12000000000},
506 mounts: {"test" => {"kind" => "json"}}}
507 set_user_from_auth :active
508 cr1 = create_minimal_req!(common_attrs.merge({state: ContainerRequest::Committed,
511 # Testing with use_existing default value
512 cr2 = create_minimal_req!(common_attrs.merge({state: ContainerRequest::Uncommitted,
516 cr2 = create_minimal_req!(common_attrs.merge({state: ContainerRequest::Uncommitted,
518 use_existing: use_existing}))
520 assert_not_nil cr1.container_uuid
521 assert_nil cr2.container_uuid
523 # Update cr2 to commited state and check for container equality on different cases:
524 # * When env1 and env2 are equal and use_existing is true, the same container
525 # should be assigned.
526 # * When use_existing is false, a different container should be assigned.
527 # * When env1 and env2 are different, a different container should be assigned.
528 cr2.update_attributes!({state: ContainerRequest::Committed})
529 assert_equal (cr2.use_existing == true and (env1 == env2)),
530 (cr1.container_uuid == cr2.container_uuid)
534 test "requesting_container_uuid at create is not allowed" do
535 set_user_from_auth :active
536 assert_raises(ActiveRecord::RecordNotSaved) do
537 create_minimal_req!(state: "Uncommitted", priority: 1, requesting_container_uuid: 'youcantdothat')
541 test "Retry on container cancelled" do
542 set_user_from_auth :active
543 cr = create_minimal_req!(priority: 1, state: "Committed", container_count_max: 2)
544 cr2 = create_minimal_req!(priority: 1, state: "Committed", container_count_max: 2, command: ["echo", "baz"])
545 prev_container_uuid = cr.container_uuid
547 c = act_as_system_user do
548 c = Container.find_by_uuid(cr.container_uuid)
549 c.update_attributes!(state: Container::Locked)
550 c.update_attributes!(state: Container::Running)
556 assert_equal "Committed", cr.state
557 assert_equal prev_container_uuid, cr.container_uuid
558 assert_not_equal cr2.container_uuid, cr.container_uuid
559 prev_container_uuid = cr.container_uuid
561 act_as_system_user do
562 c.update_attributes!(state: Container::Cancelled)
567 assert_equal "Committed", cr.state
568 assert_not_equal prev_container_uuid, cr.container_uuid
569 assert_not_equal cr2.container_uuid, cr.container_uuid
570 prev_container_uuid = cr.container_uuid
572 c = act_as_system_user do
573 c = Container.find_by_uuid(cr.container_uuid)
574 c.update_attributes!(state: Container::Cancelled)
580 assert_equal "Final", cr.state
581 assert_equal prev_container_uuid, cr.container_uuid
582 assert_not_equal cr2.container_uuid, cr.container_uuid
585 test "Output collection name setting using output_name with name collision resolution" do
586 set_user_from_auth :active
587 output_name = 'unimaginative name'
588 Collection.create!(name: output_name)
590 cr = create_minimal_req!(priority: 1,
591 state: ContainerRequest::Committed,
592 output_name: output_name)
595 assert_equal ContainerRequest::Final, cr.state
596 output_coll = Collection.find_by_uuid(cr.output_uuid)
597 # Make sure the resulting output collection name include the original name
599 assert_not_equal output_name, output_coll.name,
600 "more than one collection with the same owner and name"
601 assert output_coll.name.include?(output_name),
602 "New name should include original name"
603 assert_match /\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}\.\d+Z/, output_coll.name,
604 "New name should include ISO8601 date"
607 [[0, :check_output_ttl_0],
608 [1, :check_output_ttl_1s],
609 [365*86400, :check_output_ttl_1y],
610 ].each do |ttl, checker|
611 test "output_ttl=#{ttl}" do
612 act_as_user users(:active) do
613 cr = create_minimal_req!(priority: 1,
614 state: ContainerRequest::Committed,
619 output = Collection.find_by_uuid(cr.output_uuid)
620 send(checker, db_current_time, output.trash_at, output.delete_at)
625 def check_output_ttl_0(now, trash, delete)
630 def check_output_ttl_1s(now, trash, delete)
631 assert_not_nil(trash)
632 assert_not_nil(delete)
633 assert_in_delta(trash, now + 1.second, 10)
634 assert_in_delta(delete, now + Rails.configuration.blob_signature_ttl.second, 10)
637 def check_output_ttl_1y(now, trash, delete)
638 year = (86400*365).second
639 assert_not_nil(trash)
640 assert_not_nil(delete)
641 assert_in_delta(trash, now + year, 10)
642 assert_in_delta(delete, now + year, 10)
645 def run_container(cr)
646 act_as_system_user do
647 c = Container.find_by_uuid(cr.container_uuid)
648 c.update_attributes!(state: Container::Locked)
649 c.update_attributes!(state: Container::Running)
650 c.update_attributes!(state: Container::Complete,
652 output: '1f4b0bc7583c2a7f9102c395f4ffc5e3+45',
653 log: 'fa7aeb5140e2848d39b416daeef4ffc5+45')
658 test "Finalize committed request when reusing a finished container" do
659 set_user_from_auth :active
660 cr = create_minimal_req!(priority: 1, state: ContainerRequest::Committed)
662 assert_equal ContainerRequest::Committed, cr.state
665 assert_equal ContainerRequest::Final, cr.state
667 cr2 = create_minimal_req!(priority: 1, state: ContainerRequest::Committed)
668 assert_equal cr.container_uuid, cr2.container_uuid
669 assert_equal ContainerRequest::Final, cr2.state
671 cr3 = create_minimal_req!(priority: 1, state: ContainerRequest::Uncommitted)
672 assert_equal ContainerRequest::Uncommitted, cr3.state
673 cr3.update_attributes!(state: ContainerRequest::Committed)
674 assert_equal cr.container_uuid, cr3.container_uuid
675 assert_equal ContainerRequest::Final, cr3.state
679 [{"partitions" => ["fastcpu","vfastcpu", 100]}, ContainerRequest::Committed, ActiveRecord::RecordInvalid],
680 [{"partitions" => ["fastcpu","vfastcpu", 100]}, ContainerRequest::Uncommitted],
681 [{"partitions" => "fastcpu"}, ContainerRequest::Committed, ActiveRecord::RecordInvalid],
682 [{"partitions" => "fastcpu"}, ContainerRequest::Uncommitted],
683 [{"partitions" => ["fastcpu","vfastcpu"]}, ContainerRequest::Committed],
684 ].each do |sp, state, expected|
685 test "create container request with scheduling_parameters #{sp} in state #{state} and verify #{expected}" do
686 common_attrs = {cwd: "test",
688 command: ["echo", "hello"],
690 scheduling_parameters: sp,
691 mounts: {"test" => {"kind" => "json"}}}
692 set_user_from_auth :active
694 if expected == ActiveRecord::RecordInvalid
695 assert_raises(ActiveRecord::RecordInvalid) do
696 create_minimal_req!(common_attrs.merge({state: state}))
699 cr = create_minimal_req!(common_attrs.merge({state: state}))
700 assert_equal sp, cr.scheduling_parameters
702 if state == ContainerRequest::Committed
703 c = Container.find_by_uuid(cr.container_uuid)
704 assert_equal sp, c.scheduling_parameters
710 [['Committed', true, {name: "foobar", priority: 123}],
711 ['Committed', false, {container_count: 2}],
712 ['Committed', false, {container_count: 0}],
713 ['Committed', false, {container_count: nil}],
714 ['Final', false, {state: ContainerRequest::Committed, name: "foobar"}],
715 ['Final', false, {name: "foobar", priority: 123}],
716 ['Final', false, {name: "foobar", output_uuid: "zzzzz-4zz18-znfnqtbbv4spc3w"}],
717 ['Final', false, {name: "foobar", log_uuid: "zzzzz-4zz18-znfnqtbbv4spc3w"}],
718 ['Final', false, {log_uuid: "zzzzz-4zz18-znfnqtbbv4spc3w"}],
719 ['Final', false, {priority: 123}],
720 ['Final', false, {mounts: {}}],
721 ['Final', false, {container_count: 2}],
722 ['Final', true, {name: "foobar"}],
723 ['Final', true, {name: "foobar", description: "baz"}],
724 ].each do |state, permitted, updates|
725 test "state=#{state} can#{'not' if !permitted} update #{updates.inspect}" do
726 act_as_user users(:active) do
727 cr = create_minimal_req!(priority: 1,
729 container_count_max: 1)
734 act_as_system_user do
735 Container.find_by_uuid(cr.container_uuid).
736 update_attributes!(state: Container::Cancelled)
740 raise 'broken test case'
742 assert_equal state, cr.state
744 assert cr.update_attributes!(updates)
746 assert_raises(ActiveRecord::RecordInvalid) do
747 cr.update_attributes!(updates)
754 test "delete container_request and check its container's priority" do
755 act_as_user users(:active) do
756 cr = ContainerRequest.find_by_uuid container_requests(:running_to_be_deleted).uuid
758 # initially the cr's container has priority > 0
759 c = Container.find_by_uuid(cr.container_uuid)
760 assert_equal 1, c.priority
763 assert_nothing_raised {cr.destroy}
765 # the cr's container now has priority of 0
766 c = Container.find_by_uuid(cr.container_uuid)
767 assert_equal 0, c.priority
771 test "delete container_request in final state and expect no error due to before_destroy callback" do
772 act_as_user users(:active) do
773 cr = ContainerRequest.find_by_uuid container_requests(:completed).uuid
774 assert_nothing_raised {cr.destroy}