Merge pull request #16724 from seuros/testcase

[ActiveJob] TestCase
This commit is contained in:
Rafael Mendonça França 2014-09-02 11:31:08 -03:00
commit 2e500e5c93
10 changed files with 531 additions and 16 deletions

View File

@ -31,4 +31,6 @@ module ActiveJob
autoload :Base
autoload :QueueAdapters
autoload :TestCase
autoload :TestHelper
end

View File

@ -8,8 +8,7 @@ require 'active_job/logging'
module ActiveJob
class Base
extend QueueAdapter
include QueueAdapter
include QueueName
include Enqueuing
include Execution

View File

@ -3,21 +3,27 @@ require 'active_support/core_ext/string/inflections'
module ActiveJob
module QueueAdapter
mattr_reader(:queue_adapter) { ActiveJob::QueueAdapters::InlineAdapter }
extend ActiveSupport::Concern
def queue_adapter=(name_or_adapter)
@@queue_adapter = \
case name_or_adapter
when Symbol, String
load_adapter(name_or_adapter)
when Class
name_or_adapter
module ClassMethods
mattr_reader(:queue_adapter) { ActiveJob::QueueAdapters::InlineAdapter }
def queue_adapter=(name_or_adapter)
@@queue_adapter = \
case name_or_adapter
when :test
ActiveJob::QueueAdapters::TestAdapter.new
when Symbol, String
load_adapter(name_or_adapter)
when Class
name_or_adapter
end
end
private
def load_adapter(name)
"ActiveJob::QueueAdapters::#{name.to_s.camelize}Adapter".constantize
end
end
private
def load_adapter(name)
"ActiveJob::QueueAdapters::#{name.to_s.camelize}Adapter".constantize
end
end
end

View File

@ -12,5 +12,6 @@ module ActiveJob
autoload :SidekiqAdapter
autoload :SneakersAdapter
autoload :SuckerPunchAdapter
autoload :TestAdapter
end
end

View File

@ -0,0 +1,75 @@
module ActiveJob
module QueueAdapters
class TestAdapter
attr_accessor(:perform_enqueued_jobs) { false }
attr_accessor(:perform_enqueued_at_jobs) { false }
# Provides a store of all the enqueued jobs with the TestAdapter so you can check them.
def enqueued_jobs
@enqueued_jobs ||= []
end
# Allows you to overwrite the default enqueued jobs store from an array to some
# other object. If you just want to clear the store,
# call ActiveJob::QueueAdapters::TestAdapter.enqueued_jobs.clear.
#
# If you place another object here, please make sure it responds to:
#
# * << (message)
# * clear
# * length
# * size
# * and other common Array methods
def enqueued_jobs=(val)
@enqueued_jobs = val
end
# Provides a store of all the performed jobs with the TestAdapter so you can check them.
def performed_jobs
@performed_jobs ||= []
end
# Allows you to overwrite the default performed jobs store from an array to some
# other object. If you just want to clear the store,
# call ActiveJob::QueueAdapters::TestAdapter.performed_jobs.clear.
#
# If you place another object here, please make sure it responds to:
#
# * << (message)
# * clear
# * length
# * size
# * and other common Array methods
def performed_jobs=(val)
@performed_jobs = val
end
def enqueue(job, *args)
if perform_enqueued_jobs?
performed_jobs << {job: job, args: args, queue: job.queue_name}
job.new.execute(*args)
else
enqueued_jobs << {job: job, args: args, queue: job.queue_name}
end
end
def enqueue_at(job, timestamp, *args)
if perform_enqueued_at_jobs?
performed_jobs << {job: job, args: args, queue: job.queue_name, run_at: timestamp}
job.new.execute(*args)
else
enqueued_jobs << {job: job, args: args, queue: job.queue_name, run_at: timestamp}
end
end
private
def perform_enqueued_jobs?
perform_enqueued_jobs
end
def perform_enqueued_at_jobs?
perform_enqueued_at_jobs
end
end
end
end

View File

@ -0,0 +1,7 @@
require 'active_support/test_case'
module ActiveJob
class TestCase < ActiveSupport::TestCase
include ActiveJob::TestHelper
end
end

View File

@ -0,0 +1,196 @@
module ActiveJob
# Provides helper methods for testing Active Job
module TestHelper
extend ActiveSupport::Concern
included do
def before_setup
@old_queue_adapter = queue_adapter
ActiveJob::Base.queue_adapter = :test
clear_enqueued_jobs
clear_performed_jobs
super
end
def after_teardown
super
ActiveJob::Base.queue_adapter = @old_queue_adapter
end
# Asserts that the number of enqueued jobs matches the given number.
#
# def test_jobs
# assert_enqueued_jobs 0
# HelloJob.enqueue('david')
# assert_enqueued_jobs 1
# HelloJob.enqueue('abdelkader')
# assert_enqueued_jobs 2
# end
#
# If a block is passed, that block should cause the specified number of
# jobs to be enqueued.
#
# def test_jobs_again
# assert_enqueued_jobs 1 do
# HelloJob.enqueue('cristian')
# end
#
# assert_enqueued_jobs 2 do
# HelloJob.enqueue('aaron')
# HelloJob.enqueue('rafael')
# end
# end
def assert_enqueued_jobs(number)
if block_given?
original_count = enqueued_jobs.size
yield
new_count = enqueued_jobs.size
assert_equal original_count + number, new_count,
"#{number} jobs expected, but #{new_count - original_count} were enqueued"
else
enqueued_jobs_size = enqueued_jobs.size
assert_equal number, enqueued_jobs_size, "#{number} jobs expected, but #{enqueued_jobs_size} were enqueued"
end
end
# Assert that no job have been enqueued.
#
# def test_jobs
# assert_no_enqueued_jobs
# HelloJob.enqueue('jeremy')
# assert_enqueued_jobs 1
# end
#
# If a block is passed, that block should 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
#
# Note: This assertion is simply a shortcut for:
#
# assert_enqueued_jobs 0
def assert_no_enqueued_jobs(&block)
assert_enqueued_jobs 0, &block
end
# Asserts that the number of performed jobs matches the given number.
#
# def test_jobs
# assert_performed_jobs 0
# HelloJob.enqueue('xavier')
# assert_performed_jobs 1
# HelloJob.enqueue('yves')
# assert_performed_jobs 2
# 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.enqueue('robin')
# end
#
# assert_performed_jobs 2 do
# HelloJob.enqueue('carlos')
# HelloJob.enqueue('sean')
# end
# end
def assert_performed_jobs(number)
if block_given?
original_count = performed_jobs.size
yield
new_count = performed_jobs.size
assert_equal original_count + number, new_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
# Asserts that no jobs have been performed.
#
# def test_jobs
# assert_no_performed_jobs
# HelloJob.enqueue('matthew')
# assert_performed_jobs 1
# end
#
# If a block is passed, that block should 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
#
# Note: This assertion is simply a shortcut for:
#
# assert_performed_jobs 0
def assert_no_performed_jobs(&block)
assert_performed_jobs 0, &block
end
# Asserts that the job passed in the block has been enqueued with the given arguments.
#
# def assert_enqueued_job
# assert_enqueued_with(job: MyJob, args: [1,2,3], queue: 'low') do
# MyJob.enqueue(1,2,3)
# end
# end
def assert_enqueued_with(args = {}, &_block)
original_enqueued_jobs = enqueued_jobs.dup
clear_enqueued_jobs
args.assert_valid_keys(:job, :args, :at, :queue)
yield
matching_job = enqueued_jobs.any? do |job|
args.all? { |key, value| value == job[key] }
end
assert matching_job
ensure
queue_adapter.enqueued_jobs = original_enqueued_jobs + enqueued_jobs
end
# Asserts that the job passed in the block has been performed with the given arguments.
#
# def test_assert_performed_with
# assert_performed_with(job: MyJob, args: [1,2,3], queue: 'high') do
# MyJob.enqueue(1,2,3)
# end
# end
def assert_performed_with(args = {}, &_block)
original_performed_jobs = performed_jobs.dup
clear_performed_jobs
args.assert_valid_keys(:job, :args, :at, :queue)
yield
matching_job = performed_jobs.any? do |job|
args.all? { |key, value| value == job[key] }
end
assert matching_job, "No performed job found with #{args}"
ensure
queue_adapter.performed_jobs = original_performed_jobs + performed_jobs
end
def queue_adapter
ActiveJob::Base.queue_adapter
end
delegate :enqueued_jobs, :enqueued_jobs=,
:performed_jobs, :performed_jobs=,
to: :queue_adapter
private
def clear_enqueued_jobs
enqueued_jobs.clear
end
def clear_performed_jobs
performed_jobs.clear
end
end
end
end

View File

@ -0,0 +1,14 @@
require 'helper'
require 'jobs/hello_job'
require 'jobs/logging_job'
require 'jobs/nested_job'
class ActiveJobTestCaseTest < ActiveJob::TestCase
def test_include_helper
assert_includes self.class.ancestors, ActiveJob::TestHelper
end
def test_set_test_adapter
assert_instance_of ActiveJob::QueueAdapters::TestAdapter, self.queue_adapter
end
end

View File

@ -0,0 +1,214 @@
require 'helper'
require 'active_support/core_ext/time'
require 'active_support/core_ext/date'
require 'jobs/hello_job'
require 'jobs/logging_job'
require 'jobs/nested_job'
class EnqueuedJobsTest < ActiveJob::TestCase
setup { queue_adapter.perform_enqueued_at_jobs = true }
def test_assert_enqueued_jobs
assert_nothing_raised do
assert_enqueued_jobs 1 do
HelloJob.enqueue('david')
end
end
end
def test_repeated_enqueued_jobs_calls
assert_nothing_raised do
assert_enqueued_jobs 1 do
HelloJob.enqueue('abdelkader')
end
end
assert_nothing_raised do
assert_enqueued_jobs 2 do
HelloJob.enqueue('sean')
HelloJob.enqueue('yves')
end
end
end
def test_assert_enqueued_jobs_with_no_block
assert_nothing_raised do
HelloJob.enqueue('rafael')
assert_enqueued_jobs 1
end
assert_nothing_raised do
HelloJob.enqueue('aaron')
HelloJob.enqueue('matthew')
assert_enqueued_jobs 3
end
end
def test_assert_no_enqueued_jobs
assert_nothing_raised do
assert_no_enqueued_jobs do
# Scheduled jobs are being performed in this context
HelloJob.enqueue_at(Date.tomorrow.noon, 'godfrey')
end
end
end
def test_assert_enqueued_jobs_too_few_sent
error = assert_raise ActiveSupport::TestCase::Assertion do
assert_enqueued_jobs 2 do
HelloJob.enqueue('xavier')
end
end
assert_match(/2 .* but 1/, error.message)
end
def test_assert_enqueued_jobs_too_many_sent
error = assert_raise ActiveSupport::TestCase::Assertion do
assert_enqueued_jobs 1 do
HelloJob.enqueue('cristian')
HelloJob.enqueue('guillermo')
end
end
assert_match(/1 .* but 2/, error.message)
end
def test_assert_no_enqueued_jobs_failure
error = assert_raise ActiveSupport::TestCase::Assertion do
assert_no_enqueued_jobs do
HelloJob.enqueue('jeremy')
end
end
assert_match(/0 .* but 1/, error.message)
end
def test_assert_enqueued_job
assert_enqueued_with(job: LoggingJob, queue: 'default') do
NestedJob.enqueue_at(Date.tomorrow.noon)
end
end
def test_assert_enqueued_job_failure
assert_raise ActiveSupport::TestCase::Assertion do
assert_enqueued_with(job: LoggingJob, queue: 'default') do
NestedJob.enqueue
end
end
assert_raise ActiveSupport::TestCase::Assertion do
assert_enqueued_with(job: NestedJob, queue: 'low') do
NestedJob.enqueue
end
end
end
def test_assert_enqueued_job_args
assert_raise ArgumentError do
assert_enqueued_with(class: LoggingJob) do
NestedJob.enqueue_at(Date.tomorrow.noon)
end
end
end
end
class PerformedJobsTest < ActiveJob::TestCase
setup { queue_adapter.perform_enqueued_jobs = true }
def test_assert_performed_jobs
assert_nothing_raised do
assert_performed_jobs 1 do
HelloJob.enqueue('david')
end
end
end
def test_repeated_performed_jobs_calls
assert_nothing_raised do
assert_performed_jobs 1 do
HelloJob.enqueue('abdelkader')
end
end
assert_nothing_raised do
assert_performed_jobs 2 do
HelloJob.enqueue('sean')
HelloJob.enqueue('yves')
end
end
end
def test_assert_performed_jobs_with_no_block
assert_nothing_raised do
HelloJob.enqueue('rafael')
assert_performed_jobs 1
end
assert_nothing_raised do
HelloJob.enqueue('aaron')
HelloJob.enqueue('matthew')
assert_performed_jobs 3
end
end
def test_assert_no_performed_jobs
assert_nothing_raised do
assert_no_performed_jobs do
# Scheduled jobs are being enqueued in this context
HelloJob.enqueue_at(Date.tomorrow.noon, 'godfrey')
end
end
end
def test_assert_performed_jobs_too_few_sent
error = assert_raise ActiveSupport::TestCase::Assertion do
assert_performed_jobs 2 do
HelloJob.enqueue('xavier')
end
end
assert_match(/2 .* but 1/, error.message)
end
def test_assert_performed_jobs_too_many_sent
error = assert_raise ActiveSupport::TestCase::Assertion do
assert_performed_jobs 1 do
HelloJob.enqueue('cristian')
HelloJob.enqueue('guillermo')
end
end
assert_match(/1 .* but 2/, error.message)
end
def test_assert_no_performed_jobs_failure
error = assert_raise ActiveSupport::TestCase::Assertion do
assert_no_performed_jobs do
HelloJob.enqueue('jeremy')
end
end
assert_match(/0 .* but 1/, error.message)
end
def test_assert_performed_job
assert_performed_with(job: NestedJob, queue: 'default') do
NestedJob.enqueue
end
end
def test_assert_performed_job_failure
assert_raise ActiveSupport::TestCase::Assertion do
assert_performed_with(job: LoggingJob, queue: 'default') do
NestedJob.enqueue_at(Date.tomorrow.noon)
end
end
assert_raise ActiveSupport::TestCase::Assertion do
assert_performed_with(job: NestedJob, queue: 'low') do
NestedJob.enqueue_at(Date.tomorrow.noon)
end
end
end
end

View File

@ -1,7 +1,8 @@
require 'test_helper'
<% module_namespacing do -%>
class <%= class_name %>JobTest < ActiveSupport::TestCase
class <%= class_name %>JobTest < ActiveJob::TestCase
# test "the truth" do
# assert true
# end