require 'test_helper'
require 'helpers/git_test_helper'

class JobTest < ActiveSupport::TestCase
  include GitTestHelper

  BAD_COLLECTION = "#{'f' * 32}+0"

  setup do
    set_user_from_auth :active
  end

  def job_attrs merge_me={}
    # Default (valid) set of attributes, with given overrides
    {
      script: "hash",
      script_version: "master",
      repository: "foo",
    }.merge(merge_me)
  end

  test "Job without Docker image doesn't get locator" do
    job = Job.new job_attrs
    assert job.valid?, job.errors.full_messages.to_s
    assert_nil job.docker_image_locator
  end

  { 'name' => [:links, :docker_image_collection_tag, :name],
    'hash' => [:links, :docker_image_collection_hash, :name],
    'locator' => [:collections, :docker_image, :portable_data_hash],
  }.each_pair do |spec_type, (fixture_type, fixture_name, fixture_attr)|
    test "Job initialized with Docker image #{spec_type} gets locator" do
      image_spec = send(fixture_type, fixture_name).send(fixture_attr)
      job = Job.new job_attrs(runtime_constraints:
                              {'docker_image' => image_spec})
      assert job.valid?, job.errors.full_messages.to_s
      assert_equal(collections(:docker_image).portable_data_hash, job.docker_image_locator)
    end

    test "Job modified with Docker image #{spec_type} gets locator" do
      job = Job.new job_attrs
      assert job.valid?, job.errors.full_messages.to_s
      assert_nil job.docker_image_locator
      image_spec = send(fixture_type, fixture_name).send(fixture_attr)
      job.runtime_constraints['docker_image'] = image_spec
      assert job.valid?, job.errors.full_messages.to_s
      assert_equal(collections(:docker_image).portable_data_hash, job.docker_image_locator)
    end
  end

  test "removing a Docker runtime constraint removes the locator" do
    image_locator = collections(:docker_image).portable_data_hash
    job = Job.new job_attrs(runtime_constraints:
                            {'docker_image' => image_locator})
    assert job.valid?, job.errors.full_messages.to_s
    assert_equal(image_locator, job.docker_image_locator)
    job.runtime_constraints = {}
    assert job.valid?, job.errors.full_messages.to_s + "after clearing runtime constraints"
    assert_nil job.docker_image_locator
  end

  test "locate a Docker image with a repository + tag" do
    image_repo, image_tag =
      links(:docker_image_collection_tag2).name.split(':', 2)
    job = Job.new job_attrs(runtime_constraints:
                            {'docker_image' => image_repo,
                              'docker_image_tag' => image_tag})
    assert job.valid?, job.errors.full_messages.to_s
    assert_equal(collections(:docker_image).portable_data_hash, job.docker_image_locator)
  end

  test "can't locate a Docker image with a nonexistent tag" do
    image_repo = links(:docker_image_collection_tag).name
    image_tag = '__nonexistent tag__'
    job = Job.new job_attrs(runtime_constraints:
                            {'docker_image' => image_repo,
                              'docker_image_tag' => image_tag})
    assert(job.invalid?, "Job with bad Docker tag valid")
  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:
                            {'docker_image' => image_hash})
    assert job.valid?, job.errors.full_messages.to_s + " with partial hash #{image_hash}"
    assert_equal(collections(:docker_image).portable_data_hash, job.docker_image_locator)
  end

  { 'name' => 'arvados_test_nonexistent',
    'hash' => 'f' * 64,
    'locator' => BAD_COLLECTION,
  }.each_pair do |spec_type, image_spec|
    test "Job validation fails with nonexistent Docker image #{spec_type}" do
      job = Job.new job_attrs(runtime_constraints:
                              {'docker_image' => image_spec})
      assert(job.invalid?, "nonexistent Docker image #{spec_type} was valid")
    end
  end

  test "Job validation fails with non-Docker Collection constraint" do
    job = Job.new job_attrs(runtime_constraints:
                            {'docker_image' => collections(:foo_file).uuid})
    assert(job.invalid?, "non-Docker Collection constraint was valid")
  end

  test "can create Job with Docker image Collection without Docker links" do
    image_uuid = collections(:unlinked_docker_image).portable_data_hash
    job = Job.new job_attrs(runtime_constraints: {"docker_image" => image_uuid})
    assert(job.valid?, "Job created with unlinked Docker image was invalid")
    assert_equal(image_uuid, job.docker_image_locator)
  end

  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(attrs))
    rescue ActiveModel::MassAssignmentSecurity::Error
      # Test passes - expected attribute protection
    else
      check_attrs_unset(job, attrs)
    end
  end

  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
    check_attrs_unset(job, attrs)
  end

  test "can't create Job with Docker image locator" do
    check_creation_prohibited(docker_image_locator: BAD_COLLECTION)
  end

  test "can't assign Docker image locator to Job" do
    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.
      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
  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 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
  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 "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"
    assert_not_equal job1.queue_position, job2.queue_position
  end

  SDK_MASTER = "ca68b24e51992e790f29df5cc4bc54ce1da4a1c2"
  SDK_TAGGED = "00634b2b8a492d6f121e3cf1d6587b821136a9a7"

  def sdk_constraint(version)
    {runtime_constraints: {
        "arvados_sdk_version" => version,
        "docker_image" => links(:docker_image_collection_tag).name,
      }}
  end

  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

  { "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

  test "can't modify job to assign SDK version directly" do
    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 = 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
end