activejob 5.2.4 → 6.0.2.1

data/lib/active_job/test_helper.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
 require "active_support/core_ext/class/subclasses"
-require "active_support/core_ext/hash/keys"
 
 module ActiveJob
   # Provides helper methods for testing Active Job
@@ -52,7 +51,7 @@ module ActiveJob
       queue_adapter_changed_jobs.each { |klass| klass.disable_test_adapter }
     end
 
-    # Specifies the queue adapter to use with all active job test helpers.
+    # Specifies the queue adapter to use with all Active Job test helpers.
     #
     # Returns an instance of the queue adapter and defaults to
     # <tt>ActiveJob::QueueAdapters::TestAdapter</tt>.
@@ -75,7 +74,7 @@ module ActiveJob
     #     assert_enqueued_jobs 2
     #   end
     #
-    # If a block is passed, that block will cause the specified number of
+    # If a block is passed, asserts that the block will cause the specified number of
     # jobs to be enqueued.
     #
     #   def test_jobs_again
@@ -89,7 +88,7 @@ module ActiveJob
     #     end
     #   end
     #
-    # The number of times a specific job was enqueued can be asserted.
+    # Asserts the number of times a specific job was enqueued by passing +:only+ option.
     #
     #   def test_logging_job
     #     assert_enqueued_jobs 1, only: LoggingJob do
@@ -98,7 +97,7 @@ module ActiveJob
     #     end
     #   end
     #
-    # The number of times a job except specific class was enqueued can be asserted.
+    # Asserts the number of times a job except specific class was enqueued by passing +:except+ option.
     #
     #   def test_logging_job
     #     assert_enqueued_jobs 1, except: HelloJob do
@@ -107,7 +106,10 @@ module ActiveJob
     #     end
     #   end
     #
-    # The number of times a job is enqueued to a specific queue can also be asserted.
+    # +:only+ and +:except+ options accepts Class, Array of Class or Proc. When passed a Proc,
+    # a hash containing the job's class and it's argument are passed as argument.
+    #
+    # Asserts the number of times a job is enqueued to a specific queue by passing +:queue+ option.
     #
     #   def test_logging_job
     #     assert_enqueued_jobs 2, queue: 'default' do
@@ -117,14 +119,18 @@ module ActiveJob
     #   end
     def assert_enqueued_jobs(number, only: nil, except: nil, queue: nil)
       if block_given?
-        original_count = enqueued_jobs_size(only: only, except: except, queue: queue)
+        original_count = enqueued_jobs_with(only: only, except: except, queue: queue)
+
         yield
-        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"
+
+        new_count = enqueued_jobs_with(only: only, except: except, queue: queue)
+
+        actual_count = new_count - original_count
       else
-        actual_count = enqueued_jobs_size(only: only, except: except, queue: queue)
-        assert_equal number, actual_count, "#{number} jobs expected, but #{actual_count} were enqueued"
+        actual_count = enqueued_jobs_with(only: only, except: except, queue: queue)
       end
+
+      assert_equal number, actual_count, "#{number} jobs expected, but #{actual_count} were enqueued"
     end
 
     # Asserts that no jobs have been enqueued.
@@ -135,7 +141,7 @@ module ActiveJob
     #     assert_enqueued_jobs 1
     #   end
     #
-    # If a block is passed, that block should not cause any job to be enqueued.
+    # If a block is passed, asserts that the block will not cause any job to be enqueued.
     #
     #   def test_jobs_again
     #     assert_no_enqueued_jobs do
@@ -143,7 +149,7 @@ module ActiveJob
     #     end
     #   end
     #
-    # It can be asserted that no jobs of a specific kind are enqueued:
+    # Asserts that no jobs of a specific kind are enqueued by passing +:only+ option.
     #
     #   def test_no_logging
     #     assert_no_enqueued_jobs only: LoggingJob do
@@ -151,7 +157,7 @@ module ActiveJob
     #     end
     #   end
     #
-    # It can be asserted that no jobs except specific class are enqueued:
+    # Asserts that no jobs except specific class are enqueued by passing +:except+ option.
     #
     #   def test_no_logging
     #     assert_no_enqueued_jobs except: HelloJob do
@@ -159,16 +165,27 @@ module ActiveJob
     #     end
     #   end
     #
+    # +:only+ and +:except+ options accepts Class, Array of Class or Proc. When passed a Proc,
+    # a hash containing the job's class and it's argument are passed as argument.
+    #
+    # Asserts that no jobs are enqueued to a specific queue by passing +:queue+ option
+    #
+    #   def test_no_logging
+    #     assert_no_enqueued_jobs queue: 'default' do
+    #       LoggingJob.set(queue: :some_queue).perform_later
+    #     end
+    #   end
+    #
     # Note: This assertion is simply a shortcut for:
     #
     #   assert_enqueued_jobs 0, &block
-    def assert_no_enqueued_jobs(only: nil, except: nil, &block)
-      assert_enqueued_jobs 0, only: only, except: except, &block
+    def assert_no_enqueued_jobs(only: nil, except: nil, queue: nil, &block)
+      assert_enqueued_jobs 0, only: only, except: except, queue: queue, &block
     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.
+    # must be called around or after the job call.
     #
     #   def test_jobs
     #     assert_performed_jobs 0
@@ -178,13 +195,14 @@ module ActiveJob
     #     end
     #     assert_performed_jobs 1
     #
-    #     perform_enqueued_jobs do
-    #       HelloJob.perform_later('yves')
-    #       assert_performed_jobs 2
-    #     end
+    #     HelloJob.perform_later('yves')
+    #
+    #     perform_enqueued_jobs
+    #
+    #     assert_performed_jobs 2
     #   end
     #
-    # If a block is passed, that block should cause the specified number of
+    # If a block is passed, asserts that the block will cause the specified number of
     # jobs to be performed.
     #
     #   def test_jobs_again
@@ -198,7 +216,7 @@ module ActiveJob
     #     end
     #   end
     #
-    # The block form supports filtering. If the :only option is specified,
+    # This method also supports filtering. If the +:only+ option is specified,
     # then only the listed job(s) will be performed.
     #
     #     def test_hello_job
@@ -208,7 +226,7 @@ module ActiveJob
     #       end
     #     end
     #
-    # Also if the :except option is specified,
+    # Also if the +:except+ option is specified,
     # then the job(s) except specific class will be performed.
     #
     #     def test_hello_job
@@ -229,17 +247,42 @@ module ActiveJob
     #         end
     #       end
     #     end
-    def assert_performed_jobs(number, only: nil, except: nil)
+    #
+    # A proc may also be specified. When passed a Proc, the job's instance will be passed as argument.
+    #
+    #     def test_hello_and_logging_jobs
+    #       assert_nothing_raised do
+    #         assert_performed_jobs(1, only: ->(job) { job.is_a?(HelloJob) }) do
+    #           HelloJob.perform_later('jeremy')
+    #           LoggingJob.perform_later('stewie')
+    #           RescueJob.perform_later('david')
+    #         end
+    #       end
+    #     end
+    #
+    # If the +:queue+ option is specified,
+    # then only the job(s) enqueued to a specific queue will be performed.
+    #
+    #     def test_assert_performed_jobs_with_queue_option
+    #       assert_performed_jobs 1, queue: :some_queue do
+    #         HelloJob.set(queue: :some_queue).perform_later("jeremy")
+    #         HelloJob.set(queue: :other_queue).perform_later("bogdan")
+    #       end
+    #     end
+    def assert_performed_jobs(number, only: nil, except: nil, queue: nil, &block)
       if block_given?
         original_count = performed_jobs.size
-        perform_enqueued_jobs(only: only, except: except) { yield }
+
+        perform_enqueued_jobs(only: only, except: except, queue: queue, &block)
+
         new_count = performed_jobs.size
-        assert_equal number, new_count - original_count,
-          "#{number} jobs expected, but #{new_count - original_count} were performed"
+
+        performed_jobs_size = new_count - original_count
       else
-        performed_jobs_size = performed_jobs.size
-        assert_equal number, performed_jobs_size, "#{number} jobs expected, but #{performed_jobs_size} were performed"
+        performed_jobs_size = performed_jobs_with(only: only, except: except, queue: queue)
       end
+
+      assert_equal number, performed_jobs_size, "#{number} jobs expected, but #{performed_jobs_size} were performed"
     end
 
     # Asserts that no jobs have been performed.
@@ -253,7 +296,7 @@ module ActiveJob
     #     end
     #   end
     #
-    # If a block is passed, that block should not cause any job to be performed.
+    # If a block is passed, asserts that the block will not cause any job to be performed.
     #
     #   def test_jobs_again
     #     assert_no_performed_jobs do
@@ -261,7 +304,7 @@ module ActiveJob
     #     end
     #   end
     #
-    # The block form supports filtering. If the :only option is specified,
+    # The block form supports filtering. If the +:only+ option is specified,
     # then only the listed job(s) will not be performed.
     #
     #   def test_no_logging
@@ -270,7 +313,7 @@ module ActiveJob
     #     end
     #   end
     #
-    # Also if the :except option is specified,
+    # Also if the +:except+ option is specified,
     # then the job(s) except specific class will not be performed.
     #
     #   def test_no_logging
@@ -279,14 +322,53 @@ module ActiveJob
     #     end
     #   end
     #
+    # +:only+ and +:except+ options accepts Class, Array of Class or Proc. When passed a Proc,
+    # an instance of the job will be passed as argument.
+    #
+    # If the +:queue+ option is specified,
+    # then only the job(s) enqueued to a specific queue will not be performed.
+    #
+    #   def test_assert_no_performed_jobs_with_queue_option
+    #     assert_no_performed_jobs queue: :some_queue do
+    #       HelloJob.set(queue: :other_queue).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, except: nil, &block)
-      assert_performed_jobs 0, only: only, except: except, &block
+    def assert_no_performed_jobs(only: nil, except: nil, queue: nil, &block)
+      assert_performed_jobs 0, only: only, except: except, queue: queue, &block
     end
 
-    # Asserts that the job passed in the block has been enqueued with the given arguments.
+    # Asserts that the job has been enqueued with the given arguments.
+    #
+    #   def test_assert_enqueued_with
+    #     MyJob.perform_later(1,2,3)
+    #     assert_enqueued_with(job: MyJob, args: [1,2,3], queue: 'low')
+    #
+    #     MyJob.set(wait_until: Date.tomorrow.noon).perform_later
+    #     assert_enqueued_with(job: MyJob, at: Date.tomorrow.noon)
+    #   end
+    #
+    #
+    # The +args+ argument also accepts a proc which will get passed the actual
+    # job's arguments. Your proc needs to return a boolean value determining if
+    # the job's arguments matches your expectation. This is useful to check only
+    # for a subset of arguments.
+    #
+    #   def test_assert_enqueued_with
+    #     expected_args = ->(job_args) do
+    #       assert job_args.first.key?(:foo)
+    #     end
+    #
+    #     MyJob.perform_later(foo: 'bar', other_arg: 'No need to check in the test')
+    #     assert_enqueued_with(job: MyJob, args: expected_args, queue: 'low')
+    #   end
+    #
+    #
+    # If a block is passed, asserts that the block will cause the job to be
+    # enqueued with the given arguments.
     #
     #   def test_assert_enqueued_with
     #     assert_enqueued_with(job: MyJob, args: [1,2,3], queue: 'low') do
@@ -298,20 +380,70 @@ module ActiveJob
     #     end
     #   end
     def assert_enqueued_with(job: nil, args: nil, at: nil, queue: nil)
-      original_enqueued_jobs_count = enqueued_jobs.count
       expected = { job: job, args: args, at: at, queue: queue }.compact
       expected_args = prepare_args_for_assertion(expected)
-      yield
-      in_block_jobs = enqueued_jobs.drop(original_enqueued_jobs_count)
-      matching_job = in_block_jobs.find do |in_block_job|
-        deserialized_job = deserialize_args_for_assertion(in_block_job)
-        expected_args.all? { |key, value| value == deserialized_job[key] }
+
+      if block_given?
+        original_enqueued_jobs_count = enqueued_jobs.count
+
+        yield
+
+        jobs = enqueued_jobs.drop(original_enqueued_jobs_count)
+      else
+        jobs = enqueued_jobs
       end
+
+      matching_job = jobs.find do |enqueued_job|
+        deserialized_job = deserialize_args_for_assertion(enqueued_job)
+
+        expected_args.all? do |key, value|
+          if value.respond_to?(:call)
+            value.call(deserialized_job[key])
+          else
+            value == deserialized_job[key]
+          end
+        end
+      end
+
       assert matching_job, "No enqueued job found with #{expected}"
       instantiate_job(matching_job)
     end
 
-    # Asserts that the job passed in the block has been performed with the given arguments.
+    # Asserts that the job has been performed with the given arguments.
+    #
+    #   def test_assert_performed_with
+    #     MyJob.perform_later(1,2,3)
+    #
+    #     perform_enqueued_jobs
+    #
+    #     assert_performed_with(job: MyJob, args: [1,2,3], queue: 'high')
+    #
+    #     MyJob.set(wait_until: Date.tomorrow.noon).perform_later
+    #
+    #     perform_enqueued_jobs
+    #
+    #     assert_performed_with(job: MyJob, at: Date.tomorrow.noon)
+    #   end
+    #
+    # The +args+ argument also accepts a proc which will get passed the actual
+    # job's arguments. Your proc needs to return a boolean value determining if
+    # the job's arguments matches your expectation. This is useful to check only
+    # for a subset of arguments.
+    #
+    #   def test_assert_performed_with
+    #     expected_args = ->(job_args) do
+    #       assert job_args.first.key?(:foo)
+    #     end
+    #     MyJob.perform_later(foo: 'bar', other_arg: 'No need to check in the test')
+    #
+    #     perform_enqueued_jobs
+    #
+    #     assert_performed_with(job: MyJob, args: expected_args, queue: 'high')
+    #   end
+    #
+    # If a block is passed, that block performs all of the jobs that were
+    # enqueued throughout the duration of the block and asserts that
+    # the job has been performed with the given arguments in the block.
     #
     #   def test_assert_performed_with
     #     assert_performed_with(job: MyJob, args: [1,2,3], queue: 'high') do
@@ -322,21 +454,39 @@ module ActiveJob
     #       MyJob.set(wait_until: Date.tomorrow.noon).perform_later
     #     end
     #   end
-    def assert_performed_with(job: nil, args: nil, at: nil, queue: nil)
-      original_performed_jobs_count = performed_jobs.count
+    def assert_performed_with(job: nil, args: nil, at: nil, queue: nil, &block)
       expected = { job: job, args: args, at: at, queue: queue }.compact
       expected_args = prepare_args_for_assertion(expected)
-      perform_enqueued_jobs { yield }
-      in_block_jobs = performed_jobs.drop(original_performed_jobs_count)
-      matching_job = in_block_jobs.find do |in_block_job|
-        deserialized_job = deserialize_args_for_assertion(in_block_job)
-        expected_args.all? { |key, value| value == deserialized_job[key] }
+
+      if block_given?
+        original_performed_jobs_count = performed_jobs.count
+
+        perform_enqueued_jobs(&block)
+
+        jobs = performed_jobs.drop(original_performed_jobs_count)
+      else
+        jobs = performed_jobs
       end
+
+      matching_job = jobs.find do |enqueued_job|
+        deserialized_job = deserialize_args_for_assertion(enqueued_job)
+
+        expected_args.all? do |key, value|
+          if value.respond_to?(:call)
+            value.call(deserialized_job[key])
+          else
+            value == deserialized_job[key]
+          end
+        end
+      end
+
       assert matching_job, "No performed job found with #{expected}"
       instantiate_job(matching_job)
     end
 
-    # Performs all enqueued jobs in the duration of the block.
+    # Performs all enqueued jobs. If a block is given, performs all of the jobs
+    # that were enqueued throughout the duration of the block. If a block is
+    # not given, performs all of the enqueued jobs up to this point in the test.
     #
     #   def test_perform_enqueued_jobs
     #     perform_enqueued_jobs do
@@ -345,6 +495,14 @@ module ActiveJob
     #     assert_performed_jobs 1
     #   end
     #
+    #   def test_perform_enqueued_jobs_without_block
+    #     MyJob.perform_later(1, 2, 3)
+    #
+    #     perform_enqueued_jobs
+    #
+    #     assert_performed_jobs 1
+    #   end
+    #
     # This method also supports filtering. If the +:only+ option is specified,
     # then only the listed job(s) will be performed.
     #
@@ -367,24 +525,45 @@ module ActiveJob
     #     assert_performed_jobs 1
     #   end
     #
-    def perform_enqueued_jobs(only: nil, except: nil)
+    # +:only+ and +:except+ options accepts Class, Array of Class or Proc. When passed a Proc,
+    # an instance of the job will be passed as argument.
+    #
+    # If the +:queue+ option is specified,
+    # then only the job(s) enqueued to a specific queue will be performed.
+    #
+    #   def test_perform_enqueued_jobs_with_queue
+    #     perform_enqueued_jobs queue: :some_queue do
+    #       MyJob.set(queue: :some_queue).perform_later(1, 2, 3) # will be performed
+    #       HelloJob.set(queue: :other_queue).perform_later(1, 2, 3) # will not be performed
+    #     end
+    #     assert_performed_jobs 1
+    #   end
+    #
+    def perform_enqueued_jobs(only: nil, except: nil, queue: nil)
+      return flush_enqueued_jobs(only: only, except: except, queue: queue) unless block_given?
+
       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
+      old_queue = queue_adapter.queue
 
       begin
         queue_adapter.perform_enqueued_jobs = true
         queue_adapter.perform_enqueued_at_jobs = true
         queue_adapter.filter = only
         queue_adapter.reject = except
+        queue_adapter.queue = queue
+
         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
+        queue_adapter.queue = old_queue
       end
     end
 
@@ -406,30 +585,72 @@ module ActiveJob
         performed_jobs.clear
       end
 
-      def enqueued_jobs_size(only: nil, except: nil, queue: nil)
+      def jobs_with(jobs, only: nil, except: nil, queue: nil)
         validate_option(only: only, except: except)
-        enqueued_jobs.count do |job|
+
+        jobs.count do |job|
           job_class = job.fetch(:job)
+
           if only
-            next false unless Array(only).include?(job_class)
+            next false unless filter_as_proc(only).call(job)
           elsif except
-            next false if Array(except).include?(job_class)
+            next false if filter_as_proc(except).call(job)
           end
+
           if queue
             next false unless queue.to_s == job.fetch(:queue, job_class.queue_name)
           end
+
+          yield job if block_given?
+
           true
         end
       end
 
+      def filter_as_proc(filter)
+        return filter if filter.is_a?(Proc)
+
+        ->(job) { Array(filter).include?(job.fetch(:job)) }
+      end
+
+      def enqueued_jobs_with(only: nil, except: nil, queue: nil, &block)
+        jobs_with(enqueued_jobs, only: only, except: except, queue: queue, &block)
+      end
+
+      def performed_jobs_with(only: nil, except: nil, queue: nil, &block)
+        jobs_with(performed_jobs, only: only, except: except, queue: queue, &block)
+      end
+
+      def flush_enqueued_jobs(only: nil, except: nil, queue: nil)
+        enqueued_jobs_with(only: only, except: except, queue: queue) do |payload|
+          instantiate_job(payload).perform_now
+          queue_adapter.performed_jobs << payload
+        end
+      end
+
       def prepare_args_for_assertion(args)
         args.dup.tap do |arguments|
-          arguments[:at] = arguments[:at].to_f if arguments[:at]
+          arguments[:at] = round_time_arguments(arguments[:at]) if arguments[:at]
+          arguments[:args] = round_time_arguments(arguments[:args]) if arguments[:args]
+        end
+      end
+
+      def round_time_arguments(argument)
+        case argument
+        when Time, ActiveSupport::TimeWithZone, DateTime
+          argument.change(usec: 0)
+        when Hash
+          argument.transform_values { |value| round_time_arguments(value) }
+        when Array
+          argument.map { |element| round_time_arguments(element) }
+        else
+          argument
         end
       end
 
       def deserialize_args_for_assertion(job)
         job.dup.tap do |new_job|
+          new_job[:at] = round_time_arguments(Time.at(new_job[:at])) if new_job[:at]
           new_job[:args] = ActiveJob::Arguments.deserialize(new_job[:args]) if new_job[:args]
         end
       end