/
testing.rb
324 lines (287 loc) · 8.37 KB
/
testing.rb
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
# frozen_string_literal: true
require "securerandom"
require "sidekiq"
module Sidekiq
class Testing
class << self
attr_accessor :__test_mode
def __set_test_mode(mode)
if block_given?
current_mode = __test_mode
begin
self.__test_mode = mode
yield
ensure
self.__test_mode = current_mode
end
else
self.__test_mode = mode
end
end
def disable!(&block)
__set_test_mode(:disable, &block)
end
def fake!(&block)
__set_test_mode(:fake, &block)
end
def inline!(&block)
__set_test_mode(:inline, &block)
end
def enabled?
__test_mode != :disable
end
def disabled?
__test_mode == :disable
end
def fake?
__test_mode == :fake
end
def inline?
__test_mode == :inline
end
def server_middleware
@server_chain ||= Middleware::Chain.new
yield @server_chain if block_given?
@server_chain
end
def constantize(str)
names = str.split("::")
names.shift if names.empty? || names.first.empty?
names.inject(Object) do |constant, name|
constant.const_defined?(name) ? constant.const_get(name) : constant.const_missing(name)
end
end
end
end
# Default to fake testing to keep old behavior
Sidekiq::Testing.fake!
class EmptyQueueError < RuntimeError; end
module TestingClient
def raw_push(payloads)
if Sidekiq::Testing.fake?
payloads.each do |job|
job = Sidekiq.load_json(Sidekiq.dump_json(job))
job["enqueued_at"] = Time.now.to_f unless job["at"]
Queues.push(job["queue"], job["class"], job)
end
true
elsif Sidekiq::Testing.inline?
payloads.each do |job|
klass = Sidekiq::Testing.constantize(job["class"])
job["id"] ||= SecureRandom.hex(12)
job_hash = Sidekiq.load_json(Sidekiq.dump_json(job))
klass.process_job(job_hash)
end
true
else
super
end
end
end
Sidekiq::Client.prepend TestingClient
module Queues
##
# The Queues class is only for testing the fake queue implementation.
# There are 2 data structures involved in tandem. This is due to the
# Rspec syntax of change(QueueWorker.jobs, :size). It keeps a reference
# to the array. Because the array was dervied from a filter of the total
# jobs enqueued, it appeared as though the array didn't change.
#
# To solve this, we'll keep 2 hashes containing the jobs. One with keys based
# on the queue, and another with keys of the worker names, so the array for
# QueueWorker.jobs is a straight reference to a real array.
#
# Queue-based hash:
#
# {
# "default"=>[
# {
# "class"=>"TestTesting::QueueWorker",
# "args"=>[1, 2],
# "retry"=>true,
# "queue"=>"default",
# "jid"=>"abc5b065c5c4b27fc1102833",
# "created_at"=>1447445554.419934
# }
# ]
# }
#
# Worker-based hash:
#
# {
# "TestTesting::QueueWorker"=>[
# {
# "class"=>"TestTesting::QueueWorker",
# "args"=>[1, 2],
# "retry"=>true,
# "queue"=>"default",
# "jid"=>"abc5b065c5c4b27fc1102833",
# "created_at"=>1447445554.419934
# }
# ]
# }
#
# Example:
#
# require 'sidekiq/testing'
#
# assert_equal 0, Sidekiq::Queues["default"].size
# HardWorker.perform_async(:something)
# assert_equal 1, Sidekiq::Queues["default"].size
# assert_equal :something, Sidekiq::Queues["default"].first['args'][0]
#
# You can also clear all workers' jobs:
#
# assert_equal 0, Sidekiq::Queues["default"].size
# HardWorker.perform_async(:something)
# Sidekiq::Queues.clear_all
# assert_equal 0, Sidekiq::Queues["default"].size
#
# This can be useful to make sure jobs don't linger between tests:
#
# RSpec.configure do |config|
# config.before(:each) do
# Sidekiq::Queues.clear_all
# end
# end
#
class << self
def [](queue)
jobs_by_queue[queue]
end
def push(queue, klass, job)
jobs_by_queue[queue] << job
jobs_by_worker[klass] << job
end
def jobs_by_queue
@jobs_by_queue ||= Hash.new { |hash, key| hash[key] = [] }
end
def jobs_by_worker
@jobs_by_worker ||= Hash.new { |hash, key| hash[key] = [] }
end
def delete_for(jid, queue, klass)
jobs_by_queue[queue.to_s].delete_if { |job| job["jid"] == jid }
jobs_by_worker[klass].delete_if { |job| job["jid"] == jid }
end
def clear_for(queue, klass)
jobs_by_queue[queue].clear
jobs_by_worker[klass].clear
end
def clear_all
jobs_by_queue.clear
jobs_by_worker.clear
end
end
end
module Worker
##
# 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]
# HardWorker.jobs.clear
#
# You can also clear and drain all workers' jobs:
#
# Sidekiq::Worker.clear_all # or .drain_all
#
# 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"
#
module ClassMethods
# Queue for this worker
def queue
get_sidekiq_options["queue"]
end
# Jobs queued for this worker
def jobs
Queues.jobs_by_worker[to_s]
end
# Clear all jobs for this worker
def clear
Queues.clear_for(queue, to_s)
end
# Drain and run all jobs for this worker
def drain
while jobs.any?
next_job = jobs.first
Queues.delete_for(next_job["jid"], next_job["queue"], to_s)
process_job(next_job)
end
end
# Pop out a single job and perform it
def perform_one
raise(EmptyQueueError, "perform_one called with empty job queue") if jobs.empty?
next_job = jobs.first
Queues.delete_for(next_job["jid"], queue, to_s)
process_job(next_job)
end
def process_job(job)
worker = new
worker.jid = job["jid"]
worker.bid = job["bid"] if worker.respond_to?(:bid=)
Sidekiq::Testing.server_middleware.invoke(worker, job, job["queue"]) do
execute_job(worker, job["args"])
end
end
def execute_job(worker, args)
worker.perform(*args)
end
end
class << self
def jobs # :nodoc:
Queues.jobs_by_queue.values.flatten
end
# Clear all queued jobs across all workers
def clear_all
Queues.clear_all
end
# Drain all queued jobs across all workers
def drain_all
while jobs.any?
worker_classes = jobs.map { |job| job["class"] }.uniq
worker_classes.each do |worker_class|
Sidekiq::Testing.constantize(worker_class).drain
end
end
end
end
end
module TestingExtensions
def jobs_for(klass)
jobs.select do |job|
marshalled = job["args"][0]
marshalled.index(klass.to_s) && YAML.load(marshalled)[0] == klass
end
end
end
end
if defined?(::Rails) && Rails.respond_to?(:env) && !Rails.env.test? && !$TESTING
warn("⛔️ WARNING: Sidekiq testing API enabled, but this is not the test environment. Your jobs will not go to Redis.", uplevel: 1)
end