Add perform_enqueued_jobs

It will set proper queue_adapter state required by assert_performed_jobs assertions.

Also the block version of assert_performed_jobs will make sure this
state is respected.

Fixes #17684

2 files changed, 52 insertions, 20 deletions

diff --git a/activejob/lib/active_job/test_helper.rb b/activejob/lib/active_job/test_helper.rb
index bb20d93947..1720b140e5 100644
--- a/activejob/lib/active_job/test_helper.rb
+++ b/activejob/lib/active_job/test_helper.rb
@@ -77,13 +77,21 @@ module ActiveJob
       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 the job call.
       #
       #   def test_jobs
       #     assert_performed_jobs 0
-      #     HelloJob.perform_later('xavier')
+      #
+      #     perform_enqueued_jobs do
+      #       HelloJob.perform_later('xavier')
+      #     end
       #     assert_performed_jobs 1
-      #     HelloJob.perform_later('yves')
-      #     assert_performed_jobs 2
+      #
+      #     perform_enqueued_jobs do
+      #       HelloJob.perform_later('yves')
+      #       assert_performed_jobs 2
+      #     end
       #   end
       #
       # If a block is passed, that block should cause the specified number of
@@ -102,7 +110,7 @@ module ActiveJob
       def assert_performed_jobs(number)
         if block_given?
           original_count = performed_jobs.size
-          yield
+          perform_enqueued_jobs { yield }
           new_count = performed_jobs.size
           assert_equal original_count + number, new_count,
                        "#{number} jobs expected, but #{new_count - original_count} were performed"
@@ -116,8 +124,11 @@ module ActiveJob
       #
       #   def test_jobs
       #     assert_no_performed_jobs
-      #     HelloJob.perform_later('matthew')
-      #     assert_performed_jobs 1
+      #
+      #     perform_enqueued_jobs do
+      #       HelloJob.perform_later('matthew')
+      #       assert_performed_jobs 1
+      #     end
       #   end
       #
       # If a block is passed, that block should not cause any job to be performed.
@@ -166,7 +177,7 @@ module ActiveJob
         original_performed_jobs = performed_jobs.dup
         clear_performed_jobs
         args.assert_valid_keys(:job, :args, :at, :queue)
-        yield
+        perform_enqueued_jobs { yield }
         matching_job = performed_jobs.any? do |job|
           args.all? { |key, value| value == job[key] }
         end
@@ -175,6 +186,17 @@ module ActiveJob
         queue_adapter.performed_jobs = original_performed_jobs + performed_jobs
       end
 
+      def perform_enqueued_jobs
+        @old_perform_enqueued_jobs = queue_adapter.perform_enqueued_jobs
+        @old_perform_enqueued_at_jobs = queue_adapter.perform_enqueued_at_jobs
+        queue_adapter.perform_enqueued_jobs = true
+        queue_adapter.perform_enqueued_at_jobs = true
+        yield
+      ensure
+        queue_adapter.perform_enqueued_jobs = @old_perform_enqueued_jobs
+        queue_adapter.perform_enqueued_at_jobs = @old_perform_enqueued_at_jobs
+      end
+
       def queue_adapter
         ActiveJob::Base.queue_adapter
       end
diff --git a/activejob/test/cases/test_helper_test.rb b/activejob/test/cases/test_helper_test.rb
index 71c505a65f..784ede3674 100644
--- a/activejob/test/cases/test_helper_test.rb
+++ b/activejob/test/cases/test_helper_test.rb
@@ -6,8 +6,6 @@ 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
@@ -44,11 +42,16 @@ class EnqueuedJobsTest < ActiveJob::TestCase
     end
   end
 
+  def test_assert_no_enqueued_jobs_with_no_block
+    assert_nothing_raised do
+      assert_no_enqueued_jobs
+    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.set(wait_until: Date.tomorrow.noon).perform_later('godfrey')
+        HelloJob.perform_now
       end
     end
   end
@@ -86,7 +89,7 @@ class EnqueuedJobsTest < ActiveJob::TestCase
 
   def test_assert_enqueued_job
     assert_enqueued_with(job: LoggingJob, queue: 'default') do
-      NestedJob.set(wait_until: Date.tomorrow.noon).perform_later
+      LoggingJob.set(wait_until: Date.tomorrow.noon).perform_later
     end
   end
 
@@ -116,8 +119,6 @@ class EnqueuedJobsTest < ActiveJob::TestCase
 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
@@ -143,22 +144,31 @@ class PerformedJobsTest < ActiveJob::TestCase
 
   def test_assert_performed_jobs_with_no_block
     assert_nothing_raised do
-      HelloJob.perform_later('rafael')
+      perform_enqueued_jobs do
+        HelloJob.perform_later('rafael')
+      end
       assert_performed_jobs 1
     end
 
     assert_nothing_raised do
-      HelloJob.perform_later('aaron')
-      HelloJob.perform_later('matthew')
-      assert_performed_jobs 3
+      perform_enqueued_jobs do
+        HelloJob.perform_later('aaron')
+        HelloJob.perform_later('matthew')
+        assert_performed_jobs 3
+      end
+    end
+  end
+
+  def test_assert_no_performed_jobs_with_no_block
+    assert_nothing_raised do
+      assert_no_performed_jobs
     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.set(wait_until: Date.tomorrow.noon).perform_later('godfrey')
+        # empty block won't perform jobs
       end
     end
   end