1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
|
# frozen_string_literal: true
require_relative 'helper'
require 'active_record'
require 'action_mailer'
require 'sidekiq/rails'
require 'sidekiq/extensions/action_mailer'
require 'sidekiq/extensions/active_record'
Sidekiq.hook_rails!
class TestTesting < Sidekiq::Test
describe 'sidekiq testing' do
class PerformError < RuntimeError; end
class DirectWorker
include Sidekiq::Worker
def perform(a, b)
a + b
end
end
class EnqueuedWorker
include Sidekiq::Worker
def perform(a, b)
a + b
end
end
class StoredWorker
include Sidekiq::Worker
def perform(error)
raise PerformError if error
end
end
class FooMailer < ActionMailer::Base
def bar(str)
str
end
end
class FooModel < ActiveRecord::Base
def bar(str)
str
end
end
before do
require 'sidekiq/testing'
Sidekiq::Testing.fake!
EnqueuedWorker.jobs.clear
DirectWorker.jobs.clear
end
after do
Sidekiq::Testing.disable!
Sidekiq::Queues.clear_all
end
it 'stubs the async call' do
assert_equal 0, DirectWorker.jobs.size
assert DirectWorker.perform_async(1, 2)
assert_equal 1, DirectWorker.jobs.size
assert DirectWorker.perform_in(10, 1, 2)
assert_equal 2, DirectWorker.jobs.size
assert DirectWorker.perform_at(10, 1, 2)
assert_equal 3, DirectWorker.jobs.size
assert_in_delta 10.seconds.from_now.to_f, DirectWorker.jobs.last['at'], 0.01
end
it 'stubs the delay call on mailers' do
assert_equal 0, Sidekiq::Extensions::DelayedMailer.jobs.size
FooMailer.delay.bar('hello!')
assert_equal 1, Sidekiq::Extensions::DelayedMailer.jobs.size
end
class Something
def self.foo(x)
end
end
it 'stubs the delay call on models' do
assert_equal 0, Sidekiq::Extensions::DelayedClass.jobs.size
Something.delay.foo(Date.today)
assert_equal 1, Sidekiq::Extensions::DelayedClass.jobs.size
end
it 'stubs the enqueue call' do
assert_equal 0, EnqueuedWorker.jobs.size
assert Sidekiq::Client.enqueue(EnqueuedWorker, 1, 2)
assert_equal 1, EnqueuedWorker.jobs.size
end
it 'stubs the enqueue_to call' do
assert_equal 0, EnqueuedWorker.jobs.size
assert Sidekiq::Client.enqueue_to('someq', EnqueuedWorker, 1, 2)
assert_equal 1, Sidekiq::Queues['someq'].size
end
it 'executes all stored jobs' do
assert StoredWorker.perform_async(false)
assert StoredWorker.perform_async(true)
assert_equal 2, StoredWorker.jobs.size
assert_raises PerformError do
StoredWorker.drain
end
assert_equal 0, StoredWorker.jobs.size
end
class SpecificJidWorker
include Sidekiq::Worker
class_attribute :count
self.count = 0
def perform(worker_jid)
return unless worker_jid == self.jid
self.class.count += 1
end
end
it 'execute only jobs with assigned JID' do
4.times do |i|
jid = SpecificJidWorker.perform_async(nil)
if i % 2 == 0
SpecificJidWorker.jobs[-1]["args"] = ["wrong_jid"]
else
SpecificJidWorker.jobs[-1]["args"] = [jid]
end
end
SpecificJidWorker.perform_one
assert_equal 0, SpecificJidWorker.count
SpecificJidWorker.perform_one
assert_equal 1, SpecificJidWorker.count
SpecificJidWorker.drain
assert_equal 2, SpecificJidWorker.count
end
it 'round trip serializes the job arguments' do
assert StoredWorker.perform_async(:mike)
job = StoredWorker.jobs.first
assert_equal "mike", job['args'].first
StoredWorker.clear
end
it 'perform_one runs only one job' do
DirectWorker.perform_async(1, 2)
DirectWorker.perform_async(3, 4)
assert_equal 2, DirectWorker.jobs.size
DirectWorker.perform_one
assert_equal 1, DirectWorker.jobs.size
DirectWorker.clear
end
it 'perform_one raise error upon empty queue' do
DirectWorker.clear
assert_raises Sidekiq::EmptyQueueError do
DirectWorker.perform_one
end
end
class FirstWorker
include Sidekiq::Worker
class_attribute :count
self.count = 0
def perform
self.class.count += 1
end
end
class SecondWorker
include Sidekiq::Worker
class_attribute :count
self.count = 0
def perform
self.class.count += 1
end
end
class ThirdWorker
include Sidekiq::Worker
class_attribute :count
def perform
FirstWorker.perform_async
SecondWorker.perform_async
end
end
it 'clears jobs across all workers' do
Sidekiq::Worker.jobs.clear
FirstWorker.count = 0
SecondWorker.count = 0
assert_equal 0, FirstWorker.jobs.size
assert_equal 0, SecondWorker.jobs.size
FirstWorker.perform_async
SecondWorker.perform_async
assert_equal 1, FirstWorker.jobs.size
assert_equal 1, SecondWorker.jobs.size
Sidekiq::Worker.clear_all
assert_equal 0, FirstWorker.jobs.size
assert_equal 0, SecondWorker.jobs.size
assert_equal 0, FirstWorker.count
assert_equal 0, SecondWorker.count
end
it 'drains jobs across all workers' do
Sidekiq::Worker.jobs.clear
FirstWorker.count = 0
SecondWorker.count = 0
assert_equal 0, FirstWorker.jobs.size
assert_equal 0, SecondWorker.jobs.size
assert_equal 0, FirstWorker.count
assert_equal 0, SecondWorker.count
FirstWorker.perform_async
SecondWorker.perform_async
assert_equal 1, FirstWorker.jobs.size
assert_equal 1, SecondWorker.jobs.size
Sidekiq::Worker.drain_all
assert_equal 0, FirstWorker.jobs.size
assert_equal 0, SecondWorker.jobs.size
assert_equal 1, FirstWorker.count
assert_equal 1, SecondWorker.count
end
it 'drains jobs across all workers even when workers create new jobs' do
Sidekiq::Worker.jobs.clear
FirstWorker.count = 0
SecondWorker.count = 0
assert_equal 0, ThirdWorker.jobs.size
assert_equal 0, FirstWorker.count
assert_equal 0, SecondWorker.count
ThirdWorker.perform_async
assert_equal 1, ThirdWorker.jobs.size
Sidekiq::Worker.drain_all
assert_equal 0, ThirdWorker.jobs.size
assert_equal 1, FirstWorker.count
assert_equal 1, SecondWorker.count
end
it 'drains jobs of workers with symbolized queue names' do
Sidekiq::Worker.jobs.clear
AltQueueWorker.perform_async(5,6)
assert_equal 1, AltQueueWorker.jobs.size
Sidekiq::Worker.drain_all
assert_equal 0, AltQueueWorker.jobs.size
end
it 'can execute a job' do
DirectWorker.execute_job(DirectWorker.new, [2, 3])
end
end
describe 'queue testing' do
before do
require 'sidekiq/testing'
Sidekiq::Testing.fake!
end
after do
Sidekiq::Testing.disable!
Sidekiq::Queues.clear_all
end
class QueueWorker
include Sidekiq::Worker
def perform(a, b)
a + b
end
end
class AltQueueWorker
include Sidekiq::Worker
sidekiq_options queue: :alt
def perform(a, b)
a + b
end
end
it 'finds enqueued jobs' do
assert_equal 0, Sidekiq::Queues["default"].size
QueueWorker.perform_async(1, 2)
QueueWorker.perform_async(1, 2)
AltQueueWorker.perform_async(1, 2)
assert_equal 2, Sidekiq::Queues["default"].size
assert_equal [1, 2], Sidekiq::Queues["default"].first["args"]
assert_equal 1, Sidekiq::Queues["alt"].size
end
it 'clears out all queues' do
assert_equal 0, Sidekiq::Queues["default"].size
QueueWorker.perform_async(1, 2)
QueueWorker.perform_async(1, 2)
AltQueueWorker.perform_async(1, 2)
Sidekiq::Queues.clear_all
assert_equal 0, Sidekiq::Queues["default"].size
assert_equal 0, QueueWorker.jobs.size
assert_equal 0, Sidekiq::Queues["alt"].size
assert_equal 0, AltQueueWorker.jobs.size
end
it 'finds jobs enqueued by client' do
Sidekiq::Client.push(
'class' => 'NonExistentWorker',
'queue' => 'missing',
'args' => [1]
)
assert_equal 1, Sidekiq::Queues["missing"].size
end
it 'respects underlying array changes' do
# Rspec expect change() syntax saves a reference to
# an underlying array. When the array containing jobs is
# derived, Rspec test using `change(QueueWorker.jobs, :size).by(1)`
# won't pass. This attempts to recreate that scenario
# by saving a reference to the jobs array and ensuring
# it changes properly on enqueueing
jobs = QueueWorker.jobs
assert_equal 0, jobs.size
QueueWorker.perform_async(1, 2)
assert_equal 1, jobs.size
end
end
end
|
