706 lines
23 KiB
Ruby
706 lines
23 KiB
Ruby
# frozen_string_literal: true
|
|
|
|
require "active_support/core_ext/class/subclasses"
|
|
require "active_support/testing/assertions"
|
|
|
|
module ActiveJob
|
|
# Provides helper methods for testing Active Job
|
|
module TestHelper
|
|
delegate :enqueued_jobs, :enqueued_jobs=,
|
|
:performed_jobs, :performed_jobs=,
|
|
to: :queue_adapter
|
|
|
|
include ActiveSupport::Testing::Assertions
|
|
|
|
module TestQueueAdapter
|
|
extend ActiveSupport::Concern
|
|
|
|
included do
|
|
class_attribute :_test_adapter, instance_accessor: false, instance_predicate: false
|
|
end
|
|
|
|
module ClassMethods
|
|
def queue_adapter
|
|
self._test_adapter.nil? ? super : self._test_adapter
|
|
end
|
|
|
|
def disable_test_adapter
|
|
self._test_adapter = nil
|
|
end
|
|
|
|
def enable_test_adapter(test_adapter)
|
|
self._test_adapter = test_adapter
|
|
end
|
|
end
|
|
end
|
|
|
|
ActiveJob::Base.include(TestQueueAdapter)
|
|
|
|
def before_setup # :nodoc:
|
|
test_adapter = queue_adapter_for_test
|
|
|
|
queue_adapter_changed_jobs.each do |klass|
|
|
klass.enable_test_adapter(test_adapter)
|
|
end
|
|
|
|
clear_enqueued_jobs
|
|
clear_performed_jobs
|
|
super
|
|
end
|
|
|
|
def after_teardown # :nodoc:
|
|
super
|
|
|
|
queue_adapter_changed_jobs.each { |klass| klass.disable_test_adapter }
|
|
end
|
|
|
|
# Specifies the queue adapter to use with all Active Job test helpers.
|
|
#
|
|
# Returns an instance of the queue adapter and defaults to
|
|
# <tt>ActiveJob::QueueAdapters::TestAdapter</tt>.
|
|
#
|
|
# Note: The adapter provided by this method must provide some additional
|
|
# methods from those expected of a standard <tt>ActiveJob::QueueAdapter</tt>
|
|
# in order to be used with the active job test helpers. Refer to
|
|
# <tt>ActiveJob::QueueAdapters::TestAdapter</tt>.
|
|
def queue_adapter_for_test
|
|
ActiveJob::QueueAdapters::TestAdapter.new
|
|
end
|
|
|
|
# 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, asserts that the 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
|
|
#
|
|
# Asserts the number of times a specific job was enqueued by passing +:only+ option.
|
|
#
|
|
# def test_logging_job
|
|
# assert_enqueued_jobs 1, only: LoggingJob do
|
|
# LoggingJob.perform_later
|
|
# HelloJob.perform_later('jeremy')
|
|
# end
|
|
# end
|
|
#
|
|
# Asserts the number of times a job except specific class was enqueued by passing +:except+ option.
|
|
#
|
|
# def test_logging_job
|
|
# assert_enqueued_jobs 1, except: HelloJob do
|
|
# LoggingJob.perform_later
|
|
# HelloJob.perform_later('jeremy')
|
|
# end
|
|
# end
|
|
#
|
|
# +:only+ and +:except+ options accepts Class, Array of Class or Proc. When passed a Proc,
|
|
# a hash containing the job's class and it's argument are passed as argument.
|
|
#
|
|
# Asserts the number of times a job is enqueued to a specific queue by passing +:queue+ option.
|
|
#
|
|
# def test_logging_job
|
|
# assert_enqueued_jobs 2, queue: 'default' do
|
|
# LoggingJob.perform_later
|
|
# HelloJob.perform_later('elfassy')
|
|
# end
|
|
# end
|
|
def assert_enqueued_jobs(number, only: nil, except: nil, queue: nil, &block)
|
|
if block_given?
|
|
original_jobs = enqueued_jobs_with(only: only, except: except, queue: queue)
|
|
|
|
assert_nothing_raised(&block)
|
|
|
|
new_jobs = enqueued_jobs_with(only: only, except: except, queue: queue)
|
|
|
|
actual_count = (new_jobs - original_jobs).count
|
|
else
|
|
actual_count = enqueued_jobs_with(only: only, except: except, queue: queue).count
|
|
end
|
|
|
|
assert_equal number, actual_count, "#{number} jobs expected, but #{actual_count} were enqueued"
|
|
end
|
|
|
|
# Asserts that no jobs have been enqueued.
|
|
#
|
|
# def test_jobs
|
|
# assert_no_enqueued_jobs
|
|
# HelloJob.perform_later('jeremy')
|
|
# assert_enqueued_jobs 1
|
|
# end
|
|
#
|
|
# If a block is passed, asserts that the block will not cause any job to be enqueued.
|
|
#
|
|
# def test_jobs_again
|
|
# assert_no_enqueued_jobs do
|
|
# # No job should be enqueued from this block
|
|
# end
|
|
# end
|
|
#
|
|
# Asserts that no jobs of a specific kind are enqueued by passing +:only+ option.
|
|
#
|
|
# def test_no_logging
|
|
# assert_no_enqueued_jobs only: LoggingJob do
|
|
# HelloJob.perform_later('jeremy')
|
|
# end
|
|
# end
|
|
#
|
|
# Asserts that no jobs except specific class are enqueued by passing +:except+ option.
|
|
#
|
|
# def test_no_logging
|
|
# assert_no_enqueued_jobs except: HelloJob do
|
|
# HelloJob.perform_later('jeremy')
|
|
# end
|
|
# end
|
|
#
|
|
# +:only+ and +:except+ options accepts Class, Array of Class or Proc. When passed a Proc,
|
|
# a hash containing the job's class and it's argument are passed as argument.
|
|
#
|
|
# Asserts that no jobs are enqueued to a specific queue by passing +:queue+ option
|
|
#
|
|
# def test_no_logging
|
|
# assert_no_enqueued_jobs queue: 'default' do
|
|
# LoggingJob.set(queue: :some_queue).perform_later
|
|
# end
|
|
# end
|
|
#
|
|
# Note: This assertion is simply a shortcut for:
|
|
#
|
|
# assert_enqueued_jobs 0, &block
|
|
def assert_no_enqueued_jobs(only: nil, except: nil, queue: nil, &block)
|
|
assert_enqueued_jobs 0, only: only, except: except, queue: queue, &block
|
|
end
|
|
|
|
# Asserts that the number of performed jobs matches the given number.
|
|
# If no block is passed, <tt>perform_enqueued_jobs</tt>
|
|
# must be called around or after the job call.
|
|
#
|
|
# def test_jobs
|
|
# assert_performed_jobs 0
|
|
#
|
|
# perform_enqueued_jobs do
|
|
# HelloJob.perform_later('xavier')
|
|
# end
|
|
# assert_performed_jobs 1
|
|
#
|
|
# HelloJob.perform_later('yves')
|
|
#
|
|
# perform_enqueued_jobs
|
|
#
|
|
# assert_performed_jobs 2
|
|
# end
|
|
#
|
|
# If a block is passed, asserts that the block will 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
|
|
#
|
|
# This method also 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
|
|
#
|
|
# A proc may also be specified. When passed a Proc, the job's instance will be passed as argument.
|
|
#
|
|
# def test_hello_and_logging_jobs
|
|
# assert_nothing_raised do
|
|
# assert_performed_jobs(1, only: ->(job) { job.is_a?(HelloJob) }) do
|
|
# HelloJob.perform_later('jeremy')
|
|
# LoggingJob.perform_later('stewie')
|
|
# RescueJob.perform_later('david')
|
|
# end
|
|
# end
|
|
# end
|
|
#
|
|
# If the +:queue+ option is specified,
|
|
# then only the job(s) enqueued to a specific queue will be performed.
|
|
#
|
|
# def test_assert_performed_jobs_with_queue_option
|
|
# assert_performed_jobs 1, queue: :some_queue do
|
|
# HelloJob.set(queue: :some_queue).perform_later("jeremy")
|
|
# HelloJob.set(queue: :other_queue).perform_later("bogdan")
|
|
# end
|
|
# end
|
|
def assert_performed_jobs(number, only: nil, except: nil, queue: nil, &block)
|
|
if block_given?
|
|
original_count = performed_jobs.size
|
|
|
|
perform_enqueued_jobs(only: only, except: except, queue: queue, &block)
|
|
|
|
new_count = performed_jobs.size
|
|
|
|
performed_jobs_size = new_count - original_count
|
|
else
|
|
performed_jobs_size = performed_jobs_with(only: only, except: except, queue: queue).count
|
|
end
|
|
|
|
assert_equal number, performed_jobs_size, "#{number} jobs expected, but #{performed_jobs_size} were performed"
|
|
end
|
|
|
|
# Asserts that no jobs have been performed.
|
|
#
|
|
# def test_jobs
|
|
# assert_no_performed_jobs
|
|
#
|
|
# perform_enqueued_jobs do
|
|
# HelloJob.perform_later('matthew')
|
|
# assert_performed_jobs 1
|
|
# end
|
|
# end
|
|
#
|
|
# If a block is passed, asserts that the block will not cause any job to be performed.
|
|
#
|
|
# def test_jobs_again
|
|
# assert_no_performed_jobs do
|
|
# # No job should be performed from this block
|
|
# end
|
|
# end
|
|
#
|
|
# The block form supports filtering. If the +:only+ option is specified,
|
|
# then only the listed job(s) will not be performed.
|
|
#
|
|
# def test_no_logging
|
|
# assert_no_performed_jobs only: LoggingJob do
|
|
# HelloJob.perform_later('jeremy')
|
|
# end
|
|
# end
|
|
#
|
|
# Also if the +:except+ option is specified,
|
|
# then the job(s) except specific class will not be performed.
|
|
#
|
|
# def test_no_logging
|
|
# assert_no_performed_jobs except: HelloJob do
|
|
# HelloJob.perform_later('jeremy')
|
|
# end
|
|
# end
|
|
#
|
|
# +:only+ and +:except+ options accepts Class, Array of Class or Proc. When passed a Proc,
|
|
# an instance of the job will be passed as argument.
|
|
#
|
|
# If the +:queue+ option is specified,
|
|
# then only the job(s) enqueued to a specific queue will not be performed.
|
|
#
|
|
# def test_assert_no_performed_jobs_with_queue_option
|
|
# assert_no_performed_jobs queue: :some_queue do
|
|
# HelloJob.set(queue: :other_queue).perform_later("jeremy")
|
|
# end
|
|
# end
|
|
#
|
|
# Note: This assertion is simply a shortcut for:
|
|
#
|
|
# assert_performed_jobs 0, &block
|
|
def assert_no_performed_jobs(only: nil, except: nil, queue: nil, &block)
|
|
assert_performed_jobs 0, only: only, except: except, queue: queue, &block
|
|
end
|
|
|
|
# Asserts that the job has been enqueued with the given arguments.
|
|
#
|
|
# def test_assert_enqueued_with
|
|
# MyJob.perform_later(1,2,3)
|
|
# assert_enqueued_with(job: MyJob, args: [1,2,3])
|
|
#
|
|
# MyJob.set(wait_until: Date.tomorrow.noon, queue: "my_queue").perform_later
|
|
# assert_enqueued_with(at: Date.tomorrow.noon, queue: "my_queue")
|
|
# end
|
|
#
|
|
# The given arguments may also be specified as matcher procs that return a
|
|
# boolean value indicating whether a job's attribute meets certain criteria.
|
|
#
|
|
# For example, a proc can be used to match a range of times:
|
|
#
|
|
# def test_assert_enqueued_with
|
|
# at_matcher = ->(job_at) { (Date.yesterday..Date.tomorrow).cover?(job_at) }
|
|
#
|
|
# MyJob.set(wait_until: Date.today.noon).perform_later
|
|
#
|
|
# assert_enqueued_with(job: MyJob, at: at_matcher)
|
|
# end
|
|
#
|
|
# A proc can also be used to match a subset of a job's args:
|
|
#
|
|
# def test_assert_enqueued_with
|
|
# args_matcher = ->(job_args) { job_args[0].key?(:foo) }
|
|
#
|
|
# MyJob.perform_later(foo: "bar", other_arg: "No need to check in the test")
|
|
#
|
|
# assert_enqueued_with(job: MyJob, args: args_matcher)
|
|
# end
|
|
#
|
|
# If a block is passed, asserts that the block will cause the job to be
|
|
# enqueued with the given arguments.
|
|
#
|
|
# def test_assert_enqueued_with
|
|
# assert_enqueued_with(job: MyJob, args: [1,2,3]) 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
|
|
def assert_enqueued_with(job: nil, args: nil, at: nil, queue: nil, &block)
|
|
expected = { job: job, args: args, at: at, queue: queue }.compact
|
|
expected_args = prepare_args_for_assertion(expected)
|
|
potential_matches = []
|
|
|
|
if block_given?
|
|
original_enqueued_jobs = enqueued_jobs.dup
|
|
|
|
assert_nothing_raised(&block)
|
|
|
|
jobs = enqueued_jobs - original_enqueued_jobs
|
|
else
|
|
jobs = enqueued_jobs
|
|
end
|
|
|
|
matching_job = jobs.find do |enqueued_job|
|
|
deserialized_job = deserialize_args_for_assertion(enqueued_job)
|
|
potential_matches << deserialized_job
|
|
|
|
expected_args.all? do |key, value|
|
|
if value.respond_to?(:call)
|
|
value.call(deserialized_job[key])
|
|
else
|
|
value == deserialized_job[key]
|
|
end
|
|
end
|
|
end
|
|
|
|
message = +"No enqueued job found with #{expected}"
|
|
message << "\n\nPotential matches: #{potential_matches.join("\n")}" if potential_matches.present?
|
|
assert matching_job, message
|
|
instantiate_job(matching_job)
|
|
end
|
|
|
|
# Asserts that the job has been performed with the given arguments.
|
|
#
|
|
# def test_assert_performed_with
|
|
# MyJob.perform_later(1,2,3)
|
|
#
|
|
# perform_enqueued_jobs
|
|
#
|
|
# assert_performed_with(job: MyJob, args: [1,2,3])
|
|
#
|
|
# MyJob.set(wait_until: Date.tomorrow.noon, queue: "my_queue").perform_later
|
|
#
|
|
# perform_enqueued_jobs
|
|
#
|
|
# assert_performed_with(at: Date.tomorrow.noon, queue: "my_queue")
|
|
# end
|
|
#
|
|
# The given arguments may also be specified as matcher procs that return a
|
|
# boolean value indicating whether a job's attribute meets certain criteria.
|
|
#
|
|
# For example, a proc can be used to match a range of times:
|
|
#
|
|
# def test_assert_performed_with
|
|
# at_matcher = ->(job_at) { (Date.yesterday..Date.tomorrow).cover?(job_at) }
|
|
#
|
|
# MyJob.set(wait_until: Date.today.noon).perform_later
|
|
#
|
|
# perform_enqueued_jobs
|
|
#
|
|
# assert_performed_with(job: MyJob, at: at_matcher)
|
|
# end
|
|
#
|
|
# A proc can also be used to match a subset of a job's args:
|
|
#
|
|
# def test_assert_performed_with
|
|
# args_matcher = ->(job_args) { job_args[0].key?(:foo) }
|
|
#
|
|
# MyJob.perform_later(foo: "bar", other_arg: "No need to check in the test")
|
|
#
|
|
# perform_enqueued_jobs
|
|
#
|
|
# assert_performed_with(job: MyJob, args: args_matcher)
|
|
# end
|
|
#
|
|
# If a block is passed, that block performs all of the jobs that were
|
|
# enqueued throughout the duration of the block and asserts that
|
|
# the job has been performed with the given arguments in the block.
|
|
#
|
|
# def test_assert_performed_with
|
|
# assert_performed_with(job: MyJob, args: [1,2,3]) do
|
|
# MyJob.perform_later(1,2,3)
|
|
# end
|
|
#
|
|
# assert_performed_with(job: MyJob, at: Date.tomorrow.noon) do
|
|
# MyJob.set(wait_until: Date.tomorrow.noon).perform_later
|
|
# end
|
|
# end
|
|
def assert_performed_with(job: nil, args: nil, at: nil, queue: nil, &block)
|
|
expected = { job: job, args: args, at: at, queue: queue }.compact
|
|
expected_args = prepare_args_for_assertion(expected)
|
|
potential_matches = []
|
|
|
|
if block_given?
|
|
original_performed_jobs_count = performed_jobs.count
|
|
|
|
perform_enqueued_jobs(&block)
|
|
|
|
jobs = performed_jobs.drop(original_performed_jobs_count)
|
|
else
|
|
jobs = performed_jobs
|
|
end
|
|
|
|
matching_job = jobs.find do |enqueued_job|
|
|
deserialized_job = deserialize_args_for_assertion(enqueued_job)
|
|
potential_matches << deserialized_job
|
|
|
|
expected_args.all? do |key, value|
|
|
if value.respond_to?(:call)
|
|
value.call(deserialized_job[key])
|
|
else
|
|
value == deserialized_job[key]
|
|
end
|
|
end
|
|
end
|
|
|
|
message = +"No performed job found with #{expected}"
|
|
message << "\n\nPotential matches: #{potential_matches.join("\n")}" if potential_matches.present?
|
|
assert matching_job, message
|
|
|
|
instantiate_job(matching_job)
|
|
end
|
|
|
|
# Performs all enqueued jobs. If a block is given, performs all of the jobs
|
|
# that were enqueued throughout the duration of the block. If a block is
|
|
# not given, performs all of the enqueued jobs up to this point in the test.
|
|
#
|
|
# def test_perform_enqueued_jobs
|
|
# perform_enqueued_jobs do
|
|
# MyJob.perform_later(1, 2, 3)
|
|
# end
|
|
# assert_performed_jobs 1
|
|
# end
|
|
#
|
|
# def test_perform_enqueued_jobs_without_block
|
|
# MyJob.perform_later(1, 2, 3)
|
|
#
|
|
# perform_enqueued_jobs
|
|
#
|
|
# assert_performed_jobs 1
|
|
# end
|
|
#
|
|
# This method also supports filtering. If the +:only+ option is specified,
|
|
# then only the listed job(s) will be performed.
|
|
#
|
|
# def test_perform_enqueued_jobs_with_only
|
|
# perform_enqueued_jobs(only: MyJob) do
|
|
# MyJob.perform_later(1, 2, 3) # will be performed
|
|
# HelloJob.perform_later(1, 2, 3) # will not be performed
|
|
# end
|
|
# assert_performed_jobs 1
|
|
# end
|
|
#
|
|
# Also if the +:except+ option is specified,
|
|
# then the job(s) except specific class will be performed.
|
|
#
|
|
# def test_perform_enqueued_jobs_with_except
|
|
# perform_enqueued_jobs(except: HelloJob) do
|
|
# MyJob.perform_later(1, 2, 3) # will be performed
|
|
# HelloJob.perform_later(1, 2, 3) # will not be performed
|
|
# end
|
|
# assert_performed_jobs 1
|
|
# end
|
|
#
|
|
# +:only+ and +:except+ options accepts Class, Array of Class or Proc. When passed a Proc,
|
|
# an instance of the job will be passed as argument.
|
|
#
|
|
# If the +:queue+ option is specified,
|
|
# then only the job(s) enqueued to a specific queue will be performed.
|
|
#
|
|
# def test_perform_enqueued_jobs_with_queue
|
|
# perform_enqueued_jobs queue: :some_queue do
|
|
# MyJob.set(queue: :some_queue).perform_later(1, 2, 3) # will be performed
|
|
# HelloJob.set(queue: :other_queue).perform_later(1, 2, 3) # will not be performed
|
|
# end
|
|
# assert_performed_jobs 1
|
|
# end
|
|
#
|
|
# If the +:at+ option is specified, then only run jobs enqueued to run
|
|
# immediately or before the given time
|
|
def perform_enqueued_jobs(only: nil, except: nil, queue: nil, at: nil, &block)
|
|
return flush_enqueued_jobs(only: only, except: except, queue: queue, at: at) unless block_given?
|
|
|
|
validate_option(only: only, except: except)
|
|
|
|
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
|
|
old_reject = queue_adapter.reject
|
|
old_queue = queue_adapter.queue
|
|
old_at = queue_adapter.at
|
|
|
|
begin
|
|
queue_adapter.perform_enqueued_jobs = true
|
|
queue_adapter.perform_enqueued_at_jobs = true
|
|
queue_adapter.filter = only
|
|
queue_adapter.reject = except
|
|
queue_adapter.queue = queue
|
|
queue_adapter.at = at
|
|
|
|
assert_nothing_raised(&block)
|
|
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
|
|
queue_adapter.reject = old_reject
|
|
queue_adapter.queue = old_queue
|
|
queue_adapter.at = old_at
|
|
end
|
|
end
|
|
|
|
# Accesses the queue_adapter set by ActiveJob::Base.
|
|
#
|
|
# def test_assert_job_has_custom_queue_adapter_set
|
|
# assert_instance_of CustomQueueAdapter, HelloJob.queue_adapter
|
|
# end
|
|
def queue_adapter
|
|
ActiveJob::Base.queue_adapter
|
|
end
|
|
|
|
private
|
|
def clear_enqueued_jobs
|
|
enqueued_jobs.clear
|
|
end
|
|
|
|
def clear_performed_jobs
|
|
performed_jobs.clear
|
|
end
|
|
|
|
def jobs_with(jobs, only: nil, except: nil, queue: nil, at: nil)
|
|
validate_option(only: only, except: except)
|
|
|
|
jobs.dup.select do |job|
|
|
job_class = job.fetch(:job)
|
|
|
|
if only
|
|
next false unless filter_as_proc(only).call(job)
|
|
elsif except
|
|
next false if filter_as_proc(except).call(job)
|
|
end
|
|
|
|
if queue
|
|
next false unless queue.to_s == job.fetch(:queue, job_class.queue_name)
|
|
end
|
|
|
|
if at && job[:at]
|
|
next false if job[:at] > at.to_f
|
|
end
|
|
|
|
yield job if block_given?
|
|
|
|
true
|
|
end
|
|
end
|
|
|
|
def filter_as_proc(filter)
|
|
return filter if filter.is_a?(Proc)
|
|
|
|
->(job) { Array(filter).include?(job.fetch(:job)) }
|
|
end
|
|
|
|
def enqueued_jobs_with(only: nil, except: nil, queue: nil, at: nil, &block)
|
|
jobs_with(enqueued_jobs, only: only, except: except, queue: queue, at: at, &block)
|
|
end
|
|
|
|
def performed_jobs_with(only: nil, except: nil, queue: nil, &block)
|
|
jobs_with(performed_jobs, only: only, except: except, queue: queue, &block)
|
|
end
|
|
|
|
def flush_enqueued_jobs(only: nil, except: nil, queue: nil, at: nil)
|
|
enqueued_jobs_with(only: only, except: except, queue: queue, at: at) do |payload|
|
|
queue_adapter.enqueued_jobs.delete(payload)
|
|
queue_adapter.performed_jobs << payload
|
|
instantiate_job(payload).perform_now
|
|
end.count
|
|
end
|
|
|
|
def prepare_args_for_assertion(args)
|
|
args.dup.tap do |arguments|
|
|
if arguments[:at].acts_like?(:time)
|
|
at_range = arguments[:at] - 1..arguments[:at] + 1
|
|
arguments[:at] = ->(at) { at_range.cover?(at) }
|
|
end
|
|
end
|
|
end
|
|
|
|
def deserialize_args_for_assertion(job)
|
|
job.dup.tap do |new_job|
|
|
new_job[:at] = Time.at(new_job[:at]) if new_job[:at]
|
|
new_job[:args] = ActiveJob::Arguments.deserialize(new_job[:args]) if new_job[:args]
|
|
end
|
|
end
|
|
|
|
def instantiate_job(payload)
|
|
job = payload[:job].deserialize(payload)
|
|
job.scheduled_at = Time.at(payload[:at]) if payload.key?(:at)
|
|
job.send(:deserialize_arguments_if_needed)
|
|
job
|
|
end
|
|
|
|
def queue_adapter_changed_jobs
|
|
(ActiveJob::Base.descendants << 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
|
|
end
|
|
|
|
def validate_option(only: nil, except: nil)
|
|
raise ArgumentError, "Cannot specify both `:only` and `:except` options." if only && except
|
|
end
|
|
end
|
|
end
|