module ActiveJob::TestHelper
def after_teardown # :nodoc:
def after_teardown # :nodoc: super @old_queue_adapters.each do |(klass, adapter)| klass.queue_adapter = adapter end end
def assert_enqueued_jobs(number, only: nil)
end
HelloJob.perform_later('jeremy')
LoggingJob.perform_later
assert_enqueued_jobs 1, only: LoggingJob do
def test_logging_job
The number of times a specific job is enqueued can be asserted.
end
end
HelloJob.perform_later('rafael')
HelloJob.perform_later('aaron')
assert_enqueued_jobs 2 do
end
HelloJob.perform_later('cristian')
assert_enqueued_jobs 1 do
def test_jobs_again
jobs to be enqueued.
If a block is passed, that block should cause the specified number of
end
assert_enqueued_jobs 2
HelloJob.perform_later('abdelkader')
assert_enqueued_jobs 1
HelloJob.perform_later('david')
assert_enqueued_jobs 0
def test_jobs
Asserts that the number of enqueued jobs matches the given number.
def assert_enqueued_jobs(number, only: nil) if block_given? original_count = enqueued_jobs_size(only: only) yield new_count = enqueued_jobs_size(only: only) 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) assert_equal number, actual_count, "#{number} jobs expected, but #{actual_count} were enqueued" end end
def assert_enqueued_with(args = {})
end
MyJob.set(wait_until: Date.tomorrow.noon).perform_later
assert_enqueued_with(job: MyJob, at: Date.tomorrow.noon) do
end
MyJob.perform_later(1,2,3)
assert_enqueued_with(job: MyJob, args: [1,2,3], queue: 'low') do
def test_assert_enqueued_with
Asserts that the job passed in the block has been enqueued with the given arguments.
def assert_enqueued_with(args = {}) original_enqueued_jobs_count = enqueued_jobs.count args.assert_valid_keys(:job, :args, :at, :queue) serialized_args = serialize_args_for_assertion(args) yield in_block_jobs = enqueued_jobs.drop(original_enqueued_jobs_count) matching_job = in_block_jobs.find do |job| serialized_args.all? { |key, value| value == job[key] } end assert matching_job, "No enqueued job found with #{args}" instantiate_job(matching_job) end
def assert_no_enqueued_jobs(only: nil, &block)
Note: This assertion is simply a shortcut for:
end
end
HelloJob.perform_later('jeremy')
assert_no_enqueued_jobs only: LoggingJob do
def test_no_logging
It can be asserted that no jobs of a specific kind are enqueued:
end
end
# No job should be enqueued from this block
assert_no_enqueued_jobs do
def test_jobs_again
If a block is passed, that block should not cause any job to be enqueued.
end
assert_enqueued_jobs 1
HelloJob.perform_later('jeremy')
assert_no_enqueued_jobs
def test_jobs
Asserts that no jobs have been enqueued.
def assert_no_enqueued_jobs(only: nil, &block) assert_enqueued_jobs 0, only: only, &block end
def assert_no_performed_jobs(only: nil, &block)
Note: This assertion is simply a shortcut for:
end
end
HelloJob.perform_later('jeremy')
assert_no_performed_jobs only: LoggingJob do
def test_no_logging
then only the listed job(s) will not be performed.
The block form supports filtering. If the :only option is specified,
end
end
# No job should be performed from this block
assert_no_performed_jobs do
def test_jobs_again
If a block is passed, that block should not cause any job to be performed.
end
end
assert_performed_jobs 1
HelloJob.perform_later('matthew')
perform_enqueued_jobs do
assert_no_performed_jobs
def test_jobs
Asserts that no jobs have been performed.
def assert_no_performed_jobs(only: nil, &block) assert_performed_jobs 0, only: only, &block end
def assert_performed_jobs(number, only: nil)
end
end
RescueJob.perform_later('david')
LoggingJob.perform_later('stewie')
HelloJob.perform_later('jeremy')
assert_performed_jobs 2, only: [HelloJob, LoggingJob] do
assert_nothing_raised do
def test_hello_and_logging_jobs
An array may also be specified, to support testing multiple jobs.
end
end
LoggingJob.perform_later
HelloJob.perform_later('jeremy')
assert_performed_jobs 1, only: HelloJob do
def test_hello_job
then only the listed job(s) will be performed.
The block form supports filtering. If the :only option is specified,
end
end
HelloJob.perform_later('sean')
HelloJob.perform_later('carlos')
assert_performed_jobs 2 do
end
HelloJob.perform_later('robin')
assert_performed_jobs 1 do
def test_jobs_again
jobs to be performed.
If a block is passed, that block should cause the specified number of
end
end
assert_performed_jobs 2
HelloJob.perform_later('yves')
perform_enqueued_jobs do
assert_performed_jobs 1
end
HelloJob.perform_later('xavier')
perform_enqueued_jobs do
assert_performed_jobs 0
def test_jobs
must be called around the job call.
If no block is passed, perform_enqueued_jobs
Asserts that the number of performed jobs matches the given number.
def assert_performed_jobs(number, only: nil) if block_given? original_count = performed_jobs.size perform_enqueued_jobs(only: only) { 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
def assert_performed_with(args = {})
end
MyJob.set(wait_until: Date.tomorrow.noon).perform_later
assert_performed_with(job: MyJob, at: Date.tomorrow.noon) do
end
MyJob.perform_later(1,2,3)
assert_performed_with(job: MyJob, args: [1,2,3], queue: 'high') do
def test_assert_performed_with
Asserts that the job passed in the block has been performed with the given arguments.
def assert_performed_with(args = {}) original_performed_jobs_count = performed_jobs.count args.assert_valid_keys(:job, :args, :at, :queue) serialized_args = serialize_args_for_assertion(args) perform_enqueued_jobs { yield } in_block_jobs = performed_jobs.drop(original_performed_jobs_count) matching_job = in_block_jobs.find do |job| serialized_args.all? { |key, value| value == job[key] } end assert matching_job, "No performed job found with #{args}" instantiate_job(matching_job) end
def before_setup # :nodoc:
def before_setup # :nodoc: test_adapter = ActiveJob::QueueAdapters::TestAdapter.new @old_queue_adapters = (ActiveJob::Base.subclasses << ActiveJob::Base).select do |klass| # only override explicitly set adapters, a quirk of `class_attribute` klass.singleton_class.public_instance_methods(false).include?(:_queue_adapter) end.map do |klass| [klass, klass.queue_adapter].tap do klass.queue_adapter = test_adapter end end clear_enqueued_jobs clear_performed_jobs super end
def clear_enqueued_jobs # :nodoc:
def clear_enqueued_jobs # :nodoc: enqueued_jobs.clear end
def clear_performed_jobs # :nodoc:
def clear_performed_jobs # :nodoc: performed_jobs.clear end
def enqueued_jobs_size(only: nil) # :nodoc:
def enqueued_jobs_size(only: nil) # :nodoc: if only enqueued_jobs.count { |job| Array(only).include?(job.fetch(:job)) } else enqueued_jobs.count end end
def instantiate_job(payload) # :nodoc:
def instantiate_job(payload) # :nodoc: job = payload[:job].new(*payload[:args]) job.scheduled_at = Time.at(payload[:at]) if payload.key?(:at) job.queue_name = payload[:queue] job end
def perform_enqueued_jobs(only: nil)
def perform_enqueued_jobs(only: nil) old_perform_enqueued_jobs = queue_adapter.perform_enqueued_jobs old_perform_enqueued_at_jobs = queue_adapter.perform_enqueued_at_jobs old_filter = queue_adapter.filter begin queue_adapter.perform_enqueued_jobs = true queue_adapter.perform_enqueued_at_jobs = true queue_adapter.filter = only yield ensure queue_adapter.perform_enqueued_jobs = old_perform_enqueued_jobs queue_adapter.perform_enqueued_at_jobs = old_perform_enqueued_at_jobs queue_adapter.filter = old_filter end end
def queue_adapter
def queue_adapter ActiveJob::Base.queue_adapter end
def serialize_args_for_assertion(args) # :nodoc:
def serialize_args_for_assertion(args) # :nodoc: args.dup.tap do |serialized_args| serialized_args[:args] = ActiveJob::Arguments.serialize(serialized_args[:args]) if serialized_args[:args] serialized_args[:at] = serialized_args[:at].to_f if serialized_args[:at] end end