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
|
# coding=utf-8
import os
import pickle
import random
import shutil
import sys
import tempfile
import unittest
from collections import namedtuple
from nose2.tools import params
from threading import Thread
from persistqueue.serializers import json as serializers_json
from persistqueue.serializers import pickle as serializers_pickle
from persistqueue.serializers import msgpack as serializers_msgpack
from persistqueue.serializers import cbor2 as serializers_cbor2
from persistqueue import Queue, Empty, Full
# map keys as params for readable errors from nose
serializer_params = {
"serializer=default": {},
"serializer=json": {"serializer": serializers_json},
"serializer=msgpack": {"serializer": serializers_msgpack},
"serializer=cbor2": {"serializer": serializers_cbor2},
"serializer=pickle": {"serializer": serializers_pickle},
}
class PersistTest(unittest.TestCase):
def setUp(self):
self.path = tempfile.mkdtemp(suffix='queue')
def tearDown(self):
shutil.rmtree(self.path, ignore_errors=True)
@params(*serializer_params)
def test_open_close_single(self, serializer):
"""Write 1 item, close, reopen checking if same item is there"""
q = Queue(self.path, **serializer_params[serializer])
q.put('var1')
del q
q = Queue(self.path, **serializer_params[serializer])
self.assertEqual(1, q.qsize())
self.assertEqual('var1', q.get())
q.task_done()
del q
def test_empty(self):
q = Queue(self.path)
self.assertEqual(q.empty(), True)
q.put('var1')
self.assertEqual(q.empty(), False)
q.get()
self.assertEqual(q.empty(), True)
def test_full(self):
q = Queue(self.path, maxsize=3)
for i in range(1, q.maxsize):
q.put('var{}'.format(i))
self.assertEqual(q.full(), False)
q.put('var{}'.format(q.maxsize))
self.assertEqual(q.full(), True)
q.get()
self.assertEqual(q.full(), False)
@params(*serializer_params)
def test_open_close_1000(self, serializer):
"""Write 1000 items, close, reopen checking if all items are there"""
q = Queue(self.path, **serializer_params[serializer])
for i in range(1000):
q.put('var%d' % i)
self.assertEqual(1000, q.qsize())
del q
q = Queue(self.path, **serializer_params[serializer])
self.assertEqual(1000, q.qsize())
for i in range(1000):
data = q.get()
self.assertEqual('var%d' % i, data)
q.task_done()
with self.assertRaises(Empty):
q.get_nowait()
# assert adding another one still works
q.put('foobar')
data = q.get()
@params(*serializer_params)
def test_partial_write(self, serializer):
"""Test recovery from previous crash w/ partial write"""
q = Queue(self.path, **serializer_params[serializer])
for i in range(100):
q.put('var%d' % i)
del q
with open(os.path.join(self.path, 'q00000'), 'ab') as f:
pickle.dump('文字化け', f)
q = Queue(self.path, **serializer_params[serializer])
self.assertEqual(100, q.qsize())
for i in range(100):
self.assertEqual('var%d' % i, q.get())
q.task_done()
with self.assertRaises(Empty):
q.get_nowait()
@params(*serializer_params)
def test_random_read_write(self, serializer):
"""Test random read/write"""
q = Queue(self.path, **serializer_params[serializer])
n = 0
for i in range(1000):
if random.random() < 0.5:
if n > 0:
q.get_nowait()
q.task_done()
n -= 1
else:
with self.assertRaises(Empty):
q.get_nowait()
else:
q.put('var%d' % random.getrandbits(16))
n += 1
@params(*serializer_params)
def test_multi_threaded(self, serializer):
"""Create consumer and producer threads, check parallelism"""
q = Queue(self.path, **serializer_params[serializer])
def producer():
for i in range(1000):
q.put('var%d' % i)
def consumer():
for i in range(1000):
q.get()
q.task_done()
c = Thread(target=consumer)
c.start()
p = Thread(target=producer)
p.start()
c.join()
p.join()
q.join()
with self.assertRaises(Empty):
q.get_nowait()
@params(*serializer_params)
def test_garbage_on_head(self, serializer):
"""Adds garbage to the queue head and let the internal integrity
checks fix it"""
q = Queue(self.path, **serializer_params[serializer])
q.put('var1')
del q
with open(os.path.join(self.path, 'q00000'), 'ab') as f:
f.write(b'garbage')
q = Queue(self.path, **serializer_params[serializer])
q.put('var2')
self.assertEqual(2, q.qsize())
self.assertEqual('var1', q.get())
q.task_done()
@params(*serializer_params)
def test_task_done_too_many_times(self, serializer):
"""Test too many task_done called."""
q = Queue(self.path, **serializer_params[serializer])
q.put('var1')
q.get()
q.task_done()
with self.assertRaises(ValueError):
q.task_done()
@params(*serializer_params)
def test_get_timeout_negative(self, serializer):
q = Queue(self.path, **serializer_params[serializer])
q.put('var1')
with self.assertRaises(ValueError):
q.get(timeout=-1)
@params(*serializer_params)
def test_get_timeout(self, serializer):
"""Test when get failed within timeout."""
q = Queue(self.path, **serializer_params[serializer])
q.put('var1')
q.get()
with self.assertRaises(Empty):
q.get(timeout=1)
@params(*serializer_params)
def test_put_nowait(self, serializer):
"""Tests the put_nowait interface."""
q = Queue(self.path, **serializer_params[serializer])
q.put_nowait('var1')
self.assertEqual('var1', q.get())
q.task_done()
@params(*serializer_params)
def test_put_maxsize_reached(self, serializer):
"""Test that maxsize reached."""
q = Queue(self.path, maxsize=10, **serializer_params[serializer])
for x in range(10):
q.put(x)
with self.assertRaises(Full):
q.put('full_now', block=False)
@params(*serializer_params)
def test_put_timeout_reached(self, serializer):
"""Test put with block and timeout."""
q = Queue(self.path, maxsize=2, **serializer_params[serializer])
for x in range(2):
q.put(x)
with self.assertRaises(Full):
q.put('full_and_timeout', block=True, timeout=1)
@params(*serializer_params)
def test_put_timeout_negative(self, serializer):
"""Test and put with timeout < 0"""
q = Queue(self.path, maxsize=1, **serializer_params[serializer])
with self.assertRaises(ValueError):
q.put('var1', timeout=-1)
@params(*serializer_params)
def test_put_block_and_wait(self, serializer):
"""Test block until queue is not full."""
q = Queue(self.path, maxsize=10, **serializer_params[serializer])
def consumer():
for i in range(5):
q.get()
q.task_done()
def producer():
for j in range(16):
q.put('var%d' % j)
p = Thread(target=producer)
p.start()
c = Thread(target=consumer)
c.start()
c.join()
val = q.get_nowait()
p.join()
self.assertEqual('var5', val)
@params(*serializer_params)
def test_clear_tail_file(self, serializer):
"""Test that only remove tail file when calling task_done."""
q = Queue(self.path, chunksize=10, **serializer_params[serializer])
for i in range(35):
q.put('var%d' % i)
for _ in range(15):
q.get()
q = Queue(self.path, chunksize=10, **serializer_params[serializer])
self.assertEqual(q.qsize(), 35)
for _ in range(15):
q.get()
# the first tail file gets removed after task_done
q.task_done()
for _ in range(16):
q.get()
# the second and third files get removed after task_done
q.task_done()
self.assertEqual(q.qsize(), 4)
def test_protocol(self):
# test that protocol is set properly
expect_protocol = 2 if sys.version_info[0] == 2 else 4
self.assertEqual(
serializers_pickle.protocol,
expect_protocol,
)
# test that protocol is used properly
serializer = namedtuple("Serializer", ["dump", "load"])(
serializers_pickle.dump, lambda fp: fp.read())
q = Queue(path=self.path, serializer=serializer)
q.put(b'a')
self.assertEqual(q.get(), pickle.dumps(b'a', protocol=expect_protocol))
@params(*serializer_params)
def test_del(self, serializer):
"""test that __del__ can be called successfully"""
q = Queue(self.path, **serializer_params[serializer])
q.__del__()
self.assertTrue(q.headf.closed)
self.assertTrue(q.tailf.closed)
@params(*serializer_params)
def test_autosave_get(self, serializer):
"""test the autosave feature saves on get()"""
q = Queue(self.path, autosave=True, **serializer_params[serializer])
q.put('var1')
q.put('var2')
self.assertEqual('var1', q.get())
del q
# queue should save on get(), only one item should remain
q = Queue(self.path, autosave=True, **serializer_params[serializer])
self.assertEqual(1, q.qsize())
self.assertEqual('var2', q.get())
del q
@params(*serializer_params)
def test_autosave_join(self, serializer):
"""Enabling autosave should still allow task_done/join behavior"""
q = Queue(self.path, autosave=True, **serializer_params[serializer])
for i in range(10):
q.put('var%d' % i)
def consumer():
for i in range(10):
q.get()
# this should still 'count down' properly and allow q.join()
# to finish
q.task_done()
c = Thread(target=consumer)
c.start()
q.join()
with self.assertRaises(Empty):
q.get_nowait()
|
