[ActiveJob] TestCase

activejob/lib/active_job/queue_adapter.rb

@@ -6,14 +6,13 @@ module ActiveJob
     extend ActiveSupport::Concern
 
     module ClassMethods
-      delegate :performed_jobs, :performed_jobs=,
-               :enqueued_jobs, :enqueued_jobs=,
-               to: ActiveJob::QueueAdapters::TestAdapter
       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

activejob/lib/active_job/queue_adapters/test_adapter.rb

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

activejob/lib/active_job/test_case.rb

@@ -2,102 +2,7 @@
 require 'active_support/test_case'
 
 module ActiveJob
-  class NonInferrableJobError < ::StandardError
-    def initialize(name)
-      super "Unable to determine the job to test from #{name}. " \
-                "You'll need to specify it using 'tests YourJob' in your " \
-                'test case definition'
-    end
-  end
-
   class TestCase < ActiveSupport::TestCase
-    module Behavior
-      extend ActiveSupport::Concern
-
-      include ActiveSupport::Testing::ConstantLookup
       include ActiveJob::TestHelper
-
-      included do
-        class_attribute :_job_class
-        setup :initialize_test_adapter
-        teardown :restore_previous_adapter
-      end
-
-      module ClassMethods
-        def tests(job)
-          case job
-            when String, Symbol
-              self._job_class = job.to_s.camelize.constantize
-            when Module
-              self._job_class = job
-            else
-              fail NonInferrableJobError.new(job)
-          end
-        end
-
-        def job_class
-          if job = _job_class
-            job
-          else
-            tests determine_default_job(name)
-          end
-        end
-
-        def determine_default_job(name)
-          job = determine_constant_from_test_name(name) do |constant|
-            Class === constant && constant < ActiveJob::Base
-          end
-          fail NonInferrableJobError.new(name) if job.nil?
-          job
-        end
-      end
-
-      protected
-        def initialize_test_adapter
-          @old_adapter = ActiveJob::Base.queue_adapter
-          ActiveJob::Base.queue_adapter = :test
-          save_test_adapter_behavior
-        end
-
-        def save_test_adapter_behavior
-          @old_perform_enqueued_jobs = queue_adapter.perform_enqueued_jobs
-          @old_perform_enqueued_at_jobs = queue_adapter.perform_enqueued_at_jobs
-        end
-
-        def restore_test_adapter_behavior
-          queue_adapter.perform_enqueued_jobs = @old_perform_enqueued_jobs
-          queue_adapter.perform_enqueued_at_jobs = @old_perform_enqueued_at_jobs
-        end
-
-        def restore_previous_adapter
-          restore_test_adapter_behavior
-          ActiveJob::Base.queue_adapter = @old_adapter
-          ActiveJob::Base.performed_jobs.clear
-          ActiveJob::Base.enqueued_jobs.clear
-        end
-
-        def perform_enqueued_jobs
-          queue_adapter.perform_enqueued_jobs = true
-        end
-
-        def perform_enqueued_at_jobs
-          queue_adapter.perform_enqueued_at_jobs = true
-        end
-
-        def enqueue_jobs
-          queue_adapter.perform_enqueued_jobs = false
-        end
-
-        def enqueue_at_jobs
-          queue_adapter.perform_enqueued_at_jobs = false
-        end
-
-      private
-        def queue_adapter
-          ActiveJob::Base.queue_adapter
-        end
-    end
-
-    include Behavior
   end
 end

activejob/lib/active_job/test_helper.rb

@@ -2,169 +2,192 @@
 module ActiveJob
   # Provides helper methods for testing Active Job
   module TestHelper
-    # Asserts that the number of enqueued jobs matches the given number.
+    extend ActiveSupport::Concern
-    #
+    include ActiveSupport::Testing::ConstantLookup
-    #   def test_jobs
+
-    #     assert_enqueued_jobs 0
+    included do
-    #     HelloJob.enqueue('david')
+      class_attribute :_job_class
-    #     assert_enqueued_jobs 1
+      setup :initialize_queue_test_adapter
-    #     HelloJob.enqueue('abdelkader')
+
-    #     assert_enqueued_jobs 2
+      # Asserts that the number of enqueued jobs matches the given number.
-    #   end
+      #
-    #
+      #   def test_jobs
-    # If a block is passed, that block should cause the specified number of
+      #     assert_enqueued_jobs 0
-    # jobs to be enqueued.
+      #     HelloJob.enqueue('david')
-    #
+      #     assert_enqueued_jobs 1
-    #   def test_jobs_again
+      #     HelloJob.enqueue('abdelkader')
-    #     assert_enqueued_jobs 1 do
+      #     assert_enqueued_jobs 2
-    #       HelloJob.enqueue('cristian')
+      #   end
-    #     end
+      #
-    #
+      # If a block is passed, that block should cause the specified number of
-    #     assert_enqueued_jobs 2 do
+      # jobs to be enqueued.
-    #       HelloJob.enqueue('aaron')
+      #
-    #       HelloJob.enqueue('rafael')
+      #   def test_jobs_again
-    #     end
+      #     assert_enqueued_jobs 1 do
-    #   end
+      #       HelloJob.enqueue('cristian')
-    def assert_enqueued_jobs(number)
+      #     end
-      if block_given?
+      #
-        original_count = enqueued_jobs.size
+      #     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
+          assert_equal number, enqueued_jobs.size
+        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
+          assert_equal number, performed_jobs.size
+        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
-        new_count = enqueued_jobs.size
+        matching_job = enqueued_jobs.any? do |job|
-        assert_equal original_count + number, new_count,
+          args.all? { |key, value| value == job[key] }
-                     "#{number} job expected, but #{new_count - original_count} were enqueued"
+        end
-      else
+        assert matching_job
-        assert_equal number, enqueued_jobs.size
+      ensure
+        queue_adapter.enqueued_jobs = original_enqueued_jobs + enqueued_jobs
       end
-    end
 
-    # Assert that no job have been enqueued.
+      # Asserts that the job passed in the block has been performed with the given arguments.
-    #
+      #
-    #   def test_jobs
+      #   def test_assert_performed_with
-    #     assert_no_enqueued_jobs
+      #     assert_performed_with(job: MyJob, args: [1,2,3], queue: 'high') do
-    #     HelloJob.enqueue('jeremy')
+      #       MyJob.enqueue(1,2,3)
-    #     assert_enqueued_jobs 1
+      #     end
-    #   end
+      #   end
-    #
+      def assert_performed_with(args = {}, &_block)
-    # If a block is passed, that block should not cause any job to be enqueued.
+        original_performed_jobs = performed_jobs.dup
-    #
+        clear_performed_jobs
-    #   def test_jobs_again
+        args.assert_valid_keys(:job, :args, :at, :queue)
-    #     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 = self.class.job_class.performed_jobs.size
         yield
-        new_count = performed_jobs.size
+        matching_job = performed_jobs.any? do |job|
-        assert_equal original_count + number, new_count,
+          args.all? { |key, value| value == job[key] }
-                     "#{number} job expected, but #{new_count - original_count} were performed"
+        end
-      else
+        assert matching_job, "No performed job found with #{args}"
-        assert_equal number, performed_jobs.size
+      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 initialize_queue_test_adapter
+         ActiveJob::Base.queue_adapter = :test
+         clear_enqueued_jobs
+         clear_performed_jobs
+        end
+
+        def clear_enqueued_jobs
+          enqueued_jobs.clear
+        end
+
+        def clear_performed_jobs
+          performed_jobs.clear
+        end
     end
-
-    # Assert that no job 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
-
-    # Assert that a job was enqueued in the block matches the args
-    #
-    #   def assert_enqueued_job
-    #     assert_enqueued_job(job: MyJob, args: [1,2,3], queue: 'low') do
-    #       MyJob.enqueue(1,2,3)
-    #     end
-    #   end
-    def assert_enqueued_job(args = {}, &_block)
-      original_enqueued_jobs = enqueued_jobs
-      enqueued_jobs.clear
-      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
-      ActiveJob::Base.enqueued_jobs = original_enqueued_jobs + enqueued_jobs
-    end
-
-    # Assert that a job was performed in the block matches the args
-    #
-    #   def assert_performed_job
-    #     assert_performed_job(job: MyJob, args: [1,2,3], queue: 'high') do
-    #       MyJob.enqueue(1,2,3)
-    #     end
-    #   end
-    def assert_performed_job(args = {}, &_block)
-      original_performed_jobs = performed_jobs
-      performed_jobs.clear
-      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
-      ActiveJob::Base.performed_jobs = original_performed_jobs + performed_jobs
-    end
-
-    private
-      def enqueued_jobs
-        ActiveJob::Base.enqueued_jobs
-      end
-
-      def performed_jobs
-        ActiveJob::Base.performed_jobs
-      end
   end
 end

activejob/test/cases/test_case_test.rb

@@ -0,0 +1,15 @@
+# encoding: utf-8
+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

activejob/test/cases/test_helper_test.rb

@@ -7,8 +7,7 @@ require 'jobs/logging_job'
 require 'jobs/nested_job'
 
 class EnqueuedJobsTest < ActiveJob::TestCase
-  tests HelloJob
+  setup { queue_adapter.perform_enqueued_at_jobs = true }
-  setup :perform_enqueued_at_jobs
 
   def test_assert_enqueued_jobs
     assert_nothing_raised do
@@ -87,20 +86,20 @@ class EnqueuedJobsTest < ActiveJob::TestCase
   end
 
   def test_assert_enqueued_job
-    assert_enqueued_job(job: LoggingJob, queue: 'default') do
+    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_job(job: LoggingJob, queue: 'default') do
+      assert_enqueued_with(job: LoggingJob, queue: 'default') do
         NestedJob.enqueue
       end
     end
 
     assert_raise ActiveSupport::TestCase::Assertion do
-      assert_enqueued_job(job: NestedJob, queue: 'low') do
+      assert_enqueued_with(job: NestedJob, queue: 'low') do
         NestedJob.enqueue
       end
     end
@@ -108,7 +107,7 @@ class EnqueuedJobsTest < ActiveJob::TestCase
 
   def test_assert_enqueued_job_args
     assert_raise ArgumentError do
-      assert_enqueued_job(class: LoggingJob) do
+      assert_enqueued_with(class: LoggingJob) do
         NestedJob.enqueue_at(Date.tomorrow.noon)
       end
     end
@@ -116,8 +115,7 @@ class EnqueuedJobsTest < ActiveJob::TestCase
 end
 
 class PerformedJobsTest < ActiveJob::TestCase
-  tests HelloJob
+  setup { queue_adapter.perform_enqueued_jobs = true }
-  setup :perform_enqueued_jobs
 
   def test_assert_performed_jobs
     assert_nothing_raised do
@@ -196,20 +194,20 @@ class PerformedJobsTest < ActiveJob::TestCase
   end
 
   def test_assert_performed_job
-    assert_performed_job(job: NestedJob, queue: 'default') do
+    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_job(job: LoggingJob, queue: 'default') 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_job(job: NestedJob, queue: 'low') do
+      assert_performed_with(job: NestedJob, queue: 'low') do
         NestedJob.enqueue_at(Date.tomorrow.noon)
       end
     end

activejob/test/cases/test_test.rb

@@ -1,43 +0,0 @@
-# encoding: utf-8
-require 'helper'
-require 'jobs/hello_job'
-require 'jobs/logging_job'
-require 'jobs/nested_job'
-
-class ActiveJobTestCaseTest < ActiveJob::TestCase
-  tests HelloJob
-
-  def test_set_job_class_manual
-    assert_equal HelloJob, self.class.job_class
-  end
-end
-
-class CrazySymbolNameJobTest < ActiveJob::TestCase
-  tests :hello_job
-
-  def test_set_job_class_manual_using_symbol
-    assert_equal HelloJob, self.class.job_class
-  end
-end
-
-class CrazyStringNameJobTest < ActiveJob::TestCase
-  tests 'hello_job'
-
-  def test_set_job_class_manual_using_string
-    assert_equal HelloJob, self.class.job_class
-  end
-end
-
-class HelloJobTest < ActiveJob::TestCase
-  def test_set_job_class_manual
-    assert_equal HelloJob, self.class.job_class
-  end
-end
-
-class CrazyNameJobTest < ActiveJob::TestCase
-  def test_determine_default_job_raises_correct_error
-    assert_raise(ActiveJob::NonInferrableJobError) do
-      self.class.job_class
-    end
-  end
-end

railties/lib/rails/generators/test_unit/job/templates/unit_test.rb.erb

@@ -2,7 +2,6 @@ require 'test_helper'
 
 <% module_namespacing do -%>
 class <%= class_name %>JobTest < ActiveJob::TestCase
-  tests <%= class_name %>Job
 
   # test "the truth" do
   #   assert true