rspec-enqueue_sidekiq_job 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: de3c1c3128e120821b811fcfeaa8d4e5e2b5de23b4fe65ef104e3dfb6289ded9
+  data.tar.gz: e09df3e10ee5d249719525957f9880e5cf2cb8429d423d97f0db5285c85df428
+SHA512:
+  metadata.gz: 12c4b8b29f0eb0f4ffd720cee62143aa7a991a26a1b0df52c52133fbba31333706a3e0f47559ed188dbdfa39fc8629dd1eb0850ccd3131da02441327fba7929c
+  data.tar.gz: 83308d8e0298d057b116d0718623d0575c2323a3c3a29fc7a4c6e9fe7527b3b91b3a16b56c1c20c53023a6e5bff618211c4d836da5612566ca3743113b279b4c

data/LICENSE

@@ -0,0 +1,9 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Phil Pirozhkov
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,40 @@
+# `enqueue_sidekiq_job` RSpec block matcher
+
+## Installation
+
+```ruby
+# Gemfile
+group :test do
+  gem 'rspec-enqueue_sidekiq_job', require: 'rspec/enqueue_sidekiq_job'
+end
+```
+
+## Usage
+
+Checks if a certain job was enqueued in a block.
+
+```ruby
+expect { AwesomeWorker.perform_async }
+  .to enqueue_sidekiq_job(AwesomeWorker)
+```
+
+### Specifying arguments
+
+```ruby
+expect { AwesomeWorker.perform_async(42, 'David')
+  .to enqueue_sidekiq_job(AwesomeWorker).with(42, 'David')
+```
+
+### Testing scheduled jobs
+
+Use chainable matchers `#at` and `#in`:
+```ruby
+time = 5.minutes.from_now
+expect { AwesomeWorker.perform_at(time) }
+  .to enqueue_sidekiq_job(AwesomeWorker).at(time)
+```
+```ruby
+interval = 5.minutes
+expect { AwesomeWorker.perform_in(interval) }
+  .to enqueue_sidekiq_job(AwesomeWorker).in(5.minutes)
+```

data/lib/rspec/enqueue_sidekiq_job.rb

@@ -0,0 +1,132 @@
+require 'rspec'
+require 'sidekiq/testing'
+
+module RSpec
+  # An includable module that provides `enqueue_sidekiq_job` matcher
+  module EnqueuedSidekiqJob
+    # Checks if a certain job was enqueued in a block.
+    #
+    # expect { AwesomeWorker.perform_async }
+    #   .to enqueue_sidekiq_job(AwesomeWorker)
+    #
+    #
+    # expect { AwesomeWorker.perform_async(42, 'David')
+    #   .to enqueue_sidekiq_job(AwesomeWorker).with(42, 'David')
+    #
+    # time = 5.minutes.from_now
+    # expect { AwesomeWorker.perform_at(time) }
+    #   .to enqueue_sidekiq_job(AwesomeWorker).at(time)
+    #
+    # interval = 5.minutes
+    # expect { AwesomeWorker.perform_in(interval) }
+    #   .to enqueue_sidekiq_job(AwesomeWorker).in(5.minutes)
+    #
+    def enqueue_sidekiq_job(worker_class)
+      Matcher.new(worker_class)
+    end
+
+    # @private
+    class Matcher
+      include RSpec::Matchers::Composable
+
+      def initialize(worker_class)
+        @worker_class = worker_class
+      end
+
+      def with(*expected_arguments, **kwargs)
+        raise 'keyword arguments serialization is not supported by Sidekiq' unless kwargs.empty?
+
+        @expected_arguments = expected_arguments
+        self
+      end
+
+      def at(timestamp)
+        raise 'setting expecations with both `at` and `in` is not supported' if @expected_in
+
+        @expected_at = timestamp
+        self
+      end
+
+      def in(interval)
+        raise 'setting expecations with both `at` and `in` is not supported' if @expected_at
+
+        @expected_in = interval
+        self
+      end
+
+      def matches?(block)
+        filter(enqueued_in_block(block)).one?
+      end
+
+      def does_not_match?(block)
+        filter(enqueued_in_block(block)).none?
+      end
+
+      def failure_message
+        message = ["expected to enqueue #{worker_class} job"]
+        message << "  arguments: #{expected_arguments}" if expected_arguments
+        message << "  in: #{expected_in.inspect}" if expected_in
+        message << "  at: #{expected_at}" if expected_at
+        message.join("\n")
+      end
+
+      def failure_message_when_negated
+        message = ["expected not to enqueue #{worker_class} job"]
+        message << "  arguments: #{expected_arguments}" if expected_arguments
+        message << "  in: #{expected_in.inspect}" if expected_in
+        message << "  at: #{expected_at}" if expected_at
+        message.join("\n")
+      end
+
+      def supports_block_expectations?
+        true
+      end
+
+      def supports_value_expectations?
+        false
+      end
+
+      private
+
+      def enqueued_in_block(block)
+        before = @worker_class.jobs.dup
+        block.call
+        @worker_class.jobs - before
+      end
+
+      def filter(jobs)
+        jobs = jobs.select { |job| timestamps_match_rounded_to_seconds?(job['at']) } if expected_at
+        jobs = jobs.select { |job| intervals_match_rounded_to_seconds?(job['at']) } if expected_in
+        jobs = jobs.select { |job| values_match?(expected_arguments, job['args']) } if expected_arguments
+        jobs
+      end
+
+      # Due to zero nsec precision of `Time.now` (and therefore `5.minutes.from_now`) on
+      # some platforms, and lossy Sidekiq serialization that uses `.to_f` on timestamps,
+      # values won't match unless rounded.
+      # Rounding to whole seconds is sub-optimal but simple.
+      def timestamps_match_rounded_to_seconds?(actual)
+        return false if actual.nil?
+
+        actual_time = Time.at(actual)
+        values_match?(expected_at, actual_time) ||
+          expected_at.to_i == actual_time.to_i
+      end
+
+      def intervals_match_rounded_to_seconds?(actual)
+        return false if actual.nil?
+
+        actual_time = Time.at(actual)
+        expected_in.from_now.to_i == actual_time.to_i
+      end
+
+      attr_reader :worker_class, :expected_arguments, :expected_at, :expected_in
+    end
+
+    private_constant :Matcher
+  end
+end
+
+RSpec.configure do |config|
+  config.include RSpec::EnqueuedSidekiqJob
+end

data/lib/rspec/enqueue_sidekiq_job/version.rb

@@ -0,0 +1,5 @@
+module RSpec
+  module EnqueuedSidekiqJob
+    VERSION = '1.0.0'.freeze
+  end
+end

data/rspec-enqueue_sidekiq_job.gemspec

@@ -0,0 +1,27 @@
+require File.expand_path('lib/rspec/enqueue_sidekiq_job/version', __dir__)
+
+Gem::Specification.new do |s|
+  s.name        = 'rspec-enqueue_sidekiq_job'
+  s.version     = RSpec::EnqueuedSidekiqJob::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.author      = 'Phil Pirozhkov'
+  s.email       = 'hello@fili.pp.ru'
+  s.homepage    = 'http://github.com/pirj/rspec-enqueue_sidekiq_job'
+  s.summary     = 'RSpec matcher to check enqueueing of Sidekiq jobs'
+  s.description = s.summary
+  s.license     = 'MIT'
+
+  s.required_ruby_version = '>= 2.4.0'
+
+  s.add_dependency 'rspec-core', '~> 3'
+  s.add_dependency 'rspec-expectations', '~> 3'
+  s.add_dependency 'sidekiq', '>= 2.4.0'
+
+  s.add_development_dependency 'activesupport'
+  s.add_development_dependency 'rspec'
+  s.add_development_dependency 'rubocop'
+  s.add_development_dependency 'rubocop-rspec'
+
+  s.files = %w[LICENSE README.md rspec-enqueue_sidekiq_job.gemspec] + Dir['**/*.rb']
+  s.require_paths = ['lib']
+end

data/spec/rspec/enqueue_sidekiq_job_spec.rb

@@ -0,0 +1,203 @@
+require 'spec_helper'
+
+RSpec.describe RSpec::EnqueuedSidekiqJob do
+  let(:worker) do
+    Class.new do
+      include ::Sidekiq::Worker
+    end
+  end
+
+  let(:another_worker) do
+    Class.new do
+      include ::Sidekiq::Worker
+    end
+  end
+
+  it 'raises ArgumentError when used in value expectation', pending: 'only fails with ArgumentError on RSpec 4' do
+    expect {
+      expect(worker.perform_async).to enqueue_sidekiq_job(worker)
+    }.to raise_error(ArgumentError)
+  end
+
+  it 'fails when no worker class is specified' do
+    expect {
+      expect { worker.perform_async }.to enqueue_sidekiq_job
+    }.to raise_error(ArgumentError)
+  end
+
+  it 'passes' do
+    expect { worker.perform_async }
+      .to enqueue_sidekiq_job(worker)
+  end
+
+  it 'fails when negated and job is enqueued' do
+    expect {
+      expect { worker.perform_async }.not_to enqueue_sidekiq_job(worker)
+    }.to raise_error(/expected not to enqueue/)
+  end
+
+  context 'when no jobs were enqueued' do
+    it 'fails' do
+      expect {
+        expect {} # nop
+          .to enqueue_sidekiq_job(worker)
+      }.to raise_error(/expected to enqueue/)
+    end
+
+    it 'passes with negation' do
+      expect {} # nop
+        .not_to enqueue_sidekiq_job(worker)
+    end
+  end
+
+  context 'with another worker' do
+    it 'fails' do
+      expect {
+        expect { worker.perform_async }
+          .to enqueue_sidekiq_job(another_worker)
+      }.to raise_error(/expected to enqueue/)
+    end
+
+    it 'passes with negation' do
+      expect { worker.perform_async }
+        .not_to enqueue_sidekiq_job(another_worker)
+    end
+  end
+
+  it 'counts only jobs enqueued in block' do
+    worker.perform_async
+    expect {}.not_to enqueue_sidekiq_job(worker)
+  end
+
+  it 'counts jobs enqueued in block' do
+    worker.perform_async
+    expect { worker.perform_async }.to enqueue_sidekiq_job(worker)
+  end
+
+  it 'fails when too many jobs enqueued' do
+    expect {
+      expect {
+        worker.perform_async
+        worker.perform_async
+      }.to enqueue_sidekiq_job(worker)
+    }.to raise_error(/expected to enqueue/)
+  end
+
+  it 'fails when negated and several jobs enqueued' do
+    expect {
+      expect {
+        worker.perform_async
+        worker.perform_async
+      }.not_to enqueue_sidekiq_job(worker)
+    }.to raise_error(/expected not to enqueue/)
+  end
+
+  it 'passes with multiple jobs' do
+    expect {
+      another_worker.perform_async
+      worker.perform_async
+    }
+      .to enqueue_sidekiq_job(worker)
+      .and enqueue_sidekiq_job(another_worker)
+  end
+
+  context 'when enqueued with perform_at' do
+    it 'passes' do
+      future = 1.minute.from_now
+      expect { worker.perform_at(future) }
+        .to enqueue_sidekiq_job(worker).at(future)
+    end
+
+    it 'fails when timestamps do not match' do
+      future = 1.minute.from_now
+      expect {
+        expect { worker.perform_at(future) }
+          .to enqueue_sidekiq_job(worker).at(2.minutes.from_now)
+      }.to raise_error(/expected to enqueue.+at:/m)
+    end
+
+    it 'matches timestamps with nanosecond precision' do
+      100.times do
+        future = 1.minute.from_now
+        future = future.change(nsec: future.nsec.round(-3) + rand(999))
+        expect { worker.perform_at(future) }
+          .to enqueue_sidekiq_job(worker).at(future)
+      end
+    end
+
+    it 'accepts composable matchers' do
+      future = 1.minute.from_now
+      slightly_earlier = 58.seconds.from_now
+      expect { worker.perform_at(slightly_earlier) }
+        .to enqueue_sidekiq_job(worker).at(a_value_within(5.seconds).of(future))
+    end
+
+    it 'fails when the job was enuqued for now' do
+      expect {
+        expect { worker.perform_async }
+          .to enqueue_sidekiq_job(worker).at(1.minute.from_now)
+      }.to raise_error(/expected to enqueue.+at:/m)
+    end
+  end
+
+  context 'when enqueued with perform_in' do
+    it 'passes' do
+      interval = 1.minute
+      expect { worker.perform_in(interval) }
+        .to enqueue_sidekiq_job(worker).in(interval)
+    end
+
+    it 'fails when timestamps do not match' do
+      interval = 1.minute
+      expect {
+        expect { worker.perform_in(interval) }
+          .to enqueue_sidekiq_job(worker).in(2.minutes)
+      }.to raise_error(/expected to enqueue.+in:/m)
+    end
+
+    it 'fails when the job was enuqued for now' do
+      expect {
+        expect { worker.perform_async }
+          .to enqueue_sidekiq_job(worker).in(1.minute)
+      }.to raise_error(/expected to enqueue.+in:/m)
+    end
+  end
+
+  it 'matches when not specified at and scheduled for the future' do
+    expect { worker.perform_in(1.day) }
+      .to enqueue_sidekiq_job(worker)
+    expect { worker.perform_at(1.day.from_now) }
+      .to enqueue_sidekiq_job(worker)
+  end
+
+  context 'with arguments' do
+    it 'fails with kwargs' do
+      expect {
+        expect { worker.perform_async }
+          .to enqueue_sidekiq_job(worker).with(42, name: 'David')
+      }.to raise_error(/keyword arguments serialization is not supported by Sidekiq/)
+    end
+
+    it 'passes with provided arguments' do
+      expect { worker.perform_async(42, 'David') }
+        .to enqueue_sidekiq_job(worker).with(42, 'David')
+    end
+
+    it 'supports provided argument matchers' do
+      expect { worker.perform_async(42, 'David') }
+        .to enqueue_sidekiq_job(worker).with(be > 41, a_string_including('Dav'))
+    end
+
+    it 'passes when negated and arguments do not match' do
+      expect { worker.perform_async(42, 'David') }
+        .not_to enqueue_sidekiq_job(worker).with(11, 'Phil')
+    end
+
+    it 'fails when arguments do not match' do
+      expect {
+        expect { worker.perform_async(42, 'David') }
+          .to enqueue_sidekiq_job(worker).with(11, 'Phil')
+      }.to raise_error(/expected to enqueue.+arguments:/m)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,4 @@
+require 'active_support/core_ext/numeric/time'
+require 'active_support'
+require 'sidekiq'
+require 'rspec/enqueue_sidekiq_job'

metadata

@@ -0,0 +1,147 @@
+--- !ruby/object:Gem::Specification
+name: rspec-enqueue_sidekiq_job
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Phil Pirozhkov
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2021-03-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec-core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+- !ruby/object:Gem::Dependency
+  name: rspec-expectations
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+- !ruby/object:Gem::Dependency
+  name: sidekiq
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.4.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.4.0
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  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'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  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'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  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: RSpec matcher to check enqueueing of Sidekiq jobs
+email: hello@fili.pp.ru
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/rspec/enqueue_sidekiq_job.rb
+- lib/rspec/enqueue_sidekiq_job/version.rb
+- rspec-enqueue_sidekiq_job.gemspec
+- spec/rspec/enqueue_sidekiq_job_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/pirj/rspec-enqueue_sidekiq_job
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.4.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.3
+signing_key:
+specification_version: 4
+summary: RSpec matcher to check enqueueing of Sidekiq jobs
+test_files: []