services/api/test/unit/container_request_test.rb

   1 # Copyright (C) The Arvados Authors. All rights reserved.
   2 #
   3 # SPDX-License-Identifier: AGPL-3.0
   4
   5 require 'test_helper'
   6 require 'helpers/container_test_helper'
   7 require 'helpers/docker_migration_helper'
   8
   9 class ContainerRequestTest < ActiveSupport::TestCase
  10   include DockerMigrationHelper
  11   include DbCurrentTime
  12   include ContainerTestHelper
  13
  14   def with_container_auth(ctr)
  15     auth_was = Thread.current[:api_client_authorization]
  16     Thread.current[:api_client_authorization] = ApiClientAuthorization.find_by_uuid(ctr.auth_uuid)
  17     begin
  18       yield
  19     ensure
  20       Thread.current[:api_client_authorization] = auth_was
  21     end
  22   end
  23
  24   def lock_and_run(ctr)
  25       act_as_system_user do
  26         ctr.update_attributes!(state: Container::Locked)
  27         ctr.update_attributes!(state: Container::Running)
  28       end
  29   end
  30
  31   def create_minimal_req! attrs={}
  32     defaults = {
  33       command: ["echo", "foo"],
  34       container_image: links(:docker_image_collection_tag).name,
  35       cwd: "/tmp",
  36       environment: {},
  37       mounts: {"/out" => {"kind" => "tmp", "capacity" => 1000000}},
  38       output_path: "/out",
  39       runtime_constraints: {"vcpus" => 1, "ram" => 2},
  40       name: "foo",
  41       description: "bar",
  42     }
  43     cr = ContainerRequest.create!(defaults.merge(attrs))
  44     cr.reload
  45     return cr
  46   end
  47
  48   def check_bogus_states cr
  49     [nil, "Flubber"].each do |state|
  50       assert_raises(ActiveRecord::RecordInvalid) do
  51         cr.state = state
  52         cr.save!
  53       end
  54       cr.reload
  55     end
  56   end
  57
  58   test "Container request create" do
  59     set_user_from_auth :active
  60     cr = create_minimal_req!
  61
  62     assert_nil cr.container_uuid
  63     assert_equal 0, cr.priority
  64
  65     check_bogus_states cr
  66
  67     # Ensure we can modify all attributes
  68     cr.command = ["echo", "foo3"]
  69     cr.container_image = "img3"
  70     cr.cwd = "/tmp3"
  71     cr.environment = {"BUP" => "BOP"}
  72     cr.mounts = {"BAR" => {"kind" => "BAZ"}}
  73     cr.output_path = "/tmp4"
  74     cr.priority = 2
  75     cr.runtime_constraints = {"vcpus" => 4}
  76     cr.name = "foo3"
  77     cr.description = "bar3"
  78     cr.save!
  79
  80     assert_nil cr.container_uuid
  81   end
  82
  83   [
  84     {"runtime_constraints" => {"vcpus" => 1}},
  85     {"runtime_constraints" => {"vcpus" => 1, "ram" => nil}},
  86     {"runtime_constraints" => {"vcpus" => 0, "ram" => 123}},
  87     {"runtime_constraints" => {"vcpus" => "1", "ram" => "123"}},
  88     {"mounts" => {"FOO" => "BAR"}},
  89     {"mounts" => {"FOO" => {}}},
  90     {"mounts" => {"FOO" => {"kind" => "tmp", "capacity" => 42.222}}},
  91     {"command" => ["echo", 55]},
  92     {"environment" => {"FOO" => 55}}
  93   ].each do |value|
  94     test "Create with invalid #{value}" do
  95       set_user_from_auth :active
  96       assert_raises(ActiveRecord::RecordInvalid) do
  97         cr = create_minimal_req!({state: "Committed",
  98                priority: 1}.merge(value))
  99         cr.save!
 100       end
 101     end
 102
 103     test "Update with invalid #{value}" do
 104       set_user_from_auth :active
 105       cr = create_minimal_req!(state: "Uncommitted", priority: 1)
 106       cr.save!
 107       assert_raises(ActiveRecord::RecordInvalid) do
 108         cr = ContainerRequest.find_by_uuid cr.uuid
 109         cr.update_attributes!({state: "Committed",
 110                                priority: 1}.merge(value))
 111       end
 112     end
 113   end
 114
 115   test "Update from fixture" do
 116     set_user_from_auth :active
 117     cr = ContainerRequest.find_by_uuid(container_requests(:running).uuid)
 118     cr.update_attributes!(description: "New description")
 119     assert_equal "New description", cr.description
 120   end
 121
 122   test "Update with valid runtime constraints" do
 123       set_user_from_auth :active
 124       cr = create_minimal_req!(state: "Uncommitted", priority: 1)
 125       cr.save!
 126       cr = ContainerRequest.find_by_uuid cr.uuid
 127       cr.update_attributes!(state: "Committed",
 128                             runtime_constraints: {"vcpus" => 1, "ram" => 23})
 129       assert_not_nil cr.container_uuid
 130   end
 131
 132   test "Container request priority must be non-nil" do
 133     set_user_from_auth :active
 134     cr = create_minimal_req!
 135     cr.priority = nil
 136     cr.state = "Committed"
 137     assert_raises(ActiveRecord::RecordInvalid) do
 138       cr.save!
 139     end
 140   end
 141
 142   test "Container request commit" do
 143     set_user_from_auth :active
 144     cr = create_minimal_req!(runtime_constraints: {"vcpus" => 2, "ram" => 30})
 145
 146     assert_nil cr.container_uuid
 147
 148     cr.reload
 149     cr.state = "Committed"
 150     cr.priority = 1
 151     cr.save!
 152
 153     cr.reload
 154
 155     assert_equal({"vcpus" => 2, "ram" => 30}, cr.runtime_constraints)
 156
 157     assert_not_nil cr.container_uuid
 158     c = Container.find_by_uuid cr.container_uuid
 159     assert_not_nil c
 160     assert_equal ["echo", "foo"], c.command
 161     assert_equal collections(:docker_image).portable_data_hash, c.container_image
 162     assert_equal "/tmp", c.cwd
 163     assert_equal({}, c.environment)
 164     assert_equal({"/out" => {"kind"=>"tmp", "capacity"=>1000000}}, c.mounts)
 165     assert_equal "/out", c.output_path
 166     assert_equal({"keep_cache_ram"=>268435456, "vcpus" => 2, "ram" => 30}, c.runtime_constraints)
 167     assert_operator 0, :<, c.priority
 168
 169     assert_raises(ActiveRecord::RecordInvalid) do
 170       cr.priority = nil
 171       cr.save!
 172     end
 173
 174     cr.priority = 0
 175     cr.save!
 176
 177     cr.reload
 178     c.reload
 179     assert_equal 0, cr.priority
 180     assert_equal 0, c.priority
 181   end
 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_operator 0, :<, c1.priority
 190
 191     c2 = Container.find_by_uuid cr2.container_uuid
 192     assert_operator c1.priority, :<, c2.priority
 193     c2priority_was = c2.priority
 194
 195     cr1.update_attributes!(priority: 0)
 196
 197     c1.reload
 198     assert_equal 0, c1.priority
 199
 200     c2.reload
 201     assert_equal c2priority_was, c2.priority
 202   end
 203
 204   test "Request is finalized when its container is cancelled" do
 205     set_user_from_auth :active
 206     cr = create_minimal_req!(priority: 1, state: "Committed", container_count_max: 1)
 207     assert_equal users(:active).uuid, cr.modified_by_user_uuid
 208
 209     act_as_system_user do
 210       Container.find_by_uuid(cr.container_uuid).
 211         update_attributes!(state: Container::Cancelled)
 212     end
 213
 214     cr.reload
 215     assert_equal "Final", cr.state
 216     assert_equal users(:active).uuid, cr.modified_by_user_uuid
 217   end
 218
 219   test "Request is finalized when its container is completed" do
 220     set_user_from_auth :active
 221     project = groups(:private)
 222     cr = create_minimal_req!(owner_uuid: project.uuid,
 223                              priority: 1,
 224                              state: "Committed")
 225     assert_equal users(:active).uuid, cr.modified_by_user_uuid
 226
 227     c = act_as_system_user do
 228       c = Container.find_by_uuid(cr.container_uuid)
 229       c.update_attributes!(state: Container::Locked)
 230       c.update_attributes!(state: Container::Running)
 231       c
 232     end
 233
 234     cr.reload
 235     assert_equal "Committed", cr.state
 236
 237     output_pdh = '1f4b0bc7583c2a7f9102c395f4ffc5e3+45'
 238     log_pdh = 'fa7aeb5140e2848d39b416daeef4ffc5+45'
 239     act_as_system_user do
 240       c.update_attributes!(state: Container::Complete,
 241                            output: output_pdh,
 242                            log: log_pdh)
 243     end
 244
 245     cr.reload
 246     assert_equal "Final", cr.state
 247     assert_equal users(:active).uuid, cr.modified_by_user_uuid
 248     ['output', 'log'].each do |out_type|
 249       pdh = Container.find_by_uuid(cr.container_uuid).send(out_type)
 250       assert_equal(1, Collection.where(portable_data_hash: pdh,
 251                                        owner_uuid: project.uuid).count,
 252                    "Container #{out_type} should be copied to #{project.uuid}")
 253     end
 254     assert_not_nil cr.output_uuid
 255     assert_not_nil cr.log_uuid
 256     output = Collection.find_by_uuid cr.output_uuid
 257     assert_equal output_pdh, output.portable_data_hash
 258     log = Collection.find_by_uuid cr.log_uuid
 259     assert_equal log_pdh, log.portable_data_hash
 260   end
 261
 262   test "Container makes container request, then is cancelled" do
 263     set_user_from_auth :active
 264     cr = create_minimal_req!(priority: 5, state: "Committed", container_count_max: 1)
 265
 266     c = Container.find_by_uuid cr.container_uuid
 267     assert_operator 0, :<, c.priority
 268     lock_and_run(c)
 269
 270     cr2 = with_container_auth(c) do
 271       create_minimal_req!(priority: 10, state: "Committed", container_count_max: 1, command: ["echo", "foo2"])
 272     end
 273     assert_not_nil cr2.requesting_container_uuid
 274     assert_equal users(:active).uuid, cr2.modified_by_user_uuid
 275
 276     c2 = Container.find_by_uuid cr2.container_uuid
 277     assert_operator 0, :<, c2.priority
 278
 279     act_as_system_user do
 280       c.state = "Cancelled"
 281       c.save!
 282     end
 283
 284     cr.reload
 285     assert_equal "Final", cr.state
 286
 287     cr2.reload
 288     assert_equal 0, cr2.priority
 289     assert_equal users(:active).uuid, cr2.modified_by_user_uuid
 290
 291     c2.reload
 292     assert_equal 0, c2.priority
 293   end
 294
 295   test "child container priority follows same ordering as corresponding top-level ancestors" do
 296     findctr = lambda { |cr| Container.find_by_uuid(cr.container_uuid) }
 297
 298     set_user_from_auth :active
 299
 300     toplevel_crs = [
 301       create_minimal_req!(priority: 5, state: "Committed", environment: {"workflow" => "0"}),
 302       create_minimal_req!(priority: 5, state: "Committed", environment: {"workflow" => "1"}),
 303       create_minimal_req!(priority: 5, state: "Committed", environment: {"workflow" => "2"}),
 304     ]
 305     parents = toplevel_crs.map(&findctr)
 306
 307     children = parents.map do |parent|
 308       lock_and_run(parent)
 309       with_container_auth(parent) do
 310         create_minimal_req!(state: "Committed",
 311                             priority: 1,
 312                             environment: {"child" => parent.environment["workflow"]})
 313       end
 314     end.map(&findctr)
 315
 316     grandchildren = children.reverse.map do |child|
 317       lock_and_run(child)
 318       with_container_auth(child) do
 319         create_minimal_req!(state: "Committed",
 320                             priority: 1,
 321                             environment: {"grandchild" => child.environment["child"]})
 322       end
 323     end.reverse.map(&findctr)
 324
 325     shared_grandchildren = children.map do |child|
 326       with_container_auth(child) do
 327         create_minimal_req!(state: "Committed",
 328                             priority: 1,
 329                             environment: {"grandchild" => "shared"})
 330       end
 331     end.map(&findctr)
 332
 333     assert_equal shared_grandchildren[0].uuid, shared_grandchildren[1].uuid
 334     assert_equal shared_grandchildren[0].uuid, shared_grandchildren[2].uuid
 335     shared_grandchild = shared_grandchildren[0]
 336
 337     set_user_from_auth :active
 338
 339     # parents should be prioritized by submit time.
 340     assert_operator parents[0].priority, :>, parents[1].priority
 341     assert_operator parents[1].priority, :>, parents[2].priority
 342
 343     # children should be prioritized in same order as their respective
 344     # parents.
 345     assert_operator children[0].priority, :>, children[1].priority
 346     assert_operator children[1].priority, :>, children[2].priority
 347
 348     # grandchildren should also be prioritized in the same order,
 349     # despite having been submitted in the opposite order.
 350     assert_operator grandchildren[0].priority, :>, grandchildren[1].priority
 351     assert_operator grandchildren[1].priority, :>, grandchildren[2].priority
 352
 353     # shared grandchild container should be prioritized above
 354     # everything that isn't needed by parents[0], but not above
 355     # earlier-submitted descendants of parents[0]
 356     assert_operator shared_grandchild.priority, :>, grandchildren[1].priority
 357     assert_operator shared_grandchild.priority, :>, children[1].priority
 358     assert_operator shared_grandchild.priority, :>, parents[1].priority
 359     assert_operator shared_grandchild.priority, :<=, grandchildren[0].priority
 360     assert_operator shared_grandchild.priority, :<=, children[0].priority
 361     assert_operator shared_grandchild.priority, :<=, parents[0].priority
 362
 363     # increasing priority of the most recent toplevel container should
 364     # reprioritize all of its descendants (including the shared
 365     # grandchild) above everything else.
 366     toplevel_crs[2].update_attributes!(priority: 72)
 367     (parents + children + grandchildren + [shared_grandchild]).map(&:reload)
 368     assert_operator shared_grandchild.priority, :>, grandchildren[0].priority
 369     assert_operator shared_grandchild.priority, :>, children[0].priority
 370     assert_operator shared_grandchild.priority, :>, parents[0].priority
 371     assert_operator shared_grandchild.priority, :>, grandchildren[1].priority
 372     assert_operator shared_grandchild.priority, :>, children[1].priority
 373     assert_operator shared_grandchild.priority, :>, parents[1].priority
 374     # ...but the shared container should not have higher priority than
 375     # the earlier-submitted descendants of the high-priority workflow.
 376     assert_operator shared_grandchild.priority, :<=, grandchildren[2].priority
 377     assert_operator shared_grandchild.priority, :<=, children[2].priority
 378     assert_operator shared_grandchild.priority, :<=, parents[2].priority
 379   end
 380
 381   [
 382     ['running_container_auth', 'zzzzz-dz642-runningcontainr', 501],
 383     ['active_no_prefs', nil, 0]
 384   ].each do |token, expected, expected_priority|
 385     test "create as #{token} and expect requesting_container_uuid to be #{expected}" do
 386       set_user_from_auth token
 387       cr = ContainerRequest.create(container_image: "img", output_path: "/tmp", command: ["echo", "foo"])
 388       assert_not_nil cr.uuid, 'uuid should be set for newly created container_request'
 389       assert_equal expected, cr.requesting_container_uuid
 390       assert_equal expected_priority, cr.priority
 391     end
 392   end
 393
 394   test "create as container_runtime_token and expect requesting_container_uuid to be zzzzz-dz642-20isqbkl8xwnsao" do
 395     set_user_from_auth :container_runtime_token
 396     Thread.current[:token] = "#{Thread.current[:token]}/zzzzz-dz642-20isqbkl8xwnsao"
 397     cr = ContainerRequest.create(container_image: "img", output_path: "/tmp", command: ["echo", "foo"])
 398     assert_not_nil cr.uuid, 'uuid should be set for newly created container_request'
 399     assert_equal 'zzzzz-dz642-20isqbkl8xwnsao', cr.requesting_container_uuid
 400     assert_equal 1, cr.priority
 401   end
 402
 403   [[{"vcpus" => [2, nil]},
 404     lambda { |resolved| resolved["vcpus"] == 2 }],
 405    [{"vcpus" => [3, 7]},
 406     lambda { |resolved| resolved["vcpus"] == 3 }],
 407    [{"vcpus" => 4},
 408     lambda { |resolved| resolved["vcpus"] == 4 }],
 409    [{"ram" => [1000000000, 2000000000]},
 410     lambda { |resolved| resolved["ram"] == 1000000000 }],
 411    [{"ram" => [1234234234]},
 412     lambda { |resolved| resolved["ram"] == 1234234234 }],
 413   ].each do |rc, okfunc|
 414     test "resolve runtime constraint range #{rc} to values" do
 415       resolved = Container.resolve_runtime_constraints(rc)
 416       assert(okfunc.call(resolved),
 417              "container runtime_constraints was #{resolved.inspect}")
 418     end
 419   end
 420
 421   [[{"/out" => {
 422         "kind" => "collection",
 423         "uuid" => "zzzzz-4zz18-znfnqtbbv4spc3w",
 424         "path" => "/foo"}},
 425     lambda do |resolved|
 426       resolved["/out"] == {
 427         "portable_data_hash" => "1f4b0bc7583c2a7f9102c395f4ffc5e3+45",
 428         "kind" => "collection",
 429         "path" => "/foo",
 430       }
 431     end],
 432    [{"/out" => {
 433         "kind" => "collection",
 434         "uuid" => "zzzzz-4zz18-znfnqtbbv4spc3w",
 435         "portable_data_hash" => "1f4b0bc7583c2a7f9102c395f4ffc5e3+45",
 436         "path" => "/foo"}},
 437     lambda do |resolved|
 438       resolved["/out"] == {
 439         "portable_data_hash" => "1f4b0bc7583c2a7f9102c395f4ffc5e3+45",
 440         "kind" => "collection",
 441         "path" => "/foo",
 442       }
 443     end],
 444   ].each do |mounts, okfunc|
 445     test "resolve mounts #{mounts.inspect} to values" do
 446       set_user_from_auth :active
 447       resolved = Container.resolve_mounts(mounts)
 448       assert(okfunc.call(resolved),
 449              "Container.resolve_mounts returned #{resolved.inspect}")
 450     end
 451   end
 452
 453   test 'mount unreadable collection' do
 454     set_user_from_auth :spectator
 455     m = {
 456       "/foo" => {
 457         "kind" => "collection",
 458         "uuid" => "zzzzz-4zz18-znfnqtbbv4spc3w",
 459         "path" => "/foo",
 460       },
 461     }
 462     assert_raises(ArvadosModel::UnresolvableContainerError) do
 463       Container.resolve_mounts(m)
 464     end
 465   end
 466
 467   test 'mount collection with mismatched UUID and PDH' do
 468     set_user_from_auth :active
 469     m = {
 470       "/foo" => {
 471         "kind" => "collection",
 472         "uuid" => "zzzzz-4zz18-znfnqtbbv4spc3w",
 473         "portable_data_hash" => "fa7aeb5140e2848d39b416daeef4ffc5+45",
 474         "path" => "/foo",
 475       },
 476     }
 477     assert_raises(ArgumentError) do
 478       Container.resolve_mounts(m)
 479     end
 480   end
 481
 482   ['arvados/apitestfixture:latest',
 483    'arvados/apitestfixture',
 484    'd8309758b8fe2c81034ffc8a10c36460b77db7bc5e7b448c4e5b684f9d95a678',
 485   ].each do |tag|
 486     test "Container.resolve_container_image(#{tag.inspect})" do
 487       set_user_from_auth :active
 488       resolved = Container.resolve_container_image(tag)
 489       assert_equal resolved, collections(:docker_image).portable_data_hash
 490     end
 491   end
 492
 493   test "Container.resolve_container_image(pdh)" do
 494     set_user_from_auth :active
 495     [[:docker_image, 'v1'], [:docker_image_1_12, 'v2']].each do |coll, ver|
 496       Rails.configuration.docker_image_formats = [ver]
 497       pdh = collections(coll).portable_data_hash
 498       resolved = Container.resolve_container_image(pdh)
 499       assert_equal resolved, pdh
 500     end
 501   end
 502
 503   ['ENOEXIST',
 504    'arvados/apitestfixture:ENOEXIST',
 505   ].each do |img|
 506     test "container_image_for_container(#{img.inspect}) => 422" do
 507       set_user_from_auth :active
 508       assert_raises(ArvadosModel::UnresolvableContainerError) do
 509         Container.resolve_container_image(img)
 510       end
 511     end
 512   end
 513
 514   test "migrated docker image" do
 515     Rails.configuration.docker_image_formats = ['v2']
 516     add_docker19_migration_link
 517
 518     # Test that it returns only v2 images even though request is for v1 image.
 519
 520     set_user_from_auth :active
 521     cr = create_minimal_req!(command: ["true", "1"],
 522                              container_image: collections(:docker_image).portable_data_hash)
 523     assert_equal(Container.resolve_container_image(cr.container_image),
 524                  collections(:docker_image_1_12).portable_data_hash)
 525
 526     cr = create_minimal_req!(command: ["true", "2"],
 527                              container_image: links(:docker_image_collection_tag).name)
 528     assert_equal(Container.resolve_container_image(cr.container_image),
 529                  collections(:docker_image_1_12).portable_data_hash)
 530   end
 531
 532   test "use unmigrated docker image" do
 533     Rails.configuration.docker_image_formats = ['v1']
 534     add_docker19_migration_link
 535
 536     # Test that it returns only supported v1 images even though there is a
 537     # migration link.
 538
 539     set_user_from_auth :active
 540     cr = create_minimal_req!(command: ["true", "1"],
 541                              container_image: collections(:docker_image).portable_data_hash)
 542     assert_equal(Container.resolve_container_image(cr.container_image),
 543                  collections(:docker_image).portable_data_hash)
 544
 545     cr = create_minimal_req!(command: ["true", "2"],
 546                              container_image: links(:docker_image_collection_tag).name)
 547     assert_equal(Container.resolve_container_image(cr.container_image),
 548                  collections(:docker_image).portable_data_hash)
 549   end
 550
 551   test "incompatible docker image v1" do
 552     Rails.configuration.docker_image_formats = ['v1']
 553     add_docker19_migration_link
 554
 555     # Don't return unsupported v2 image even if we ask for it directly.
 556     set_user_from_auth :active
 557     cr = create_minimal_req!(command: ["true", "1"],
 558                              container_image: collections(:docker_image_1_12).portable_data_hash)
 559     assert_raises(ArvadosModel::UnresolvableContainerError) do
 560       Container.resolve_container_image(cr.container_image)
 561     end
 562   end
 563
 564   test "incompatible docker image v2" do
 565     Rails.configuration.docker_image_formats = ['v2']
 566     # No migration link, don't return unsupported v1 image,
 567
 568     set_user_from_auth :active
 569     cr = create_minimal_req!(command: ["true", "1"],
 570                              container_image: collections(:docker_image).portable_data_hash)
 571     assert_raises(ArvadosModel::UnresolvableContainerError) do
 572       Container.resolve_container_image(cr.container_image)
 573     end
 574     cr = create_minimal_req!(command: ["true", "2"],
 575                              container_image: links(:docker_image_collection_tag).name)
 576     assert_raises(ArvadosModel::UnresolvableContainerError) do
 577       Container.resolve_container_image(cr.container_image)
 578     end
 579   end
 580
 581   test "requestor can retrieve container owned by dispatch" do
 582     assert_not_empty Container.readable_by(users(:admin)).where(uuid: containers(:running).uuid)
 583     assert_not_empty Container.readable_by(users(:active)).where(uuid: containers(:running).uuid)
 584     assert_empty Container.readable_by(users(:spectator)).where(uuid: containers(:running).uuid)
 585   end
 586
 587   [
 588     [{"var" => "value1"}, {"var" => "value1"}, nil],
 589     [{"var" => "value1"}, {"var" => "value1"}, true],
 590     [{"var" => "value1"}, {"var" => "value1"}, false],
 591     [{"var" => "value1"}, {"var" => "value2"}, nil],
 592   ].each do |env1, env2, use_existing|
 593     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
 594       common_attrs = {cwd: "test",
 595                       priority: 1,
 596                       command: ["echo", "hello"],
 597                       output_path: "test",
 598                       runtime_constraints: {"vcpus" => 4,
 599                                             "ram" => 12000000000},
 600                       mounts: {"test" => {"kind" => "json"}}}
 601       set_user_from_auth :active
 602       cr1 = create_minimal_req!(common_attrs.merge({state: ContainerRequest::Committed,
 603                                                     environment: env1}))
 604       if use_existing.nil?
 605         # Testing with use_existing default value
 606         cr2 = create_minimal_req!(common_attrs.merge({state: ContainerRequest::Uncommitted,
 607                                                       environment: env2}))
 608       else
 609
 610         cr2 = create_minimal_req!(common_attrs.merge({state: ContainerRequest::Uncommitted,
 611                                                       environment: env2,
 612                                                       use_existing: use_existing}))
 613       end
 614       assert_not_nil cr1.container_uuid
 615       assert_nil cr2.container_uuid
 616
 617       # Update cr2 to commited state and check for container equality on different cases:
 618       # * When env1 and env2 are equal and use_existing is true, the same container
 619       #   should be assigned.
 620       # * When use_existing is false, a different container should be assigned.
 621       # * When env1 and env2 are different, a different container should be assigned.
 622       cr2.update_attributes!({state: ContainerRequest::Committed})
 623       assert_equal (cr2.use_existing == true and (env1 == env2)),
 624                    (cr1.container_uuid == cr2.container_uuid)
 625     end
 626   end
 627
 628   test "requesting_container_uuid at create is not allowed" do
 629     set_user_from_auth :active
 630     assert_raises(ActiveRecord::RecordInvalid) do
 631       create_minimal_req!(state: "Uncommitted", priority: 1, requesting_container_uuid: 'youcantdothat')
 632     end
 633   end
 634
 635   test "Retry on container cancelled" do
 636     set_user_from_auth :active
 637     cr = create_minimal_req!(priority: 1, state: "Committed", container_count_max: 2)
 638     cr2 = create_minimal_req!(priority: 1, state: "Committed", container_count_max: 2, command: ["echo", "baz"])
 639     prev_container_uuid = cr.container_uuid
 640
 641     c = act_as_system_user do
 642       c = Container.find_by_uuid(cr.container_uuid)
 643       c.update_attributes!(state: Container::Locked)
 644       c.update_attributes!(state: Container::Running)
 645       c
 646     end
 647
 648     cr.reload
 649     cr2.reload
 650     assert_equal "Committed", cr.state
 651     assert_equal prev_container_uuid, cr.container_uuid
 652     assert_not_equal cr2.container_uuid, cr.container_uuid
 653     prev_container_uuid = cr.container_uuid
 654
 655     act_as_system_user do
 656       c.update_attributes!(state: Container::Cancelled)
 657     end
 658
 659     cr.reload
 660     cr2.reload
 661     assert_equal "Committed", cr.state
 662     assert_not_equal prev_container_uuid, cr.container_uuid
 663     assert_not_equal cr2.container_uuid, cr.container_uuid
 664     prev_container_uuid = cr.container_uuid
 665
 666     c = act_as_system_user do
 667       c = Container.find_by_uuid(cr.container_uuid)
 668       c.update_attributes!(state: Container::Cancelled)
 669       c
 670     end
 671
 672     cr.reload
 673     cr2.reload
 674     assert_equal "Final", cr.state
 675     assert_equal prev_container_uuid, cr.container_uuid
 676     assert_not_equal cr2.container_uuid, cr.container_uuid
 677   end
 678
 679   test "Retry on container cancelled with runtime_token" do
 680     set_user_from_auth :spectator
 681     spec = api_client_authorizations(:active)
 682     cr = create_minimal_req!(priority: 1, state: "Committed",
 683                              runtime_token: spec.token,
 684                              container_count_max: 2)
 685     prev_container_uuid = cr.container_uuid
 686
 687     c = act_as_system_user do
 688       c = Container.find_by_uuid(cr.container_uuid)
 689       assert_equal spec.token, c.runtime_token
 690       c.update_attributes!(state: Container::Locked)
 691       c.update_attributes!(state: Container::Running)
 692       c
 693     end
 694
 695     cr.reload
 696     assert_equal "Committed", cr.state
 697     assert_equal prev_container_uuid, cr.container_uuid
 698     prev_container_uuid = cr.container_uuid
 699
 700     act_as_system_user do
 701       c.update_attributes!(state: Container::Cancelled)
 702     end
 703
 704     cr.reload
 705     assert_equal "Committed", cr.state
 706     assert_not_equal prev_container_uuid, cr.container_uuid
 707     prev_container_uuid = cr.container_uuid
 708
 709     c = act_as_system_user do
 710       c = Container.find_by_uuid(cr.container_uuid)
 711       assert_equal spec.token, c.runtime_token
 712       c.update_attributes!(state: Container::Cancelled)
 713       c
 714     end
 715
 716     cr.reload
 717     assert_equal "Final", cr.state
 718     assert_equal prev_container_uuid, cr.container_uuid
 719
 720   end
 721
 722   test "Output collection name setting using output_name with name collision resolution" do
 723     set_user_from_auth :active
 724     output_name = 'unimaginative name'
 725     Collection.create!(name: output_name)
 726
 727     cr = create_minimal_req!(priority: 1,
 728                              state: ContainerRequest::Committed,
 729                              output_name: output_name)
 730     run_container(cr)
 731     cr.reload
 732     assert_equal ContainerRequest::Final, cr.state
 733     output_coll = Collection.find_by_uuid(cr.output_uuid)
 734     # Make sure the resulting output collection name include the original name
 735     # plus the date
 736     assert_not_equal output_name, output_coll.name,
 737                      "more than one collection with the same owner and name"
 738     assert output_coll.name.include?(output_name),
 739            "New name should include original name"
 740     assert_match /\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}\.\d+Z/, output_coll.name,
 741                  "New name should include ISO8601 date"
 742   end
 743
 744   [[0, :check_output_ttl_0],
 745    [1, :check_output_ttl_1s],
 746    [365*86400, :check_output_ttl_1y],
 747   ].each do |ttl, checker|
 748     test "output_ttl=#{ttl}" do
 749       act_as_user users(:active) do
 750         cr = create_minimal_req!(priority: 1,
 751                                  state: ContainerRequest::Committed,
 752                                  output_name: 'foo',
 753                                  output_ttl: ttl)
 754         run_container(cr)
 755         cr.reload
 756         output = Collection.find_by_uuid(cr.output_uuid)
 757         send(checker, db_current_time, output.trash_at, output.delete_at)
 758       end
 759     end
 760   end
 761
 762   def check_output_ttl_0(now, trash, delete)
 763     assert_nil(trash)
 764     assert_nil(delete)
 765   end
 766
 767   def check_output_ttl_1s(now, trash, delete)
 768     assert_not_nil(trash)
 769     assert_not_nil(delete)
 770     assert_in_delta(trash, now + 1.second, 10)
 771     assert_in_delta(delete, now + Rails.configuration.blob_signature_ttl.second, 10)
 772   end
 773
 774   def check_output_ttl_1y(now, trash, delete)
 775     year = (86400*365).second
 776     assert_not_nil(trash)
 777     assert_not_nil(delete)
 778     assert_in_delta(trash, now + year, 10)
 779     assert_in_delta(delete, now + year, 10)
 780   end
 781
 782   def run_container(cr)
 783     act_as_system_user do
 784       c = Container.find_by_uuid(cr.container_uuid)
 785       c.update_attributes!(state: Container::Locked)
 786       c.update_attributes!(state: Container::Running)
 787       c.update_attributes!(state: Container::Complete,
 788                            exit_code: 0,
 789                            output: '1f4b0bc7583c2a7f9102c395f4ffc5e3+45',
 790                            log: 'fa7aeb5140e2848d39b416daeef4ffc5+45')
 791       c
 792     end
 793   end
 794
 795   test "Finalize committed request when reusing a finished container" do
 796     set_user_from_auth :active
 797     cr = create_minimal_req!(priority: 1, state: ContainerRequest::Committed)
 798     cr.reload
 799     assert_equal ContainerRequest::Committed, cr.state
 800     run_container(cr)
 801     cr.reload
 802     assert_equal ContainerRequest::Final, cr.state
 803
 804     cr2 = create_minimal_req!(priority: 1, state: ContainerRequest::Committed)
 805     assert_equal cr.container_uuid, cr2.container_uuid
 806     assert_equal ContainerRequest::Final, cr2.state
 807
 808     cr3 = create_minimal_req!(priority: 1, state: ContainerRequest::Uncommitted)
 809     assert_equal ContainerRequest::Uncommitted, cr3.state
 810     cr3.update_attributes!(state: ContainerRequest::Committed)
 811     assert_equal cr.container_uuid, cr3.container_uuid
 812     assert_equal ContainerRequest::Final, cr3.state
 813   end
 814
 815   [
 816     [false, ActiveRecord::RecordInvalid],
 817     [true, nil],
 818   ].each do |preemptible_conf, expected|
 819     test "having Rails.configuration.preemptible_instances=#{preemptible_conf}, create preemptible container request and verify #{expected}" do
 820       sp = {"preemptible" => true}
 821       common_attrs = {cwd: "test",
 822                       priority: 1,
 823                       command: ["echo", "hello"],
 824                       output_path: "test",
 825                       scheduling_parameters: sp,
 826                       mounts: {"test" => {"kind" => "json"}}}
 827       Rails.configuration.preemptible_instances = preemptible_conf
 828       set_user_from_auth :active
 829
 830       cr = create_minimal_req!(common_attrs)
 831       cr.state = ContainerRequest::Committed
 832
 833       if !expected.nil?
 834         assert_raises(expected) do
 835           cr.save!
 836         end
 837       else
 838         cr.save!
 839         assert_equal sp, cr.scheduling_parameters
 840       end
 841     end
 842   end
 843
 844   [
 845     'zzzzz-dz642-runningcontainr',
 846     nil,
 847   ].each do |requesting_c|
 848     test "having preemptible instances active on the API server, a committed #{requesting_c.nil? ? 'non-':''}child CR should not ask for preemptible instance if parameter already set to false" do
 849       common_attrs = {cwd: "test",
 850                       priority: 1,
 851                       command: ["echo", "hello"],
 852                       output_path: "test",
 853                       scheduling_parameters: {"preemptible" => false},
 854                       mounts: {"test" => {"kind" => "json"}}}
 855
 856       Rails.configuration.preemptible_instances = true
 857       set_user_from_auth :active
 858
 859       if requesting_c
 860         cr = with_container_auth(Container.find_by_uuid requesting_c) do
 861           create_minimal_req!(common_attrs)
 862         end
 863         assert_not_nil cr.requesting_container_uuid
 864       else
 865         cr = create_minimal_req!(common_attrs)
 866       end
 867
 868       cr.state = ContainerRequest::Committed
 869       cr.save!
 870
 871       assert_equal false, cr.scheduling_parameters['preemptible']
 872     end
 873   end
 874
 875   [
 876     [true, 'zzzzz-dz642-runningcontainr', true],
 877     [true, nil, nil],
 878     [false, 'zzzzz-dz642-runningcontainr', nil],
 879     [false, nil, nil],
 880   ].each do |preemptible_conf, requesting_c, schedule_preemptible|
 881     test "having Rails.configuration.preemptible_instances=#{preemptible_conf}, #{requesting_c.nil? ? 'non-':''}child CR should #{schedule_preemptible ? '':'not'} ask for preemptible instance by default" do
 882       common_attrs = {cwd: "test",
 883                       priority: 1,
 884                       command: ["echo", "hello"],
 885                       output_path: "test",
 886                       mounts: {"test" => {"kind" => "json"}}}
 887
 888       Rails.configuration.preemptible_instances = preemptible_conf
 889       set_user_from_auth :active
 890
 891       if requesting_c
 892         cr = with_container_auth(Container.find_by_uuid requesting_c) do
 893           create_minimal_req!(common_attrs)
 894         end
 895         assert_not_nil cr.requesting_container_uuid
 896       else
 897         cr = create_minimal_req!(common_attrs)
 898       end
 899
 900       cr.state = ContainerRequest::Committed
 901       cr.save!
 902
 903       assert_equal schedule_preemptible, cr.scheduling_parameters['preemptible']
 904     end
 905   end
 906
 907   [
 908     [{"partitions" => ["fastcpu","vfastcpu", 100]}, ContainerRequest::Committed, ActiveRecord::RecordInvalid],
 909     [{"partitions" => ["fastcpu","vfastcpu", 100]}, ContainerRequest::Uncommitted],
 910     [{"partitions" => "fastcpu"}, ContainerRequest::Committed, ActiveRecord::RecordInvalid],
 911     [{"partitions" => "fastcpu"}, ContainerRequest::Uncommitted],
 912     [{"partitions" => ["fastcpu","vfastcpu"]}, ContainerRequest::Committed],
 913     [{"max_run_time" => "one day"}, ContainerRequest::Committed, ActiveRecord::RecordInvalid],
 914     [{"max_run_time" => "one day"}, ContainerRequest::Uncommitted],
 915     [{"max_run_time" => -1}, ContainerRequest::Committed, ActiveRecord::RecordInvalid],
 916     [{"max_run_time" => -1}, ContainerRequest::Uncommitted],
 917     [{"max_run_time" => 86400}, ContainerRequest::Committed],
 918   ].each do |sp, state, expected|
 919     test "create container request with scheduling_parameters #{sp} in state #{state} and verify #{expected}" do
 920       common_attrs = {cwd: "test",
 921                       priority: 1,
 922                       command: ["echo", "hello"],
 923                       output_path: "test",
 924                       scheduling_parameters: sp,
 925                       mounts: {"test" => {"kind" => "json"}}}
 926       set_user_from_auth :active
 927
 928       if expected == ActiveRecord::RecordInvalid
 929         assert_raises(ActiveRecord::RecordInvalid) do
 930           create_minimal_req!(common_attrs.merge({state: state}))
 931         end
 932       else
 933         cr = create_minimal_req!(common_attrs.merge({state: state}))
 934         assert_equal sp, cr.scheduling_parameters
 935
 936         if state == ContainerRequest::Committed
 937           c = Container.find_by_uuid(cr.container_uuid)
 938           assert_equal sp, c.scheduling_parameters
 939         end
 940       end
 941     end
 942   end
 943
 944   test "Having preemptible_instances=true create a committed child container request and verify the scheduling parameter of its container" do
 945     common_attrs = {cwd: "test",
 946                     priority: 1,
 947                     command: ["echo", "hello"],
 948                     output_path: "test",
 949                     state: ContainerRequest::Committed,
 950                     mounts: {"test" => {"kind" => "json"}}}
 951     set_user_from_auth :active
 952     Rails.configuration.preemptible_instances = true
 953
 954     cr = with_container_auth(Container.find_by_uuid 'zzzzz-dz642-runningcontainr') do
 955       create_minimal_req!(common_attrs)
 956     end
 957     assert_equal 'zzzzz-dz642-runningcontainr', cr.requesting_container_uuid
 958     assert_equal true, cr.scheduling_parameters["preemptible"]
 959
 960     c = Container.find_by_uuid(cr.container_uuid)
 961     assert_equal true, c.scheduling_parameters["preemptible"]
 962   end
 963
 964   [['Committed', true, {name: "foobar", priority: 123}],
 965    ['Committed', false, {container_count: 2}],
 966    ['Committed', false, {container_count: 0}],
 967    ['Committed', false, {container_count: nil}],
 968    ['Final', false, {state: ContainerRequest::Committed, name: "foobar"}],
 969    ['Final', false, {name: "foobar", priority: 123}],
 970    ['Final', false, {name: "foobar", output_uuid: "zzzzz-4zz18-znfnqtbbv4spc3w"}],
 971    ['Final', false, {name: "foobar", log_uuid: "zzzzz-4zz18-znfnqtbbv4spc3w"}],
 972    ['Final', false, {log_uuid: "zzzzz-4zz18-znfnqtbbv4spc3w"}],
 973    ['Final', false, {priority: 123}],
 974    ['Final', false, {mounts: {}}],
 975    ['Final', false, {container_count: 2}],
 976    ['Final', true, {name: "foobar"}],
 977    ['Final', true, {name: "foobar", description: "baz"}],
 978   ].each do |state, permitted, updates|
 979     test "state=#{state} can#{'not' if !permitted} update #{updates.inspect}" do
 980       act_as_user users(:active) do
 981         cr = create_minimal_req!(priority: 1,
 982                                  state: "Committed",
 983                                  container_count_max: 1)
 984         case state
 985         when 'Committed'
 986           # already done
 987         when 'Final'
 988           act_as_system_user do
 989             Container.find_by_uuid(cr.container_uuid).
 990               update_attributes!(state: Container::Cancelled)
 991           end
 992           cr.reload
 993         else
 994           raise 'broken test case'
 995         end
 996         assert_equal state, cr.state
 997         if permitted
 998           assert cr.update_attributes!(updates)
 999         else
1000           assert_raises(ActiveRecord::RecordInvalid) do
1001             cr.update_attributes!(updates)
1002           end
1003         end
1004       end
1005     end
1006   end
1007
1008   test "delete container_request and check its container's priority" do
1009     act_as_user users(:active) do
1010       cr = ContainerRequest.find_by_uuid container_requests(:running_to_be_deleted).uuid
1011
1012       # initially the cr's container has priority > 0
1013       c = Container.find_by_uuid(cr.container_uuid)
1014       assert_equal 1, c.priority
1015
1016       cr.destroy
1017
1018       # the cr's container now has priority of 0
1019       c = Container.find_by_uuid(cr.container_uuid)
1020       assert_equal 0, c.priority
1021     end
1022   end
1023
1024   test "delete container_request in final state and expect no error due to before_destroy callback" do
1025     act_as_user users(:active) do
1026       cr = ContainerRequest.find_by_uuid container_requests(:completed).uuid
1027       assert_nothing_raised {cr.destroy}
1028     end
1029   end
1030
1031   test "Container request valid priority" do
1032     set_user_from_auth :active
1033     cr = create_minimal_req!
1034
1035     assert_raises(ActiveRecord::RecordInvalid) do
1036       cr.priority = -1
1037       cr.save!
1038     end
1039
1040     cr.priority = 0
1041     cr.save!
1042
1043     cr.priority = 1
1044     cr.save!
1045
1046     cr.priority = 500
1047     cr.save!
1048
1049     cr.priority = 999
1050     cr.save!
1051
1052     cr.priority = 1000
1053     cr.save!
1054
1055     assert_raises(ActiveRecord::RecordInvalid) do
1056       cr.priority = 1001
1057       cr.save!
1058     end
1059   end
1060
1061   # Note: some of these tests might look redundant because they test
1062   # that out-of-order spellings of hashes are still considered equal
1063   # regardless of whether the existing (container) or new (container
1064   # request) hash needs to be re-ordered.
1065   secrets = {"/foo" => {"kind" => "text", "content" => "xyzzy"}}
1066   same_secrets = {"/foo" => {"content" => "xyzzy", "kind" => "text"}}
1067   different_secrets = {"/foo" => {"kind" => "text", "content" => "something completely different"}}
1068   [
1069     [true, nil, nil],
1070     [true, nil, {}],
1071     [true, {}, nil],
1072     [true, {}, {}],
1073     [true, secrets, same_secrets],
1074     [true, same_secrets, secrets],
1075     [false, nil, secrets],
1076     [false, {}, secrets],
1077     [false, secrets, {}],
1078     [false, secrets, nil],
1079     [false, secrets, different_secrets],
1080   ].each do |expect_reuse, sm1, sm2|
1081     test "container reuse secret_mounts #{sm1.inspect}, #{sm2.inspect}" do
1082       set_user_from_auth :active
1083       cr1 = create_minimal_req!(state: "Committed", priority: 1, secret_mounts: sm1)
1084       cr2 = create_minimal_req!(state: "Committed", priority: 1, secret_mounts: sm2)
1085       assert_not_nil cr1.container_uuid
1086       assert_not_nil cr2.container_uuid
1087       if expect_reuse
1088         assert_equal cr1.container_uuid, cr2.container_uuid
1089       else
1090         assert_not_equal cr1.container_uuid, cr2.container_uuid
1091       end
1092     end
1093   end
1094
1095   test "scrub secret_mounts but reuse container for request with identical secret_mounts" do
1096     set_user_from_auth :active
1097     sm = {'/secret/foo' => {'kind' => 'text', 'content' => secret_string}}
1098     cr1 = create_minimal_req!(state: "Committed", priority: 1, secret_mounts: sm.dup)
1099     run_container(cr1)
1100     cr1.reload
1101
1102     # secret_mounts scrubbed from db
1103     c = Container.where(uuid: cr1.container_uuid).first
1104     assert_equal({}, c.secret_mounts)
1105     assert_equal({}, cr1.secret_mounts)
1106
1107     # can reuse container if secret_mounts match
1108     cr2 = create_minimal_req!(state: "Committed", priority: 1, secret_mounts: sm.dup)
1109     assert_equal cr1.container_uuid, cr2.container_uuid
1110
1111     # don't reuse container if secret_mounts don't match
1112     cr3 = create_minimal_req!(state: "Committed", priority: 1, secret_mounts: {})
1113     assert_not_equal cr1.container_uuid, cr3.container_uuid
1114
1115     assert_no_secrets_logged
1116   end
1117
1118   test "conflicting key in mounts and secret_mounts" do
1119     sm = {'/secret/foo' => {'kind' => 'text', 'content' => secret_string}}
1120     set_user_from_auth :active
1121     cr = create_minimal_req!
1122     assert_equal false, cr.update_attributes(state: "Committed",
1123                                              priority: 1,
1124                                              mounts: cr.mounts.merge(sm),
1125                                              secret_mounts: sm)
1126     assert_equal [:secret_mounts], cr.errors.messages.keys
1127   end
1128
1129   test "using runtime_token" do
1130     set_user_from_auth :spectator
1131     spec = api_client_authorizations(:active)
1132     cr = create_minimal_req!(state: "Committed", runtime_token: spec.token, priority: 1)
1133     cr.save!
1134     c = Container.find_by_uuid cr.container_uuid
1135     lock_and_run c
1136     assert_nil c.auth_uuid
1137     assert_equal c.runtime_token, spec.token
1138
1139     assert_not_nil ApiClientAuthorization.find_by_uuid(spec.uuid)
1140
1141     act_as_system_user do
1142       c.update_attributes!(state: Container::Complete,
1143                            exit_code: 0,
1144                            output: '1f4b0bc7583c2a7f9102c395f4ffc5e3+45',
1145                            log: 'fa7aeb5140e2848d39b416daeef4ffc5+45')
1146     end
1147
1148     cr.reload
1149     c.reload
1150     assert_nil cr.runtime_token
1151     assert_nil c.runtime_token
1152   end
1153
1154   test "invalid runtime_token" do
1155     set_user_from_auth :active
1156     spec = api_client_authorizations(:spectator)
1157     assert_raises(ArgumentError) do
1158       cr = create_minimal_req!(state: "Committed", runtime_token: "#{spec.token}xx")
1159       cr.save!
1160     end
1161   end
1162 end