-
Notifications
You must be signed in to change notification settings - Fork 76
/
worker_spec.rb
584 lines (480 loc) · 18.6 KB
/
worker_spec.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
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
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
require 'spec_helper'
require 'yaml'
require 'qless/worker'
module Qless
describe Worker do
let(:reserver) { fire_double("Qless::JobReservers::Ordered", description: "job reserver", queues: []) }
let(:client ) { stub.as_null_object }
before { Subscriber.stub(:start) }
def procline
$0
end
class FileWriterJob
def self.perform(job)
sleep(job['sleep']) if job['sleep']
File.open(job['file'], "w") { |f| f.write("done: #{$0}") }
end
end
let(:job_output_file) { File.join(temp_dir, "job.out.#{Time.now.to_i}") }
let(:log_output) { StringIO.new }
let(:job) { Job.build(client, FileWriterJob, data: { 'file' => job_output_file }) }
let(:temp_dir) { "./spec/tmp" }
before do
FileUtils.rm_rf temp_dir
FileUtils.mkdir_p temp_dir
reserver.stub(:reserve).and_return(job, nil)
end
def middleware_module(num)
Module.new {
define_method :around_perform do |job|
File.open(job['file'] + ".before#{num}", 'w') { |f| f.write("before#{num}") }
super(job)
File.open(job['file'] + ".after#{num}", 'w') { |f| f.write("after#{num}") }
end
}
end
def parent_process_middleware_module(num)
Module.new {
define_method :around_perform_in_parent_process do |job|
File.open(job['file'] + ".before#{num}", 'w') { |f| f.write("before#{num}-#{Process.pid}") }
super(job)
File.open(job['file'] + ".after#{num}", 'w') { |f| f.write("after#{num}-#{Process.pid}") }
end
}
end
# to account for the fact that we format the backtrace lines...
let(:__file__) { __FILE__.split(File::SEPARATOR).last }
shared_examples_for 'a working worker' do
describe "#perform" do
before { clear_qless_memoization }
after(:all) { clear_qless_memoization }
class MyJobClass; end
let(:job) { Job.build(client, MyJobClass) }
it 'performs the job' do
MyJobClass.should_receive(:perform)
worker.perform(job)
end
it 'fails the job if performing it raises an error, including root exceptions' do
MyJobClass.stub(:perform) { raise Exception.new("boom") }
expected_line_number = __LINE__ - 1
job.should respond_to(:fail).with(2).arguments
job.should_receive(:fail) do |group, message|
group.should eq("Qless::MyJobClass:Exception")
message.should include("boom")
message.should include("#{__file__}:#{expected_line_number}")
end
worker.perform(job)
end
it 'removes the redundant worker boot backtrace lines from failure backtraces' do
MyJobClass.stub(:perform) { raise Exception.new("boom") }
job.should respond_to(:fail).with(2).arguments
job.should_receive(:fail) do |group, message|
last_line = message.split("\n").last
expect(last_line).to match(/worker\.rb:\d+:in `around_perform'/)
end
worker.perform(job)
end
it 'replaces the working directory with `.` in failure backtraces' do
MyJobClass.stub(:perform) { raise Exception.new("boom") }
job.should respond_to(:fail).with(2).arguments
job.should_receive(:fail) do |group, message|
expect(message).not_to include(Dir.pwd)
expect(message).to include("./lib")
end
worker.perform(job)
end
it 'truncates failure messages so they do not get too big' do
failure_message = "a" * 50_000
MyJobClass.stub(:perform) { raise Exception.new(failure_message) }
job.should respond_to(:fail).with(2).arguments
job.should_receive(:fail) do |group, message|
expect(message.bytesize).to be < 25_000
end
worker.perform(job)
end
it 'replaces the value of GEM_HOME with <GEM_HOME> in failure backtraces' do
gem_home = '/this/is/gem/home'
with_env_vars 'GEM_HOME' => gem_home do
MyJobClass.stub(:perform) do
error = Exception.new("boom")
error.set_backtrace(["#{gem_home}/foo.rb:1"])
raise error
end
job.should respond_to(:fail).with(2).arguments
job.should_receive(:fail) do |group, message|
expect(message).not_to include(gem_home)
expect(message).to include("<GEM_HOME>/foo.rb:1")
end
worker.perform(job)
end
end
it 'completes the job if it finishes with no errors' do
MyJobClass.stub(:perform)
job.should respond_to(:complete).with(0).arguments
job.should_receive(:complete).with(no_args)
worker.perform(job)
end
it 'fails the job if the job class is invalid or not found' do
hide_const('Qless::MyJobClass')
job.should_receive(:fail)
expect { worker.perform(job) }.not_to raise_error
end
it 'does not complete the job if the job logic itself changes the state of it (e.g. moves it to a new queue)' do
MyJobClass.stub(:perform) { |j| j.move("other") }
job.should_not_receive(:complete)
worker.perform(job)
end
end
describe "#work" do
around(:each) do |example|
old_procline = procline
example.run
$0 = old_procline
end
it "performs the job in a process and it completes" do
worker.work(0)
File.read(job_output_file).should include("done")
end
it 'supports middleware modules' do
worker.extend middleware_module(1)
worker.extend middleware_module(2)
worker.work(0)
File.read(job_output_file + '.before1').should eq("before1")
File.read(job_output_file + '.after1').should eq("after1")
File.read(job_output_file + '.before2').should eq("before2")
File.read(job_output_file + '.after2').should eq("after2")
end
it 'fails the job if a middleware module raises an error' do
expected_line_number = __LINE__ + 3
worker.extend Module.new {
def around_perform(job)
raise "boom"
super(job)
end
}
job.should respond_to(:fail).with(2).arguments
job.should_receive(:fail) do |group, message|
message.should include("boom")
message.should include("#{__file__}:#{expected_line_number}")
end
worker.perform(job)
end
it 'supports middleware modules that wrap the job in the parent process' do
worker.extend parent_process_middleware_module(1)
worker.extend parent_process_middleware_module(2)
worker.work(0)
File.read(job_output_file + '.before1').should eq("before1-#{Process.pid}")
File.read(job_output_file + '.after1').should eq("after1-#{Process.pid}")
File.read(job_output_file + '.before2').should eq("before2-#{Process.pid}")
File.read(job_output_file + '.after2').should eq("after2-#{Process.pid}")
end
it 'fails the job if the parent process middleware raises an error' do
expected_line_number = __LINE__ + 3
worker.extend Module.new {
def around_perform_in_parent_process(job)
raise "boom"
super(job)
end
}
job.should respond_to(:fail).with(2).arguments
job.should_receive(:fail) do |group, message|
message.should include("boom")
message.should include("#{__file__}:#{expected_line_number}")
end
worker.work(0)
end
def parent_process_middleware_return_value
return_val = nil
worker.extend Module.new {
define_method :around_perform_in_parent_process do |job|
return_val = super(job)
end
}
worker.work(0)
return_val
end
it 'informs the parent process middleware when the job fails' do
job.klass.stub(:perform).and_raise("boom")
return_val = parent_process_middleware_return_value
expect(return_val).to be_failed
expect(return_val).not_to be_complete
end
it 'informs the parent process middleware when the job completes' do
return_val = parent_process_middleware_return_value
expect(return_val).not_to be_failed
expect(return_val).to be_complete
end
it 'begins with a "starting" procline' do
starting_procline = nil
reserver.stub(:reserve) do
starting_procline = procline
nil
end
worker.work(0)
starting_procline.should include("Starting")
end
it 'can be unpaused' do
worker.pause_processing
paused_checks = 0
old_paused = worker.method(:paused?)
worker.stub(:paused?) do
paused_checks += 1 # count the number of loop iterations
worker.unpause_processing if paused_checks == 20 # so we don't loop forever
old_paused.call
end
worker.work(0)
paused_checks.should be >= 20
end
context 'when an error occurs while reserving a job' do
before { reserver.stub(:reserve) { raise "redis error" } }
it 'does not kill the worker' do
expect { worker.work(0) }.not_to raise_error
end
it 'logs the error' do
worker.work(0)
expect(log_output.string).to include("redis error")
end
end
end
end
context 'multi process' do
let(:worker) { Worker.new(reserver, output: log_output, verbose: true) }
it_behaves_like 'a working worker'
after { worker.send :kill_child }
it 'sets an appropriate procline for the parent process' do
parent_procline = nil
old_wait = Process.method(:waitpid)
Process.stub(:waitpid) do |child|
parent_procline = procline
old_wait.call(child)
end
worker.work(0)
parent_procline.should match(/Forked .* at/)
end
it 'sets an appropriate procline in the child process' do
worker.work(0)
output = File.read(job_output_file)
output.should include("Processing", job.queue_name, job.klass_name, job.jid)
end
it 'kills the child immediately when told to #shutdown!' do
job['sleep'] = 0.5 # to ensure the parent has a chance to kill the child before it does work
worker.term_timeout = 0.1
old_wait = worker.method(:wait_for_child)
worker.stub(:wait_for_child) do
worker.shutdown!
old_wait.call
end
File.exist?(job_output_file).should be_false
worker.work(0)
File.exist?(job_output_file).should be_false
end
it 'stops working when told to shutdown' do
num_jobs_performed = 0
old_wait = Process.method(:waitpid)
Process.stub(:waitpid) do |child|
worker.shutdown if num_jobs_performed == 1
num_jobs_performed += 1
old_wait.call(child)
end
reserver.stub(:reserve).and_return(job, job)
worker.work(0.0001)
num_jobs_performed.should eq(2)
end
it 'can be paused' do
old_wait = Process.method(:waitpid)
Process.stub(:waitpid) do |child|
worker.pause_processing # pause the worker after starting the first job
old_wait.call(child)
end
paused_procline = nil
paused_checks = 0
old_paused = worker.method(:paused?)
worker.stub(:paused?) do
paused_checks += 1 # count the number of loop iterations
worker.shutdown if paused_checks == 20 # so we don't loop forever
old_paused.call.tap do |paused|
paused_procline = procline if paused
end
end
# a job should only be reserved once because it is paused while processing the first one
reserver.should_receive(:reserve).once
worker.work(0)
paused_checks.should eq(20)
paused_procline.should include("Paused")
end
end
context 'single process' do
let(:worker) { Worker.new(reserver, run_as_single_process: '1', output: log_output, verbose: true) }
it_behaves_like 'a working worker'
it 'stops working when told to shutdown' do
num_jobs_performed = 0
old_perform = worker.method(:perform)
worker.stub(:perform) do |job|
worker.shutdown if num_jobs_performed == 1
num_jobs_performed += 1
old_perform.call(job)
end
reserver.stub(:reserve).and_return(job, job)
worker.work(0.0001)
num_jobs_performed.should eq(2)
end
it 'can be paused' do
old_perform = worker.method(:perform)
worker.stub(:perform) do |job|
worker.pause_processing # pause the worker after starting the first job
old_perform.call(job)
end
paused_procline = nil
paused_checks = 0
old_paused = worker.method(:paused?)
worker.stub(:paused?) do
paused_checks += 1 # count the number of loop iterations
worker.shutdown if paused_checks == 20 # so we don't loop forever
old_paused.call.tap do |paused|
paused_procline = procline if paused
end
end
# a job should only be reserved once because it is paused while processing the first one
reserver.should_receive(:reserve).once
worker.work(0)
paused_checks.should eq(20)
paused_procline.should include("Paused")
end
context "when completing the job fails" do
it 'logs the fact and does not kill the worker' do
job.stub(:complete).and_raise(Qless::Job::CantCompleteError)
worker.work(0)
log_output.string.should include("CantCompleteError")
end
end
context "when an error occurs but the job can't be failed" do
it 'logs the fact and does not kill the worker' do
job.klass.stub(:perform).and_raise("boom")
job.stub(:fail).and_raise(Qless::Job::CantFailError)
worker.work(0)
log_output.string.should include("CantFailError")
end
end
end
describe ".start" do
def with_env_vars(vars = {})
defaults = {
'REDIS_URL' => redis_url,
'QUEUE' => 'mock_queue'
}
super(defaults.merge(vars)) { yield }
end
it 'starts working with sleep interval INTERVAL' do
with_env_vars "INTERVAL" => "2.3" do
worker = fire_double("Qless::Worker")
Worker.stub(:new).and_return(worker)
worker.should_receive(:work).with(2.3)
Worker.start
end
end
it 'defaults the sleep interval to 5.0' do
with_env_vars do
worker = fire_double("Qless::Worker")
Worker.stub(:new).and_return(worker)
worker.should_receive(:work).with(5.0)
Worker.start
end
end
it 'uses the named QUEUE' do
with_env_vars 'QUEUE' => 'normal' do
Worker.should_receive(:new) do |reserver|
reserver.queues.map(&:name).should eq(["normal"])
stub.as_null_object
end
Worker.start
end
end
it 'uses the named QUEUES (comma delimited)' do
with_env_vars 'QUEUES' => 'high,normal, low' do
Worker.should_receive(:new) do |reserver|
reserver.queues.map(&:name).should eq(["high", "normal", "low"])
stub.as_null_object
end
Worker.start
end
end
it 'raises an error if no queues are provided' do
with_env_vars 'QUEUE' => '', 'QUEUES' => '' do
expect {
Worker.start
}.to raise_error(/must pass QUEUE or QUEUES/)
end
end
it 'uses the Ordered reserver by default' do
with_env_vars do
Worker.should_receive(:new) do |reserver|
reserver.should be_a(JobReservers::Ordered)
stub.as_null_object
end
Worker.start
end
end
it 'uses the RoundRobin reserver if so configured' do
with_env_vars 'JOB_RESERVER' => 'RoundRobin' do
Worker.should_receive(:new) do |reserver|
reserver.should be_a(JobReservers::RoundRobin)
stub.as_null_object
end
Worker.start
end
end
it 'sets verbose, very_verbose, run_as_single_process to false by default' do
with_env_vars do
orig_new = Worker.method(:new)
Worker.should_receive(:new) do |reserver, options = {}|
worker = orig_new.call(reserver, options.merge(:output => StringIO.new))
worker.verbose.should be_false
worker.very_verbose.should be_false
worker.run_as_single_process.should be_false
stub.as_null_object
end
Worker.start
end
end
it 'sets verbose=true when passed VERBOSE' do
with_env_vars 'VERBOSE' => '1' do
orig_new = Worker.method(:new)
Worker.should_receive(:new) do |reserver, options = {}|
worker = orig_new.call(reserver, options.merge(:output => StringIO.new))
worker.verbose.should be_true
worker.very_verbose.should be_false
worker.run_as_single_process.should be_false
stub.as_null_object
end
Worker.start
end
end
it 'sets very_verbose=true when passed VVERBOSE' do
with_env_vars 'VVERBOSE' => '1' do
orig_new = Worker.method(:new)
Worker.should_receive(:new) do |reserver, options = {}|
worker = orig_new.call(reserver, options.merge(:output => StringIO.new))
worker.verbose.should be_false
worker.very_verbose.should be_true
worker.run_as_single_process.should be_false
stub.as_null_object
end
Worker.start
end
end
it 'sets run_as_single_process=true when passed RUN_AS_SINGLE_PROCESS' do
with_env_vars 'RUN_AS_SINGLE_PROCESS' => '1' do
orig_new = Worker.method(:new)
Worker.should_receive(:new) do |reserver, options = {}|
worker = orig_new.call(reserver, options)
worker.verbose.should be_false
worker.very_verbose.should be_false
worker.run_as_single_process.should be_true
stub.as_null_object
end
Worker.start
end
end
end
end
end