← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/tests/test_lockdir.py

(vila) Calling super() instead of mentioning the base class in setUp avoid
 mistakes. (Vincent Ladeuil)

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/tests/test_lockdir.py
1
 
# Copyright (C) 2006 Canonical Ltd
2
 
 
 
1
# Copyright (C) 2006-2011 Canonical Ltd
 
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
5
5
# the Free Software Foundation; either version 2 of the License, or
6
6
# (at your option) any later version.
7
 
 
 
7
#
8
8
# This program is distributed in the hope that it will be useful,
9
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
11
11
# GNU General Public License for more details.
12
 
 
 
12
#
13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
 
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
16
16
 
17
17
"""Tests for LockDir"""
18
18
 
19
 
from threading import Thread
 
19
import os
20
20
import time
21
21
 
 
22
import bzrlib
 
23
from bzrlib import (
 
24
    config,
 
25
    errors,
 
26
    lock,
 
27
    lockdir,
 
28
    osutils,
 
29
    tests,
 
30
    transport,
 
31
    )
22
32
from bzrlib.errors import (
23
 
        LockBreakMismatch,
24
 
        LockContention, LockError, UnlockableTransport,
25
 
        LockNotHeld, LockBroken
26
 
        )
27
 
from bzrlib.lockdir import LockDir
28
 
from bzrlib.tests import TestCaseWithTransport
29
 
 
30
 
# These tests sometimes use threads to test the behaviour of lock files with
31
 
# concurrent actors.  This is not a typical (or necessarily supported) use;
32
 
# they're really meant for guarding between processes.
 
33
    LockBreakMismatch,
 
34
    LockBroken,
 
35
    LockContention,
 
36
    LockFailed,
 
37
    LockNotHeld,
 
38
    )
 
39
from bzrlib.lockdir import (
 
40
    LockDir,
 
41
    LockHeldInfo,
 
42
    )
 
43
from bzrlib.tests import (
 
44
    features,
 
45
    TestCase,
 
46
    TestCaseInTempDir,
 
47
    TestCaseWithTransport,
 
48
    )
33
49
 
34
50
# These tests are run on the default transport provided by the test framework
35
51
# (typically a local disk transport).  That can be changed by the --transport
37
53
# implementation are tested separately.  (The main requirement is just that
38
54
# they don't allow overwriting nonempty directories.)
39
55
 
 
56
 
40
57
class TestLockDir(TestCaseWithTransport):
41
58
    """Test LockDir operations"""
42
59
 
 
60
    def logging_report_function(self, fmt, *args):
 
61
        self._logged_reports.append((fmt, args))
 
62
 
 
63
    def setup_log_reporter(self, lock_dir):
 
64
        self._logged_reports = []
 
65
        lock_dir._report_function = self.logging_report_function
 
66
 
43
67
    def test_00_lock_creation(self):
44
68
        """Creation of lock file on a transport"""
45
69
        t = self.get_transport()
56
80
        lf = LockDir(self.get_transport(), 'test_lock')
57
81
        self.assertEqual(lf.peek(), None)
58
82
 
 
83
    def get_lock(self):
 
84
        return LockDir(self.get_transport(), 'test_lock')
 
85
 
 
86
    def test_unlock_after_break_raises(self):
 
87
        ld = self.get_lock()
 
88
        ld2 = self.get_lock()
 
89
        ld.create()
 
90
        ld.attempt_lock()
 
91
        ld2.force_break(ld2.peek())
 
92
        self.assertRaises(LockBroken, ld.unlock)
 
93
 
59
94
    def test_03_readonly_peek(self):
60
95
        lf = LockDir(self.get_readonly_transport(), 'test_lock')
61
96
        self.assertEqual(lf.peek(), None)
76
111
        """Fail to create lock on readonly transport"""
77
112
        t = self.get_readonly_transport()
78
113
        lf = LockDir(t, 'test_lock')
79
 
        self.assertRaises(UnlockableTransport, lf.create)
 
114
        self.assertRaises(LockFailed, lf.create)
80
115
 
81
116
    def test_12_lock_readonly_transport(self):
82
117
        """Fail to lock on readonly transport"""
83
118
        lf = LockDir(self.get_transport(), 'test_lock')
84
119
        lf.create()
85
120
        lf = LockDir(self.get_readonly_transport(), 'test_lock')
86
 
        self.assertRaises(UnlockableTransport, lf.attempt_lock)
 
121
        self.assertRaises(LockFailed, lf.attempt_lock)
87
122
 
88
123
    def test_20_lock_contested(self):
89
124
        """Contention to get a lock"""
93
128
        lf1.attempt_lock()
94
129
        lf2 = LockDir(t, 'test_lock')
95
130
        try:
96
 
            # locking is between LockDir instances; aliases within 
 
131
            # locking is between LockDir instances; aliases within
97
132
            # a single process are not detected
98
133
            lf2.attempt_lock()
99
134
            self.fail('Failed to detect lock collision')
109
144
        lf1 = LockDir(t, 'test_lock')
110
145
        lf1.create()
111
146
        lf1.attempt_lock()
 
147
        self.addCleanup(lf1.unlock)
112
148
        # lock is held, should get some info on it
113
149
        info1 = lf1.peek()
114
 
        self.assertEqual(set(info1.keys()),
115
 
                         set(['user', 'nonce', 'hostname', 'pid', 'start_time']))
 
150
        self.assertEqual(set(info1.info_dict.keys()),
 
151
            set(['user', 'nonce', 'hostname', 'pid', 'start_time']))
116
152
        # should get the same info if we look at it through a different
117
153
        # instance
118
154
        info2 = LockDir(t, 'test_lock').peek()
128
164
        lf2 = LockDir(self.get_readonly_transport(), 'test_lock')
129
165
        self.assertEqual(lf2.peek(), None)
130
166
        lf1.attempt_lock()
 
167
        self.addCleanup(lf1.unlock)
131
168
        info2 = lf2.peek()
132
169
        self.assertTrue(info2)
133
 
        self.assertEqual(info2['nonce'], lf1.nonce)
 
170
        self.assertEqual(info2.get('nonce'), lf1.nonce)
134
171
 
135
172
    def test_30_lock_wait_fail(self):
136
173
        """Wait on a lock, then fail
137
 
        
 
174
 
138
175
        We ask to wait up to 400ms; this should fail within at most one
139
176
        second.  (Longer times are more realistic but we don't want the test
140
177
        suite to take too long, and this should do for now.)
143
180
        lf1 = LockDir(t, 'test_lock')
144
181
        lf1.create()
145
182
        lf2 = LockDir(t, 'test_lock')
 
183
        self.setup_log_reporter(lf2)
146
184
        lf1.attempt_lock()
147
185
        try:
148
186
            before = time.time()
149
187
            self.assertRaises(LockContention, lf2.wait_lock,
150
188
                              timeout=0.4, poll=0.1)
151
189
            after = time.time()
152
 
            self.assertTrue(after - before <= 1.0)
 
190
            # it should only take about 0.4 seconds, but we allow more time in
 
191
            # case the machine is heavily loaded
 
192
            self.assertTrue(after - before <= 8.0,
 
193
                "took %f seconds to detect lock contention" % (after - before))
153
194
        finally:
154
195
            lf1.unlock()
 
196
        self.assertEqual(1, len(self._logged_reports))
 
197
        self.assertContainsRe(self._logged_reports[0][0],
 
198
            r'Unable to obtain lock .* held by jrandom@example\.com on .*'
 
199
            r' \(process #\d+\), acquired .* ago\.\n'
 
200
            r'Will continue to try until \d{2}:\d{2}:\d{2}, unless '
 
201
            r'you press Ctrl-C.\n'
 
202
            r'See "bzr help break-lock" for more.')
155
203
 
156
204
    def test_31_lock_wait_easy(self):
157
205
        """Succeed when waiting on a lock with no contention.
159
207
        t = self.get_transport()
160
208
        lf1 = LockDir(t, 'test_lock')
161
209
        lf1.create()
 
210
        self.setup_log_reporter(lf1)
162
211
        try:
163
212
            before = time.time()
164
213
            lf1.wait_lock(timeout=0.4, poll=0.1)
166
215
            self.assertTrue(after - before <= 1.0)
167
216
        finally:
168
217
            lf1.unlock()
169
 
 
170
 
    def test_32_lock_wait_succeed(self):
171
 
        """Succeed when trying to acquire a lock that gets released
172
 
 
173
 
        One thread holds on a lock and then releases it; another 
174
 
        tries to lock it.
175
 
        """
176
 
        t = self.get_transport()
177
 
        lf1 = LockDir(t, 'test_lock')
178
 
        lf1.create()
179
 
        lf1.attempt_lock()
180
 
 
181
 
        def wait_and_unlock():
182
 
            time.sleep(0.1)
183
 
            lf1.unlock()
184
 
        unlocker = Thread(target=wait_and_unlock)
185
 
        unlocker.start()
186
 
        try:
187
 
            lf2 = LockDir(t, 'test_lock')
188
 
            before = time.time()
189
 
            # wait and then lock
190
 
            lf2.wait_lock(timeout=0.4, poll=0.1)
191
 
            after = time.time()
192
 
            self.assertTrue(after - before <= 1.0)
193
 
        finally:
194
 
            unlocker.join()
195
 
 
196
 
    def test_33_wait(self):
197
 
        """Succeed when waiting on a lock that gets released
198
 
 
199
 
        The difference from test_32_lock_wait_succeed is that the second 
200
 
        caller does not actually acquire the lock, but just waits for it
201
 
        to be released.  This is done over a readonly transport.
202
 
        """
203
 
        t = self.get_transport()
204
 
        lf1 = LockDir(t, 'test_lock')
205
 
        lf1.create()
206
 
        lf1.attempt_lock()
207
 
 
208
 
        def wait_and_unlock():
209
 
            time.sleep(0.1)
210
 
            lf1.unlock()
211
 
        unlocker = Thread(target=wait_and_unlock)
212
 
        unlocker.start()
213
 
        try:
214
 
            lf2 = LockDir(self.get_readonly_transport(), 'test_lock')
215
 
            before = time.time()
216
 
            # wait but don't lock
217
 
            lf2.wait(timeout=0.4, poll=0.1)
218
 
            after = time.time()
219
 
            self.assertTrue(after - before <= 1.0)
220
 
        finally:
221
 
            unlocker.join()
 
218
        self.assertEqual([], self._logged_reports)
222
219
 
223
220
    def test_40_confirm_easy(self):
224
221
        """Confirm a lock that's already held"""
226
223
        lf1 = LockDir(t, 'test_lock')
227
224
        lf1.create()
228
225
        lf1.attempt_lock()
 
226
        self.addCleanup(lf1.unlock)
229
227
        lf1.confirm()
230
228
 
231
229
    def test_41_confirm_not_held(self):
243
241
        lf1.attempt_lock()
244
242
        t.move('test_lock', 'lock_gone_now')
245
243
        self.assertRaises(LockBroken, lf1.confirm)
 
244
        # Clean up
 
245
        t.move('lock_gone_now', 'test_lock')
 
246
        lf1.unlock()
246
247
 
247
248
    def test_43_break(self):
248
249
        """Break a lock whose caller has forgotten it"""
259
260
        lf2.force_break(holder_info)
260
261
        # now we should be able to take it
261
262
        lf2.attempt_lock()
 
263
        self.addCleanup(lf2.unlock)
262
264
        lf2.confirm()
263
265
 
264
266
    def test_44_break_already_released(self):
276
278
        lf2.force_break(holder_info)
277
279
        # now we should be able to take it
278
280
        lf2.attempt_lock()
 
281
        self.addCleanup(lf2.unlock)
279
282
        lf2.confirm()
280
283
 
281
284
    def test_45_break_mismatch(self):
307
310
        """Check the on-disk representation of LockDirs is as expected.
308
311
 
309
312
        There should always be a top-level directory named by the lock.
310
 
        When the lock is held, there should be a lockname/held directory 
 
313
        When the lock is held, there should be a lockname/held directory
311
314
        containing an info file.
312
315
        """
313
316
        t = self.get_transport()
318
321
        self.assertTrue(t.has('test_lock/held/info'))
319
322
        lf1.unlock()
320
323
        self.assertFalse(t.has('test_lock/held/info'))
 
324
 
 
325
    def test_break_lock(self):
 
326
        # the ui based break_lock routine should Just Work (tm)
 
327
        ld1 = self.get_lock()
 
328
        ld2 = self.get_lock()
 
329
        ld1.create()
 
330
        ld1.lock_write()
 
331
        # do this without IO redirection to ensure it doesn't prompt.
 
332
        self.assertRaises(AssertionError, ld1.break_lock)
 
333
        orig_factory = bzrlib.ui.ui_factory
 
334
        bzrlib.ui.ui_factory = bzrlib.ui.CannedInputUIFactory([True])
 
335
        try:
 
336
            ld2.break_lock()
 
337
            self.assertRaises(LockBroken, ld1.unlock)
 
338
        finally:
 
339
            bzrlib.ui.ui_factory = orig_factory
 
340
 
 
341
    def test_break_lock_corrupt_info(self):
 
342
        """break_lock works even if the info file is corrupt (and tells the UI
 
343
        that it is corrupt).
 
344
        """
 
345
        ld = self.get_lock()
 
346
        ld2 = self.get_lock()
 
347
        ld.create()
 
348
        ld.lock_write()
 
349
        ld.transport.put_bytes_non_atomic('test_lock/held/info', '\0')
 
350
 
 
351
        class LoggingUIFactory(bzrlib.ui.SilentUIFactory):
 
352
            def __init__(self):
 
353
                self.prompts = []
 
354
 
 
355
            def get_boolean(self, prompt):
 
356
                self.prompts.append(('boolean', prompt))
 
357
                return True
 
358
 
 
359
        ui = LoggingUIFactory()
 
360
        self.overrideAttr(bzrlib.ui, 'ui_factory', ui)
 
361
        ld2.break_lock()
 
362
        self.assertLength(1, ui.prompts)
 
363
        self.assertEqual('boolean', ui.prompts[0][0])
 
364
        self.assertStartsWith(ui.prompts[0][1], 'Break (corrupt LockDir')
 
365
        self.assertRaises(LockBroken, ld.unlock)
 
366
 
 
367
    def test_break_lock_missing_info(self):
 
368
        """break_lock works even if the info file is missing (and tells the UI
 
369
        that it is corrupt).
 
370
        """
 
371
        ld = self.get_lock()
 
372
        ld2 = self.get_lock()
 
373
        ld.create()
 
374
        ld.lock_write()
 
375
        ld.transport.delete('test_lock/held/info')
 
376
 
 
377
        class LoggingUIFactory(bzrlib.ui.SilentUIFactory):
 
378
            def __init__(self):
 
379
                self.prompts = []
 
380
 
 
381
            def get_boolean(self, prompt):
 
382
                self.prompts.append(('boolean', prompt))
 
383
                return True
 
384
 
 
385
        ui = LoggingUIFactory()
 
386
        orig_factory = bzrlib.ui.ui_factory
 
387
        bzrlib.ui.ui_factory = ui
 
388
        try:
 
389
            ld2.break_lock()
 
390
            self.assertRaises(LockBroken, ld.unlock)
 
391
            self.assertLength(0, ui.prompts)
 
392
        finally:
 
393
            bzrlib.ui.ui_factory = orig_factory
 
394
        # Suppress warnings due to ld not being unlocked
 
395
        # XXX: if lock_broken hook was invoked in this case, this hack would
 
396
        # not be necessary.  - Andrew Bennetts, 2010-09-06.
 
397
        del self._lock_actions[:]
 
398
 
 
399
    def test_create_missing_base_directory(self):
 
400
        """If LockDir.path doesn't exist, it can be created
 
401
 
 
402
        Some people manually remove the entire lock/ directory trying
 
403
        to unlock a stuck repository/branch/etc. Rather than failing
 
404
        after that, just create the lock directory when needed.
 
405
        """
 
406
        t = self.get_transport()
 
407
        lf1 = LockDir(t, 'test_lock')
 
408
 
 
409
        lf1.create()
 
410
        self.assertTrue(t.has('test_lock'))
 
411
 
 
412
        t.rmdir('test_lock')
 
413
        self.assertFalse(t.has('test_lock'))
 
414
 
 
415
        # This will create 'test_lock' if it needs to
 
416
        lf1.lock_write()
 
417
        self.assertTrue(t.has('test_lock'))
 
418
        self.assertTrue(t.has('test_lock/held/info'))
 
419
 
 
420
        lf1.unlock()
 
421
        self.assertFalse(t.has('test_lock/held/info'))
 
422
 
 
423
    def test_display_form(self):
 
424
        ld1 = self.get_lock()
 
425
        ld1.create()
 
426
        ld1.lock_write()
 
427
        try:
 
428
            info_list = ld1.peek().to_readable_dict()
 
429
        finally:
 
430
            ld1.unlock()
 
431
        self.assertEqual(info_list['user'], u'jrandom@example.com')
 
432
        self.assertContainsRe(info_list['pid'], '^\d+$')
 
433
        self.assertContainsRe(info_list['time_ago'], r'^\d+ seconds? ago$')
 
434
 
 
435
    def test_lock_without_email(self):
 
436
        global_config = config.GlobalStack()
 
437
        # Intentionally has no email address
 
438
        global_config.set('email', 'User Identity')
 
439
        ld1 = self.get_lock()
 
440
        ld1.create()
 
441
        ld1.lock_write()
 
442
        ld1.unlock()
 
443
 
 
444
    def test_lock_permission(self):
 
445
        self.requireFeature(features.not_running_as_root)
 
446
        if not osutils.supports_posix_readonly():
 
447
            raise tests.TestSkipped('Cannot induce a permission failure')
 
448
        ld1 = self.get_lock()
 
449
        lock_path = ld1.transport.local_abspath('test_lock')
 
450
        os.mkdir(lock_path)
 
451
        osutils.make_readonly(lock_path)
 
452
        self.assertRaises(errors.LockFailed, ld1.attempt_lock)
 
453
 
 
454
    def test_lock_by_token(self):
 
455
        ld1 = self.get_lock()
 
456
        token = ld1.lock_write()
 
457
        self.addCleanup(ld1.unlock)
 
458
        self.assertNotEqual(None, token)
 
459
        ld2 = self.get_lock()
 
460
        t2 = ld2.lock_write(token)
 
461
        self.addCleanup(ld2.unlock)
 
462
        self.assertEqual(token, t2)
 
463
 
 
464
    def test_lock_with_buggy_rename(self):
 
465
        # test that lock acquisition handles servers which pretend they
 
466
        # renamed correctly but that actually fail
 
467
        t = transport.get_transport_from_url(
 
468
            'brokenrename+' + self.get_url())
 
469
        ld1 = LockDir(t, 'test_lock')
 
470
        ld1.create()
 
471
        ld1.attempt_lock()
 
472
        ld2 = LockDir(t, 'test_lock')
 
473
        # we should fail to lock
 
474
        e = self.assertRaises(errors.LockContention, ld2.attempt_lock)
 
475
        # now the original caller should succeed in unlocking
 
476
        ld1.unlock()
 
477
        # and there should be nothing left over
 
478
        self.assertEquals([], t.list_dir('test_lock'))
 
479
 
 
480
    def test_failed_lock_leaves_no_trash(self):
 
481
        # if we fail to acquire the lock, we don't leave pending directories
 
482
        # behind -- https://bugs.launchpad.net/bzr/+bug/109169
 
483
        ld1 = self.get_lock()
 
484
        ld2 = self.get_lock()
 
485
        # should be nothing before we start
 
486
        ld1.create()
 
487
        t = self.get_transport().clone('test_lock')
 
488
 
 
489
        def check_dir(a):
 
490
            self.assertEquals(a, t.list_dir('.'))
 
491
 
 
492
        check_dir([])
 
493
        # when held, that's all we see
 
494
        ld1.attempt_lock()
 
495
        self.addCleanup(ld1.unlock)
 
496
        check_dir(['held'])
 
497
        # second guy should fail
 
498
        self.assertRaises(errors.LockContention, ld2.attempt_lock)
 
499
        # no kibble
 
500
        check_dir(['held'])
 
501
 
 
502
    def test_no_lockdir_info(self):
 
503
        """We can cope with empty info files."""
 
504
        # This seems like a fairly common failure case - see
 
505
        # <https://bugs.launchpad.net/bzr/+bug/185103> and all its dupes.
 
506
        # Processes are often interrupted after opening the file
 
507
        # before the actual contents are committed.
 
508
        t = self.get_transport()
 
509
        t.mkdir('test_lock')
 
510
        t.mkdir('test_lock/held')
 
511
        t.put_bytes('test_lock/held/info', '')
 
512
        lf = LockDir(t, 'test_lock')
 
513
        info = lf.peek()
 
514
        formatted_info = info.to_readable_dict()
 
515
        self.assertEquals(
 
516
            dict(user='<unknown>', hostname='<unknown>', pid='<unknown>',
 
517
                time_ago='(unknown)'),
 
518
            formatted_info)
 
519
 
 
520
    def test_corrupt_lockdir_info(self):
 
521
        """We can cope with corrupt (and thus unparseable) info files."""
 
522
        # This seems like a fairly common failure case too - see
 
523
        # <https://bugs.launchpad.net/bzr/+bug/619872> for instance.
 
524
        # In particular some systems tend to fill recently created files with
 
525
        # nul bytes after recovering from a system crash.
 
526
        t = self.get_transport()
 
527
        t.mkdir('test_lock')
 
528
        t.mkdir('test_lock/held')
 
529
        t.put_bytes('test_lock/held/info', '\0')
 
530
        lf = LockDir(t, 'test_lock')
 
531
        self.assertRaises(errors.LockCorrupt, lf.peek)
 
532
        # Currently attempt_lock gives LockContention, but LockCorrupt would be
 
533
        # a reasonable result too.
 
534
        self.assertRaises(
 
535
            (errors.LockCorrupt, errors.LockContention), lf.attempt_lock)
 
536
        self.assertRaises(errors.LockCorrupt, lf.validate_token, 'fake token')
 
537
 
 
538
    def test_missing_lockdir_info(self):
 
539
        """We can cope with absent info files."""
 
540
        t = self.get_transport()
 
541
        t.mkdir('test_lock')
 
542
        t.mkdir('test_lock/held')
 
543
        lf = LockDir(t, 'test_lock')
 
544
        # In this case we expect the 'not held' result from peek, because peek
 
545
        # cannot be expected to notice that there is a 'held' directory with no
 
546
        # 'info' file.
 
547
        self.assertEqual(None, lf.peek())
 
548
        # And lock/unlock may work or give LockContention (but not any other
 
549
        # error).
 
550
        try:
 
551
            lf.attempt_lock()
 
552
        except LockContention:
 
553
            # LockContention is ok, and expected on Windows
 
554
            pass
 
555
        else:
 
556
            # no error is ok, and expected on POSIX (because POSIX allows
 
557
            # os.rename over an empty directory).
 
558
            lf.unlock()
 
559
        # Currently raises TokenMismatch, but LockCorrupt would be reasonable
 
560
        # too.
 
561
        self.assertRaises(
 
562
            (errors.TokenMismatch, errors.LockCorrupt),
 
563
            lf.validate_token, 'fake token')
 
564
 
 
565
 
 
566
class TestLockDirHooks(TestCaseWithTransport):
 
567
 
 
568
    def setUp(self):
 
569
        super(TestLockDirHooks, self).setUp()
 
570
        self._calls = []
 
571
 
 
572
    def get_lock(self):
 
573
        return LockDir(self.get_transport(), 'test_lock')
 
574
 
 
575
    def record_hook(self, result):
 
576
        self._calls.append(result)
 
577
 
 
578
    def test_LockDir_acquired_success(self):
 
579
        # the LockDir.lock_acquired hook fires when a lock is acquired.
 
580
        LockDir.hooks.install_named_hook('lock_acquired',
 
581
                                         self.record_hook, 'record_hook')
 
582
        ld = self.get_lock()
 
583
        ld.create()
 
584
        self.assertEqual([], self._calls)
 
585
        result = ld.attempt_lock()
 
586
        lock_path = ld.transport.abspath(ld.path)
 
587
        self.assertEqual([lock.LockResult(lock_path, result)], self._calls)
 
588
        ld.unlock()
 
589
        self.assertEqual([lock.LockResult(lock_path, result)], self._calls)
 
590
 
 
591
    def test_LockDir_acquired_fail(self):
 
592
        # the LockDir.lock_acquired hook does not fire on failure.
 
593
        ld = self.get_lock()
 
594
        ld.create()
 
595
        ld2 = self.get_lock()
 
596
        ld2.attempt_lock()
 
597
        # install a lock hook now, when the disk lock is locked
 
598
        LockDir.hooks.install_named_hook('lock_acquired',
 
599
                                         self.record_hook, 'record_hook')
 
600
        self.assertRaises(errors.LockContention, ld.attempt_lock)
 
601
        self.assertEqual([], self._calls)
 
602
        ld2.unlock()
 
603
        self.assertEqual([], self._calls)
 
604
 
 
605
    def test_LockDir_released_success(self):
 
606
        # the LockDir.lock_released hook fires when a lock is acquired.
 
607
        LockDir.hooks.install_named_hook('lock_released',
 
608
                                         self.record_hook, 'record_hook')
 
609
        ld = self.get_lock()
 
610
        ld.create()
 
611
        self.assertEqual([], self._calls)
 
612
        result = ld.attempt_lock()
 
613
        self.assertEqual([], self._calls)
 
614
        ld.unlock()
 
615
        lock_path = ld.transport.abspath(ld.path)
 
616
        self.assertEqual([lock.LockResult(lock_path, result)], self._calls)
 
617
 
 
618
    def test_LockDir_released_fail(self):
 
619
        # the LockDir.lock_released hook does not fire on failure.
 
620
        ld = self.get_lock()
 
621
        ld.create()
 
622
        ld2 = self.get_lock()
 
623
        ld.attempt_lock()
 
624
        ld2.force_break(ld2.peek())
 
625
        LockDir.hooks.install_named_hook('lock_released',
 
626
                                         self.record_hook, 'record_hook')
 
627
        self.assertRaises(LockBroken, ld.unlock)
 
628
        self.assertEqual([], self._calls)
 
629
 
 
630
    def test_LockDir_broken_success(self):
 
631
        # the LockDir.lock_broken hook fires when a lock is broken.
 
632
        ld = self.get_lock()
 
633
        ld.create()
 
634
        ld2 = self.get_lock()
 
635
        result = ld.attempt_lock()
 
636
        LockDir.hooks.install_named_hook('lock_broken',
 
637
                                         self.record_hook, 'record_hook')
 
638
        ld2.force_break(ld2.peek())
 
639
        lock_path = ld.transport.abspath(ld.path)
 
640
        self.assertEqual([lock.LockResult(lock_path, result)], self._calls)
 
641
 
 
642
    def test_LockDir_broken_failure(self):
 
643
        # the LockDir.lock_broken hook does not fires when a lock is already
 
644
        # released.
 
645
        ld = self.get_lock()
 
646
        ld.create()
 
647
        ld2 = self.get_lock()
 
648
        result = ld.attempt_lock()
 
649
        holder_info = ld2.peek()
 
650
        ld.unlock()
 
651
        LockDir.hooks.install_named_hook('lock_broken',
 
652
                                         self.record_hook, 'record_hook')
 
653
        ld2.force_break(holder_info)
 
654
        lock_path = ld.transport.abspath(ld.path)
 
655
        self.assertEqual([], self._calls)
 
656
 
 
657
 
 
658
class TestLockHeldInfo(TestCaseInTempDir):
 
659
    """Can get information about the lock holder, and detect whether they're
 
660
    still alive."""
 
661
 
 
662
    def test_repr(self):
 
663
        info = LockHeldInfo.for_this_process(None)
 
664
        self.assertContainsRe(repr(info), r"LockHeldInfo\(.*\)")
 
665
 
 
666
    def test_unicode(self):
 
667
        info = LockHeldInfo.for_this_process(None)
 
668
        self.assertContainsRe(unicode(info),
 
669
            r'held by .* on .* \(process #\d+\), acquired .* ago')
 
670
 
 
671
    def test_is_locked_by_this_process(self):
 
672
        info = LockHeldInfo.for_this_process(None)
 
673
        self.assertTrue(info.is_locked_by_this_process())
 
674
 
 
675
    def test_is_not_locked_by_this_process(self):
 
676
        info = LockHeldInfo.for_this_process(None)
 
677
        info.info_dict['pid'] = '123123123123123'
 
678
        self.assertFalse(info.is_locked_by_this_process())
 
679
 
 
680
    def test_lock_holder_live_process(self):
 
681
        """Detect that the holder (this process) is still running."""
 
682
        info = LockHeldInfo.for_this_process(None)
 
683
        self.assertFalse(info.is_lock_holder_known_dead())
 
684
 
 
685
    def test_lock_holder_dead_process(self):
 
686
        """Detect that the holder (this process) is still running."""
 
687
        self.overrideAttr(lockdir, 'get_host_name',
 
688
            lambda: 'aproperhostname')
 
689
        info = LockHeldInfo.for_this_process(None)
 
690
        info.info_dict['pid'] = '123123123'
 
691
        self.assertTrue(info.is_lock_holder_known_dead())
 
692
 
 
693
    def test_lock_holder_other_machine(self):
 
694
        """The lock holder isn't here so we don't know if they're alive."""
 
695
        info = LockHeldInfo.for_this_process(None)
 
696
        info.info_dict['hostname'] = 'egg.example.com'
 
697
        info.info_dict['pid'] = '123123123'
 
698
        self.assertFalse(info.is_lock_holder_known_dead())
 
699
 
 
700
    def test_lock_holder_other_user(self):
 
701
        """Only auto-break locks held by this user."""
 
702
        info = LockHeldInfo.for_this_process(None)
 
703
        info.info_dict['user'] = 'notme@example.com'
 
704
        info.info_dict['pid'] = '123123123'
 
705
        self.assertFalse(info.is_lock_holder_known_dead())
 
706
 
 
707
    def test_no_good_hostname(self):
 
708
        """Correctly handle ambiguous hostnames.
 
709
 
 
710
        If the lock's recorded with just 'localhost' we can't really trust
 
711
        it's the same 'localhost'.  (There are quite a few of them. :-)
 
712
        So even if the process is known not to be alive, we can't say that's
 
713
        known for sure.
 
714
        """
 
715
        self.overrideAttr(lockdir, 'get_host_name',
 
716
            lambda: 'localhost')
 
717
        info = LockHeldInfo.for_this_process(None)
 
718
        info.info_dict['pid'] = '123123123'
 
719
        self.assertFalse(info.is_lock_holder_known_dead())
 
720
 
 
721
 
 
722
class TestStaleLockDir(TestCaseWithTransport):
 
723
    """Can automatically break stale locks.
 
724
 
 
725
    :see: https://bugs.launchpad.net/bzr/+bug/220464
 
726
    """
 
727
 
 
728
    def test_auto_break_stale_lock(self):
 
729
        """Locks safely known to be stale are just cleaned up.
 
730
 
 
731
        This generates a warning but no other user interaction.
 
732
        """
 
733
        self.overrideAttr(lockdir, 'get_host_name',
 
734
            lambda: 'aproperhostname')
 
735
        # This is off by default at present; see the discussion in the bug.
 
736
        # If you change the default, don't forget to update the docs.
 
737
        config.GlobalConfig().set_user_option('locks.steal_dead', True)
 
738
        # Create a lock pretending to come from a different nonexistent
 
739
        # process on the same machine.
 
740
        l1 = LockDir(self.get_transport(), 'a',
 
741
            extra_holder_info={'pid': '12312313'})
 
742
        token_1 = l1.attempt_lock()
 
743
        l2 = LockDir(self.get_transport(), 'a')
 
744
        token_2 = l2.attempt_lock()
 
745
        # l1 will notice its lock was stolen.
 
746
        self.assertRaises(errors.LockBroken,
 
747
            l1.unlock)
 
748
        l2.unlock()
 
749
 
 
750
    def test_auto_break_stale_lock_configured_off(self):
 
751
        """Automatic breaking can be turned off"""
 
752
        l1 = LockDir(self.get_transport(), 'a',
 
753
            extra_holder_info={'pid': '12312313'})
 
754
        token_1 = l1.attempt_lock()
 
755
        self.addCleanup(l1.unlock)
 
756
        l2 = LockDir(self.get_transport(), 'a')
 
757
        # This fails now, because dead lock breaking is off by default.
 
758
        self.assertRaises(LockContention,
 
759
            l2.attempt_lock)
 
760
        # and it's in fact not broken
 
761
        l1.confirm()