rspec-sidekiq 0.5.1 → 1.0.0

data/lib/rspec/sidekiq/batch.rb

@@ -1,44 +1,47 @@
-if defined?(Sidekiq::Batch)
-  module RSpec
-    module Sidekiq
-      class NullObject
-        def initialize(*)
-        end
-
-        def method_missing(*args, &block)
-          self
-        end
-      end
-
-      class NullBatch < NullObject
-        def jobs(*)
-          yield
-        end
-      end
-
-      class NullStatus < NullObject
-        def join
-          ::Sidekiq::Worker.drain_all
-        end
-      end
-    end
-  end
-
-  RSpec.configure do |config|
-    config.before(:each) do
-      if mocked_with_mocha?
-        Sidekiq::Batch.stubs(:new) { RSpec::Sidekiq::NullBatch.new }
-        Sidekiq::Batch::Status.stubs(:new) { RSpec::Sidekiq::NullStatus.new }
-      else
-        Sidekiq::Batch.stub(:new) { RSpec::Sidekiq::NullBatch.new }
-        Sidekiq::Batch::Status.stub(:new) { RSpec::Sidekiq::NullStatus.new }
-      end
-    end
-  end
-
-  ## Helpers ----------------------------------------------
-
-  def mocked_with_mocha?
-    Sidekiq::Batch.respond_to? :stubs
-  end
+if defined? Sidekiq::Batch
+  module RSpec
+    module Sidekiq
+      class NullObject
+        def initialize(*)
+        end
+
+        def method_missing(*args, &block)
+          self
+        end
+      end
+
+      class NullBatch < NullObject
+        def jobs(*)
+          yield
+        end
+      end
+
+      class NullStatus < NullObject
+        def join
+          ::Sidekiq::Worker.drain_all
+        end
+
+        def total
+          ::Sidekiq::Worker.jobs.size
+        end
+      end
+    end
+  end
+
+  RSpec.configure do |config|
+    config.before(:each) do
+      if mocked_with_mocha?
+        Sidekiq::Batch.stubs(:new) { RSpec::Sidekiq::NullBatch.new }
+        Sidekiq::Batch::Status.stubs(:new) { RSpec::Sidekiq::NullStatus.new }
+      else
+        Sidekiq::Batch.stub(:new) { RSpec::Sidekiq::NullBatch.new }
+        Sidekiq::Batch::Status.stub(:new) { RSpec::Sidekiq::NullStatus.new }
+      end
+    end
+  end
+
+  ## Helpers ----------------------------------------------
+  def mocked_with_mocha?
+    Sidekiq::Batch.respond_to? :stubs
+  end
 end

data/lib/rspec/sidekiq/configuration.rb

@@ -1,11 +1,13 @@
-module RSpec
-  module Sidekiq
-    class Configuration
-      attr_accessor :clear_all_enqueued_jobs
-
-      def initialize
-        @clear_all_enqueued_jobs = true
-      end
-    end
-  end
+module RSpec
+  module Sidekiq
+    class Configuration
+      attr_accessor :clear_all_enqueued_jobs, :enable_terminal_colours, :warn_when_jobs_not_processed_by_sidekiq
+
+      def initialize
+        @clear_all_enqueued_jobs = true
+        @enable_terminal_colours = true
+        @warn_when_jobs_not_processed_by_sidekiq = true
+      end
+    end
+  end
 end

data/lib/rspec/sidekiq/helpers/within_sidekiq_retries_exhausted_block.rb

@@ -0,0 +1,11 @@
+module Sidekiq
+  module Worker
+    module ClassMethods
+      def within_sidekiq_retries_exhausted_block &block
+        block.call
+
+        self.sidekiq_retries_exhausted_block.call
+      end
+    end
+  end
+end

data/lib/rspec/sidekiq/helpers.rb

@@ -0,0 +1,2 @@
+require "rspec/core"
+require "rspec/sidekiq/helpers/within_sidekiq_retries_exhausted_block"

data/lib/rspec/sidekiq/matchers/be_delayed.rb

@@ -0,0 +1,67 @@
+module RSpec
+  module Sidekiq
+    module Matchers
+      def be_delayed *expected_arguments
+        BeDelayed.new *expected_arguments
+      end
+
+      class BeDelayed
+        def initialize *expected_arguments
+          @expected_arguments = expected_arguments
+        end
+
+        def description
+          description = "be delayed"
+          description += " for #{@expected_interval} seconds" if @expected_interval
+          description += " until #{@expected_time}" if @expected_time
+          description += " with arguments #{@expected_arguments}" unless @expected_arguments.empty?
+          description
+        end
+
+        def failure_message
+          "expected #{@expected_method.receiver}.#{@expected_method.name} to " + description
+        end
+
+        def for interval
+          @expected_interval = interval
+          self
+        end
+
+        def matches? expected_method
+          @expected_method = expected_method
+
+          find_job @expected_method, @expected_arguments do |job|
+            if @expected_interval
+              return job["at"].to_i == job["enqueued_at"].to_i + @expected_interval
+            elsif @expected_time
+              return job["at"].to_i == @expected_time.to_i
+            else
+              return true
+            end
+          end
+
+          return false
+        end
+
+        def negative_failure_message
+          "expected #{@expected_method.receiver}.#{@expected_method.name} to not " + description
+        end
+
+        def until time
+          @expected_time = time
+          self
+        end
+
+        private
+        def find_job method, arguments, &block
+          job = (::Sidekiq::Extensions::DelayedClass.jobs + ::Sidekiq::Extensions::DelayedModel.jobs + ::Sidekiq::Extensions::DelayedMailer.jobs).find do |job|
+            yaml = YAML.load(job["args"].first)
+            @expected_method.receiver == yaml[0] && @expected_method.name == yaml[1] && (@expected_arguments <=> yaml[2]) == 0
+          end
+
+          yield job if block && job
+        end
+      end
+    end
+  end
+end

data/lib/rspec/sidekiq/matchers/be_processed_in.rb

@@ -1,33 +1,33 @@
-module RSpec
-  module Sidekiq
-    module Matchers
-      def be_processed_in expected
-        BeProcessedIn.new expected
-      end
-
-      class BeProcessedIn
-        def initialize expected
-          @expected = expected
-        end
-
-        def description
-          "be processed in the \"#{@expected}\" queue"
-        end
-
-        def failure_message
-          "expected #{@klass} to be processed in the #{@expected} queue but got #{@actual}"
-        end
-
-        def matches? job
-          @klass = job.kind_of?(Class) ? job : job.class
-          @actual = @klass.get_sidekiq_options["queue"]
-          @actual.to_s == @expected.to_s
-        end
-
-        def negative_failure_message
-          "expected #{@klass} to not be processed in the #{@expected} queue"
-        end
-      end
-    end
-  end
+module RSpec
+  module Sidekiq
+    module Matchers
+      def be_processed_in expected_queue
+        BeProcessedIn.new expected_queue
+      end
+
+      class BeProcessedIn
+        def initialize expected_queue
+          @expected_queue = expected_queue
+        end
+
+        def description
+          "be processed in the \"#{@expected_queue}\" queue"
+        end
+
+        def failure_message
+          "expected #{@klass} to be processed in the \"#{@expected_queue}\" queue but got \"#{@actual}\""
+        end
+
+        def matches? job
+          @klass = job.kind_of?(Class) ? job : job.class
+          @actual = @klass.get_sidekiq_options["queue"]
+          @actual.to_s == @expected_queue.to_s
+        end
+
+        def negative_failure_message
+          "expected #{@klass} to not be processed in the \"#{@expected_queue}\" queue"
+        end
+      end
+    end
+  end
 end

data/lib/rspec/sidekiq/matchers/be_retryable.rb

@@ -1,39 +1,39 @@
-module RSpec
-  module Sidekiq
-    module Matchers
-      def be_retryable expected
-        BeRetryable.new expected
-      end
-
-      class BeRetryable
-        def initialize expected
-          @expected = expected
-        end
-
-        def description
-          if @expected.is_a?(Fixnum)
-            "retry #{@expected} times"          # retry: 5
-          elsif @expected
-            "retry the default number of times" # retry: true
-          else
-            "not retry"                         # retry: false
-          end
-        end
-
-        def failure_message
-          "expected #{@klass} to #{description} but got #{@actual}"
-        end
-
-        def matches? job
-          @klass = job.kind_of?(Class) ? job : job.class
-          @actual = @klass.get_sidekiq_options["retry"]
-          @actual == @expected
-        end
-
-        def negative_failure_message
-          "expected #{@klass} to not #{description}"
-        end
-      end
-    end
-  end
+module RSpec
+  module Sidekiq
+    module Matchers
+      def be_retryable expected_retry
+        BeRetryable.new expected_retry
+      end
+
+      class BeRetryable
+        def initialize expected_retry
+          @expected_retry = expected_retry
+        end
+
+        def description
+          if @expected_retry.is_a?(Fixnum)
+            "retry #{@expected_retry} times"          # retry: 5
+          elsif @expected_retry
+            "retry the default number of times" # retry: true
+          else
+            "not retry"                         # retry: false
+          end
+        end
+
+        def failure_message
+          "expected #{@klass} to #{description} but got #{@actual}"
+        end
+
+        def matches? job
+          @klass = job.kind_of?(Class) ? job : job.class
+          @actual = @klass.get_sidekiq_options["retry"]
+          @actual == @expected_retry
+        end
+
+        def negative_failure_message
+          "expected #{@klass} to not #{description}".gsub "not not ", ""
+        end
+      end
+    end
+  end
 end

data/lib/rspec/sidekiq/matchers/be_unique.rb

@@ -1,29 +1,29 @@
-module RSpec
-  module Sidekiq
-    module Matchers
-      def be_unique
-        BeUnique.new
-      end
-
-      class BeUnique
-        def description
-          "be unique in the queue"
-        end
-
-        def failure_message
-          "expected #{@klass} to be unique in the queue but it is not"
-        end
-
-        def matches? job
-          @klass = job.kind_of?(Class) ? job : job.class
-          @actual = @klass.get_sidekiq_options["unique"]
-          @actual == true
-        end
-
-        def negative_failure_message
-          "expected #{@klass} to not be unique in the queue"
-        end
-      end
-    end
-  end
+module RSpec
+  module Sidekiq
+    module Matchers
+      def be_unique
+        BeUnique.new
+      end
+
+      class BeUnique
+        def description
+          "be unique in the queue"
+        end
+
+        def failure_message
+          "expected #{@klass} to be unique in the queue"
+        end
+
+        def matches? job
+          @klass = job.kind_of?(Class) ? job : job.class
+          @actual = @klass.get_sidekiq_options["unique"]
+          @actual == true
+        end
+
+        def negative_failure_message
+          "expected #{@klass} to not be unique in the queue"
+        end
+      end
+    end
+  end
 end

data/lib/rspec/sidekiq/matchers/have_enqueued_job.rb

@@ -1,34 +1,34 @@
-module RSpec
-  module Sidekiq
-    module Matchers
-      def have_enqueued_job *expected
-        HaveEnqueuedJob.new expected
-      end
-
-      class HaveEnqueuedJob
-        def initialize expected
-          @expected = expected
-        end
-
-        def description
-          "have an enqueued #{@klass} job with arguments #{@expected}"
-        end
-
-        def failure_message
-          "expected to have an enqueued #{@klass} job with arguments #{@expected} but none found\n\n" +
-          "found: #{@actual}"
-        end
-
-        def matches? klass
-          @klass = klass
-          @actual = klass.jobs.map { |job| job["args"] }
-          @actual.include? @expected
-        end
-
-        def negative_failure_message
-          "expected to not have an enqueued #{@klass} job with arguments #{@expected}"
-        end
-      end
-    end
-  end
+module RSpec
+  module Sidekiq
+    module Matchers
+      def have_enqueued_job *expected_arguments
+        HaveEnqueuedJob.new expected_arguments
+      end
+
+      class HaveEnqueuedJob
+        def initialize expected_arguments
+          @expected_arguments = expected_arguments
+        end
+
+        def description
+          "have an enqueued #{@klass} job with arguments #{@expected_arguments}"
+        end
+
+        def failure_message
+          "expected to have an enqueued #{@klass} job with arguments #{@expected_arguments}\n\n" +
+          "found: #{@actual}"
+        end
+
+        def matches? klass
+          @klass = klass
+          @actual = klass.jobs.map { |job| job["args"] }
+          @actual.any? { |arguments| Array(@expected_arguments) == arguments }
+        end
+
+        def negative_failure_message
+          "expected to not have an enqueued #{@klass} job with arguments #{@expected_arguments}"
+        end
+      end
+    end
+  end
 end