-
Notifications
You must be signed in to change notification settings - Fork 9
/
test_lock.py
431 lines (332 loc) · 14.5 KB
/
test_lock.py
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
# Copyright 2012 Rackspace Hosting, Inc.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
"""Test the lock."""
import uuid
import mock
from twisted.internet import defer, task
from silverberg.client import CQLClient
from silverberg.lock import BasicLock, BusyLockError, with_lock
from silverberg.test.util import BaseTestCase
from silverberg.cassandra.ttypes import InvalidRequestException
from silverberg.lock import NoLockClaimsError
class BasicLockTest(BaseTestCase):
"""Test the lock."""
def setUp(self):
self.client = mock.create_autospec(CQLClient)
self.table_name = 'lock'
self.responses = [1]
def _execute(*args, **kwargs):
return defer.succeed(self.responses.pop(0))
self.client.execute.side_effect = _execute
def test__read_lock(self):
lock_uuid = uuid.uuid1()
expected = [
'SELECT * FROM lock WHERE "lockId"=:lockId ORDER BY "claimId";',
{'lockId': lock_uuid}, 2]
lock = BasicLock(self.client, self.table_name, lock_uuid)
d = lock._read_lock(None)
self.assertEqual(self.assertFired(d), 1)
self.client.execute.assert_called_once_with(*expected)
def test__verify_lock(self):
lock_uuid = uuid.uuid1()
lock = BasicLock(self.client, self.table_name, lock_uuid)
d = lock._verify_lock([{'lockId': lock._lock_id, 'claimId': lock._claim_id}])
result = self.assertFired(d)
self.assertEqual(result, True)
def test__verify_lock_release(self):
lock_uuid = uuid.uuid1()
def _side_effect(*args, **kwargs):
return defer.succeed(None)
self.client.execute.side_effect = _side_effect
lock = BasicLock(self.client, self.table_name, lock_uuid)
expected = [
'DELETE FROM lock WHERE "lockId"=:lockId AND "claimId"=:claimId;',
{'lockId': lock_uuid, 'claimId': lock._claim_id}, 2]
d = lock._verify_lock([{'lockId': lock._lock_id, 'claimId': ''}])
result = self.failureResultOf(d)
self.assertTrue(result.check(BusyLockError))
self.client.execute.assert_called_once_with(*expected)
def test__verify_lock_no_rows(self):
"""
_verify_lock fails with an error when response contains no rows.
"""
lock_uuid = uuid.uuid1()
lock = BasicLock(self.client, self.table_name, lock_uuid)
d = lock._verify_lock([])
result = self.failureResultOf(d)
self.assertTrue(result.check(NoLockClaimsError))
def test__write_lock(self):
lock_uuid = uuid.uuid1()
lock = BasicLock(self.client, self.table_name, lock_uuid, 1000)
expected = [
'INSERT INTO lock ("lockId","claimId") VALUES (:lockId,:claimId) USING TTL 1000;',
{'lockId': lock_uuid, 'claimId': lock._claim_id}, 2]
d = lock._write_lock()
self.assertEqual(self.assertFired(d), 1)
self.client.execute.assert_called_once_with(*expected)
def test_ensure_schema(self):
"""BasicLock.ensure_schema creates the table/columnfamily."""
expected = [
'CREATE TABLE lock ("lockId" ascii, "claimId" timeuuid, PRIMARY KEY("lockId", "claimId"));',
{}, 2]
d = BasicLock.ensure_schema(self.client, 'lock')
self.successResultOf(d)
self.client.execute.assert_called_once_with(*expected)
def test_ensure_schema_already_created(self):
"""
BasicLock.ensure_schema doesn't explode on InvalidRequestException,
meaning the table already exists.
"""
def _side_effect(*args, **kwargs):
return defer.fail(InvalidRequestException())
self.client.execute.side_effect = _side_effect
d = BasicLock.ensure_schema(self.client, 'lock')
self.successResultOf(d)
def test_drop_schema(self):
"""BasicLock.drop_schema deletes the table/columnfamily."""
expected = [
'DROP TABLE lock',
{}, 2]
d = BasicLock.drop_schema(self.client, 'lock')
self.successResultOf(d)
self.client.execute.assert_called_once_with(*expected)
def test_acquire(self):
"""Lock acquire should write and then read back its write."""
lock_uuid = uuid.uuid1()
lock = BasicLock(self.client, self.table_name, lock_uuid)
def _side_effect(*args, **kwargs):
return defer.succeed([{'lockId': lock._lock_id,
'claimId': lock._claim_id}])
self.client.execute.side_effect = _side_effect
d = lock.acquire()
self.assertEqual(self.assertFired(d), True)
expected = [
mock.call('INSERT INTO lock ("lockId","claimId") VALUES (:lockId,:claimId) USING TTL 300;',
{'lockId': lock._lock_id, 'claimId': lock._claim_id}, 2),
mock.call('SELECT * FROM lock WHERE "lockId"=:lockId ORDER BY "claimId";',
{'lockId': lock._lock_id}, 2)]
self.assertEqual(self.client.execute.call_args_list, expected)
def test_acquire_retry(self):
"""BasicLock.acquire will retry max_retry times."""
lock_uuid = uuid.uuid1()
clock = task.Clock()
lock = BasicLock(self.client, self.table_name, lock_uuid, max_retry=1, reactor=clock)
responses = [
defer.fail(BusyLockError('', '')),
defer.succeed(True)
]
def _new_verify_lock(response):
return responses.pop(0)
lock._verify_lock = _new_verify_lock
def _side_effect(*args, **kwargs):
return defer.succeed([])
self.client.execute.side_effect = _side_effect
d = lock.acquire()
clock.advance(20)
self.assertEqual(self.assertFired(d), True)
self.assertEqual(self.client.execute.call_count, 4)
def test_acquire_retries_on_NoLockClaimsError(self):
"""
acquire retries when _verify_lock fails with a NoLockClaimsError.
"""
lock_uuid = uuid.uuid1()
clock = task.Clock()
lock = BasicLock(self.client, self.table_name, lock_uuid, max_retry=1, reactor=clock)
responses = [
defer.fail(NoLockClaimsError('', '')),
defer.succeed(True)
]
def _new_verify_lock(response):
return responses.pop(0)
lock._verify_lock = _new_verify_lock
def _side_effect(*args, **kwargs):
return defer.succeed([])
self.client.execute.side_effect = _side_effect
d = lock.acquire()
clock.advance(20)
self.assertEqual(self.assertFired(d), True)
self.assertEqual(self.client.execute.call_count, 4)
def test_acquire_retry_never_acquired(self):
"""BasicLock.acquire will retry max_retry times and then give up."""
lock_uuid = uuid.uuid1()
clock = task.Clock()
lock = BasicLock(self.client, self.table_name, lock_uuid, max_retry=1, reactor=clock)
responses = [
defer.fail(BusyLockError('', '')),
defer.fail(BusyLockError('', ''))
]
def _new_verify_lock(response):
return responses.pop(0)
lock._verify_lock = _new_verify_lock
def _side_effect(*args, **kwargs):
return defer.succeed([])
self.client.execute.side_effect = _side_effect
d = lock.acquire()
clock.advance(20)
result = self.failureResultOf(d)
self.assertTrue(result.check(BusyLockError))
self.assertEqual(self.client.execute.call_count, 4)
def test_acquire_retry_not_lock_error(self):
"""If an error occurs that is not lock related, it is propagated."""
lock_uuid = uuid.uuid1()
clock = task.Clock()
lock = BasicLock(self.client, self.table_name, lock_uuid, max_retry=1, reactor=clock)
responses = [
defer.fail(NameError('Keep your foot off the blasted samoflange.')),
]
def _new_verify_lock(response):
return responses.pop(0)
lock._verify_lock = _new_verify_lock
def _side_effect(*args, **kwargs):
return defer.succeed([])
self.client.execute.side_effect = _side_effect
d = lock.acquire()
result = self.failureResultOf(d)
self.assertTrue(result.check(NameError))
def test_release(self):
lock_uuid = uuid.uuid1()
lock = BasicLock(self.client, self.table_name, lock_uuid)
expected = [
'DELETE FROM lock WHERE "lockId"=:lockId AND "claimId"=:claimId;',
{'lockId': lock_uuid, 'claimId': lock._claim_id}, 2]
d = lock.release()
self.assertFired(d)
self.client.execute.assert_called_once_with(*expected)
@mock.patch('silverberg.lock.uuid.uuid1', return_value='claim_uuid')
def test_acquire_logs(self, uuid1):
"""
When lock is acquired, it logs with time taken to acquire the log
"""
lock_uuid = 'lock_uuid'
log = mock.MagicMock(spec=['msg'])
clock = task.Clock()
lock = BasicLock(self.client, self.table_name, lock_uuid, max_retry=1,
retry_wait=3, reactor=clock, log=log)
self.responses = [
None, # _write_lock
[{'lockId': lock._lock_id, 'claimId': 'wait for it..'}], # _read_lock
None, # delete for release lock
None, # _write_lock again
[{'lockId': lock._lock_id, 'claimId': lock._claim_id}] # _read_lock
]
d = lock.acquire()
clock.advance(5)
self.assertEqual(self.assertFired(d), True)
log.msg.assert_called_with('Acquired lock in 5.0 seconds',
lock_acquire_time=5.0, lock_id=lock_uuid,
claim_id='claim_uuid')
@mock.patch('silverberg.lock.uuid.uuid1', return_value='claim_uuid')
def test_release_logs(self, uuid1):
"""
When lock is released, it logs with time the lock was held
"""
lock_uuid = 'lock_uuid'
log = mock.MagicMock(spec=['msg'])
clock = task.Clock()
lock = BasicLock(self.client, self.table_name, lock_uuid, max_retry=1,
retry_wait=3, reactor=clock, log=log)
self.responses = [
None, # _write_lock
[{'lockId': lock._lock_id, 'claimId': lock._claim_id}], # _read_lock
None # delete for release lock
]
lock.acquire()
clock.advance(34)
lock.release()
log.msg.assert_called_with('Released lock. Was held for 34.0 seconds',
lock_held_time=34.0, lock_id=lock_uuid,
claim_id='claim_uuid')
@mock.patch('silverberg.lock.uuid.uuid1', return_value='claim_uuid')
def test_lock_acquire_failure_logged(self, uuid1):
"""
If lock acquisition fails, it is logged along with time taken
"""
lock_uuid = 'lock_uuid'
log = mock.MagicMock(spec=['msg'])
clock = task.Clock()
lock = BasicLock(self.client, self.table_name, lock_uuid, max_retry=1,
retry_wait=3, reactor=clock, log=log)
self.responses = [
None, # _write_lock
[{'lockId': lock._lock_id, 'claimId': 'wait for it..'}], # _read_lock
None, # delete for release lock
None, # _write_lock again
[{'lockId': lock._lock_id, 'claimId': 'nope'}], # _read_lock
None # delete again for release lock
]
d = lock.acquire()
clock.advance(3)
self.failureResultOf(d)
log.msg.assert_called_with('Could not acquire lock in 3.0 seconds',
lock_acquire_fail_time=3.0, lock_id=lock_uuid,
claim_id='claim_uuid')
class WithLockTest(BaseTestCase):
"""Test the lock context manager."""
def setUp(self):
patcher = mock.patch('silverberg.lock.BasicLock',)
self.addCleanup(patcher.stop)
self.BasicLock = patcher.start()
self.lock = mock.create_autospec(BasicLock)
def _acquire(*args, **kwargs):
return defer.succeed(None)
self.lock.acquire.side_effect = _acquire
def _release():
return defer.succeed(None)
self.lock.release.side_effect = _release
self.BasicLock.return_value = self.lock
def test_with_lock(self):
"""
Acquire the lock, run the function, and release the lock.
"""
lock_uuid = uuid.uuid1()
def _func():
return defer.succeed('Success')
lock = self.BasicLock(None, 'lock', lock_uuid)
d = with_lock(lock, _func)
result = self.successResultOf(d)
self.assertEqual(result, 'Success')
self.lock.acquire.assert_called_once_with()
self.lock.release.assert_called_once_with()
def test_with_lock_not_acquired(self):
"""
Raise an error if the lock isn't acquired.
"""
def _side_effect(*args, **kwargs):
return defer.fail(BusyLockError('', ''))
self.lock.acquire.side_effect = _side_effect
lock_uuid = uuid.uuid1()
called = [False]
def _func():
called[0] = True
return defer.succeed(None)
lock = self.BasicLock(None, 'lock', lock_uuid)
d = with_lock(lock, _func)
result = self.failureResultOf(d)
self.assertTrue(result.check(BusyLockError))
self.assertFalse(called[0])
self.assertEqual(self.lock.release.call_count, 0)
def test_with_lock_func_errors(self):
"""
If the func raises an error, the lock is released and the error passsed on.
"""
lock_uuid = uuid.uuid1()
def _func():
return defer.fail(TypeError('The samoflange is broken.'))
lock = self.BasicLock(None, 'lock', lock_uuid)
d = with_lock(lock, _func)
result = self.failureResultOf(d)
self.assertTrue(result.check(TypeError))
self.assertEqual(result.getErrorMessage(), 'The samoflange is broken.')
self.lock.acquire.assert_called_once_with()
self.lock.release.assert_called_once_with()