Merge pull request #1480 from morgoth/improve-aj-matcher

Add more methods to have_enqueued_job matcher

Author: soulcutter

lib/rspec/rails/matchers/active_job.rb

@@ -1,4 +1,5 @@
 require "active_job/base"
+require "active_job/arguments"
 
 module RSpec
   module Rails
@@ -11,23 +12,45 @@ module ActiveJob
         class HaveEnqueuedJob < RSpec::Matchers::BuiltIn::BaseMatcher
           def initialize(job)
             @job = job
+            @args = []
+            @queue = nil
+            @at = nil
             set_expected_number(:exactly, 1)
           end
 
           def matches?(proc)
             raise ArgumentError, "have_enqueued_jobs only supports block expectations" unless Proc === proc
 
-            before_block_jobs_size = enqueued_jobs_size(@job)
+            original_enqueued_jobs_count = queue_adapter.enqueued_jobs.count
             proc.call
-            @in_block_jobs_size = enqueued_jobs_size(@job) - before_block_jobs_size
+            in_block_jobs = queue_adapter.enqueued_jobs.drop(original_enqueued_jobs_count)
+
+            @matching_jobs_count = in_block_jobs.count do |job|
+              serialized_attributes.all? { |key, value| value == job[key] }
+            end
 
             case @expectation_type
-            when :exactly then @expected_number == @in_block_jobs_size
-            when :at_most then @expected_number >= @in_block_jobs_size
-            when :at_least then @expected_number <= @in_block_jobs_size
+            when :exactly then @expected_number == @matching_jobs_count
+            when :at_most then @expected_number >= @matching_jobs_count
+            when :at_least then @expected_number <= @matching_jobs_count
             end
           end
 
+          def with(*args)
+            @args = args
+            self
+          end
+
+          def on_queue(queue)
+            @queue = queue
+            self
+          end
+
+          def at(date)
+            @at = date
+            self
+          end
+
           def exactly(count)
             set_expected_number(:exactly, count)
             self
@@ -48,11 +71,11 @@ def times
           end
 
           def failure_message
-            "expected to enqueue #{message_expectation_modifier} #{@expected_number} jobs, but enqueued #{@in_block_jobs_size}"
+            "expected to enqueue #{base_message}"
           end
 
           def failure_message_when_negated
-            "expected not to enqueue #{message_expectation_modifier} #{@expected_number} jobs, but enqueued #{@in_block_jobs_size}"
+            "expected not to enqueue #{base_message}"
           end
 
           def message_expectation_modifier
@@ -69,11 +92,21 @@ def supports_block_expectations?
 
         private
 
-          def enqueued_jobs_size(job)
-            if job
-              queue_adapter.enqueued_jobs.count { |enqueued_job| job == enqueued_job.fetch(:job) }
-            else
-              queue_adapter.enqueued_jobs.count
+          def base_message
+            "#{message_expectation_modifier} #{@expected_number} jobs,".tap do |msg|
+              msg << " with #{@args}," if @args.any?
+              msg << " on queue #{@queue}," if @queue
+              msg << " at #{@at}," if @at
+              msg << " but enqueued #{@matching_jobs_count}"
+            end
+          end
+
+          def serialized_attributes
+            {}.tap do |attributes|
+              attributes[:args]  = ::ActiveJob::Arguments.serialize(@args) if @args.any?
+              attributes[:at]    = @at.to_f if @at
+              attributes[:queue] = @queue if @queue
+              attributes[:job]   = @job if @job
             end
           end
 
@@ -120,6 +153,10 @@ def queue_adapter
       #       HelloJob.perform_later
       #       HeavyLiftingJob.perform_later
       #     }.to have_enqueued_job(HelloJob).and have_enqueued_job(HeavyLiftingJob)
+      #
+      #     expect {
+      #       HelloJob.set(wait_until: Date.tomorrow.noon, queue: "low").perform_later(42)
+      #     }.to have_enqueued_job.with(42).on_queue("low").at(Date.tomorrow.noon)
       def have_enqueued_job(job = nil)
         ActiveJob::HaveEnqueuedJob.new(job)
       end

spec/rspec/rails/matchers/active_job_spec.rb

@@ -15,7 +15,8 @@ def perform; end
 
   let(:hello_job) do
     Class.new(ActiveJob::Base) do
-      def perform; end
+      def perform(*)
+      end
     end
   end
 
@@ -25,6 +26,30 @@ def perform; end
     end
   end
 
+  let(:global_id_model) do
+    Class.new do
+      include GlobalID::Identification
+
+      attr_reader :id
+
+      def self.find(id)
+        new(id)
+      end
+
+      def self.name
+        "AnonymousClass"
+      end
+
+      def initialize(id)
+        @id = id
+      end
+
+      def to_global_id(options = {})
+        @global_id ||= GlobalID.create(self, :app => "rspec-suite")
+      end
+    end
+  end
+
   before do
     ActiveJob::Base.queue_adapter = :test
   end
@@ -144,5 +169,43 @@ def perform; end
         }.to have_enqueued_job.at_most(:once)
       }.to raise_error(/expected to enqueue at most 1 jobs, but enqueued 2/)
     end
+
+    it "passes with provided queue name" do
+      expect {
+        hello_job.set(:queue => "low").perform_later
+      }.to have_enqueued_job.on_queue("low")
+    end
+
+    it "passes with provided at date" do
+      date = Date.tomorrow.noon
+      expect {
+        hello_job.set(:wait_until => date).perform_later
+      }.to have_enqueued_job.at(date)
+    end
+
+    it "passes with provided arguments" do
+      expect {
+        hello_job.perform_later(42, "David")
+      }.to have_enqueued_job.with(42, "David")
+    end
+
+    it "passes with provided arguments containing global id object" do
+      global_id_object = global_id_model.new(42)
+
+      expect {
+        hello_job.perform_later(global_id_object)
+      }.to have_enqueued_job.with(global_id_object)
+    end
+
+    it "generates failure message with all provided options" do
+      date = Date.tomorrow.noon
+      message = "expected to enqueue exactly 2 jobs, with [42], on queue low, at #{date}, but enqueued 0"
+
+      expect {
+        expect {
+          hello_job.perform_later
+        }.to have_enqueued_job(hello_job).with(42).on_queue("low").at(date).exactly(2).times
+      }.to raise_error(message)
+    end
   end
 end