/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to bzrlib/tests/test_lockdir.py

  • Committer: Vincent Ladeuil
  • Date: 2010-10-07 06:08:01 UTC
  • mto: This revision was merged to the branch mainline in revision 5491.
  • Revision ID: v.ladeuil+lp@free.fr-20101007060801-wfdhizfhfmctl8qa
Fix some typos and propose a release planning.

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
# Copyright (C) 2006-2010 Canonical Ltd
 
2
#
 
3
# This program is free software; you can redistribute it and/or modify
 
4
# it under the terms of the GNU General Public License as published by
 
5
# the Free Software Foundation; either version 2 of the License, or
 
6
# (at your option) any later version.
 
7
#
 
8
# This program is distributed in the hope that it will be useful,
 
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
 
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 
11
# GNU General Public License for more details.
 
12
#
 
13
# You should have received a copy of the GNU General Public License
 
14
# along with this program; if not, write to the Free Software
 
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
16
 
 
17
"""Tests for LockDir"""
 
18
 
 
19
from cStringIO import StringIO
 
20
import os
 
21
from threading import Thread, Lock
 
22
import time
 
23
 
 
24
import bzrlib
 
25
from bzrlib import (
 
26
    config,
 
27
    errors,
 
28
    lock,
 
29
    osutils,
 
30
    tests,
 
31
    transport,
 
32
    )
 
33
from bzrlib.errors import (
 
34
    LockBreakMismatch,
 
35
    LockBroken,
 
36
    LockContention,
 
37
    LockError,
 
38
    LockFailed,
 
39
    LockNotHeld,
 
40
    )
 
41
from bzrlib.lockdir import LockDir
 
42
from bzrlib.tests import TestCaseWithTransport
 
43
from bzrlib.trace import note
 
44
 
 
45
# These tests sometimes use threads to test the behaviour of lock files with
 
46
# concurrent actors.  This is not a typical (or necessarily supported) use;
 
47
# they're really meant for guarding between processes.
 
48
 
 
49
# These tests are run on the default transport provided by the test framework
 
50
# (typically a local disk transport).  That can be changed by the --transport
 
51
# option to bzr selftest.  The required properties of the transport
 
52
# implementation are tested separately.  (The main requirement is just that
 
53
# they don't allow overwriting nonempty directories.)
 
54
 
 
55
class TestLockDir(TestCaseWithTransport):
 
56
    """Test LockDir operations"""
 
57
 
 
58
    def logging_report_function(self, fmt, *args):
 
59
        self._logged_reports.append((fmt, args))
 
60
 
 
61
    def setup_log_reporter(self, lock_dir):
 
62
        self._logged_reports = []
 
63
        lock_dir._report_function = self.logging_report_function
 
64
 
 
65
    def test_00_lock_creation(self):
 
66
        """Creation of lock file on a transport"""
 
67
        t = self.get_transport()
 
68
        lf = LockDir(t, 'test_lock')
 
69
        self.assertFalse(lf.is_held)
 
70
 
 
71
    def test_01_lock_repr(self):
 
72
        """Lock string representation"""
 
73
        lf = LockDir(self.get_transport(), 'test_lock')
 
74
        r = repr(lf)
 
75
        self.assertContainsRe(r, r'^LockDir\(.*/test_lock\)$')
 
76
 
 
77
    def test_02_unlocked_peek(self):
 
78
        lf = LockDir(self.get_transport(), 'test_lock')
 
79
        self.assertEqual(lf.peek(), None)
 
80
 
 
81
    def get_lock(self):
 
82
        return LockDir(self.get_transport(), 'test_lock')
 
83
 
 
84
    def test_unlock_after_break_raises(self):
 
85
        ld = self.get_lock()
 
86
        ld2 = self.get_lock()
 
87
        ld.create()
 
88
        ld.attempt_lock()
 
89
        ld2.force_break(ld2.peek())
 
90
        self.assertRaises(LockBroken, ld.unlock)
 
91
 
 
92
    def test_03_readonly_peek(self):
 
93
        lf = LockDir(self.get_readonly_transport(), 'test_lock')
 
94
        self.assertEqual(lf.peek(), None)
 
95
 
 
96
    def test_10_lock_uncontested(self):
 
97
        """Acquire and release a lock"""
 
98
        t = self.get_transport()
 
99
        lf = LockDir(t, 'test_lock')
 
100
        lf.create()
 
101
        lf.attempt_lock()
 
102
        try:
 
103
            self.assertTrue(lf.is_held)
 
104
        finally:
 
105
            lf.unlock()
 
106
            self.assertFalse(lf.is_held)
 
107
 
 
108
    def test_11_create_readonly_transport(self):
 
109
        """Fail to create lock on readonly transport"""
 
110
        t = self.get_readonly_transport()
 
111
        lf = LockDir(t, 'test_lock')
 
112
        self.assertRaises(LockFailed, lf.create)
 
113
 
 
114
    def test_12_lock_readonly_transport(self):
 
115
        """Fail to lock on readonly transport"""
 
116
        lf = LockDir(self.get_transport(), 'test_lock')
 
117
        lf.create()
 
118
        lf = LockDir(self.get_readonly_transport(), 'test_lock')
 
119
        self.assertRaises(LockFailed, lf.attempt_lock)
 
120
 
 
121
    def test_20_lock_contested(self):
 
122
        """Contention to get a lock"""
 
123
        t = self.get_transport()
 
124
        lf1 = LockDir(t, 'test_lock')
 
125
        lf1.create()
 
126
        lf1.attempt_lock()
 
127
        lf2 = LockDir(t, 'test_lock')
 
128
        try:
 
129
            # locking is between LockDir instances; aliases within
 
130
            # a single process are not detected
 
131
            lf2.attempt_lock()
 
132
            self.fail('Failed to detect lock collision')
 
133
        except LockContention, e:
 
134
            self.assertEqual(e.lock, lf2)
 
135
            self.assertContainsRe(str(e),
 
136
                    r'^Could not acquire.*test_lock.*$')
 
137
        lf1.unlock()
 
138
 
 
139
    def test_20_lock_peek(self):
 
140
        """Peek at the state of a lock"""
 
141
        t = self.get_transport()
 
142
        lf1 = LockDir(t, 'test_lock')
 
143
        lf1.create()
 
144
        lf1.attempt_lock()
 
145
        self.addCleanup(lf1.unlock)
 
146
        # lock is held, should get some info on it
 
147
        info1 = lf1.peek()
 
148
        self.assertEqual(set(info1.keys()),
 
149
                         set(['user', 'nonce', 'hostname', 'pid', 'start_time']))
 
150
        # should get the same info if we look at it through a different
 
151
        # instance
 
152
        info2 = LockDir(t, 'test_lock').peek()
 
153
        self.assertEqual(info1, info2)
 
154
        # locks which are never used should be not-held
 
155
        self.assertEqual(LockDir(t, 'other_lock').peek(), None)
 
156
 
 
157
    def test_21_peek_readonly(self):
 
158
        """Peek over a readonly transport"""
 
159
        t = self.get_transport()
 
160
        lf1 = LockDir(t, 'test_lock')
 
161
        lf1.create()
 
162
        lf2 = LockDir(self.get_readonly_transport(), 'test_lock')
 
163
        self.assertEqual(lf2.peek(), None)
 
164
        lf1.attempt_lock()
 
165
        self.addCleanup(lf1.unlock)
 
166
        info2 = lf2.peek()
 
167
        self.assertTrue(info2)
 
168
        self.assertEqual(info2['nonce'], lf1.nonce)
 
169
 
 
170
    def test_30_lock_wait_fail(self):
 
171
        """Wait on a lock, then fail
 
172
 
 
173
        We ask to wait up to 400ms; this should fail within at most one
 
174
        second.  (Longer times are more realistic but we don't want the test
 
175
        suite to take too long, and this should do for now.)
 
176
        """
 
177
        t = self.get_transport()
 
178
        lf1 = LockDir(t, 'test_lock')
 
179
        lf1.create()
 
180
        lf2 = LockDir(t, 'test_lock')
 
181
        self.setup_log_reporter(lf2)
 
182
        lf1.attempt_lock()
 
183
        try:
 
184
            before = time.time()
 
185
            self.assertRaises(LockContention, lf2.wait_lock,
 
186
                              timeout=0.4, poll=0.1)
 
187
            after = time.time()
 
188
            # it should only take about 0.4 seconds, but we allow more time in
 
189
            # case the machine is heavily loaded
 
190
            self.assertTrue(after - before <= 8.0,
 
191
                    "took %f seconds to detect lock contention" % (after - before))
 
192
        finally:
 
193
            lf1.unlock()
 
194
        self.assertEqual(1, len(self._logged_reports))
 
195
        self.assertEqual(self._logged_reports[0][0],
 
196
            '%s lock %s held by %s\n'
 
197
            'at %s [process #%s], acquired %s.\n'
 
198
            'Will continue to try until %s, unless '
 
199
            'you press Ctrl-C.\n'
 
200
            'See "bzr help break-lock" for more.')
 
201
        start, lock_url, user, hostname, pid, time_ago, deadline_str = \
 
202
            self._logged_reports[0][1]
 
203
        self.assertEqual(start, u'Unable to obtain')
 
204
        self.assertEqual(user, u'jrandom@example.com')
 
205
        # skip hostname
 
206
        self.assertContainsRe(pid, r'\d+')
 
207
        self.assertContainsRe(time_ago, r'.* ago')
 
208
        self.assertContainsRe(deadline_str, r'\d{2}:\d{2}:\d{2}')
 
209
 
 
210
    def test_31_lock_wait_easy(self):
 
211
        """Succeed when waiting on a lock with no contention.
 
212
        """
 
213
        t = self.get_transport()
 
214
        lf1 = LockDir(t, 'test_lock')
 
215
        lf1.create()
 
216
        self.setup_log_reporter(lf1)
 
217
        try:
 
218
            before = time.time()
 
219
            lf1.wait_lock(timeout=0.4, poll=0.1)
 
220
            after = time.time()
 
221
            self.assertTrue(after - before <= 1.0)
 
222
        finally:
 
223
            lf1.unlock()
 
224
        self.assertEqual([], self._logged_reports)
 
225
 
 
226
    def test_32_lock_wait_succeed(self):
 
227
        """Succeed when trying to acquire a lock that gets released
 
228
 
 
229
        One thread holds on a lock and then releases it; another
 
230
        tries to lock it.
 
231
        """
 
232
        # This test sometimes fails like this:
 
233
        # Traceback (most recent call last):
 
234
 
 
235
        #   File "/home/pqm/bzr-pqm-workdir/home/+trunk/bzrlib/tests/
 
236
        # test_lockdir.py", line 247, in test_32_lock_wait_succeed
 
237
        #     self.assertEqual(1, len(self._logged_reports))
 
238
        # AssertionError: not equal:
 
239
        # a = 1
 
240
        # b = 0
 
241
        raise tests.TestSkipped("Test fails intermittently")
 
242
        t = self.get_transport()
 
243
        lf1 = LockDir(t, 'test_lock')
 
244
        lf1.create()
 
245
        lf1.attempt_lock()
 
246
 
 
247
        def wait_and_unlock():
 
248
            time.sleep(0.1)
 
249
            lf1.unlock()
 
250
        unlocker = Thread(target=wait_and_unlock)
 
251
        unlocker.start()
 
252
        try:
 
253
            lf2 = LockDir(t, 'test_lock')
 
254
            self.setup_log_reporter(lf2)
 
255
            before = time.time()
 
256
            # wait and then lock
 
257
            lf2.wait_lock(timeout=0.4, poll=0.1)
 
258
            after = time.time()
 
259
            self.assertTrue(after - before <= 1.0)
 
260
        finally:
 
261
            unlocker.join()
 
262
 
 
263
        # There should be only 1 report, even though it should have to
 
264
        # wait for a while
 
265
        lock_base = lf2.transport.abspath(lf2.path)
 
266
        self.assertEqual(1, len(self._logged_reports))
 
267
        self.assertEqual('%s %s\n'
 
268
                         '%s\n%s\n'
 
269
                         'Will continue to try until %s\n',
 
270
                         self._logged_reports[0][0])
 
271
        args = self._logged_reports[0][1]
 
272
        self.assertEqual('Unable to obtain', args[0])
 
273
        self.assertEqual('lock %s' % (lock_base,), args[1])
 
274
        self.assertStartsWith(args[2], 'held by ')
 
275
        self.assertStartsWith(args[3], 'locked ')
 
276
        self.assertEndsWith(args[3], ' ago')
 
277
        self.assertContainsRe(args[4], r'\d\d:\d\d:\d\d')
 
278
 
 
279
    def test_34_lock_write_waits(self):
 
280
        """LockDir.lock_write() will wait for the lock."""
 
281
        # the test suite sets the default to 0 to make deadlocks fail fast.
 
282
        # change it for this test, as we want to try a manual deadlock.
 
283
        raise tests.TestSkipped('Timing-sensitive test')
 
284
        bzrlib.lockdir._DEFAULT_TIMEOUT_SECONDS = 300
 
285
        t = self.get_transport()
 
286
        lf1 = LockDir(t, 'test_lock')
 
287
        lf1.create()
 
288
        lf1.attempt_lock()
 
289
 
 
290
        def wait_and_unlock():
 
291
            time.sleep(0.1)
 
292
            lf1.unlock()
 
293
        unlocker = Thread(target=wait_and_unlock)
 
294
        unlocker.start()
 
295
        try:
 
296
            lf2 = LockDir(t, 'test_lock')
 
297
            self.setup_log_reporter(lf2)
 
298
            before = time.time()
 
299
            # wait and then lock
 
300
            lf2.lock_write()
 
301
            after = time.time()
 
302
        finally:
 
303
            unlocker.join()
 
304
 
 
305
        # There should be only 1 report, even though it should have to
 
306
        # wait for a while
 
307
        lock_base = lf2.transport.abspath(lf2.path)
 
308
        self.assertEqual(1, len(self._logged_reports))
 
309
        self.assertEqual('%s %s\n'
 
310
                         '%s\n%s\n'
 
311
                         'Will continue to try until %s\n',
 
312
                         self._logged_reports[0][0])
 
313
        args = self._logged_reports[0][1]
 
314
        self.assertEqual('Unable to obtain', args[0])
 
315
        self.assertEqual('lock %s' % (lock_base,), args[1])
 
316
        self.assertStartsWith(args[2], 'held by ')
 
317
        self.assertStartsWith(args[3], 'locked ')
 
318
        self.assertEndsWith(args[3], ' ago')
 
319
        self.assertContainsRe(args[4], r'\d\d:\d\d:\d\d')
 
320
 
 
321
    def test_35_wait_lock_changing(self):
 
322
        """LockDir.wait_lock() will report if the lock changes underneath.
 
323
 
 
324
        This is the stages we want to happen:
 
325
 
 
326
        0) Synchronization locks are created and locked.
 
327
        1) Lock1 obtains the lockdir, and releases the 'check' lock.
 
328
        2) Lock2 grabs the 'check' lock, and checks the lockdir.
 
329
           It sees the lockdir is already acquired, reports the fact,
 
330
           and unsets the 'checked' lock.
 
331
        3) Thread1 blocks on acquiring the 'checked' lock, and then tells
 
332
           Lock1 to release and acquire the lockdir. This resets the 'check'
 
333
           lock.
 
334
        4) Lock2 acquires the 'check' lock, and checks again. It notices
 
335
           that the holder of the lock has changed, and so reports a new
 
336
           lock holder.
 
337
        5) Thread1 blocks on the 'checked' lock, this time, it completely
 
338
           unlocks the lockdir, allowing Lock2 to acquire the lock.
 
339
        """
 
340
 
 
341
        raise tests.KnownFailure(
 
342
            "timing dependency in lock tests (#213182)")
 
343
 
 
344
        wait_to_check_lock = Lock()
 
345
        wait_until_checked_lock = Lock()
 
346
 
 
347
        wait_to_check_lock.acquire()
 
348
        wait_until_checked_lock.acquire()
 
349
        note('locked check and checked locks')
 
350
 
 
351
        class LockDir1(LockDir):
 
352
            """Use the synchronization points for the first lock."""
 
353
 
 
354
            def attempt_lock(self):
 
355
                # Once we have acquired the lock, it is okay for
 
356
                # the other lock to check it
 
357
                try:
 
358
                    return super(LockDir1, self).attempt_lock()
 
359
                finally:
 
360
                    note('lock1: releasing check lock')
 
361
                    wait_to_check_lock.release()
 
362
 
 
363
        class LockDir2(LockDir):
 
364
            """Use the synchronization points for the second lock."""
 
365
 
 
366
            def attempt_lock(self):
 
367
                note('lock2: waiting for check lock')
 
368
                wait_to_check_lock.acquire()
 
369
                note('lock2: acquired check lock')
 
370
                try:
 
371
                    return super(LockDir2, self).attempt_lock()
 
372
                finally:
 
373
                    note('lock2: releasing checked lock')
 
374
                    wait_until_checked_lock.release()
 
375
 
 
376
        t = self.get_transport()
 
377
        lf1 = LockDir1(t, 'test_lock')
 
378
        lf1.create()
 
379
 
 
380
        lf2 = LockDir2(t, 'test_lock')
 
381
        self.setup_log_reporter(lf2)
 
382
 
 
383
        def wait_and_switch():
 
384
            lf1.attempt_lock()
 
385
            # Block until lock2 has had a chance to check
 
386
            note('lock1: waiting 1 for checked lock')
 
387
            wait_until_checked_lock.acquire()
 
388
            note('lock1: acquired for checked lock')
 
389
            note('lock1: released lockdir')
 
390
            lf1.unlock()
 
391
            note('lock1: acquiring lockdir')
 
392
            # Create a new nonce, so the lock looks different.
 
393
            lf1.nonce = osutils.rand_chars(20)
 
394
            lf1.lock_write()
 
395
            note('lock1: acquired lockdir')
 
396
 
 
397
            # Block until lock2 has peeked again
 
398
            note('lock1: waiting 2 for checked lock')
 
399
            wait_until_checked_lock.acquire()
 
400
            note('lock1: acquired for checked lock')
 
401
            # Now unlock, and let lock 2 grab the lock
 
402
            lf1.unlock()
 
403
            wait_to_check_lock.release()
 
404
 
 
405
        unlocker = Thread(target=wait_and_switch)
 
406
        unlocker.start()
 
407
        try:
 
408
            # Wait and play against the other thread
 
409
            lf2.wait_lock(timeout=20.0, poll=0.01)
 
410
        finally:
 
411
            unlocker.join()
 
412
        lf2.unlock()
 
413
 
 
414
        # There should be 2 reports, because the lock changed
 
415
        lock_base = lf2.transport.abspath(lf2.path)
 
416
        self.assertEqual(2, len(self._logged_reports))
 
417
        lock_url = lf2.transport.abspath(lf2.path)
 
418
        self.assertEqual('%s %s\n'
 
419
                         '%s\n%s\n'
 
420
                         'Will continue to try until %s, unless '
 
421
                         'you press Ctrl-C.\n'
 
422
                         'See "bzr help break-lock" for more.',
 
423
                         self._logged_reports[0][0])
 
424
        args = self._logged_reports[0][1]
 
425
        self.assertEqual('Unable to obtain', args[0])
 
426
        self.assertEqual('lock %s' % (lock_base,), args[1])
 
427
        self.assertStartsWith(args[2], 'held by ')
 
428
        self.assertStartsWith(args[3], 'locked ')
 
429
        self.assertEndsWith(args[3], ' ago')
 
430
        self.assertContainsRe(args[4], r'\d\d:\d\d:\d\d')
 
431
 
 
432
        self.assertEqual('%s %s\n'
 
433
                         '%s\n%s\n'
 
434
                         'Will continue to try until %s, unless '
 
435
                         'you press Ctrl-C.\n'
 
436
                         'See "bzr help break-lock" for more.',
 
437
                         self._logged_reports[1][0])
 
438
        args = self._logged_reports[1][1]
 
439
        self.assertEqual('Lock owner changed for', args[0])
 
440
        self.assertEqual('lock %s' % (lock_base,), args[1])
 
441
        self.assertStartsWith(args[2], 'held by ')
 
442
        self.assertStartsWith(args[3], 'locked ')
 
443
        self.assertEndsWith(args[3], ' ago')
 
444
        self.assertContainsRe(args[4], r'\d\d:\d\d:\d\d')
 
445
 
 
446
    def test_40_confirm_easy(self):
 
447
        """Confirm a lock that's already held"""
 
448
        t = self.get_transport()
 
449
        lf1 = LockDir(t, 'test_lock')
 
450
        lf1.create()
 
451
        lf1.attempt_lock()
 
452
        self.addCleanup(lf1.unlock)
 
453
        lf1.confirm()
 
454
 
 
455
    def test_41_confirm_not_held(self):
 
456
        """Confirm a lock that's already held"""
 
457
        t = self.get_transport()
 
458
        lf1 = LockDir(t, 'test_lock')
 
459
        lf1.create()
 
460
        self.assertRaises(LockNotHeld, lf1.confirm)
 
461
 
 
462
    def test_42_confirm_broken_manually(self):
 
463
        """Confirm a lock broken by hand"""
 
464
        t = self.get_transport()
 
465
        lf1 = LockDir(t, 'test_lock')
 
466
        lf1.create()
 
467
        lf1.attempt_lock()
 
468
        t.move('test_lock', 'lock_gone_now')
 
469
        self.assertRaises(LockBroken, lf1.confirm)
 
470
        # Clean up
 
471
        t.move('lock_gone_now', 'test_lock')
 
472
        lf1.unlock()
 
473
 
 
474
    def test_43_break(self):
 
475
        """Break a lock whose caller has forgotten it"""
 
476
        t = self.get_transport()
 
477
        lf1 = LockDir(t, 'test_lock')
 
478
        lf1.create()
 
479
        lf1.attempt_lock()
 
480
        # we incorrectly discard the lock object without unlocking it
 
481
        del lf1
 
482
        # someone else sees it's still locked
 
483
        lf2 = LockDir(t, 'test_lock')
 
484
        holder_info = lf2.peek()
 
485
        self.assertTrue(holder_info)
 
486
        lf2.force_break(holder_info)
 
487
        # now we should be able to take it
 
488
        lf2.attempt_lock()
 
489
        self.addCleanup(lf2.unlock)
 
490
        lf2.confirm()
 
491
 
 
492
    def test_44_break_already_released(self):
 
493
        """Lock break races with regular release"""
 
494
        t = self.get_transport()
 
495
        lf1 = LockDir(t, 'test_lock')
 
496
        lf1.create()
 
497
        lf1.attempt_lock()
 
498
        # someone else sees it's still locked
 
499
        lf2 = LockDir(t, 'test_lock')
 
500
        holder_info = lf2.peek()
 
501
        # in the interim the lock is released
 
502
        lf1.unlock()
 
503
        # break should succeed
 
504
        lf2.force_break(holder_info)
 
505
        # now we should be able to take it
 
506
        lf2.attempt_lock()
 
507
        self.addCleanup(lf2.unlock)
 
508
        lf2.confirm()
 
509
 
 
510
    def test_45_break_mismatch(self):
 
511
        """Lock break races with someone else acquiring it"""
 
512
        t = self.get_transport()
 
513
        lf1 = LockDir(t, 'test_lock')
 
514
        lf1.create()
 
515
        lf1.attempt_lock()
 
516
        # someone else sees it's still locked
 
517
        lf2 = LockDir(t, 'test_lock')
 
518
        holder_info = lf2.peek()
 
519
        # in the interim the lock is released
 
520
        lf1.unlock()
 
521
        lf3 = LockDir(t, 'test_lock')
 
522
        lf3.attempt_lock()
 
523
        # break should now *fail*
 
524
        self.assertRaises(LockBreakMismatch, lf2.force_break,
 
525
                          holder_info)
 
526
        lf3.unlock()
 
527
 
 
528
    def test_46_fake_read_lock(self):
 
529
        t = self.get_transport()
 
530
        lf1 = LockDir(t, 'test_lock')
 
531
        lf1.create()
 
532
        lf1.lock_read()
 
533
        lf1.unlock()
 
534
 
 
535
    def test_50_lockdir_representation(self):
 
536
        """Check the on-disk representation of LockDirs is as expected.
 
537
 
 
538
        There should always be a top-level directory named by the lock.
 
539
        When the lock is held, there should be a lockname/held directory
 
540
        containing an info file.
 
541
        """
 
542
        t = self.get_transport()
 
543
        lf1 = LockDir(t, 'test_lock')
 
544
        lf1.create()
 
545
        self.assertTrue(t.has('test_lock'))
 
546
        lf1.lock_write()
 
547
        self.assertTrue(t.has('test_lock/held/info'))
 
548
        lf1.unlock()
 
549
        self.assertFalse(t.has('test_lock/held/info'))
 
550
 
 
551
    def test_break_lock(self):
 
552
        # the ui based break_lock routine should Just Work (tm)
 
553
        ld1 = self.get_lock()
 
554
        ld2 = self.get_lock()
 
555
        ld1.create()
 
556
        ld1.lock_write()
 
557
        # do this without IO redirection to ensure it doesn't prompt.
 
558
        self.assertRaises(AssertionError, ld1.break_lock)
 
559
        orig_factory = bzrlib.ui.ui_factory
 
560
        bzrlib.ui.ui_factory = bzrlib.ui.CannedInputUIFactory([True])
 
561
        try:
 
562
            ld2.break_lock()
 
563
            self.assertRaises(LockBroken, ld1.unlock)
 
564
        finally:
 
565
            bzrlib.ui.ui_factory = orig_factory
 
566
 
 
567
    def test_break_lock_corrupt_info(self):
 
568
        """break_lock works even if the info file is corrupt (and tells the UI
 
569
        that it is corrupt).
 
570
        """
 
571
        ld = self.get_lock()
 
572
        ld2 = self.get_lock()
 
573
        ld.create()
 
574
        ld.lock_write()
 
575
        ld.transport.put_bytes_non_atomic('test_lock/held/info', '\0')
 
576
        class LoggingUIFactory(bzrlib.ui.SilentUIFactory):
 
577
            def __init__(self):
 
578
                self.prompts = []
 
579
            def get_boolean(self, prompt):
 
580
                self.prompts.append(('boolean', prompt))
 
581
                return True
 
582
        ui = LoggingUIFactory()
 
583
        orig_factory = bzrlib.ui.ui_factory
 
584
        bzrlib.ui.ui_factory = ui
 
585
        try:
 
586
            ld2.break_lock()
 
587
            self.assertLength(1, ui.prompts)
 
588
            self.assertEqual('boolean', ui.prompts[0][0])
 
589
            self.assertStartsWith(ui.prompts[0][1], 'Break (corrupt LockDir')
 
590
            self.assertRaises(LockBroken, ld.unlock)
 
591
        finally:
 
592
            bzrlib.ui.ui_factory = orig_factory
 
593
 
 
594
    def test_break_lock_missing_info(self):
 
595
        """break_lock works even if the info file is missing (and tells the UI
 
596
        that it is corrupt).
 
597
        """
 
598
        ld = self.get_lock()
 
599
        ld2 = self.get_lock()
 
600
        ld.create()
 
601
        ld.lock_write()
 
602
        ld.transport.delete('test_lock/held/info')
 
603
        class LoggingUIFactory(bzrlib.ui.SilentUIFactory):
 
604
            def __init__(self):
 
605
                self.prompts = []
 
606
            def get_boolean(self, prompt):
 
607
                self.prompts.append(('boolean', prompt))
 
608
                return True
 
609
        ui = LoggingUIFactory()
 
610
        orig_factory = bzrlib.ui.ui_factory
 
611
        bzrlib.ui.ui_factory = ui
 
612
        try:
 
613
            ld2.break_lock()
 
614
            self.assertRaises(LockBroken, ld.unlock)
 
615
            self.assertLength(0, ui.prompts)
 
616
        finally:
 
617
            bzrlib.ui.ui_factory = orig_factory
 
618
        # Suppress warnings due to ld not being unlocked
 
619
        # XXX: if lock_broken hook was invoked in this case, this hack would
 
620
        # not be necessary.  - Andrew Bennetts, 2010-09-06.
 
621
        del self._lock_actions[:]
 
622
 
 
623
    def test_create_missing_base_directory(self):
 
624
        """If LockDir.path doesn't exist, it can be created
 
625
 
 
626
        Some people manually remove the entire lock/ directory trying
 
627
        to unlock a stuck repository/branch/etc. Rather than failing
 
628
        after that, just create the lock directory when needed.
 
629
        """
 
630
        t = self.get_transport()
 
631
        lf1 = LockDir(t, 'test_lock')
 
632
 
 
633
        lf1.create()
 
634
        self.failUnless(t.has('test_lock'))
 
635
 
 
636
        t.rmdir('test_lock')
 
637
        self.failIf(t.has('test_lock'))
 
638
 
 
639
        # This will create 'test_lock' if it needs to
 
640
        lf1.lock_write()
 
641
        self.failUnless(t.has('test_lock'))
 
642
        self.failUnless(t.has('test_lock/held/info'))
 
643
 
 
644
        lf1.unlock()
 
645
        self.failIf(t.has('test_lock/held/info'))
 
646
 
 
647
    def test__format_lock_info(self):
 
648
        ld1 = self.get_lock()
 
649
        ld1.create()
 
650
        ld1.lock_write()
 
651
        try:
 
652
            info_list = ld1._format_lock_info(ld1.peek())
 
653
        finally:
 
654
            ld1.unlock()
 
655
        self.assertEqual(info_list[0], u'jrandom@example.com')
 
656
        # info_list[1] is hostname. we skip this.
 
657
        self.assertContainsRe(info_list[2], '^\d+$') # pid
 
658
        self.assertContainsRe(info_list[3], r'^\d+ seconds? ago$') # time_ago
 
659
 
 
660
    def test_lock_without_email(self):
 
661
        global_config = config.GlobalConfig()
 
662
        # Intentionally has no email address
 
663
        global_config.set_user_option('email', 'User Identity')
 
664
        ld1 = self.get_lock()
 
665
        ld1.create()
 
666
        ld1.lock_write()
 
667
        ld1.unlock()
 
668
 
 
669
    def test_lock_permission(self):
 
670
        if not osutils.supports_posix_readonly():
 
671
            raise tests.TestSkipped('Cannot induce a permission failure')
 
672
        ld1 = self.get_lock()
 
673
        lock_path = ld1.transport.local_abspath('test_lock')
 
674
        os.mkdir(lock_path)
 
675
        osutils.make_readonly(lock_path)
 
676
        self.assertRaises(errors.LockFailed, ld1.attempt_lock)
 
677
 
 
678
    def test_lock_by_token(self):
 
679
        ld1 = self.get_lock()
 
680
        token = ld1.lock_write()
 
681
        self.addCleanup(ld1.unlock)
 
682
        self.assertNotEqual(None, token)
 
683
        ld2 = self.get_lock()
 
684
        t2 = ld2.lock_write(token)
 
685
        self.addCleanup(ld2.unlock)
 
686
        self.assertEqual(token, t2)
 
687
 
 
688
    def test_lock_with_buggy_rename(self):
 
689
        # test that lock acquisition handles servers which pretend they
 
690
        # renamed correctly but that actually fail
 
691
        t = transport.get_transport('brokenrename+' + self.get_url())
 
692
        ld1 = LockDir(t, 'test_lock')
 
693
        ld1.create()
 
694
        ld1.attempt_lock()
 
695
        ld2 = LockDir(t, 'test_lock')
 
696
        # we should fail to lock
 
697
        e = self.assertRaises(errors.LockContention, ld2.attempt_lock)
 
698
        # now the original caller should succeed in unlocking
 
699
        ld1.unlock()
 
700
        # and there should be nothing left over
 
701
        self.assertEquals([], t.list_dir('test_lock'))
 
702
 
 
703
    def test_failed_lock_leaves_no_trash(self):
 
704
        # if we fail to acquire the lock, we don't leave pending directories
 
705
        # behind -- https://bugs.launchpad.net/bzr/+bug/109169
 
706
        ld1 = self.get_lock()
 
707
        ld2 = self.get_lock()
 
708
        # should be nothing before we start
 
709
        ld1.create()
 
710
        t = self.get_transport().clone('test_lock')
 
711
        def check_dir(a):
 
712
            self.assertEquals(a, t.list_dir('.'))
 
713
        check_dir([])
 
714
        # when held, that's all we see
 
715
        ld1.attempt_lock()
 
716
        self.addCleanup(ld1.unlock)
 
717
        check_dir(['held'])
 
718
        # second guy should fail
 
719
        self.assertRaises(errors.LockContention, ld2.attempt_lock)
 
720
        # no kibble
 
721
        check_dir(['held'])
 
722
 
 
723
    def test_no_lockdir_info(self):
 
724
        """We can cope with empty info files."""
 
725
        # This seems like a fairly common failure case - see
 
726
        # <https://bugs.launchpad.net/bzr/+bug/185103> and all its dupes.
 
727
        # Processes are often interrupted after opening the file
 
728
        # before the actual contents are committed.
 
729
        t = self.get_transport()
 
730
        t.mkdir('test_lock')
 
731
        t.mkdir('test_lock/held')
 
732
        t.put_bytes('test_lock/held/info', '')
 
733
        lf = LockDir(t, 'test_lock')
 
734
        info = lf.peek()
 
735
        formatted_info = lf._format_lock_info(info)
 
736
        self.assertEquals(
 
737
            ['<unknown>', '<unknown>', '<unknown>', '(unknown)'],
 
738
            formatted_info)
 
739
 
 
740
    def test_corrupt_lockdir_info(self):
 
741
        """We can cope with corrupt (and thus unparseable) info files."""
 
742
        # This seems like a fairly common failure case too - see
 
743
        # <https://bugs.edge.launchpad.net/bzr/+bug/619872> for instance.
 
744
        # In particular some systems tend to fill recently created files with
 
745
        # nul bytes after recovering from a system crash.
 
746
        t = self.get_transport()
 
747
        t.mkdir('test_lock')
 
748
        t.mkdir('test_lock/held')
 
749
        t.put_bytes('test_lock/held/info', '\0')
 
750
        lf = LockDir(t, 'test_lock')
 
751
        self.assertRaises(errors.LockCorrupt, lf.peek)
 
752
        # Currently attempt_lock gives LockContention, but LockCorrupt would be
 
753
        # a reasonable result too.
 
754
        self.assertRaises(
 
755
            (errors.LockCorrupt, errors.LockContention), lf.attempt_lock)
 
756
        self.assertRaises(errors.LockCorrupt, lf.validate_token, 'fake token')
 
757
 
 
758
    def test_missing_lockdir_info(self):
 
759
        """We can cope with absent info files."""
 
760
        t = self.get_transport()
 
761
        t.mkdir('test_lock')
 
762
        t.mkdir('test_lock/held')
 
763
        lf = LockDir(t, 'test_lock')
 
764
        # In this case we expect the 'not held' result from peek, because peek
 
765
        # cannot be expected to notice that there is a 'held' directory with no
 
766
        # 'info' file.
 
767
        self.assertEqual(None, lf.peek())
 
768
        # And lock/unlock may work or give LockContention (but not any other
 
769
        # error).
 
770
        try:
 
771
            lf.attempt_lock()
 
772
        except LockContention:
 
773
            # LockContention is ok, and expected on Windows
 
774
            pass
 
775
        else:
 
776
            # no error is ok, and expected on POSIX (because POSIX allows
 
777
            # os.rename over an empty directory).
 
778
            lf.unlock()
 
779
        # Currently raises TokenMismatch, but LockCorrupt would be reasonable
 
780
        # too.
 
781
        self.assertRaises(
 
782
            (errors.TokenMismatch, errors.LockCorrupt),
 
783
            lf.validate_token, 'fake token')
 
784
 
 
785
 
 
786
class TestLockDirHooks(TestCaseWithTransport):
 
787
 
 
788
    def setUp(self):
 
789
        super(TestLockDirHooks, self).setUp()
 
790
        self._calls = []
 
791
 
 
792
    def get_lock(self):
 
793
        return LockDir(self.get_transport(), 'test_lock')
 
794
 
 
795
    def record_hook(self, result):
 
796
        self._calls.append(result)
 
797
 
 
798
    def test_LockDir_acquired_success(self):
 
799
        # the LockDir.lock_acquired hook fires when a lock is acquired.
 
800
        LockDir.hooks.install_named_hook('lock_acquired',
 
801
                                         self.record_hook, 'record_hook')
 
802
        ld = self.get_lock()
 
803
        ld.create()
 
804
        self.assertEqual([], self._calls)
 
805
        result = ld.attempt_lock()
 
806
        lock_path = ld.transport.abspath(ld.path)
 
807
        self.assertEqual([lock.LockResult(lock_path, result)], self._calls)
 
808
        ld.unlock()
 
809
        self.assertEqual([lock.LockResult(lock_path, result)], self._calls)
 
810
 
 
811
    def test_LockDir_acquired_fail(self):
 
812
        # the LockDir.lock_acquired hook does not fire on failure.
 
813
        ld = self.get_lock()
 
814
        ld.create()
 
815
        ld2 = self.get_lock()
 
816
        ld2.attempt_lock()
 
817
        # install a lock hook now, when the disk lock is locked
 
818
        LockDir.hooks.install_named_hook('lock_acquired',
 
819
                                         self.record_hook, 'record_hook')
 
820
        self.assertRaises(errors.LockContention, ld.attempt_lock)
 
821
        self.assertEqual([], self._calls)
 
822
        ld2.unlock()
 
823
        self.assertEqual([], self._calls)
 
824
 
 
825
    def test_LockDir_released_success(self):
 
826
        # the LockDir.lock_released hook fires when a lock is acquired.
 
827
        LockDir.hooks.install_named_hook('lock_released',
 
828
                                         self.record_hook, 'record_hook')
 
829
        ld = self.get_lock()
 
830
        ld.create()
 
831
        self.assertEqual([], self._calls)
 
832
        result = ld.attempt_lock()
 
833
        self.assertEqual([], self._calls)
 
834
        ld.unlock()
 
835
        lock_path = ld.transport.abspath(ld.path)
 
836
        self.assertEqual([lock.LockResult(lock_path, result)], self._calls)
 
837
 
 
838
    def test_LockDir_released_fail(self):
 
839
        # the LockDir.lock_released hook does not fire on failure.
 
840
        ld = self.get_lock()
 
841
        ld.create()
 
842
        ld2 = self.get_lock()
 
843
        ld.attempt_lock()
 
844
        ld2.force_break(ld2.peek())
 
845
        LockDir.hooks.install_named_hook('lock_released',
 
846
                                         self.record_hook, 'record_hook')
 
847
        self.assertRaises(LockBroken, ld.unlock)
 
848
        self.assertEqual([], self._calls)
 
849
 
 
850
    def test_LockDir_broken_success(self):
 
851
        # the LockDir.lock_broken hook fires when a lock is broken.
 
852
        ld = self.get_lock()
 
853
        ld.create()
 
854
        ld2 = self.get_lock()
 
855
        result = ld.attempt_lock()
 
856
        LockDir.hooks.install_named_hook('lock_broken',
 
857
                                         self.record_hook, 'record_hook')
 
858
        ld2.force_break(ld2.peek())
 
859
        lock_path = ld.transport.abspath(ld.path)
 
860
        self.assertEqual([lock.LockResult(lock_path, result)], self._calls)
 
861
 
 
862
    def test_LockDir_broken_failure(self):
 
863
        # the LockDir.lock_broken hook does not fires when a lock is already
 
864
        # released.
 
865
        ld = self.get_lock()
 
866
        ld.create()
 
867
        ld2 = self.get_lock()
 
868
        result = ld.attempt_lock()
 
869
        holder_info = ld2.peek()
 
870
        ld.unlock()
 
871
        LockDir.hooks.install_named_hook('lock_broken',
 
872
                                         self.record_hook, 'record_hook')
 
873
        ld2.force_break(holder_info)
 
874
        lock_path = ld.transport.abspath(ld.path)
 
875
        self.assertEqual([], self._calls)