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
|
# Copyright (C) 2006 Canonical Ltd
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 2 of the License, or
# (at your option) any later version.
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
"""Tests for LockDir"""
from cStringIO import StringIO
from threading import Thread
import time
import bzrlib
from bzrlib.errors import (
LockBreakMismatch,
LockContention, LockError, UnlockableTransport,
LockNotHeld, LockBroken
)
from bzrlib.lockdir import LockDir
from bzrlib.tests import TestCaseWithTransport
# These tests sometimes use threads to test the behaviour of lock files with
# concurrent actors. This is not a typical (or necessarily supported) use;
# they're really meant for guarding between processes.
# These tests are run on the default transport provided by the test framework
# (typically a local disk transport). That can be changed by the --transport
# option to bzr selftest. The required properties of the transport
# implementation are tested separately. (The main requirement is just that
# they don't allow overwriting nonempty directories.)
class TestLockDir(TestCaseWithTransport):
"""Test LockDir operations"""
def test_00_lock_creation(self):
"""Creation of lock file on a transport"""
t = self.get_transport()
lf = LockDir(t, 'test_lock')
self.assertFalse(lf.is_held)
def test_01_lock_repr(self):
"""Lock string representation"""
lf = LockDir(self.get_transport(), 'test_lock')
r = repr(lf)
self.assertContainsRe(r, r'^LockDir\(.*/test_lock\)$')
def test_02_unlocked_peek(self):
lf = LockDir(self.get_transport(), 'test_lock')
self.assertEqual(lf.peek(), None)
def get_lock(self):
return LockDir(self.get_transport(), 'test_lock')
def test_unlock_after_break_raises(self):
ld = self.get_lock()
ld2 = self.get_lock()
ld.create()
ld.attempt_lock()
ld2.force_break(ld2.peek())
self.assertRaises(LockBroken, ld.unlock)
def test_03_readonly_peek(self):
lf = LockDir(self.get_readonly_transport(), 'test_lock')
self.assertEqual(lf.peek(), None)
def test_10_lock_uncontested(self):
"""Acquire and release a lock"""
t = self.get_transport()
lf = LockDir(t, 'test_lock')
lf.create()
lf.attempt_lock()
try:
self.assertTrue(lf.is_held)
finally:
lf.unlock()
self.assertFalse(lf.is_held)
def test_11_create_readonly_transport(self):
"""Fail to create lock on readonly transport"""
t = self.get_readonly_transport()
lf = LockDir(t, 'test_lock')
self.assertRaises(UnlockableTransport, lf.create)
def test_12_lock_readonly_transport(self):
"""Fail to lock on readonly transport"""
lf = LockDir(self.get_transport(), 'test_lock')
lf.create()
lf = LockDir(self.get_readonly_transport(), 'test_lock')
self.assertRaises(UnlockableTransport, lf.attempt_lock)
def test_20_lock_contested(self):
"""Contention to get a lock"""
t = self.get_transport()
lf1 = LockDir(t, 'test_lock')
lf1.create()
lf1.attempt_lock()
lf2 = LockDir(t, 'test_lock')
try:
# locking is between LockDir instances; aliases within
# a single process are not detected
lf2.attempt_lock()
self.fail('Failed to detect lock collision')
except LockContention, e:
self.assertEqual(e.lock, lf2)
self.assertContainsRe(str(e),
r'^Could not acquire.*test_lock.*$')
lf1.unlock()
def test_20_lock_peek(self):
"""Peek at the state of a lock"""
t = self.get_transport()
lf1 = LockDir(t, 'test_lock')
lf1.create()
lf1.attempt_lock()
# lock is held, should get some info on it
info1 = lf1.peek()
self.assertEqual(set(info1.keys()),
set(['user', 'nonce', 'hostname', 'pid', 'start_time']))
# should get the same info if we look at it through a different
# instance
info2 = LockDir(t, 'test_lock').peek()
self.assertEqual(info1, info2)
# locks which are never used should be not-held
self.assertEqual(LockDir(t, 'other_lock').peek(), None)
def test_21_peek_readonly(self):
"""Peek over a readonly transport"""
t = self.get_transport()
lf1 = LockDir(t, 'test_lock')
lf1.create()
lf2 = LockDir(self.get_readonly_transport(), 'test_lock')
self.assertEqual(lf2.peek(), None)
lf1.attempt_lock()
info2 = lf2.peek()
self.assertTrue(info2)
self.assertEqual(info2['nonce'], lf1.nonce)
def test_30_lock_wait_fail(self):
"""Wait on a lock, then fail
We ask to wait up to 400ms; this should fail within at most one
second. (Longer times are more realistic but we don't want the test
suite to take too long, and this should do for now.)
"""
t = self.get_transport()
lf1 = LockDir(t, 'test_lock')
lf1.create()
lf2 = LockDir(t, 'test_lock')
lf1.attempt_lock()
try:
before = time.time()
self.assertRaises(LockContention, lf2.wait_lock,
timeout=0.4, poll=0.1)
after = time.time()
# it should only take about 0.4 seconds, but we allow more time in
# case the machine is heavily loaded
self.assertTrue(after - before <= 8.0,
"took %f seconds to detect lock contention" % (after - before))
finally:
lf1.unlock()
def test_31_lock_wait_easy(self):
"""Succeed when waiting on a lock with no contention.
"""
t = self.get_transport()
lf1 = LockDir(t, 'test_lock')
lf1.create()
try:
before = time.time()
lf1.wait_lock(timeout=0.4, poll=0.1)
after = time.time()
self.assertTrue(after - before <= 1.0)
finally:
lf1.unlock()
def test_32_lock_wait_succeed(self):
"""Succeed when trying to acquire a lock that gets released
One thread holds on a lock and then releases it; another
tries to lock it.
"""
t = self.get_transport()
lf1 = LockDir(t, 'test_lock')
lf1.create()
lf1.attempt_lock()
def wait_and_unlock():
time.sleep(0.1)
lf1.unlock()
unlocker = Thread(target=wait_and_unlock)
unlocker.start()
try:
lf2 = LockDir(t, 'test_lock')
before = time.time()
# wait and then lock
lf2.wait_lock(timeout=0.4, poll=0.1)
after = time.time()
self.assertTrue(after - before <= 1.0)
finally:
unlocker.join()
def test_33_wait(self):
"""Succeed when waiting on a lock that gets released
The difference from test_32_lock_wait_succeed is that the second
caller does not actually acquire the lock, but just waits for it
to be released. This is done over a readonly transport.
"""
t = self.get_transport()
lf1 = LockDir(t, 'test_lock')
lf1.create()
lf1.attempt_lock()
def wait_and_unlock():
time.sleep(0.1)
lf1.unlock()
unlocker = Thread(target=wait_and_unlock)
unlocker.start()
try:
lf2 = LockDir(self.get_readonly_transport(), 'test_lock')
before = time.time()
# wait but don't lock
lf2.wait(timeout=0.4, poll=0.1)
after = time.time()
self.assertTrue(after - before <= 1.0)
finally:
unlocker.join()
def test_40_confirm_easy(self):
"""Confirm a lock that's already held"""
t = self.get_transport()
lf1 = LockDir(t, 'test_lock')
lf1.create()
lf1.attempt_lock()
lf1.confirm()
def test_41_confirm_not_held(self):
"""Confirm a lock that's already held"""
t = self.get_transport()
lf1 = LockDir(t, 'test_lock')
lf1.create()
self.assertRaises(LockNotHeld, lf1.confirm)
def test_42_confirm_broken_manually(self):
"""Confirm a lock broken by hand"""
t = self.get_transport()
lf1 = LockDir(t, 'test_lock')
lf1.create()
lf1.attempt_lock()
t.move('test_lock', 'lock_gone_now')
self.assertRaises(LockBroken, lf1.confirm)
def test_43_break(self):
"""Break a lock whose caller has forgotten it"""
t = self.get_transport()
lf1 = LockDir(t, 'test_lock')
lf1.create()
lf1.attempt_lock()
# we incorrectly discard the lock object without unlocking it
del lf1
# someone else sees it's still locked
lf2 = LockDir(t, 'test_lock')
holder_info = lf2.peek()
self.assertTrue(holder_info)
lf2.force_break(holder_info)
# now we should be able to take it
lf2.attempt_lock()
lf2.confirm()
def test_44_break_already_released(self):
"""Lock break races with regular release"""
t = self.get_transport()
lf1 = LockDir(t, 'test_lock')
lf1.create()
lf1.attempt_lock()
# someone else sees it's still locked
lf2 = LockDir(t, 'test_lock')
holder_info = lf2.peek()
# in the interim the lock is released
lf1.unlock()
# break should succeed
lf2.force_break(holder_info)
# now we should be able to take it
lf2.attempt_lock()
lf2.confirm()
def test_45_break_mismatch(self):
"""Lock break races with someone else acquiring it"""
t = self.get_transport()
lf1 = LockDir(t, 'test_lock')
lf1.create()
lf1.attempt_lock()
# someone else sees it's still locked
lf2 = LockDir(t, 'test_lock')
holder_info = lf2.peek()
# in the interim the lock is released
lf1.unlock()
lf3 = LockDir(t, 'test_lock')
lf3.attempt_lock()
# break should now *fail*
self.assertRaises(LockBreakMismatch, lf2.force_break,
holder_info)
lf3.unlock()
def test_46_fake_read_lock(self):
t = self.get_transport()
lf1 = LockDir(t, 'test_lock')
lf1.create()
lf1.lock_read()
lf1.unlock()
def test_50_lockdir_representation(self):
"""Check the on-disk representation of LockDirs is as expected.
There should always be a top-level directory named by the lock.
When the lock is held, there should be a lockname/held directory
containing an info file.
"""
t = self.get_transport()
lf1 = LockDir(t, 'test_lock')
lf1.create()
self.assertTrue(t.has('test_lock'))
lf1.lock_write()
self.assertTrue(t.has('test_lock/held/info'))
lf1.unlock()
self.assertFalse(t.has('test_lock/held/info'))
def test_break_lock(self):
# the ui based break_lock routine should Just Work (tm)
ld1 = self.get_lock()
ld2 = self.get_lock()
ld1.create()
ld1.lock_write()
# do this without IO redirection to ensure it doesn't prompt.
self.assertRaises(AssertionError, ld1.break_lock)
orig_factory = bzrlib.ui.ui_factory
# silent ui - no need for stdout
bzrlib.ui.ui_factory = bzrlib.ui.SilentUIFactory()
bzrlib.ui.ui_factory.stdin = StringIO("y\n")
try:
ld2.break_lock()
self.assertRaises(LockBroken, ld1.unlock)
finally:
bzrlib.ui.ui_factory = orig_factory
|