Merge pull request #29815 from posthumanism/add-except-option

Add `except` option for ActiveJob::TestHelper methods

2 files changed, 81 insertions, 15 deletions

diff --git a/activejob/lib/active_job/queue_adapters/test_adapter.rb b/activejob/lib/active_job/queue_adapters/test_adapter.rb
index 43566b433c..885f9ff01c 100644
--- a/activejob/lib/active_job/queue_adapters/test_adapter.rb
+++ b/activejob/lib/active_job/queue_adapters/test_adapter.rb
@@ -12,7 +12,7 @@ module ActiveJob
     #
     #   Rails.application.config.active_job.queue_adapter = :test
     class TestAdapter
-      attr_accessor(:perform_enqueued_jobs, :perform_enqueued_at_jobs, :filter)
+      attr_accessor(:perform_enqueued_jobs, :perform_enqueued_at_jobs, :filter, :reject)
       attr_writer(:enqueued_jobs, :performed_jobs)
 
       # Provides a store of all the enqueued jobs with the TestAdapter so you can check them.
@@ -54,7 +54,13 @@ module ActiveJob
         end
 
         def filtered?(job)
-          filter && !Array(filter).include?(job.class)
+          if filter
+            !Array(filter).include?(job.class)
+          elsif reject
+            Array(reject).include?(job.class)
+          else
+            false
+          end
         end
     end
   end
diff --git a/activejob/lib/active_job/test_helper.rb b/activejob/lib/active_job/test_helper.rb
index 1807521d04..dd3a709f55 100644
--- a/activejob/lib/active_job/test_helper.rb
+++ b/activejob/lib/active_job/test_helper.rb
@@ -6,6 +6,7 @@ require "active_support/core_ext/hash/keys"
 module ActiveJob
   # Provides helper methods for testing Active Job
   module TestHelper
+    class InvalidOptionsError < StandardError; end
     delegate :enqueued_jobs, :enqueued_jobs=,
       :performed_jobs, :performed_jobs=,
       to: :queue_adapter
@@ -89,7 +90,7 @@ module ActiveJob
     #     end
     #   end
     #
-    # The number of times a specific job is enqueued can be asserted.
+    # The number of times a specific job was enqueued can be asserted.
     #
     #   def test_logging_job
     #     assert_enqueued_jobs 1, only: LoggingJob do
@@ -98,6 +99,15 @@ module ActiveJob
     #     end
     #   end
     #
+    # The number of times a job except specific class was enqueued can be asserted.
+    #
+    #   def test_logging_job
+    #     assert_enqueued_jobs 1, except: HelloJob do
+    #       LoggingJob.perform_later
+    #       HelloJob.perform_later('jeremy')
+    #     end
+    #   end
+    #
     # The number of times a job is enqueued to a specific queue can also be asserted.
     #
     #   def test_logging_job
@@ -106,14 +116,14 @@ module ActiveJob
     #       HelloJob.perform_later('elfassy')
     #     end
     #   end
-    def assert_enqueued_jobs(number, only: nil, queue: nil)
+    def assert_enqueued_jobs(number, only: nil, except: except, queue: nil)
       if block_given?
-        original_count = enqueued_jobs_size(only: only, queue: queue)
+        original_count = enqueued_jobs_size(only: only, except: except, queue: queue)
         yield
-        new_count = enqueued_jobs_size(only: only, queue: queue)
+        new_count = enqueued_jobs_size(only: only, except: except, queue: queue)
         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, queue: queue)
+        actual_count = enqueued_jobs_size(only: only, except: except, queue: queue)
         assert_equal number, actual_count, "#{number} jobs expected, but #{actual_count} were enqueued"
       end
     end
@@ -142,11 +152,19 @@ module ActiveJob
     #     end
     #   end
     #
+    # It can be asserted that no jobs except specific class are enqueued:
+    #
+    #   def test_no_logging
+    #     assert_no_enqueued_jobs except: HelloJob do
+    #       HelloJob.perform_later('jeremy')
+    #     end
+    #   end
+    #
     # Note: This assertion is simply a shortcut for:
     #
     #   assert_enqueued_jobs 0, &block
-    def assert_no_enqueued_jobs(only: nil, &block)
-      assert_enqueued_jobs 0, only: only, &block
+    def assert_no_enqueued_jobs(only: nil, except: except, &block)
+      assert_enqueued_jobs 0, only: only, except: except, &block
     end
 
     # Asserts that the number of performed jobs matches the given number.
@@ -191,6 +209,16 @@ module ActiveJob
     #       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
@@ -202,10 +230,10 @@ module ActiveJob
     #         end
     #       end
     #     end
-    def assert_performed_jobs(number, only: nil)
+    def assert_performed_jobs(number, only: nil, except: nil)
       if block_given?
         original_count = performed_jobs.size
-        perform_enqueued_jobs(only: only) { yield }
+        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"
@@ -243,11 +271,20 @@ module ActiveJob
     #     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
+    #
     # Note: This assertion is simply a shortcut for:
     #
     #   assert_performed_jobs 0, &block
-    def assert_no_performed_jobs(only: nil, &block)
-      assert_performed_jobs 0, only: only, &block
+    def assert_no_performed_jobs(only: nil, except: nil, &block)
+      assert_performed_jobs 0, only: only, except: except, &block
     end
 
     # Asserts that the job passed in the block has been enqueued with the given arguments.
@@ -317,20 +354,36 @@ module ActiveJob
     #     end
     #     assert_performed_jobs 1
     #   end
-    def perform_enqueued_jobs(only: nil)
+    #
+    # 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
+    #
+    def perform_enqueued_jobs(only: nil, except: nil)
+      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
 
       begin
         queue_adapter.perform_enqueued_jobs = true
         queue_adapter.perform_enqueued_at_jobs = true
         queue_adapter.filter = only
+        queue_adapter.reject = except
         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
+        queue_adapter.reject = old_reject
       end
     end
 
@@ -352,11 +405,14 @@ module ActiveJob
         performed_jobs.clear
       end
 
-      def enqueued_jobs_size(only: nil, queue: nil)
+      def enqueued_jobs_size(only: nil, except: nil, queue: nil)
+        validate_option(only: only, except: except)
         enqueued_jobs.count do |job|
           job_class = job.fetch(:job)
           if only
             next false unless Array(only).include?(job_class)
+          elsif except
+            next false if Array(except).include?(job_class)
           end
           if queue
             next false unless queue.to_s == job.fetch(:queue, job_class.queue_name)
@@ -385,5 +441,9 @@ module ActiveJob
           klass.singleton_class.public_instance_methods(false).include?(:_queue_adapter)
         end
       end
+
+      def validate_option(only: nil, except: nil)
+        raise InvalidOptionsError, "Cannot specify both `:only` and `:except` options." if only && except
+      end
   end
 end