2 require 'helpers/docker_migration_helper'
4 class ContainerRequestTest < ActiveSupport::TestCase
5 include DockerMigrationHelper
8 def create_minimal_req! attrs={}
10 command: ["echo", "foo"],
11 container_image: links(:docker_image_collection_tag).name,
14 mounts: {"/out" => {"kind" => "tmp", "capacity" => 1000000}},
16 runtime_constraints: {"vcpus" => 1, "ram" => 2},
20 cr = ContainerRequest.create!(defaults.merge(attrs))
25 def check_bogus_states cr
26 [nil, "Flubber"].each do |state|
27 assert_raises(ActiveRecord::RecordInvalid) do
35 test "Container request create" do
36 set_user_from_auth :active
37 cr = create_minimal_req!
39 assert_nil cr.container_uuid
40 assert_nil cr.priority
44 # Ensure we can modify all attributes
45 cr.command = ["echo", "foo3"]
46 cr.container_image = "img3"
48 cr.environment = {"BUP" => "BOP"}
49 cr.mounts = {"BAR" => "BAZ"}
50 cr.output_path = "/tmp4"
52 cr.runtime_constraints = {"vcpus" => 4}
54 cr.description = "bar3"
57 assert_nil cr.container_uuid
62 {"vcpus" => 1, "ram" => nil},
63 {"vcpus" => 0, "ram" => 123},
64 {"vcpus" => "1", "ram" => "123"}
65 ].each do |invalid_constraints|
66 test "Create with #{invalid_constraints}" do
67 set_user_from_auth :active
68 assert_raises(ActiveRecord::RecordInvalid) do
69 cr = create_minimal_req!(state: "Committed",
71 runtime_constraints: invalid_constraints)
76 test "Update with #{invalid_constraints}" do
77 set_user_from_auth :active
78 cr = create_minimal_req!(state: "Uncommitted", priority: 1)
80 assert_raises(ActiveRecord::RecordInvalid) do
81 cr = ContainerRequest.find_by_uuid cr.uuid
82 cr.update_attributes!(state: "Committed",
83 runtime_constraints: invalid_constraints)
88 test "Update from fixture" do
89 set_user_from_auth :active
90 cr = ContainerRequest.find_by_uuid(container_requests(:running).uuid)
91 cr.update_attributes!(description: "New description")
92 assert_equal "New description", cr.description
95 test "Update with valid runtime constraints" do
96 set_user_from_auth :active
97 cr = create_minimal_req!(state: "Uncommitted", priority: 1)
99 cr = ContainerRequest.find_by_uuid cr.uuid
100 cr.update_attributes!(state: "Committed",
101 runtime_constraints: {"vcpus" => 1, "ram" => 23})
102 assert_not_nil cr.container_uuid
105 test "Container request priority must be non-nil" do
106 set_user_from_auth :active
107 cr = create_minimal_req!(priority: nil)
108 cr.state = "Committed"
109 assert_raises(ActiveRecord::RecordInvalid) do
114 test "Container request commit" do
115 set_user_from_auth :active
116 cr = create_minimal_req!(runtime_constraints: {"vcpus" => 2, "ram" => 30})
118 assert_nil cr.container_uuid
121 cr.state = "Committed"
127 assert_equal({"vcpus" => 2, "ram" => 30}, cr.runtime_constraints)
129 assert_not_nil cr.container_uuid
130 c = Container.find_by_uuid cr.container_uuid
132 assert_equal ["echo", "foo"], c.command
133 assert_equal collections(:docker_image).portable_data_hash, c.container_image
134 assert_equal "/tmp", c.cwd
135 assert_equal({}, c.environment)
136 assert_equal({"/out" => {"kind"=>"tmp", "capacity"=>1000000}}, c.mounts)
137 assert_equal "/out", c.output_path
138 assert_equal({"keep_cache_ram"=>268435456, "vcpus" => 2, "ram" => 30}, c.runtime_constraints)
139 assert_equal 1, c.priority
141 assert_raises(ActiveRecord::RecordInvalid) do
151 assert_equal 0, cr.priority
152 assert_equal 0, c.priority
156 test "Container request max priority" do
157 set_user_from_auth :active
158 cr = create_minimal_req!(priority: 5, state: "Committed")
160 c = Container.find_by_uuid cr.container_uuid
161 assert_equal 5, c.priority
163 cr2 = create_minimal_req!
165 cr2.state = "Committed"
166 cr2.container_uuid = cr.container_uuid
167 act_as_system_user do
171 # cr and cr2 have priority 5 and 10, and are being satisfied by
172 # the same container c, so c's priority should be
175 assert_equal 10, c.priority
177 cr2.update_attributes!(priority: 0)
180 assert_equal 5, c.priority
182 cr.update_attributes!(priority: 0)
185 assert_equal 0, c.priority
189 test "Independent container requests" do
190 set_user_from_auth :active
191 cr1 = create_minimal_req!(command: ["foo", "1"], priority: 5, state: "Committed")
192 cr2 = create_minimal_req!(command: ["foo", "2"], priority: 10, state: "Committed")
194 c1 = Container.find_by_uuid cr1.container_uuid
195 assert_equal 5, c1.priority
197 c2 = Container.find_by_uuid cr2.container_uuid
198 assert_equal 10, c2.priority
200 cr1.update_attributes!(priority: 0)
203 assert_equal 0, c1.priority
206 assert_equal 10, c2.priority
209 test "Request is finalized when its container is cancelled" do
210 set_user_from_auth :active
211 cr = create_minimal_req!(priority: 1, state: "Committed", container_count_max: 1)
213 act_as_system_user do
214 Container.find_by_uuid(cr.container_uuid).
215 update_attributes!(state: Container::Cancelled)
219 assert_equal "Final", cr.state
222 test "Request is finalized when its container is completed" do
223 set_user_from_auth :active
224 project = groups(:private)
225 cr = create_minimal_req!(owner_uuid: project.uuid,
229 c = act_as_system_user do
230 c = Container.find_by_uuid(cr.container_uuid)
231 c.update_attributes!(state: Container::Locked)
232 c.update_attributes!(state: Container::Running)
237 assert_equal "Committed", cr.state
239 output_pdh = '1f4b0bc7583c2a7f9102c395f4ffc5e3+45'
240 log_pdh = 'fa7aeb5140e2848d39b416daeef4ffc5+45'
241 act_as_system_user do
242 c.update_attributes!(state: Container::Complete,
248 assert_equal "Final", cr.state
249 ['output', 'log'].each do |out_type|
250 pdh = Container.find_by_uuid(cr.container_uuid).send(out_type)
251 assert_equal(1, Collection.where(portable_data_hash: pdh,
252 owner_uuid: project.uuid).count,
253 "Container #{out_type} should be copied to #{project.uuid}")
255 assert_not_nil cr.output_uuid
256 assert_not_nil cr.log_uuid
257 output = Collection.find_by_uuid cr.output_uuid
258 assert_equal output_pdh, output.portable_data_hash
259 log = Collection.find_by_uuid cr.log_uuid
260 assert_equal log_pdh, log.portable_data_hash
263 test "Container makes container request, then is cancelled" do
264 set_user_from_auth :active
265 cr = create_minimal_req!(priority: 5, state: "Committed", container_count_max: 1)
267 c = Container.find_by_uuid cr.container_uuid
268 assert_equal 5, c.priority
270 cr2 = create_minimal_req!
271 cr2.update_attributes!(priority: 10, state: "Committed", requesting_container_uuid: c.uuid, command: ["echo", "foo2"], container_count_max: 1)
274 c2 = Container.find_by_uuid cr2.container_uuid
275 assert_equal 10, c2.priority
277 act_as_system_user do
278 c.state = "Cancelled"
283 assert_equal "Final", cr.state
286 assert_equal 0, cr2.priority
289 assert_equal 0, c2.priority
293 ['running_container_auth', 'zzzzz-dz642-runningcontainr'],
294 ['active_no_prefs', nil],
295 ].each do |token, expected|
296 test "create as #{token} and expect requesting_container_uuid to be #{expected}" do
297 set_user_from_auth token
298 cr = ContainerRequest.create(container_image: "img", output_path: "/tmp", command: ["echo", "foo"])
299 assert_not_nil cr.uuid, 'uuid should be set for newly created container_request'
300 assert_equal expected, cr.requesting_container_uuid
304 [[{"vcpus" => [2, nil]},
305 lambda { |resolved| resolved["vcpus"] == 2 }],
306 [{"vcpus" => [3, 7]},
307 lambda { |resolved| resolved["vcpus"] == 3 }],
309 lambda { |resolved| resolved["vcpus"] == 4 }],
310 [{"ram" => [1000000000, 2000000000]},
311 lambda { |resolved| resolved["ram"] == 1000000000 }],
312 [{"ram" => [1234234234]},
313 lambda { |resolved| resolved["ram"] == 1234234234 }],
314 ].each do |rc, okfunc|
315 test "resolve runtime constraint range #{rc} to values" do
316 resolved = Container.resolve_runtime_constraints(rc)
317 assert(okfunc.call(resolved),
318 "container runtime_constraints was #{resolved.inspect}")
323 "kind" => "collection",
324 "uuid" => "zzzzz-4zz18-znfnqtbbv4spc3w",
327 resolved["/out"] == {
328 "portable_data_hash" => "1f4b0bc7583c2a7f9102c395f4ffc5e3+45",
329 "kind" => "collection",
334 "kind" => "collection",
335 "uuid" => "zzzzz-4zz18-znfnqtbbv4spc3w",
336 "portable_data_hash" => "1f4b0bc7583c2a7f9102c395f4ffc5e3+45",
339 resolved["/out"] == {
340 "portable_data_hash" => "1f4b0bc7583c2a7f9102c395f4ffc5e3+45",
341 "kind" => "collection",
345 ].each do |mounts, okfunc|
346 test "resolve mounts #{mounts.inspect} to values" do
347 set_user_from_auth :active
348 resolved = Container.resolve_mounts(mounts)
349 assert(okfunc.call(resolved),
350 "Container.resolve_mounts returned #{resolved.inspect}")
354 test 'mount unreadable collection' do
355 set_user_from_auth :spectator
358 "kind" => "collection",
359 "uuid" => "zzzzz-4zz18-znfnqtbbv4spc3w",
363 assert_raises(ArvadosModel::UnresolvableContainerError) do
364 Container.resolve_mounts(m)
368 test 'mount collection with mismatched UUID and PDH' do
369 set_user_from_auth :active
372 "kind" => "collection",
373 "uuid" => "zzzzz-4zz18-znfnqtbbv4spc3w",
374 "portable_data_hash" => "fa7aeb5140e2848d39b416daeef4ffc5+45",
378 assert_raises(ArgumentError) do
379 Container.resolve_mounts(m)
383 ['arvados/apitestfixture:latest',
384 'arvados/apitestfixture',
385 'd8309758b8fe2c81034ffc8a10c36460b77db7bc5e7b448c4e5b684f9d95a678',
387 test "Container.resolve_container_image(#{tag.inspect})" do
388 set_user_from_auth :active
389 resolved = Container.resolve_container_image(tag)
390 assert_equal resolved, collections(:docker_image).portable_data_hash
394 test "Container.resolve_container_image(pdh)" do
395 set_user_from_auth :active
396 [[:docker_image, 'v1'], [:docker_image_1_12, 'v2']].each do |coll, ver|
397 Rails.configuration.docker_image_formats = [ver]
398 pdh = collections(coll).portable_data_hash
399 resolved = Container.resolve_container_image(pdh)
400 assert_equal resolved, pdh
404 ['acbd18db4cc2f85cedef654fccc4a4d8+3',
406 'arvados/apitestfixture:ENOEXIST',
408 test "container_image_for_container(#{img.inspect}) => 422" do
409 set_user_from_auth :active
410 assert_raises(ArvadosModel::UnresolvableContainerError) do
411 Container.resolve_container_image(img)
416 test "migrated docker image" do
417 Rails.configuration.docker_image_formats = ['v2']
418 add_docker19_migration_link
420 # Test that it returns only v2 images even though request is for v1 image.
422 set_user_from_auth :active
423 cr = create_minimal_req!(command: ["true", "1"],
424 container_image: collections(:docker_image).portable_data_hash)
425 assert_equal(Container.resolve_container_image(cr.container_image),
426 collections(:docker_image_1_12).portable_data_hash)
428 cr = create_minimal_req!(command: ["true", "2"],
429 container_image: links(:docker_image_collection_tag).name)
430 assert_equal(Container.resolve_container_image(cr.container_image),
431 collections(:docker_image_1_12).portable_data_hash)
434 test "use unmigrated docker image" do
435 Rails.configuration.docker_image_formats = ['v1']
436 add_docker19_migration_link
438 # Test that it returns only supported v1 images even though there is a
441 set_user_from_auth :active
442 cr = create_minimal_req!(command: ["true", "1"],
443 container_image: collections(:docker_image).portable_data_hash)
444 assert_equal(Container.resolve_container_image(cr.container_image),
445 collections(:docker_image).portable_data_hash)
447 cr = create_minimal_req!(command: ["true", "2"],
448 container_image: links(:docker_image_collection_tag).name)
449 assert_equal(Container.resolve_container_image(cr.container_image),
450 collections(:docker_image).portable_data_hash)
453 test "incompatible docker image v1" do
454 Rails.configuration.docker_image_formats = ['v1']
455 add_docker19_migration_link
457 # Don't return unsupported v2 image even if we ask for it directly.
458 set_user_from_auth :active
459 cr = create_minimal_req!(command: ["true", "1"],
460 container_image: collections(:docker_image_1_12).portable_data_hash)
461 assert_raises(ArvadosModel::UnresolvableContainerError) do
462 Container.resolve_container_image(cr.container_image)
466 test "incompatible docker image v2" do
467 Rails.configuration.docker_image_formats = ['v2']
468 # No migration link, don't return unsupported v1 image,
470 set_user_from_auth :active
471 cr = create_minimal_req!(command: ["true", "1"],
472 container_image: collections(:docker_image).portable_data_hash)
473 assert_raises(ArvadosModel::UnresolvableContainerError) do
474 Container.resolve_container_image(cr.container_image)
476 cr = create_minimal_req!(command: ["true", "2"],
477 container_image: links(:docker_image_collection_tag).name)
478 assert_raises(ArvadosModel::UnresolvableContainerError) do
479 Container.resolve_container_image(cr.container_image)
483 test "requestor can retrieve container owned by dispatch" do
484 assert_not_empty Container.readable_by(users(:admin)).where(uuid: containers(:running).uuid)
485 assert_not_empty Container.readable_by(users(:active)).where(uuid: containers(:running).uuid)
486 assert_empty Container.readable_by(users(:spectator)).where(uuid: containers(:running).uuid)
490 [{"var" => "value1"}, {"var" => "value1"}, nil],
491 [{"var" => "value1"}, {"var" => "value1"}, true],
492 [{"var" => "value1"}, {"var" => "value1"}, false],
493 [{"var" => "value1"}, {"var" => "value2"}, nil],
494 ].each do |env1, env2, use_existing|
495 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
496 common_attrs = {cwd: "test",
498 command: ["echo", "hello"],
500 runtime_constraints: {"vcpus" => 4,
501 "ram" => 12000000000},
502 mounts: {"test" => {"kind" => "json"}}}
503 set_user_from_auth :active
504 cr1 = create_minimal_req!(common_attrs.merge({state: ContainerRequest::Committed,
507 # Testing with use_existing default value
508 cr2 = create_minimal_req!(common_attrs.merge({state: ContainerRequest::Uncommitted,
512 cr2 = create_minimal_req!(common_attrs.merge({state: ContainerRequest::Uncommitted,
514 use_existing: use_existing}))
516 assert_not_nil cr1.container_uuid
517 assert_nil cr2.container_uuid
519 # Update cr2 to commited state and check for container equality on different cases:
520 # * When env1 and env2 are equal and use_existing is true, the same container
521 # should be assigned.
522 # * When use_existing is false, a different container should be assigned.
523 # * When env1 and env2 are different, a different container should be assigned.
524 cr2.update_attributes!({state: ContainerRequest::Committed})
525 assert_equal (cr2.use_existing == true and (env1 == env2)),
526 (cr1.container_uuid == cr2.container_uuid)
530 test "requesting_container_uuid at create is not allowed" do
531 set_user_from_auth :active
532 assert_raises(ActiveRecord::RecordNotSaved) do
533 create_minimal_req!(state: "Uncommitted", priority: 1, requesting_container_uuid: 'youcantdothat')
537 test "Retry on container cancelled" do
538 set_user_from_auth :active
539 cr = create_minimal_req!(priority: 1, state: "Committed", container_count_max: 2)
540 cr2 = create_minimal_req!(priority: 1, state: "Committed", container_count_max: 2, command: ["echo", "baz"])
541 prev_container_uuid = cr.container_uuid
543 c = act_as_system_user do
544 c = Container.find_by_uuid(cr.container_uuid)
545 c.update_attributes!(state: Container::Locked)
546 c.update_attributes!(state: Container::Running)
552 assert_equal "Committed", cr.state
553 assert_equal prev_container_uuid, cr.container_uuid
554 assert_not_equal cr2.container_uuid, cr.container_uuid
555 prev_container_uuid = cr.container_uuid
557 act_as_system_user do
558 c.update_attributes!(state: Container::Cancelled)
563 assert_equal "Committed", cr.state
564 assert_not_equal prev_container_uuid, cr.container_uuid
565 assert_not_equal cr2.container_uuid, cr.container_uuid
566 prev_container_uuid = cr.container_uuid
568 c = act_as_system_user do
569 c = Container.find_by_uuid(cr.container_uuid)
570 c.update_attributes!(state: Container::Cancelled)
576 assert_equal "Final", cr.state
577 assert_equal prev_container_uuid, cr.container_uuid
578 assert_not_equal cr2.container_uuid, cr.container_uuid
581 test "Output collection name setting using output_name with name collision resolution" do
582 set_user_from_auth :active
583 output_name = 'unimaginative name'
584 Collection.create!(name: output_name)
586 cr = create_minimal_req!(priority: 1,
587 state: ContainerRequest::Committed,
588 output_name: output_name)
591 assert_equal ContainerRequest::Final, cr.state
592 output_coll = Collection.find_by_uuid(cr.output_uuid)
593 # Make sure the resulting output collection name include the original name
595 assert_not_equal output_name, output_coll.name,
596 "more than one collection with the same owner and name"
597 assert output_coll.name.include?(output_name),
598 "New name should include original name"
599 assert_match /\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}\.\d+Z/, output_coll.name,
600 "New name should include ISO8601 date"
603 [[0, :check_output_ttl_0],
604 [1, :check_output_ttl_1s],
605 [365*86400, :check_output_ttl_1y],
606 ].each do |ttl, checker|
607 test "output_ttl=#{ttl}" do
608 act_as_user users(:active) do
609 cr = create_minimal_req!(priority: 1,
610 state: ContainerRequest::Committed,
615 output = Collection.find_by_uuid(cr.output_uuid)
616 send(checker, db_current_time, output.trash_at, output.delete_at)
621 def check_output_ttl_0(now, trash, delete)
626 def check_output_ttl_1s(now, trash, delete)
627 assert_not_nil(trash)
628 assert_not_nil(delete)
629 assert_in_delta(trash, now + 1.second, 10)
630 assert_in_delta(delete, now + Rails.configuration.blob_signature_ttl.second, 10)
633 def check_output_ttl_1y(now, trash, delete)
634 year = (86400*365).second
635 assert_not_nil(trash)
636 assert_not_nil(delete)
637 assert_in_delta(trash, now + year, 10)
638 assert_in_delta(delete, now + year, 10)
641 def run_container(cr)
642 act_as_system_user do
643 c = Container.find_by_uuid(cr.container_uuid)
644 c.update_attributes!(state: Container::Locked)
645 c.update_attributes!(state: Container::Running)
646 c.update_attributes!(state: Container::Complete,
648 output: '1f4b0bc7583c2a7f9102c395f4ffc5e3+45',
649 log: 'fa7aeb5140e2848d39b416daeef4ffc5+45')
654 test "Finalize committed request when reusing a finished container" do
655 set_user_from_auth :active
656 cr = create_minimal_req!(priority: 1, state: ContainerRequest::Committed)
658 assert_equal ContainerRequest::Committed, cr.state
661 assert_equal ContainerRequest::Final, cr.state
663 cr2 = create_minimal_req!(priority: 1, state: ContainerRequest::Committed)
664 assert_equal cr.container_uuid, cr2.container_uuid
665 assert_equal ContainerRequest::Final, cr2.state
667 cr3 = create_minimal_req!(priority: 1, state: ContainerRequest::Uncommitted)
668 assert_equal ContainerRequest::Uncommitted, cr3.state
669 cr3.update_attributes!(state: ContainerRequest::Committed)
670 assert_equal cr.container_uuid, cr3.container_uuid
671 assert_equal ContainerRequest::Final, cr3.state
675 [{"partitions" => ["fastcpu","vfastcpu", 100]}, ContainerRequest::Committed, ActiveRecord::RecordInvalid],
676 [{"partitions" => ["fastcpu","vfastcpu", 100]}, ContainerRequest::Uncommitted],
677 [{"partitions" => "fastcpu"}, ContainerRequest::Committed, ActiveRecord::RecordInvalid],
678 [{"partitions" => "fastcpu"}, ContainerRequest::Uncommitted],
679 [{"partitions" => ["fastcpu","vfastcpu"]}, ContainerRequest::Committed],
680 ].each do |sp, state, expected|
681 test "create container request with scheduling_parameters #{sp} in state #{state} and verify #{expected}" do
682 common_attrs = {cwd: "test",
684 command: ["echo", "hello"],
686 scheduling_parameters: sp,
687 mounts: {"test" => {"kind" => "json"}}}
688 set_user_from_auth :active
690 if expected == ActiveRecord::RecordInvalid
691 assert_raises(ActiveRecord::RecordInvalid) do
692 create_minimal_req!(common_attrs.merge({state: state}))
695 cr = create_minimal_req!(common_attrs.merge({state: state}))
696 assert_equal sp, cr.scheduling_parameters
698 if state == ContainerRequest::Committed
699 c = Container.find_by_uuid(cr.container_uuid)
700 assert_equal sp, c.scheduling_parameters
706 [['Committed', true, {name: "foobar", priority: 123}],
707 ['Committed', false, {container_count: 2}],
708 ['Committed', false, {container_count: 0}],
709 ['Committed', false, {container_count: nil}],
710 ['Final', false, {state: ContainerRequest::Committed, name: "foobar"}],
711 ['Final', false, {name: "foobar", priority: 123}],
712 ['Final', false, {name: "foobar", output_uuid: "zzzzz-4zz18-znfnqtbbv4spc3w"}],
713 ['Final', false, {name: "foobar", log_uuid: "zzzzz-4zz18-znfnqtbbv4spc3w"}],
714 ['Final', false, {log_uuid: "zzzzz-4zz18-znfnqtbbv4spc3w"}],
715 ['Final', false, {priority: 123}],
716 ['Final', false, {mounts: {}}],
717 ['Final', false, {container_count: 2}],
718 ['Final', true, {name: "foobar"}],
719 ['Final', true, {name: "foobar", description: "baz"}],
720 ].each do |state, permitted, updates|
721 test "state=#{state} can#{'not' if !permitted} update #{updates.inspect}" do
722 act_as_user users(:active) do
723 cr = create_minimal_req!(priority: 1,
725 container_count_max: 1)
730 act_as_system_user do
731 Container.find_by_uuid(cr.container_uuid).
732 update_attributes!(state: Container::Cancelled)
736 raise 'broken test case'
738 assert_equal state, cr.state
740 assert cr.update_attributes!(updates)
742 assert_raises(ActiveRecord::RecordInvalid) do
743 cr.update_attributes!(updates)