Merge branch 'master' into 16811-public-favs
[arvados.git] / services / api / test / unit / job_test.rb
index 761953e8eb4e441f3e30cacf86a1f45ddf816e6c..c529aab8b653947ef0d8f64db7fed64c5000c523 100644 (file)
@@ -1,7 +1,13 @@
+# 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"
@@ -84,7 +90,7 @@ class JobTest < ActiveSupport::TestCase
   ].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.default_docker_image_for_jobs = default_docker_image if use_config
+      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
@@ -98,16 +104,6 @@ class JobTest < ActiveSupport::TestCase
     end
   end
 
-  test "create a job with a disambiguated script_version branch name" do
-    job = Job.
-      new(script: "testscript",
-          script_version: "heads/7387838c69a21827834586cc42b467ff6c63293b",
-          repository: "active/shabranchnames",
-          script_parameters: {})
-    assert(job.save)
-    assert_equal("abec49829bf1758413509b7ffcab32a771b71e81", job.script_version)
-  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:
@@ -121,9 +117,10 @@ class JobTest < ActiveSupport::TestCase
     '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
 
@@ -171,171 +168,6 @@ class JobTest < ActiveSupport::TestCase
     check_modification_prohibited(docker_image_locator: BAD_COLLECTION)
   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.
-      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
-  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_equal 'Queued', job.state, "job.state"
-
-      parameters.each do |parameter|
-        expectations = parameter[2]
-        if 'use_current_user_uuid' == parameter[1]
-          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
-  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
-
-  test "Test job locking" do
-    set_user_from_auth :active_trustedclient
-    job = Job.create! job_attrs
-
-    assert_equal "Queued", job.state
-
-    # Should be able to lock successfully
-    job.lock current_user.uuid
-    assert_equal "Running", job.state
-
-    assert_raises ArvadosModel::AlreadyLockedError do
-      # Can't lock it again
-      job.lock current_user.uuid
-    end
-    job.reload
-    assert_equal "Running", job.state
-
-    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
-
-    assert_raises ArvadosModel::PermissionDeniedError do
-      # Can't update fields as a different user
-      job.update_attributes(state: "Failed")
-    end
-    job.reload
-    assert_equal "Running", job.state
-
-
-    set_user_from_auth :active_trustedclient
-
-    # Can update fields as the locked_by user
-    job.update_attributes(state: "Failed")
-    assert_equal "Failed", job.state
-  end
-
-  test "admin user can cancel a running job despite lock" do
-    set_user_from_auth :active_trustedclient
-    job = Job.create! job_attrs
-    job.lock current_user.uuid
-    assert_equal Job::Running, job.state
-
-    set_user_from_auth :spectator
-    assert_raises do
-      job.update_attributes!(state: Job::Cancelled)
-    end
-
-    set_user_from_auth :admin
-    job.reload
-    assert_equal Job::Running, job.state
-    job.update_attributes!(state: Job::Cancelled)
-    assert_equal Job::Cancelled, job.state
-  end
-
-  test "verify job queue position" do
-    job1 = Job.create! job_attrs
-    assert_equal 'Queued', job1.state, "Incorrect job state for newly created job1"
-
-    job2 = Job.create! job_attrs
-    assert_equal 'Queued', job2.state, "Incorrect job state for newly created job2"
-
-    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"
-  end
-
   SDK_MASTER = "ca68b24e51992e790f29df5cc4bc54ce1da4a1c2"
   SDK_TAGGED = "00634b2b8a492d6f121e3cf1d6587b821136a9a7"
 
@@ -356,61 +188,6 @@ class JobTest < ActiveSupport::TestCase
     end
   end
 
-  { "master" => SDK_MASTER,
-    "commit2" => SDK_TAGGED,
-    SDK_TAGGED[0, 8] => SDK_TAGGED,
-    "__nonexistent__" => nil,
-  }.each_pair do |search, commit_hash|
-    test "creating job with SDK version '#{search}'" do
-      check_job_sdk_version(commit_hash) do
-        Job.new(job_attrs(sdk_constraint(search)))
-      end
-    end
-
-    test "updating job from no SDK to version '#{search}'" do
-      job = Job.create!(job_attrs)
-      assert_nil job.arvados_sdk_version
-      check_job_sdk_version(commit_hash) do
-        job.runtime_constraints = sdk_constraint(search)[:runtime_constraints]
-        job
-      end
-    end
-
-    test "updating job from SDK version 'master' to '#{search}'" do
-      job = Job.create!(job_attrs(sdk_constraint("master")))
-      assert_equal(SDK_MASTER, job.arvados_sdk_version)
-      check_job_sdk_version(commit_hash) do
-        job.runtime_constraints = sdk_constraint(search)[:runtime_constraints]
-        job
-      end
-    end
-  end
-
-  test "clear the SDK version" do
-    job = Job.create!(job_attrs(sdk_constraint("master")))
-    assert_equal(SDK_MASTER, job.arvados_sdk_version)
-    job.runtime_constraints = {}
-    assert(job.valid?, "job invalid after clearing SDK version")
-    assert_nil(job.arvados_sdk_version)
-  end
-
-  test "job with SDK constraint, without Docker image is invalid" do
-    sdk_attrs = sdk_constraint("master")
-    sdk_attrs[:runtime_constraints].delete("docker_image")
-    job = Job.create(job_attrs(sdk_attrs))
-    refute(job.valid?, "Job valid with SDK version, without Docker image")
-    sdk_errors = job.errors.messages[:arvados_sdk_version] || []
-    refute_empty(sdk_errors.grep(/\bDocker\b/),
-                 "no Job SDK errors mention that Docker is required")
-  end
-
-  test "invalid to clear Docker image constraint when SDK constraint exists" do
-    job = Job.create!(job_attrs(sdk_constraint("master")))
-    job.runtime_constraints.delete("docker_image")
-    refute(job.valid?,
-           "Job with SDK constraint valid after clearing Docker image")
-  end
-
   test "can't create job with SDK version assigned directly" do
     check_creation_prohibited(arvados_sdk_version: SDK_MASTER)
   end
@@ -419,46 +196,6 @@ class JobTest < ActiveSupport::TestCase
     check_modification_prohibited(arvados_sdk_version: SDK_MASTER)
   end
 
-  test "job validation fails when collection uuid found in script_parameters" do
-    bad_params = {
-      script_parameters: {
-        'input' => {
-          'param1' => 'the collection uuid zzzzz-4zz18-012345678901234'
-        }
-      }
-    }
-    assert_raises(ActiveRecord::RecordInvalid,
-                  "created job with a collection uuid in script_parameters") do
-      Job.create!(job_attrs(bad_params))
-    end
-  end
-
-  test "job validation succeeds when no collection uuid in script_parameters" do
-    good_params = {
-      script_parameters: {
-        'arg1' => 'foo',
-        'arg2' => [ 'bar', 'baz' ],
-        'arg3' => {
-          'a' => 1,
-          'b' => [2, 3, 4],
-        }
-      }
-    }
-    job = Job.create!(job_attrs(good_params))
-    assert job.valid?
-  end
-
-  test 'update job uuid tag in internal.git when version changes' do
-    authorize_with :active
-    j = jobs :queued
-    j.update_attributes repository: 'active/foo', script_version: 'b1'
-    assert_equal('1de84a854e2b440dc53bf42f8548afa4c17da332',
-                 internal_tag(j.uuid))
-    j.update_attributes repository: 'active/foo', script_version: 'master'
-    assert_equal('077ba2ad3ea24a929091a9e6ce545c93199b8e57',
-                 internal_tag(j.uuid))
-  end
-
   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'}))
@@ -481,7 +218,7 @@ class JobTest < ActiveSupport::TestCase
     assert_equal Job.deep_sort_hash(a).to_json, Job.deep_sort_hash(b).to_json
   end
 
-  test 'find_reusable' do
+  def try_find_reusable
     foobar = jobs(:foobar)
     example_attrs = {
       script_version: foobar.script_version,
@@ -501,5 +238,40 @@ class JobTest < ActiveSupport::TestCase
     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 '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
+
+  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
+
+  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