Module: Sidekiq::Worker::ClassMethods

Defined in:
lib/sidekiq/testing.rb,
lib/sidekiq/worker.rb

Overview

The Sidekiq testing infrastructure overrides perform_async so that it does not actually touch the network. Instead it stores the asynchronous jobs in a per-class array so that their presence/absence can be asserted by your tests.

This is similar to ActionMailer’s :test delivery_method and its ActionMailer::Base.deliveries array.

Example:

require 'sidekiq/testing'

assert_equal 0, HardWorker.jobs.size
HardWorker.perform_async(:something)
assert_equal 1, HardWorker.jobs.size
assert_equal :something, HardWorker.jobs[0]['args'][0]

assert_equal 0, Sidekiq::Extensions::DelayedMailer.jobs.size
MyMailer.delay.send_welcome_email('[email protected]')
assert_equal 1, Sidekiq::Extensions::DelayedMailer.jobs.size

You can also clear and drain all workers’ jobs:

assert_equal 0, Sidekiq::Extensions::DelayedMailer.jobs.size
assert_equal 0, Sidekiq::Extensions::DelayedModel.jobs.size

MyMailer.delay.send_welcome_email('[email protected]')
MyModel.delay.do_something_hard

assert_equal 1, Sidekiq::Extensions::DelayedMailer.jobs.size
assert_equal 1, Sidekiq::Extensions::DelayedModel.jobs.size

Sidekiq::Worker.clear_all # or .drain_all

assert_equal 0, Sidekiq::Extensions::DelayedMailer.jobs.size
assert_equal 0, Sidekiq::Extensions::DelayedModel.jobs.size

This can be useful to make sure jobs don’t linger between tests:

RSpec.configure do |config|
  config.before(:each) do
    Sidekiq::Worker.clear_all
  end
end

or for acceptance testing, i.e. with cucumber:

AfterStep do
  Sidekiq::Worker.drain_all
end

When I sign up as "[email protected]"
Then I should receive a welcome email to "[email protected]"

Constant Summary collapse

DEFAULT_OPTIONS = 
{ 'retry' => true, 'queue' => 'default' }

Instance Method Summary collapse

Instance Method Details

#clear ⇒ Object

Clear all jobs for this worker



82
83
84
 
# File 'lib/sidekiq/testing.rb', line 82

def clear
  jobs.clear
end

#client_push(item) ⇒ Object

:nodoc:



84
85
86
 
# File 'lib/sidekiq/worker.rb', line 84

def client_push(item) # :nodoc:
  Sidekiq::Client.push(item.stringify_keys)
end

#drain ⇒ Object

Drain and run all jobs for this worker



87
88
89
90
91
92
93
 
# File 'lib/sidekiq/testing.rb', line 87

def drain
  while job = jobs.shift do
    worker = new
    worker.jid = job['jid']
    worker.perform(*job['args'])
  end
end

#get_sidekiq_options ⇒ Object

:nodoc:



80
81
82
 
# File 'lib/sidekiq/worker.rb', line 80

def get_sidekiq_options # :nodoc:
  self.sidekiq_options_hash ||= DEFAULT_OPTIONS
end

#jobs ⇒ Object

Jobs queued for this worker



77
78
79
 
# File 'lib/sidekiq/testing.rb', line 77

def jobs
  Worker.jobs[self]
end

#perform_async(*args) ⇒ Object 



39
40
41
 
# File 'lib/sidekiq/worker.rb', line 39

def perform_async(*args)
  client_push('class' => self, 'args' => args)
end

#perform_in(interval, *args) ⇒ Object Also known as: perform_at 



43
44
45
46
47
48
49
50
51
52
53
54
 
# File 'lib/sidekiq/worker.rb', line 43

def perform_in(interval, *args)
  int = interval.to_f
  now = Time.now.to_f
  ts = (int < 1_000_000_000 ? now + int : int)

  # Optimization to enqueue something now that is scheduled to go out now or in the past
  if ts <= now
    perform_async(*args)
  else
    client_push('class' => self, 'args' => args, 'at' => ts)
  end
end

#perform_one ⇒ Object

Pop out a single job and perform it

Raises:



96
97
98
99
100
101
102
 
# File 'lib/sidekiq/testing.rb', line 96

def perform_one
  raise(EmptyQueueError, "perform_one called with empty job queue") if jobs.empty?
  job = jobs.shift
  worker = new
  worker.jid = job['jid']
  worker.perform(*job['args'])
end

#sidekiq_options(opts = {}) ⇒ Object

Allows customization for this type of Worker. Legal options:

:queue - use a named queue for this Worker, default 'default'
:retry - enable the RetryJobs middleware for this Worker, default *true*
:backtrace - whether to save any error backtrace in the retry payload to display in web UI,
   can be true, false or an integer number of lines to save, default *false*



65
66
67
68
 
# File 'lib/sidekiq/worker.rb', line 65

def sidekiq_options(opts={})
  self.sidekiq_options_hash = get_sidekiq_options.merge((opts || {}).stringify_keys)
  ::Sidekiq.logger.warn("#{self.name} - :timeout is unsafe and support has been removed from Sidekiq, see http://bit.ly/OtYpK for details") if opts.include? :timeout
end

#sidekiq_retries_exhausted(&block) ⇒ Object 



74
75
76
 
# File 'lib/sidekiq/worker.rb', line 74

def sidekiq_retries_exhausted(&block)
  self.sidekiq_retries_exhausted_block = block
end

#sidekiq_retry_in(&block) ⇒ Object 



70
71
72
 
# File 'lib/sidekiq/worker.rb', line 70

def sidekiq_retry_in(&block)
  self.sidekiq_retry_in_block = block
end