Merge pull request #19969 from y-yagi/fix_job_helper_method

match a expected value with message of `assert_equal` in AJ helper methods

3 files changed, 30 insertions, 2 deletions

diff --git a/activejob/CHANGELOG.md b/activejob/CHANGELOG.md
index 85a437a1dd..1c55c1a4b8 100644
--- a/activejob/CHANGELOG.md
+++ b/activejob/CHANGELOG.md
@@ -1,3 +1,9 @@
+*   `assert_enqueued_jobs` and `assert_performed_jobs` in block form use the
+    given number as expected value. This makes the error message much easier to
+    understand.
+
+    *y-yagi*
+
 *   A generated job now inherents from `app/jobs/application_job.rb` by default.
 
     *Jeroen van Baarsen*
diff --git a/activejob/lib/active_job/test_helper.rb b/activejob/lib/active_job/test_helper.rb
index 4efb4b72d2..9b307e8dc8 100644
--- a/activejob/lib/active_job/test_helper.rb
+++ b/activejob/lib/active_job/test_helper.rb
@@ -68,7 +68,7 @@ module ActiveJob
           original_count = enqueued_jobs_size(only: only)
           yield
           new_count = enqueued_jobs_size(only: only)
-          assert_equal original_count + number, new_count, "#{number} jobs expected, but #{new_count - original_count} were enqueued"
+          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)
           assert_equal number, actual_count, "#{number} jobs expected, but #{actual_count} were enqueued"
@@ -164,7 +164,7 @@ module ActiveJob
           original_count = performed_jobs.size
           perform_enqueued_jobs(only: only) { yield }
           new_count = performed_jobs.size
-          assert_equal original_count + number, new_count,
+          assert_equal number, new_count - original_count,
                        "#{number} jobs expected, but #{new_count - original_count} were performed"
         else
           performed_jobs_size = performed_jobs.size
diff --git a/activejob/test/cases/test_helper_test.rb b/activejob/test/cases/test_helper_test.rb
index 19a2820a6e..04c4c446e2 100644
--- a/activejob/test/cases/test_helper_test.rb
+++ b/activejob/test/cases/test_helper_test.rb
@@ -31,6 +31,17 @@ class EnqueuedJobsTest < ActiveJob::TestCase
     end
   end
 
+  def test_assert_enqueued_jobs_message
+    HelloJob.perform_later('sean')
+    e = assert_raises Minitest::Assertion do
+      assert_enqueued_jobs 2 do
+        HelloJob.perform_later('sean')
+      end
+    end
+    assert_match "Expected: 2", e.message
+    assert_match "Actual: 1", e.message
+  end
+
   def test_assert_enqueued_jobs_with_no_block
     assert_nothing_raised do
       HelloJob.perform_later('rafael')
@@ -230,6 +241,17 @@ class PerformedJobsTest < ActiveJob::TestCase
     end
   end
 
+  def test_assert_performed_jobs_message
+    HelloJob.perform_later('sean')
+    e = assert_raises Minitest::Assertion do
+      assert_performed_jobs 2 do
+        HelloJob.perform_later('sean')
+      end
+    end
+    assert_match "Expected: 2", e.message
+    assert_match "Actual: 1", e.message
+  end
+
   def test_assert_performed_jobs_with_no_block
     assert_nothing_raised do
       perform_enqueued_jobs do