instance method
assert_performed_jobs
Ruby on Rails 5.2.8.1
Since v4.2.9Signature
assert_performed_jobs(number, only: nil, except: nil)
Asserts that the number of performed jobs matches the given number. If no block is passed, perform_enqueued_jobs must be called around the job call.
def test_jobs
assert_performed_jobs 0
perform_enqueued_jobs do
HelloJob.perform_later('xavier')
end
assert_performed_jobs 1
perform_enqueued_jobs do
HelloJob.perform_later('yves')
assert_performed_jobs 2
end
end
If a block is passed, that block should cause the specified number of jobs to be performed.
def test_jobs_again
assert_performed_jobs 1 do
HelloJob.perform_later('robin')
end
assert_performed_jobs 2 do
HelloJob.perform_later('carlos')
HelloJob.perform_later('sean')
end
end
The block form supports filtering. If the :only option is specified, then only the listed job(s) will be performed.
def test_hello_job
assert_performed_jobs 1, only: HelloJob do
HelloJob.perform_later('jeremy')
LoggingJob.perform_later
end
end
Also if the :except option is specified, then the job(s) except specific class will be performed.
def test_hello_job
assert_performed_jobs 1, except: LoggingJob do
HelloJob.perform_later('jeremy')
LoggingJob.perform_later
end
end
An array may also be specified, to support testing multiple jobs.
def test_hello_and_logging_jobs
assert_nothing_raised do
assert_performed_jobs 2, only: [HelloJob, LoggingJob] do
HelloJob.perform_later('jeremy')
LoggingJob.perform_later('stewie')
RescueJob.perform_later('david')
end
end
end
Parameters
-
numberreq -
onlykey = nil -
exceptkey = nil
Source
# File activejob/lib/active_job/test_helper.rb, line 232
def assert_performed_jobs(number, only: nil, except: nil)
if block_given?
original_count = performed_jobs.size
perform_enqueued_jobs(only: only, except: except) { yield }
new_count = performed_jobs.size
assert_equal number, new_count - original_count,
"#{number} jobs expected, but #{new_count - original_count} were performed"
else
performed_jobs_size = performed_jobs.size
assert_equal number, performed_jobs_size, "#{number} jobs expected, but #{performed_jobs_size} were performed"
end
end
Defined in activejob/lib/active_job/test_helper.rb line 232
· View on GitHub
· Improve this page
· Find usages on GitHub
Defined in ActiveJob::TestHelper