instance method
assert_enqueued_jobs
Ruby on Rails 5.2.8.1
Since v4.2.9Signature
assert_enqueued_jobs(number, only: nil, except: nil, queue: nil)Asserts that the number of enqueued jobs matches the given number.
def test_jobs
assert_enqueued_jobs 0
HelloJob.perform_later('david')
assert_enqueued_jobs 1
HelloJob.perform_later('abdelkader')
assert_enqueued_jobs 2
end
If a block is passed, that block will cause the specified number of jobs to be enqueued.
def test_jobs_again
assert_enqueued_jobs 1 do
HelloJob.perform_later('cristian')
end
assert_enqueued_jobs 2 do
HelloJob.perform_later('aaron')
HelloJob.perform_later('rafael')
end
end
The number of times a specific job was enqueued can be asserted.
def test_logging_job
assert_enqueued_jobs 1, only: LoggingJob do
LoggingJob.perform_later
HelloJob.perform_later('jeremy')
end
end
The number of times a job except specific class was enqueued can be asserted.
def test_logging_job
assert_enqueued_jobs 1, except: HelloJob do
LoggingJob.perform_later
HelloJob.perform_later('jeremy')
end
end
The number of times a job is enqueued to a specific queue can also be asserted.
def test_logging_job
assert_enqueued_jobs 2, queue: 'default' do
LoggingJob.perform_later
HelloJob.perform_later('elfassy')
end
end
Parameters
-
numberreq -
onlykey = nil -
exceptkey = nil -
queuekey = nil
Source
# File activejob/lib/active_job/test_helper.rb, line 118
def assert_enqueued_jobs(number, only: nil, except: nil, queue: nil)
if block_given?
original_count = enqueued_jobs_size(only: only, except: except, queue: queue)
yield
new_count = enqueued_jobs_size(only: only, except: except, queue: queue)
assert_equal number, new_count - original_count, "#{number} jobs expected, but #{new_count - original_count} were enqueued"
else
actual_count = enqueued_jobs_size(only: only, except: except, queue: queue)
assert_equal number, actual_count, "#{number} jobs expected, but #{actual_count} were enqueued"
end
end
Defined in activejob/lib/active_job/test_helper.rb line 118
· View on GitHub
· Improve this page
· Find usages on GitHub
Defined in ActiveJob::TestHelper