rspec-sidekiq 5.0.0 → 5.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e2bbe8c4c2097c67abf526af45ba5a3652fa83e898ccb82732f3639b83cc7d33
-  data.tar.gz: ec606df39e62123fd43d595c412f9dd70edc5c93389395b6d6e58f53deccf32a
+  metadata.gz: 56ce84afbf67491fa24da1f527bced61c54afa3d62dbb50e6a09a89e8c0bc16c
+  data.tar.gz: 5b4a368bbb098d580713009fb9381d66326c37eced31c91eaf85b43158a85db5
 SHA512:
-  metadata.gz: 7a601baf7161f039f0fb8b78a8ea3bed432b418431eae0b2e149365922f88d7f7c543450433175c4c16ba974ab91b8050ba1dc927619bbc2162a229f34de94ad
-  data.tar.gz: 2964a340caee3c386a99eb8a69a79552782ff2e9cfcdacd9140d50232939138f95297b313620ec658f1e21fa044d946e3f030d8a8a212b3b1af2e1c89a175c6a
+  metadata.gz: 4ec18b3d6ceff7390807d7358259b44f236ca6d81b1b9175c069b6c4912041b914082042a5396c7cf1eb0b602a5448d9aacd9e23b3cee211ad7222c3ec3719af
+  data.tar.gz: 4f0232e7b482f7c565a5cca98be9b7143e51adbe6015329f9d052e393fd857fe97e2449fb53f9e3d209ff6319c54e23e9e2919e7003a44bfc00834692039eed0

data/CHANGES.md

@@ -1,5 +1,11 @@
 Unreleased
 ---
+* Add `until` matcher for Sidekiq Enterprise unique jobs (#232, #147)
+* Add `with_context` matcher for matching against job contexts (#222)
+* Support for Sidekiq 8 (#233)
+* Add `frozen_string_literal: true` (#220)
+* Fix queue always nil in default_retries_exhausted_message (#229)
+* Fix pattern matching warnings on Ruby 2.7 (#227)
 
 5.0.0
 ---

data/README.md

@@ -1,5 +1,3 @@
-**Welcome @wspurgin as new maintainer for `rspec-sidekiq`!**
-
 [![Gem Version](https://badge.fury.io/rb/rspec-sidekiq.svg)](https://badge.fury.io/rb/rspec-sidekiq)
 [![Github Actions CI][github_actions_badge]][github_actions]
 
@@ -81,6 +79,17 @@ expect { AwesomeJob.perform_async }.to enqueue_sidekiq_job.at_most(2).times
 expect { AwesomeJob.perform_async }.to enqueue_sidekiq_job.at_most(:twice)
 expect { AwesomeJob.perform_async }.to enqueue_sidekiq_job.at_most(:thrice)
 
+# With specific context:
+# Useful for testing anything `set` on the job, including
+# overrides to things like `retry`
+expect {
+  AwesomeJob.set(trace_id: "something").perform_async
+}.to enqueue_sidekiq_job.with_context(trace_id: anything)
+
+expect {
+  AwesomeJob.set(retry: 5).perform_async
+}.to enqueue_sidekiq_job.with_context(retry: 5)
+
 # Combine and chain them as desired
 expect { AwesomeJob.perform_at(specific_time, "Awesome!") }.to(
   enqueue_sidekiq_job(AwesomeJob)
@@ -133,6 +142,13 @@ expect(AwesomeJob).to have_enqueued_sidekiq_job.at_most(:twice)
 expect(AwesomeJob).to have_enqueued_sidekiq_job.at_most(:thrice)
 ```
 
+Likewise, specify what should be in the context:
+```ruby
+AwesomeJob.set(trace_id: "something").perform_async
+
+expect(AwesomeJob).to have_enqueued_sidekiq_job.with_context(trace_id: anything)
+```
+
 #### Testing scheduled jobs
 
 *Use chainable matchers `#at`, `#in` and `#immediately`*
@@ -204,6 +220,10 @@ it { is_expected.to be_processed_in :download }
 
 ### ```be_retryable```
 *Describes if a job should retry when there is a failure in its execution*
+
+Note: this only tests against the `retry` option in the job's Sidekiq options.
+To test an enqueued job's retry, i.e. `AwesomeJob.set(retry: 5)`, use
+`with_context`
 ```ruby
 sidekiq_options retry: 5
 # test with...
@@ -235,14 +255,33 @@ it { is_expected.to save_backtrace false }
 ```
 
 ### ```be_unique```
+
+:warning: This is intended to for Sidekiq Enterprise unique job implementation.
+There is _limited_ support for Sidekiq Unique Jobs, but compatibility is not
+guaranteed.
+
 *Describes when a job should be unique within its queue*
 ```ruby
-sidekiq_options unique: true
+sidekiq_options unique_for: 1.hour
 # test with...
 expect(AwesomeJob).to be_unique
 it { is_expected.to be_unique }
+
+# specify a specific interval
+sidekiq_options unique_for: 1.hour
+it { is_expected.to be_unique.for(1.hour) }
+```
+
+#### `until` sub-matcher
+
+:warning: This sub-matcher only works for Sidekiq Enterprise
+
+```ruby
+sidekiq_options unique_for: 1.hour, unique_until: :start
+it { is_expected.to be_unique.until(:start) }
 ```
 
+
 ### ```be_expired_in```
 *Describes when a job should expire*
 ```ruby

data/lib/rspec/sidekiq/batch.rb

@@ -1,4 +1,7 @@
-require 'rspec/core'
+# frozen_string_literal: true
+
+require "rspec/core"
+require "rspec/support/fuzzy_matcher"
 
 if defined? Sidekiq::Batch
   module RSpec

data/lib/rspec/sidekiq/configuration.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "rubygems"
 require "set"
 
@@ -22,6 +24,10 @@ module RSpec
         Gem::Version.new(::Sidekiq::VERSION) >= Gem::Version.new("7.0.0")
       end
 
+      def sidekiq_gte_8?
+        Gem::Version.new(::Sidekiq::VERSION) >= Gem::Version.new("8.0.0")
+      end
+
       def silence_warning(symbol)
         @silence_warnings << symbol
       end

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Sidekiq
   module Worker
     module ClassMethods
@@ -8,15 +10,15 @@ module Sidekiq
 
       def default_retries_exhausted_message
         {
-          'queue' => get_sidekiq_options[:worker],
+          'queue' => get_sidekiq_options['queue'],
           'class' => name,
           'args' => [],
-          'error_message' => 'An error occured'
+          'error_message' => 'An error occurred'
         }
       end
 
       def default_retries_exhausted_exception
-        StandardError.new('An error occured')
+        StandardError.new('An error occurred')
       end
     end
   end

data/lib/rspec/sidekiq/helpers.rb

@@ -1,2 +1,4 @@
+# frozen_string_literal: true
+
 require 'rspec/core'
 require 'rspec/sidekiq/helpers/within_sidekiq_retries_exhausted_block'

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module RSpec
   module Sidekiq
     module Matchers
@@ -26,7 +28,7 @@ module RSpec
               # send to custom evaluator
               at_evaluator(value)
             else
-              job.context.has_key?(key) && job.context[key] == value
+              job.context.has_key?(key) && RSpec::Support::FuzzyMatcher.values_match?(value, job.context[key])
             end
           end
         end
@@ -58,7 +60,11 @@ module RSpec
         private
 
         def active_job?
-          job["class"] == "ActiveJob::QueueAdapters::SidekiqAdapter::JobWrapper"
+          if RSpec::Sidekiq.configuration.sidekiq_gte_8?
+            job["class"] == "Sidekiq::ActiveJob::Wrapper"
+          else
+            job["class"] == "ActiveJob::QueueAdapters::SidekiqAdapter::JobWrapper"
+          end
         end
 
         def deserialized_active_job_args
@@ -121,13 +127,13 @@ module RSpec
         def includes?(arguments, options, count)
           matching = jobs.filter { |job| matches?(job, arguments, options) }
 
-          case count
-          in [:exactly, n]
-            matching.size == n
-          in [:at_least, n]
-            matching.size >= n
-          in [:at_most, n]
-            matching.size <= n
+          case count[0]
+          when :exactly
+            matching.size == count[1]
+          when :at_least
+            matching.size >= count[1]
+          when :at_most
+            matching.size <= count[1]
           else
             matching.size > 0
           end
@@ -243,6 +249,26 @@ module RSpec
         end
         alias :time :times
 
+        def with_context(**kwargs)
+          raise ArgumentError, "Must specify keyword arguments to with_context" if kwargs.empty?
+
+          # gather keys and compare against currently set expected_options
+          # Someone could have accidentally used with_context and other
+          # chainables with different expectations. Better to explicitly
+          # inform loudly of clashes than let them overwrite silently
+          normalized = normalize_arguments(kwargs)
+          already_set = normalized.keys & @expected_options.keys
+          if already_set.any?
+            prettied = already_set.map { |key| "'#{key}'" }
+            raise ArgumentError, "There are already expectations against #{prettied.join(",")}. Did you already call other context chainables like `on` or `at`?"
+          end
+
+          # We're good, no accidental overwrites of expectations
+          @expected_options.merge!(normalized)
+
+          self
+        end
+
         def set_expected_count(relativity, n)
           n =
             case n
@@ -275,13 +301,13 @@ module RSpec
             message << "but enqueued only jobs"
             if expected_arguments
               job_messages = actual_jobs.map do |job|
-                base = "  -JID:#{job.jid} with arguments:"
-                base << "\n    -#{formatted(job.args)}"
+                base = ["  -JID:#{job.jid} with arguments:"]
+                base << "    -#{formatted(job.args)}"
                 if expected_options.any?
-                  base << "\n   with context: #{formatted(job.context)}"
+                  base << "   with context: #{formatted(job.context)}"
                 end
 
-                base
+                base.join("\n")
               end
 
               message << job_messages.join("\n")
@@ -302,13 +328,13 @@ module RSpec
         end
 
         def count_message
-          case expected_count
-          in [:positive, _]
+          case expected_count[0]
+          when :positive
             "a"
-          in [:exactly, n]
-            n
-          in [relativity, n]
-            "#{relativity.to_s.gsub('_', ' ')} #{n}"
+          when :exactly
+            expected_count[1]
+          else
+            "#{expected_count[0].to_s.gsub('_', ' ')} #{expected_count[1]}"
           end
         end
 

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module RSpec
   module Sidekiq
     module Matchers

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module RSpec
   module Sidekiq
     module Matchers

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module RSpec
   module Sidekiq
     module Matchers

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module RSpec
   module Sidekiq
     module Matchers

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module RSpec
   module Sidekiq
     module Matchers
@@ -25,6 +27,9 @@ module RSpec
             if !interval_matches? && @expected_interval
               "expected #{@klass} to be unique for #{@expected_interval} seconds, "\
               "but its interval was #{actual_interval} seconds"
+            elsif !expiration_matches?
+              "expected #{@klass} to be unique until #{@expected_expiration}, "\
+              "but its unique_until was #{actual_expiration || 'not specified'}"
             else
               "expected #{@klass} to be unique in the queue"
             end
@@ -33,7 +38,7 @@ module RSpec
           def matches?(job)
             @klass = job.is_a?(Class) ? job : job.class
             @actual = @klass.get_sidekiq_options[unique_key]
-            !!(value_matches? && interval_matches?)
+            !!(value_matches? && interval_matches? && expiration_matches?)
           end
 
           def for(interval)
@@ -41,6 +46,11 @@ module RSpec
             self
           end
 
+          def until(expiration)
+            @expected_expiration = expiration
+            self
+          end
+
           def interval_specified?
             @expected_interval
           end
@@ -49,6 +59,10 @@ module RSpec
             !interval_specified? || actual_interval == @expected_interval
           end
 
+          def expiration_matches?
+            @expected_expiration.nil? || actual_expiration ==  @expected_expiration
+          end
+
           def failure_message_when_negated
             "expected #{@klass} to not be unique in the queue"
           end
@@ -59,6 +73,10 @@ module RSpec
             @klass.get_sidekiq_options['unique_job_expiration']
           end
 
+          def actual_expiration
+            fail 'until is not supported for SidekiqUniqueJobs'
+          end
+
           def value_matches?
             [true, :all].include?(@actual)
           end
@@ -73,6 +91,10 @@ module RSpec
             @actual
           end
 
+          def actual_expiration
+            @klass.get_sidekiq_options['unique_until']
+          end
+
           def value_matches?
             @actual && @actual > 0
           end

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module RSpec
   module Sidekiq
     module Matchers
@@ -72,6 +74,9 @@ module RSpec
       #   expect { AwesomeJob.perform_async }.to enqueue_sidekiq_job.immediately
       #   expect { AwesomeJob.perform_at(1.hour.ago) }.to enqueue_sidekiq_job.immediately
       #
+      #   # With specific context
+      #   expect { AwesomeJob.set(trace_id: "something").perform_async }.to enqueue_sidekiq_job.with_context(trace_id: anything)
+      #
       #   ## Composable
       #
       #   expect do

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module RSpec
   module Sidekiq
     module Matchers

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module RSpec
   module Sidekiq
     module Matchers

data/lib/rspec/sidekiq/matchers.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "rspec/core"
 require "rspec/matchers"
 require "rspec/mocks/argument_list_matcher"

data/lib/rspec/sidekiq/sidekiq.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module RSpec
   module Sidekiq
     class << self

data/lib/rspec/sidekiq/version.rb

@@ -1,5 +1,7 @@
+# frozen_string_literal: true
+
 module RSpec
   module Sidekiq
-    VERSION = "5.0.0"
+    VERSION = "5.1.0"
   end
 end

data/lib/rspec-sidekiq.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'forwardable'
 
 require 'sidekiq'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rspec-sidekiq
 version: !ruby/object:Gem::Version
-  version: 5.0.0
+  version: 5.1.0
 platform: ruby
 authors:
 - Aidan Coyle
@@ -10,7 +10,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-05-15 00:00:00.000000000 Z
+date: 2025-03-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec-core
@@ -63,7 +63,7 @@ dependencies:
         version: '5'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '8'
+        version: '9'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -73,7 +73,7 @@ dependencies:
         version: '5'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '8'
+        version: '9'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
@@ -228,6 +228,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Simple testing of Sidekiq jobs via a collection of matchers and helpers
 email:
 executables: []
@@ -257,7 +271,8 @@ files:
 homepage: http://github.com/wspurgin/rspec-sidekiq
 licenses:
 - MIT
-metadata: {}
+metadata:
+  changelog_uri: https://github.com/wspurgin/rspec-sidekiq/blob/main/CHANGES.md
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -273,7 +288,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.26
+rubygems_version: 3.5.22
 signing_key:
 specification_version: 4
 summary: RSpec for Sidekiq