rails--rails/activejob/test/cases/callbacks_test.rb

# frozen_string_literal: true

require "helper"
require "jobs/callback_job"
require "jobs/abort_before_enqueue_job"

require "active_support/core_ext/object/inclusion"

class CallbacksTest < ActiveSupport::TestCase
  test "perform callbacks" do
    performed_callback_job = CallbackJob.new("A-JOB-ID")
    performed_callback_job.perform_now
    assert "CallbackJob ran before_perform".in? performed_callback_job.history
    assert "CallbackJob ran after_perform".in? performed_callback_job.history
    assert "CallbackJob ran around_perform_start".in? performed_callback_job.history
    assert "CallbackJob ran around_perform_stop".in? performed_callback_job.history
  end

  test "enqueue callbacks" do
    enqueued_callback_job = CallbackJob.perform_later
    assert "CallbackJob ran before_enqueue".in? enqueued_callback_job.history
    assert "CallbackJob ran after_enqueue".in? enqueued_callback_job.history
    assert "CallbackJob ran around_enqueue_start".in? enqueued_callback_job.history
    assert "CallbackJob ran around_enqueue_stop".in? enqueued_callback_job.history
  end

  test "#enqueue returns false when before_enqueue aborts callback chain and return_false_on_aborted_enqueue = true" do
    prev = ActiveJob::Base.return_false_on_aborted_enqueue
    ActiveJob::Base.return_false_on_aborted_enqueue = true
    assert_equal false, AbortBeforeEnqueueJob.new.enqueue
  ensure
    ActiveJob::Base.return_false_on_aborted_enqueue = prev
  end

  test "#enqueue returns self when before_enqueue aborts callback chain and return_false_on_aborted_enqueue = false" do
    prev = ActiveJob::Base.return_false_on_aborted_enqueue
    ActiveJob::Base.return_false_on_aborted_enqueue = false
    job = AbortBeforeEnqueueJob.new
    assert_deprecated do
      assert_equal job, job.enqueue
    end
  ensure
    ActiveJob::Base.return_false_on_aborted_enqueue = prev
  end

  test "#enqueue returns self when the job was enqueued" do
    job = CallbackJob.new
    assert_equal job, job.enqueue
  end
end