forked from mperham/connection_pool
/
test_connection_pool.rb
557 lines (420 loc) · 12.2 KB
/
test_connection_pool.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
require_relative 'helper'
class TestConnectionPool < Minitest::Test
class NetworkConnection
SLEEP_TIME = 0.1
def initialize
@x = 0
end
def do_something
@x += 1
sleep SLEEP_TIME
@x
end
def fast
@x += 1
end
def do_something_with_block
@x += yield
sleep SLEEP_TIME
@x
end
def respond_to?(method_id, *args)
method_id == :do_magic || super(method_id, *args)
end
end
class Recorder
def initialize
@calls = []
end
attr_reader :calls
def do_work(label)
@calls << label
end
end
def use_pool(pool, size)
Array.new(size) do
Thread.new do
pool.with do sleep end
end
end.each do |thread|
Thread.pass until thread.status == 'sleep'
end
end
def kill_threads(threads)
threads.each do |thread|
thread.kill
thread.join
end
end
def test_basic_multithreaded_usage
pool_size = 5
pool = ConnectionPool.new(size: pool_size) { NetworkConnection.new }
start = Time.new
generations = 3
result = Array.new(pool_size * generations) do
Thread.new do
pool.with do |net|
net.do_something
end
end
end.map(&:value)
finish = Time.new
assert_equal((1..generations).cycle(pool_size).sort, result.sort)
assert_operator(finish - start, :>, generations * NetworkConnection::SLEEP_TIME)
end
def test_timeout
pool = ConnectionPool.new(timeout: 0, size: 1) { NetworkConnection.new }
thread = Thread.new do
pool.with do |net|
net.do_something
sleep 0.01
end
end
Thread.pass while thread.status == 'run'
assert_raises Timeout::Error do
pool.with { |net| net.do_something }
end
thread.join
pool.with do |conn|
refute_nil conn
end
end
def test_with
pool = ConnectionPool.new(timeout: 0, size: 1) { Object.new }
pool.with do
Thread.new do
assert_raises Timeout::Error do
pool.checkout
end
end.join
end
assert Thread.new { pool.checkout }.join
end
def test_with_timeout
pool = ConnectionPool.new(timeout: 0, size: 1) { Object.new }
assert_raises Timeout::Error do
Timeout.timeout(0.01) do
pool.with do |obj|
assert_equal 0, pool.available
sleep 0.015
end
end
end
assert_equal 1, pool.available
end
def test_invalid_size
assert_raises ArgumentError, TypeError do
ConnectionPool.new(timeout: 0, size: nil) { Object.new }
end
assert_raises ArgumentError, TypeError do
ConnectionPool.new(timeout: 0, size: '') { Object.new }
end
end
def test_handle_interrupt_ensures_checkin
pool = ConnectionPool.new(timeout: 0, size: 1) { Object.new }
def pool.checkout(options)
sleep 0.015
super
end
did_something = false
action = lambda do
Timeout.timeout(0.01) do
pool.with do |obj|
did_something = true
# Timeout::Error will be triggered by any non-trivial Ruby code
# executed here since it couldn't be raised during checkout.
# It looks like setting the local variable above does not trigger
# the Timeout check in MRI 2.2.1.
obj.tap { obj.hash }
end
end
end
if RUBY_ENGINE == "ruby"
# These asserts rely on the Ruby implementation reaching `did_something =
# true` before the interrupt is detected by the thread. Interrupt
# detection timing is implementation-specific in practice, with JRuby,
# Rubinius, and TruffleRuby all having different interrupt timings to MRI.
# In fact they generally detect interrupts more quickly than MRI, so they
# may not reach `did_something = true` before detecting the interrupt.
assert_raises Timeout::Error, &action
assert did_something
else
action.call
end
assert_equal 1, pool.available
end
def test_explicit_return
pool = ConnectionPool.new(timeout: 0, size: 1) do
mock = Minitest::Mock.new
def mock.disconnect!
raise "should not disconnect upon explicit return"
end
mock
end
pool.with do |conn|
return true
end
end
def test_with_timeout_override
pool = ConnectionPool.new(timeout: 0, size: 1) { NetworkConnection.new }
t = Thread.new do
pool.with do |net|
net.do_something
sleep 0.01
end
end
Thread.pass while t.status == 'run'
assert_raises Timeout::Error do
pool.with { |net| net.do_something }
end
pool.with(timeout: 2 * NetworkConnection::SLEEP_TIME) do |conn|
refute_nil conn
end
end
def test_checkin
pool = ConnectionPool.new(timeout: 0, size: 1) { NetworkConnection.new }
conn = pool.checkout
Thread.new do
assert_raises Timeout::Error do
pool.checkout
end
end.join
pool.checkin
assert_same conn, Thread.new { pool.checkout }.value
end
def test_returns_value
pool = ConnectionPool.new(timeout: 0, size: 1) { Object.new }
assert_equal 1, pool.with {|o| 1 }
end
def test_checkin_never_checkout
pool = ConnectionPool.new(timeout: 0, size: 1) { Object.new }
e = assert_raises ConnectionPool::Error do
pool.checkin
end
assert_equal 'no connections are checked out', e.message
end
def test_checkin_no_current_checkout
pool = ConnectionPool.new(timeout: 0, size: 1) { Object.new }
pool.checkout
pool.checkin
assert_raises ConnectionPool::Error do
pool.checkin
end
end
def test_checkin_twice
pool = ConnectionPool.new(timeout: 0, size: 1) { Object.new }
pool.checkout
pool.checkout
pool.checkin
Thread.new do
assert_raises Timeout::Error do
pool.checkout
end
end.join
pool.checkin
assert Thread.new { pool.checkout }.join
end
def test_checkout
pool = ConnectionPool.new(size: 1) { NetworkConnection.new }
conn = pool.checkout
assert_kind_of NetworkConnection, conn
assert_same conn, pool.checkout
end
def test_checkout_multithread
pool = ConnectionPool.new(size: 2) { NetworkConnection.new }
conn = pool.checkout
t = Thread.new do
pool.checkout
end
refute_same conn, t.value
end
def test_checkout_timeout
pool = ConnectionPool.new(timeout: 0, size: 0) { Object.new }
assert_raises Timeout::Error do
pool.checkout
end
end
def test_checkout_timeout_override
pool = ConnectionPool.new(timeout: 0, size: 1) { NetworkConnection.new }
thread = Thread.new do
pool.with do |net|
net.do_something
sleep 0.01
end
end
Thread.pass while thread.status == 'run'
assert_raises Timeout::Error do
pool.checkout
end
assert pool.checkout timeout: 2 * NetworkConnection::SLEEP_TIME
end
def test_passthru
pool = ConnectionPool.wrap(timeout: 2 * NetworkConnection::SLEEP_TIME, size: 1) { NetworkConnection.new }
assert_equal 1, pool.do_something
assert_equal 2, pool.do_something
assert_equal 5, pool.do_something_with_block { 3 }
assert_equal 6, pool.with { |net| net.fast }
end
def test_passthru_respond_to
pool = ConnectionPool.wrap(timeout: 2 * NetworkConnection::SLEEP_TIME, size: 1) { NetworkConnection.new }
assert pool.respond_to?(:with)
assert pool.respond_to?(:do_something)
assert pool.respond_to?(:do_magic)
refute pool.respond_to?(:do_lots_of_magic)
end
def test_return_value
pool = ConnectionPool.new(timeout: 2 * NetworkConnection::SLEEP_TIME, size: 1) { NetworkConnection.new }
result = pool.with do |net|
net.fast
end
assert_equal 1, result
end
def test_heavy_threading
pool = ConnectionPool.new(timeout: 0.5, size: 3) { NetworkConnection.new }
threads = Array.new(20) do
Thread.new do
pool.with do |net|
sleep 0.01
end
end
end
threads.map { |thread| thread.join }
end
def test_reuses_objects_when_pool_not_saturated
pool = ConnectionPool.new(size: 5) { NetworkConnection.new }
ids = 10.times.map do
pool.with { |c| c.object_id }
end
assert_equal 1, ids.uniq.size
end
def test_nested_checkout
recorder = Recorder.new
pool = ConnectionPool.new(size: 1) { recorder }
pool.with do |r_outer|
@other = Thread.new do |t|
pool.with do |r_other|
r_other.do_work('other')
end
end
pool.with do |r_inner|
r_inner.do_work('inner')
end
Thread.pass
r_outer.do_work('outer')
end
@other.join
assert_equal ['inner', 'outer', 'other'], recorder.calls
end
def test_shutdown_is_executed_for_all_connections
recorders = []
pool = ConnectionPool.new(size: 3) do
Recorder.new.tap { |r| recorders << r }
end
threads = use_pool pool, 3
pool.shutdown do |recorder|
recorder.do_work("shutdown")
end
kill_threads(threads)
assert_equal [["shutdown"]] * 3, recorders.map { |r| r.calls }
end
def test_raises_error_after_shutting_down
pool = ConnectionPool.new(size: 1) { true }
pool.shutdown { }
assert_raises ConnectionPool::PoolShuttingDownError do
pool.checkout
end
end
def test_runs_shutdown_block_asynchronously_if_connection_was_in_use
recorders = []
pool = ConnectionPool.new(size: 3) do
Recorder.new.tap { |r| recorders << r }
end
threads = use_pool pool, 2
pool.checkout
pool.shutdown do |recorder|
recorder.do_work("shutdown")
end
kill_threads(threads)
assert_equal [["shutdown"], ["shutdown"], []], recorders.map { |r| r.calls }
pool.checkin
assert_equal [["shutdown"], ["shutdown"], ["shutdown"]], recorders.map { |r| r.calls }
end
def test_raises_an_error_if_shutdown_is_called_without_a_block
pool = ConnectionPool.new(size: 1) { }
assert_raises ArgumentError do
pool.shutdown
end
end
def test_shutdown_is_executed_for_all_connections_in_wrapped_pool
recorders = []
wrapper = ConnectionPool::Wrapper.new(size: 3) do
Recorder.new.tap { |r| recorders << r }
end
threads = use_pool wrapper, 3
wrapper.pool_shutdown do |recorder|
recorder.do_work("shutdown")
end
kill_threads(threads)
assert_equal [["shutdown"]] * 3, recorders.map { |r| r.calls }
end
def test_wrapper_pool
wrapper = ConnectionPool::Wrapper.new { NetworkConnection.new }
assert_equal ConnectionPool, wrapper.pool.class
end
def test_wrapper_method_missing
wrapper = ConnectionPool::Wrapper.new { NetworkConnection.new }
assert_equal 1, wrapper.fast
end
def test_wrapper_respond_to_eh
wrapper = ConnectionPool::Wrapper.new { NetworkConnection.new }
assert_respond_to wrapper, :with
assert_respond_to wrapper, :fast
refute_respond_to wrapper, :"nonexistent method"
end
def test_wrapper_with
wrapper = ConnectionPool::Wrapper.new(timeout: 0, size: 1) { Object.new }
wrapper.with do
Thread.new do
assert_raises Timeout::Error do
wrapper.with { flunk 'connection checked out :(' }
end
end.join
end
assert Thread.new { wrapper.with { } }.join
end
class ConnWithEval
def eval(arg)
"eval'ed #{arg}"
end
end
def test_wrapper_kernel_methods
wrapper = ConnectionPool::Wrapper.new(timeout: 0, size: 1) { ConnWithEval.new }
assert_equal "eval'ed 1", wrapper.eval(1)
end
def test_wrapper_with_connection_pool
recorder = Recorder.new
pool = ConnectionPool.new(size: 1) { recorder }
wrapper = ConnectionPool::Wrapper.new(pool: pool)
pool.with { |r| r.do_work('with') }
wrapper.do_work('wrapped')
assert_equal ['with', 'wrapped'], recorder.calls
end
def test_stats_without_active_connection
pool = ConnectionPool.new(size: 2) { NetworkConnection.new }
assert_equal(2, pool.size)
assert_equal(2, pool.available)
end
def test_stats_with_active_connection
pool = ConnectionPool.new(size: 2) { NetworkConnection.new }
pool.with do
assert_equal(1, pool.available)
end
end
def test_stats_with_string_size
pool = ConnectionPool.new(size: '2') { NetworkConnection.new }
pool.with do
assert_equal(2, pool.size)
assert_equal(1, pool.available)
end
end
end