instance method `assert_enqueued_with`

Ruby on Rails 5.2.8.1

Since v4.2.9

Available in: v4.2.9 v5.2.8.1 v6.0.6 v6.1.7.10 v7.0.10 v7.1.6 v7.2.3 v8.0.4 v8.1.2

Compare with:

assert_enqueued_with(job: nil, args: nil, at: nil, queue: nil)

Asserts that the job passed in the block has been enqueued with the given arguments.

def test_assert_enqueued_with
  assert_enqueued_with(job: MyJob, args: [1,2,3], queue: 'low') do
    MyJob.perform_later(1,2,3)
  end

  assert_enqueued_with(job: MyJob, at: Date.tomorrow.noon) do
    MyJob.set(wait_until: Date.tomorrow.noon).perform_later
  end
end

Parameters

job key = nil
args key = nil
at key = nil
queue key = nil

Source

# File activejob/lib/active_job/test_helper.rb, line 300
    def assert_enqueued_with(job: nil, args: nil, at: nil, queue: nil)
      original_enqueued_jobs_count = enqueued_jobs.count
      expected = { job: job, args: args, at: at, queue: queue }.compact
      expected_args = prepare_args_for_assertion(expected)
      yield
      in_block_jobs = enqueued_jobs.drop(original_enqueued_jobs_count)
      matching_job = in_block_jobs.find do |in_block_job|
        deserialized_job = deserialize_args_for_assertion(in_block_job)
        expected_args.all? { |key, value| value == deserialized_job[key] }
      end
      assert matching_job, "No enqueued job found with #{expected}"
      instantiate_job(matching_job)
    end

Defined in activejob/lib/active_job/test_helper.rb line 300 · View on GitHub · Improve this page · Find usages on GitHub

Defined in ActiveJob::TestHelper

Signature

Parameters