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('foo@example.com')
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('foo@example.com')
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 "foo@example.com"
Then I should receive a welcome email to "foo@example.com"

Instance Method Summary collapse

Instance Method Details

#clearObject

Clear all jobs for this worker



146
147
148
# File 'lib/sidekiq/testing.rb', line 146

def clear
  jobs.clear
end

#client_push(item) ⇒ Object

:nodoc:



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

def client_push(item) # :nodoc:
  pool = Thread.current[:sidekiq_via_pool] || get_sidekiq_options['pool'] || Sidekiq.redis_pool
  Sidekiq::Client.new(pool).push(item.stringify_keys)
end

#drainObject

Drain and run all jobs for this worker



151
152
153
154
155
156
157
# File 'lib/sidekiq/testing.rb', line 151

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

#execute_job(worker, args) ⇒ Object



168
169
170
# File 'lib/sidekiq/testing.rb', line 168

def execute_job(worker, args)
  worker.perform(*args)
end

#get_sidekiq_optionsObject

:nodoc:



78
79
80
# File 'lib/sidekiq/worker.rb', line 78

def get_sidekiq_options # :nodoc:
  self.sidekiq_options_hash ||= Sidekiq.default_worker_options
end

#jobsObject

Jobs queued for this worker



141
142
143
# File 'lib/sidekiq/testing.rb', line 141

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
  ts = (int < 1_000_000_000 ? (now + interval).to_f : int)

  item = { 'class' => self, 'args' => args, 'at' => ts }

  # Optimization to enqueue something now that is scheduled to go out now or in the past
  item.delete('at'.freeze) if ts <= now.to_f

  client_push(item)
end

#perform_oneObject

Pop out a single job and perform it

Raises:



160
161
162
163
164
165
166
# File 'lib/sidekiq/testing.rb', line 160

def perform_one
  raise(EmptyQueueError, "perform_one called with empty job queue") if jobs.empty?
  job = jobs.shift
  worker = new
  worker.jid = job['jid']
  execute_job(worker, 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*
:pool - use the given Redis connection pool to push this type of job to a given shard.


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

def sidekiq_options(opts={})
  self.sidekiq_options_hash = get_sidekiq_options.merge((opts || {}).stringify_keys)
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