+# Copyright (C) The Arvados Authors. All rights reserved.
+#
+# SPDX-License-Identifier: AGPL-3.0
+
require 'test_helper'
require 'helpers/git_test_helper'
+require 'helpers/docker_migration_helper'
class JobTest < ActiveSupport::TestCase
+ include DockerMigrationHelper
include GitTestHelper
BAD_COLLECTION = "#{'f' * 32}+0"
# Default (valid) set of attributes, with given overrides
{
script: "hash",
- script_version: "master",
- repository: "foo",
+ script_version: "main",
+ repository: "active/foo",
}.merge(merge_me)
end
assert(job.invalid?, "Job with bad Docker tag valid")
end
+ [
+ false,
+ true
+ ].each do |use_config|
+ test "Job with no Docker image uses default docker image when configuration is set #{use_config}" do
+ default_docker_image = collections(:docker_image)[:portable_data_hash]
+ Rails.configuration.Containers.JobsAPI.DefaultDockerImage = default_docker_image if use_config
+
+ job = Job.new job_attrs
+ assert job.valid?, job.errors.full_messages.to_s
+
+ if use_config
+ refute_nil job.docker_image_locator
+ assert_equal default_docker_image, job.docker_image_locator
+ else
+ assert_nil job.docker_image_locator
+ end
+ end
+ end
+
test "locate a Docker image with a partial hash" do
image_hash = links(:docker_image_collection_hash).name[0..24]
job = Job.new job_attrs(runtime_constraints:
'locator' => BAD_COLLECTION,
}.each_pair do |spec_type, image_spec|
test "Job validation fails with nonexistent Docker image #{spec_type}" do
+ Rails.configuration.RemoteClusters = ConfigLoader.to_OrderedOptions({})
job = Job.new job_attrs(runtime_constraints:
{'docker_image' => image_spec})
- assert(job.invalid?, "nonexistent Docker image #{spec_type} was valid")
+ assert(job.invalid?, "nonexistent Docker image #{spec_type} #{image_spec} was valid")
end
end
assert_equal(image_uuid, job.docker_image_locator)
end
- test "can't create Job with Docker image locator" do
+ def check_attrs_unset(job, attrs)
+ assert_empty(attrs.each_key.map { |key| job.send(key) }.compact,
+ "job has values for #{attrs.keys}")
+ end
+
+ def check_creation_prohibited(attrs)
begin
- job = Job.new job_attrs(docker_image_locator: BAD_COLLECTION)
+ job = Job.new(job_attrs(attrs))
rescue ActiveModel::MassAssignmentSecurity::Error
# Test passes - expected attribute protection
else
- assert_nil job.docker_image_locator
+ check_attrs_unset(job, attrs)
end
end
- test "can't assign Docker image locator to Job" do
- job = Job.new job_attrs
- begin
- Job.docker_image_locator = BAD_COLLECTION
- rescue NoMethodError
- # Test passes - expected attribute protection
+ def check_modification_prohibited(attrs)
+ job = Job.new(job_attrs)
+ attrs.each_pair do |key, value|
+ assert_raises(NoMethodError) { job.send("{key}=".to_sym, value) }
end
- assert_nil job.docker_image_locator
+ check_attrs_unset(job, attrs)
end
- [
- {script_parameters: ""},
- {script_parameters: []},
- {script_parameters: {symbols: :are_not_allowed_here}},
- {runtime_constraints: ""},
- {runtime_constraints: []},
- {tasks_summary: ""},
- {tasks_summary: []},
- {script_version: "no/branch/could/ever/possibly/have/this/name"},
- ].each do |invalid_attrs|
- test "validation failures set error messages: #{invalid_attrs.to_json}" do
- # Ensure valid_attrs doesn't produce errors -- otherwise we will
- # not know whether errors reported below are actually caused by
- # invalid_attrs.
- dummy = Job.create! job_attrs
-
- job = Job.create job_attrs(invalid_attrs)
- assert_raises(ActiveRecord::RecordInvalid, ArgumentError,
- "save! did not raise the expected exception") do
- job.save!
- end
- assert_not_empty job.errors, "validation failure did not provide errors"
- end
+ test "can't create Job with Docker image locator" do
+ check_creation_prohibited(docker_image_locator: BAD_COLLECTION)
end
- [
- # Each test case is of the following format
- # Array of parameters where each parameter is of the format:
- # attr name to be changed, attr value, and array of expectations (where each expectation is an array)
- [['running', false, [['state', 'Queued']]]],
- [['state', 'Running', [['started_at', 'not_nil']]]],
- [['is_locked_by_uuid', 'use_current_user_uuid', [['state', 'Queued']]], ['state', 'Running', [['running', true], ['started_at', 'not_nil'], ['success', 'nil']]]],
- [['running', false, [['state', 'Queued']]], ['state', 'Complete', [['success', true]]]],
- [['running', true, [['state', 'Running']]], ['cancelled_at', Time.now, [['state', 'Cancelled']]]],
- [['running', true, [['state', 'Running']]], ['state', 'Cancelled', [['cancelled_at', 'not_nil']]]],
- [['running', true, [['state', 'Running']]], ['success', true, [['state', 'Complete']]]],
- [['running', true, [['state', 'Running']]], ['success', false, [['state', 'Failed']]]],
- [['running', true, [['state', 'Running']]], ['state', 'Complete', [['success', true],['finished_at', 'not_nil']]]],
- [['running', true, [['state', 'Running']]], ['state', 'Failed', [['success', false],['finished_at', 'not_nil']]]],
- [['cancelled_at', Time.now, [['state', 'Cancelled']]], ['success', false, [['state', 'Cancelled'],['finished_at', 'nil'], ['cancelled_at', 'not_nil']]]],
- [['cancelled_at', Time.now, [['state', 'Cancelled'],['running', false]]], ['success', true, [['state', 'Cancelled'],['running', false],['finished_at', 'nil'],['cancelled_at', 'not_nil']]]],
- # potential migration cases
- [['state', nil, [['state', 'Queued']]]],
- [['state', nil, [['state', 'Queued']]], ['cancelled_at', Time.now, [['state', 'Cancelled']]]],
- [['running', true, [['state', 'Running']]], ['state', nil, [['state', 'Running']]]],
- ].each do |parameters|
- test "verify job status #{parameters}" do
- job = Job.create! job_attrs
- assert job.valid?, job.errors.full_messages.to_s
- assert_equal 'Queued', job.state, "job.state"
-
- parameters.each do |parameter|
- expectations = parameter[2]
- if parameter[1] == 'use_current_user_uuid'
- parameter[1] = Thread.current[:user].uuid
- end
-
- if expectations.instance_of? Array
- job[parameter[0]] = parameter[1]
- assert_equal true, job.save, job.errors.full_messages.to_s
- expectations.each do |expectation|
- if expectation[1] == 'not_nil'
- assert_not_nil job[expectation[0]], expectation[0]
- elsif expectation[1] == 'nil'
- assert_nil job[expectation[0]], expectation[0]
- else
- assert_equal expectation[1], job[expectation[0]], expectation[0]
- end
- end
- else
- raise 'I do not know how to handle this expectation'
- end
- end
- end
+ test "can't assign Docker image locator to Job" do
+ check_modification_prohibited(docker_image_locator: BAD_COLLECTION)
end
- test "Test job state changes" do
- all = ["Queued", "Running", "Complete", "Failed", "Cancelled"]
- valid = {"Queued" => all, "Running" => ["Complete", "Failed", "Cancelled"]}
- all.each do |start|
- all.each do |finish|
- if start != finish
- job = Job.create! job_attrs(state: start)
- assert_equal start, job.state
- job.state = finish
- job.save
- job.reload
- if valid[start] and valid[start].include? finish
- assert_equal finish, job.state
- else
- assert_equal start, job.state
- end
- end
- end
- end
- end
+ SDK_MASTER = "ca68b24e51992e790f29df5cc4bc54ce1da4a1c2"
+ SDK_TAGGED = "00634b2b8a492d6f121e3cf1d6587b821136a9a7"
- test "Test job locking" do
- set_user_from_auth :active_trustedclient
- job = Job.create! job_attrs
+ def sdk_constraint(version)
+ {runtime_constraints: {
+ "arvados_sdk_version" => version,
+ "docker_image" => links(:docker_image_collection_tag).name,
+ }}
+ end
- assert_equal "Queued", job.state
+ def check_job_sdk_version(expected)
+ job = yield
+ if expected.nil?
+ refute(job.valid?, "job valid with bad Arvados SDK version")
+ else
+ assert(job.valid?, "job not valid with good Arvados SDK version")
+ assert_equal(expected, job.arvados_sdk_version)
+ end
+ end
- # Should be able to lock successfully
- job.lock current_user.uuid
- assert_equal "Running", job.state
+ test "can't create job with SDK version assigned directly" do
+ check_creation_prohibited(arvados_sdk_version: SDK_MASTER)
+ end
- assert_raises ArvadosModel::AlreadyLockedError do
- # Can't lock it again
- job.lock current_user.uuid
- end
- job.reload
- assert_equal "Running", job.state
+ test "can't modify job to assign SDK version directly" do
+ check_modification_prohibited(arvados_sdk_version: SDK_MASTER)
+ end
- set_user_from_auth :project_viewer
- assert_raises ArvadosModel::AlreadyLockedError do
- # Can't lock it as a different user either
- job.lock current_user.uuid
- end
- job.reload
- assert_equal "Running", job.state
+ test 'script_parameters_digest is independent of key order' do
+ j1 = Job.new(job_attrs(script_parameters: {'a' => 'a', 'ddee' => {'d' => 'd', 'e' => 'e'}}))
+ j2 = Job.new(job_attrs(script_parameters: {'ddee' => {'e' => 'e', 'd' => 'd'}, 'a' => 'a'}))
+ assert j1.valid?
+ assert j2.valid?
+ assert_equal(j1.script_parameters_digest, j2.script_parameters_digest)
+ end
- assert_raises ArvadosModel::PermissionDeniedError do
- # Can't update fields as a different user
- job.update_attributes(state: "Failed")
+ test 'job fixtures have correct script_parameters_digest' do
+ Job.all.each do |j|
+ d = j.script_parameters_digest
+ assert_equal(j.update_script_parameters_digest, d,
+ "wrong script_parameters_digest for #{j.uuid}")
end
- job.reload
- assert_equal "Running", job.state
-
+ end
- set_user_from_auth :active_trustedclient
+ test 'deep_sort_hash on array of hashes' do
+ a = {'z' => [[{'a' => 'a', 'b' => 'b'}]]}
+ b = {'z' => [[{'b' => 'b', 'a' => 'a'}]]}
+ assert_equal Job.deep_sort_hash(a).to_json, Job.deep_sort_hash(b).to_json
+ end
- # Can update fields as the locked_by user
- job.update_attributes(state: "Failed")
- assert_equal "Failed", job.state
+ def try_find_reusable
+ foobar = jobs(:foobar)
+ example_attrs = {
+ script_version: foobar.script_version,
+ script: foobar.script,
+ script_parameters: foobar.script_parameters,
+ repository: foobar.repository,
+ }
+
+ # Two matching jobs exist with identical outputs. The older one
+ # should be reused.
+ j = Job.find_reusable(example_attrs, {}, [], [users(:active)])
+ assert j
+ assert_equal foobar.uuid, j.uuid
+
+ # Two matching jobs exist with different outputs. Neither should
+ # be reused.
+ Job.where(uuid: jobs(:job_with_latest_version).uuid).
+ update_all(output: 'aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa+1')
+ assert_nil Job.find_reusable(example_attrs, {}, [], [users(:active)])
+
+ # ...unless config says to reuse the earlier job in such cases.
+ Rails.configuration.Containers.JobsAPI.ReuseJobIfOutputsDiffer = true
+ j = Job.find_reusable(example_attrs, {}, [], [users(:active)])
+ assert_equal foobar.uuid, j.uuid
end
- test "verify job queue position" do
- job1 = Job.create! job_attrs
- assert job1.valid?, job1.errors.full_messages.to_s
- assert_equal 'Queued', job1.state, "Incorrect job state for newly created job1"
+ test 'enable legacy api configuration option = true' do
+ Rails.configuration.Containers.JobsAPI.Enable = "true"
+ check_enable_legacy_jobs_api
+ assert_equal(Disable_update_jobs_api_method_list, Rails.configuration.API.DisabledAPIs)
+ end
- job2 = Job.create! job_attrs
- assert job2.valid?, job2.errors.full_messages.to_s
- assert_equal 'Queued', job2.state, "Incorrect job state for newly created job2"
+ test 'enable legacy api configuration option = false' do
+ Rails.configuration.Containers.JobsAPI.Enable = "false"
+ check_enable_legacy_jobs_api
+ assert_equal Disable_jobs_api_method_list, Rails.configuration.API.DisabledAPIs
+ end
- assert_not_nil job1.queue_position, "Expected non-nil queue position for job1"
- assert_not_nil job2.queue_position, "Expected non-nil queue position for job2"
- assert_not_equal job1.queue_position, job2.queue_position
+ test 'enable legacy api configuration option = auto, has jobs' do
+ Rails.configuration.Containers.JobsAPI.Enable = "auto"
+ assert Job.count > 0
+ check_enable_legacy_jobs_api
+ assert_equal(Disable_update_jobs_api_method_list, Rails.configuration.API.DisabledAPIs)
end
+ test 'enable legacy api configuration option = auto, no jobs' do
+ Rails.configuration.Containers.JobsAPI.Enable = "auto"
+ act_as_system_user do
+ Job.destroy_all
+ end
+ assert_equal 0, Job.count
+ assert_equal({}, Rails.configuration.API.DisabledAPIs)
+ check_enable_legacy_jobs_api
+ assert_equal Disable_jobs_api_method_list, Rails.configuration.API.DisabledAPIs
+ end
end