2 require 'helpers/git_test_helper'
3 require 'helpers/docker_migration_helper'
5 class JobTest < ActiveSupport::TestCase
6 include DockerMigrationHelper
9 BAD_COLLECTION = "#{'f' * 32}+0"
12 set_user_from_auth :active
15 def job_attrs merge_me={}
16 # Default (valid) set of attributes, with given overrides
19 script_version: "master",
20 repository: "active/foo",
24 test "Job without Docker image doesn't get locator" do
25 job = Job.new job_attrs
26 assert job.valid?, job.errors.full_messages.to_s
27 assert_nil job.docker_image_locator
30 { 'name' => [:links, :docker_image_collection_tag, :name],
31 'hash' => [:links, :docker_image_collection_hash, :name],
32 'locator' => [:collections, :docker_image, :portable_data_hash],
33 }.each_pair do |spec_type, (fixture_type, fixture_name, fixture_attr)|
34 test "Job initialized with Docker image #{spec_type} gets locator" do
35 image_spec = send(fixture_type, fixture_name).send(fixture_attr)
36 job = Job.new job_attrs(runtime_constraints:
37 {'docker_image' => image_spec})
38 assert job.valid?, job.errors.full_messages.to_s
39 assert_equal(collections(:docker_image).portable_data_hash, job.docker_image_locator)
42 test "Job modified with Docker image #{spec_type} gets locator" do
43 job = Job.new job_attrs
44 assert job.valid?, job.errors.full_messages.to_s
45 assert_nil job.docker_image_locator
46 image_spec = send(fixture_type, fixture_name).send(fixture_attr)
47 job.runtime_constraints['docker_image'] = image_spec
48 assert job.valid?, job.errors.full_messages.to_s
49 assert_equal(collections(:docker_image).portable_data_hash, job.docker_image_locator)
53 test "removing a Docker runtime constraint removes the locator" do
54 image_locator = collections(:docker_image).portable_data_hash
55 job = Job.new job_attrs(runtime_constraints:
56 {'docker_image' => image_locator})
57 assert job.valid?, job.errors.full_messages.to_s
58 assert_equal(image_locator, job.docker_image_locator)
59 job.runtime_constraints = {}
60 assert job.valid?, job.errors.full_messages.to_s + "after clearing runtime constraints"
61 assert_nil job.docker_image_locator
64 test "locate a Docker image with a repository + tag" do
65 image_repo, image_tag =
66 links(:docker_image_collection_tag2).name.split(':', 2)
67 job = Job.new job_attrs(runtime_constraints:
68 {'docker_image' => image_repo,
69 'docker_image_tag' => image_tag})
70 assert job.valid?, job.errors.full_messages.to_s
71 assert_equal(collections(:docker_image).portable_data_hash, job.docker_image_locator)
74 test "can't locate a Docker image with a nonexistent tag" do
75 image_repo = links(:docker_image_collection_tag).name
76 image_tag = '__nonexistent tag__'
77 job = Job.new job_attrs(runtime_constraints:
78 {'docker_image' => image_repo,
79 'docker_image_tag' => image_tag})
80 assert(job.invalid?, "Job with bad Docker tag valid")
86 ].each do |use_config|
87 test "Job with no Docker image uses default docker image when configuration is set #{use_config}" do
88 default_docker_image = collections(:docker_image)[:portable_data_hash]
89 Rails.configuration.default_docker_image_for_jobs = default_docker_image if use_config
91 job = Job.new job_attrs
92 assert job.valid?, job.errors.full_messages.to_s
95 refute_nil job.docker_image_locator
96 assert_equal default_docker_image, job.docker_image_locator
98 assert_nil job.docker_image_locator
103 test "create a job with a disambiguated script_version branch name" do
105 new(script: "testscript",
106 script_version: "heads/7387838c69a21827834586cc42b467ff6c63293b",
107 repository: "active/shabranchnames",
108 script_parameters: {})
110 assert_equal("abec49829bf1758413509b7ffcab32a771b71e81", job.script_version)
113 test "locate a Docker image with a partial hash" do
114 image_hash = links(:docker_image_collection_hash).name[0..24]
115 job = Job.new job_attrs(runtime_constraints:
116 {'docker_image' => image_hash})
117 assert job.valid?, job.errors.full_messages.to_s + " with partial hash #{image_hash}"
118 assert_equal(collections(:docker_image).portable_data_hash, job.docker_image_locator)
121 { 'name' => 'arvados_test_nonexistent',
123 'locator' => BAD_COLLECTION,
124 }.each_pair do |spec_type, image_spec|
125 test "Job validation fails with nonexistent Docker image #{spec_type}" do
126 job = Job.new job_attrs(runtime_constraints:
127 {'docker_image' => image_spec})
128 assert(job.invalid?, "nonexistent Docker image #{spec_type} was valid")
132 test "Job validation fails with non-Docker Collection constraint" do
133 job = Job.new job_attrs(runtime_constraints:
134 {'docker_image' => collections(:foo_file).uuid})
135 assert(job.invalid?, "non-Docker Collection constraint was valid")
138 test "can create Job with Docker image Collection without Docker links" do
139 image_uuid = collections(:unlinked_docker_image).portable_data_hash
140 job = Job.new job_attrs(runtime_constraints: {"docker_image" => image_uuid})
141 assert(job.valid?, "Job created with unlinked Docker image was invalid")
142 assert_equal(image_uuid, job.docker_image_locator)
145 def check_attrs_unset(job, attrs)
146 assert_empty(attrs.each_key.map { |key| job.send(key) }.compact,
147 "job has values for #{attrs.keys}")
150 def check_creation_prohibited(attrs)
152 job = Job.new(job_attrs(attrs))
153 rescue ActiveModel::MassAssignmentSecurity::Error
154 # Test passes - expected attribute protection
156 check_attrs_unset(job, attrs)
160 def check_modification_prohibited(attrs)
161 job = Job.new(job_attrs)
162 attrs.each_pair do |key, value|
163 assert_raises(NoMethodError) { job.send("{key}=".to_sym, value) }
165 check_attrs_unset(job, attrs)
168 test "can't create Job with Docker image locator" do
169 check_creation_prohibited(docker_image_locator: BAD_COLLECTION)
172 test "can't assign Docker image locator to Job" do
173 check_modification_prohibited(docker_image_locator: BAD_COLLECTION)
177 {script_parameters: ""},
178 {script_parameters: []},
179 {script_parameters: {symbols: :are_not_allowed_here}},
180 {runtime_constraints: ""},
181 {runtime_constraints: []},
184 {script_version: "no/branch/could/ever/possibly/have/this/name"},
185 ].each do |invalid_attrs|
186 test "validation failures set error messages: #{invalid_attrs.to_json}" do
187 # Ensure valid_attrs doesn't produce errors -- otherwise we will
188 # not know whether errors reported below are actually caused by
190 Job.create! job_attrs
192 job = Job.create job_attrs(invalid_attrs)
193 assert_raises(ActiveRecord::RecordInvalid, ArgumentError,
194 "save! did not raise the expected exception") do
197 assert_not_empty job.errors, "validation failure did not provide errors"
202 # Each test case is of the following format
203 # Array of parameters where each parameter is of the format:
204 # attr name to be changed, attr value, and array of expectations (where each expectation is an array)
205 [['running', false, [['state', 'Queued']]]],
206 [['state', 'Running', [['started_at', 'not_nil']]]],
207 [['is_locked_by_uuid', 'use_current_user_uuid', [['state', 'Queued']]], ['state', 'Running', [['running', true], ['started_at', 'not_nil'], ['success', 'nil']]]],
208 [['running', false, [['state', 'Queued']]], ['state', 'Complete', [['success', true]]]],
209 [['running', true, [['state', 'Running']]], ['cancelled_at', Time.now, [['state', 'Cancelled']]]],
210 [['running', true, [['state', 'Running']]], ['state', 'Cancelled', [['cancelled_at', 'not_nil']]]],
211 [['running', true, [['state', 'Running']]], ['success', true, [['state', 'Complete']]]],
212 [['running', true, [['state', 'Running']]], ['success', false, [['state', 'Failed']]]],
213 [['running', true, [['state', 'Running']]], ['state', 'Complete', [['success', true],['finished_at', 'not_nil']]]],
214 [['running', true, [['state', 'Running']]], ['state', 'Failed', [['success', false],['finished_at', 'not_nil']]]],
215 [['cancelled_at', Time.now, [['state', 'Cancelled']]], ['success', false, [['state', 'Cancelled'],['finished_at', 'nil'], ['cancelled_at', 'not_nil']]]],
216 [['cancelled_at', Time.now, [['state', 'Cancelled'],['running', false]]], ['success', true, [['state', 'Cancelled'],['running', false],['finished_at', 'nil'],['cancelled_at', 'not_nil']]]],
217 # potential migration cases
218 [['state', nil, [['state', 'Queued']]]],
219 [['state', nil, [['state', 'Queued']]], ['cancelled_at', Time.now, [['state', 'Cancelled']]]],
220 [['running', true, [['state', 'Running']]], ['state', nil, [['state', 'Running']]]],
221 ].each do |parameters|
222 test "verify job status #{parameters}" do
223 job = Job.create! job_attrs
224 assert_equal 'Queued', job.state, "job.state"
226 parameters.each do |parameter|
227 expectations = parameter[2]
228 if 'use_current_user_uuid' == parameter[1]
229 parameter[1] = Thread.current[:user].uuid
232 if expectations.instance_of? Array
233 job[parameter[0]] = parameter[1]
234 assert_equal true, job.save, job.errors.full_messages.to_s
235 expectations.each do |expectation|
236 if expectation[1] == 'not_nil'
237 assert_not_nil job[expectation[0]], expectation[0]
238 elsif expectation[1] == 'nil'
239 assert_nil job[expectation[0]], expectation[0]
241 assert_equal expectation[1], job[expectation[0]], expectation[0]
245 raise 'I do not know how to handle this expectation'
251 test "Test job state changes" do
252 all = ["Queued", "Running", "Complete", "Failed", "Cancelled"]
253 valid = {"Queued" => all, "Running" => ["Complete", "Failed", "Cancelled"]}
257 job = Job.create! job_attrs(state: start)
258 assert_equal start, job.state
262 if valid[start] and valid[start].include? finish
263 assert_equal finish, job.state
265 assert_equal start, job.state
272 test "Test job locking" do
273 set_user_from_auth :active_trustedclient
274 job = Job.create! job_attrs
276 assert_equal "Queued", job.state
278 # Should be able to lock successfully
279 job.lock current_user.uuid
280 assert_equal "Running", job.state
282 assert_raises ArvadosModel::AlreadyLockedError do
283 # Can't lock it again
284 job.lock current_user.uuid
287 assert_equal "Running", job.state
289 set_user_from_auth :project_viewer
290 assert_raises ArvadosModel::AlreadyLockedError do
291 # Can't lock it as a different user either
292 job.lock current_user.uuid
295 assert_equal "Running", job.state
297 assert_raises ArvadosModel::PermissionDeniedError do
298 # Can't update fields as a different user
299 job.update_attributes(state: "Failed")
302 assert_equal "Running", job.state
305 set_user_from_auth :active_trustedclient
307 # Can update fields as the locked_by user
308 job.update_attributes(state: "Failed")
309 assert_equal "Failed", job.state
312 test "admin user can cancel a running job despite lock" do
313 set_user_from_auth :active_trustedclient
314 job = Job.create! job_attrs
315 job.lock current_user.uuid
316 assert_equal Job::Running, job.state
318 set_user_from_auth :spectator
320 job.update_attributes!(state: Job::Cancelled)
323 set_user_from_auth :admin
325 assert_equal Job::Running, job.state
326 job.update_attributes!(state: Job::Cancelled)
327 assert_equal Job::Cancelled, job.state
330 test "verify job queue position" do
331 job1 = Job.create! job_attrs
332 assert_equal 'Queued', job1.state, "Incorrect job state for newly created job1"
334 job2 = Job.create! job_attrs
335 assert_equal 'Queued', job2.state, "Incorrect job state for newly created job2"
337 assert_not_nil job1.queue_position, "Expected non-nil queue position for job1"
338 assert_not_nil job2.queue_position, "Expected non-nil queue position for job2"
341 SDK_MASTER = "ca68b24e51992e790f29df5cc4bc54ce1da4a1c2"
342 SDK_TAGGED = "00634b2b8a492d6f121e3cf1d6587b821136a9a7"
344 def sdk_constraint(version)
345 {runtime_constraints: {
346 "arvados_sdk_version" => version,
347 "docker_image" => links(:docker_image_collection_tag).name,
351 def check_job_sdk_version(expected)
354 refute(job.valid?, "job valid with bad Arvados SDK version")
356 assert(job.valid?, "job not valid with good Arvados SDK version")
357 assert_equal(expected, job.arvados_sdk_version)
361 { "master" => SDK_MASTER,
362 "commit2" => SDK_TAGGED,
363 SDK_TAGGED[0, 8] => SDK_TAGGED,
364 "__nonexistent__" => nil,
365 }.each_pair do |search, commit_hash|
366 test "creating job with SDK version '#{search}'" do
367 check_job_sdk_version(commit_hash) do
368 Job.new(job_attrs(sdk_constraint(search)))
372 test "updating job from no SDK to version '#{search}'" do
373 job = Job.create!(job_attrs)
374 assert_nil job.arvados_sdk_version
375 check_job_sdk_version(commit_hash) do
376 job.runtime_constraints = sdk_constraint(search)[:runtime_constraints]
381 test "updating job from SDK version 'master' to '#{search}'" do
382 job = Job.create!(job_attrs(sdk_constraint("master")))
383 assert_equal(SDK_MASTER, job.arvados_sdk_version)
384 check_job_sdk_version(commit_hash) do
385 job.runtime_constraints = sdk_constraint(search)[:runtime_constraints]
391 test "clear the SDK version" do
392 job = Job.create!(job_attrs(sdk_constraint("master")))
393 assert_equal(SDK_MASTER, job.arvados_sdk_version)
394 job.runtime_constraints = {}
395 assert(job.valid?, "job invalid after clearing SDK version")
396 assert_nil(job.arvados_sdk_version)
399 test "job with SDK constraint, without Docker image is invalid" do
400 sdk_attrs = sdk_constraint("master")
401 sdk_attrs[:runtime_constraints].delete("docker_image")
402 job = Job.create(job_attrs(sdk_attrs))
403 refute(job.valid?, "Job valid with SDK version, without Docker image")
404 sdk_errors = job.errors.messages[:arvados_sdk_version] || []
405 refute_empty(sdk_errors.grep(/\bDocker\b/),
406 "no Job SDK errors mention that Docker is required")
409 test "invalid to clear Docker image constraint when SDK constraint exists" do
410 job = Job.create!(job_attrs(sdk_constraint("master")))
411 job.runtime_constraints.delete("docker_image")
413 "Job with SDK constraint valid after clearing Docker image")
416 test "use migrated docker image if requesting old-format image by tag" do
417 Rails.configuration.docker_image_formats = ['v2']
418 add_docker19_migration_link
422 runtime_constraints: {
423 'docker_image' => links(:docker_image_collection_tag).name}))
425 assert_equal(job.docker_image_locator, collections(:docker_image_1_12).portable_data_hash)
428 test "use migrated docker image if requesting old-format image by pdh" do
429 Rails.configuration.docker_image_formats = ['v2']
430 add_docker19_migration_link
434 runtime_constraints: {
435 'docker_image' => collections(:docker_image).portable_data_hash}))
437 assert_equal(job.docker_image_locator, collections(:docker_image_1_12).portable_data_hash)
440 [[:docker_image, :docker_image, :docker_image_1_12],
441 [:docker_image_1_12, :docker_image, :docker_image_1_12],
442 [:docker_image, :docker_image_1_12, :docker_image_1_12],
443 [:docker_image_1_12, :docker_image_1_12, :docker_image_1_12],
444 ].each do |existing_image, request_image, expect_image|
445 test "if a #{existing_image} job exists, #{request_image} yields #{expect_image} after migration" do
446 Rails.configuration.docker_image_formats = ['v1']
448 if existing_image == :docker_image
449 oldjob = Job.create!(
452 runtime_constraints: {
453 'docker_image' => collections(existing_image).portable_data_hash}))
455 assert_equal(oldjob.docker_image_locator,
456 collections(existing_image).portable_data_hash)
457 elsif existing_image == :docker_image_1_12
458 assert_raises(ActiveRecord::RecordInvalid,
459 "Should not resolve v2 image when only v1 is supported") do
460 oldjob = Job.create!(
463 runtime_constraints: {
464 'docker_image' => collections(existing_image).portable_data_hash}))
468 Rails.configuration.docker_image_formats = ['v2']
469 add_docker19_migration_link
471 # Check that both v1 and v2 images get resolved to v2.
472 newjob = Job.create!(
475 runtime_constraints: {
476 'docker_image' => collections(request_image).portable_data_hash}))
478 assert_equal(newjob.docker_image_locator,
479 collections(expect_image).portable_data_hash)
483 test "can't create job with SDK version assigned directly" do
484 check_creation_prohibited(arvados_sdk_version: SDK_MASTER)
487 test "can't modify job to assign SDK version directly" do
488 check_modification_prohibited(arvados_sdk_version: SDK_MASTER)
491 test "job validation fails when collection uuid found in script_parameters" do
495 'param1' => 'the collection uuid zzzzz-4zz18-012345678901234'
499 assert_raises(ActiveRecord::RecordInvalid,
500 "created job with a collection uuid in script_parameters") do
501 Job.create!(job_attrs(bad_params))
505 test "job validation succeeds when no collection uuid in script_parameters" do
509 'arg2' => [ 'bar', 'baz' ],
516 job = Job.create!(job_attrs(good_params))
520 test 'update job uuid tag in internal.git when version changes' do
521 authorize_with :active
523 j.update_attributes repository: 'active/foo', script_version: 'b1'
524 assert_equal('1de84a854e2b440dc53bf42f8548afa4c17da332',
525 internal_tag(j.uuid))
526 j.update_attributes repository: 'active/foo', script_version: 'master'
527 assert_equal('077ba2ad3ea24a929091a9e6ce545c93199b8e57',
528 internal_tag(j.uuid))
531 test 'script_parameters_digest is independent of key order' do
532 j1 = Job.new(job_attrs(script_parameters: {'a' => 'a', 'ddee' => {'d' => 'd', 'e' => 'e'}}))
533 j2 = Job.new(job_attrs(script_parameters: {'ddee' => {'e' => 'e', 'd' => 'd'}, 'a' => 'a'}))
536 assert_equal(j1.script_parameters_digest, j2.script_parameters_digest)
539 test 'job fixtures have correct script_parameters_digest' do
541 d = j.script_parameters_digest
542 assert_equal(j.update_script_parameters_digest, d,
543 "wrong script_parameters_digest for #{j.uuid}")
547 test 'deep_sort_hash on array of hashes' do
548 a = {'z' => [[{'a' => 'a', 'b' => 'b'}]]}
549 b = {'z' => [[{'b' => 'b', 'a' => 'a'}]]}
550 assert_equal Job.deep_sort_hash(a).to_json, Job.deep_sort_hash(b).to_json
553 test 'find_reusable' do
554 foobar = jobs(:foobar)
556 script_version: foobar.script_version,
557 script: foobar.script,
558 script_parameters: foobar.script_parameters,
559 repository: foobar.repository,
562 # Two matching jobs exist with identical outputs. The older one
564 j = Job.find_reusable(example_attrs, {}, [], [users(:active)])
566 assert_equal foobar.uuid, j.uuid
568 # Two matching jobs exist with different outputs. Neither should
570 Job.where(uuid: jobs(:job_with_latest_version).uuid).
571 update_all(output: 'aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa+1')
572 assert_nil Job.find_reusable(example_attrs, {}, [], [users(:active)])
579 test "cancel job with cascade #{cascade}" do
580 job = Job.find_by_uuid jobs(:running_job_with_components_at_level_1).uuid
581 job.cancel cascade: cascade
582 assert_equal Job::Cancelled, job.state
584 descendents = ['zzzzz-8i9sb-jobcomponentsl2',
585 'zzzzz-d1hrv-picomponentsl02',
586 'zzzzz-8i9sb-job1atlevel3noc',
587 'zzzzz-8i9sb-job2atlevel3noc']
589 jobs = Job.where(uuid: descendents)
591 assert_equal ('Cancelled' == j.state), cascade
594 pipelines = PipelineInstance.where(uuid: descendents)
595 pipelines.each do |pi|
596 assert_equal ('Paused' == pi.state), cascade
601 test 'cancelling a completed job raises error' do
602 job = Job.find_by_uuid jobs(:job_with_latest_version).uuid
604 assert_equal 'Complete', job.state
606 assert_raises(ArvadosModel::InvalidStateTransitionError) do
611 test 'cancelling a job with circular relationship with another does not result in an infinite loop' do
612 job = Job.find_by_uuid jobs(:running_job_2_with_circular_component_relationship).uuid
614 job.cancel cascade: true
616 assert_equal Job::Cancelled, job.state
618 child = Job.find_by_uuid job.components.collect{|_, uuid| uuid}[0]
619 assert_equal Job::Cancelled, child.state