← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/tests/test_lockdir.py

  • Committer: Vincent Ladeuil
  • Date: 2010-10-26 08:08:23 UTC
  • mfrom: (5514.1.1 665100-content-type)
  • mto: This revision was merged to the branch mainline in revision 5516.
  • Revision ID: v.ladeuil+lp@free.fr-20101026080823-3wggo03b7cpn9908
Correctly set the Content-Type header when POSTing http requests

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-2010 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
19
from cStringIO import StringIO
20
 
from threading import Thread
 
20
import os
 
21
from threading import Thread, Lock
21
22
import time
22
23
 
23
24
import bzrlib
 
25
from bzrlib import (
 
26
    config,
 
27
    errors,
 
28
    lock,
 
29
    osutils,
 
30
    tests,
 
31
    transport,
 
32
    )
24
33
from bzrlib.errors import (
25
 
        LockBreakMismatch,
26
 
        LockContention, LockError, UnlockableTransport,
27
 
        LockNotHeld, LockBroken
28
 
        )
 
34
    LockBreakMismatch,
 
35
    LockBroken,
 
36
    LockContention,
 
37
    LockError,
 
38
    LockFailed,
 
39
    LockNotHeld,
 
40
    )
29
41
from bzrlib.lockdir import LockDir
30
 
from bzrlib.tests import TestCaseWithTransport
 
42
from bzrlib.tests import (features, TestCaseWithTransport)
 
43
from bzrlib.trace import note
31
44
 
32
45
# These tests sometimes use threads to test the behaviour of lock files with
33
46
# concurrent actors.  This is not a typical (or necessarily supported) use;
42
55
class TestLockDir(TestCaseWithTransport):
43
56
    """Test LockDir operations"""
44
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
 
45
65
    def test_00_lock_creation(self):
46
66
        """Creation of lock file on a transport"""
47
67
        t = self.get_transport()
89
109
        """Fail to create lock on readonly transport"""
90
110
        t = self.get_readonly_transport()
91
111
        lf = LockDir(t, 'test_lock')
92
 
        self.assertRaises(UnlockableTransport, lf.create)
 
112
        self.assertRaises(LockFailed, lf.create)
93
113
 
94
114
    def test_12_lock_readonly_transport(self):
95
115
        """Fail to lock on readonly transport"""
96
116
        lf = LockDir(self.get_transport(), 'test_lock')
97
117
        lf.create()
98
118
        lf = LockDir(self.get_readonly_transport(), 'test_lock')
99
 
        self.assertRaises(UnlockableTransport, lf.attempt_lock)
 
119
        self.assertRaises(LockFailed, lf.attempt_lock)
100
120
 
101
121
    def test_20_lock_contested(self):
102
122
        """Contention to get a lock"""
106
126
        lf1.attempt_lock()
107
127
        lf2 = LockDir(t, 'test_lock')
108
128
        try:
109
 
            # locking is between LockDir instances; aliases within 
 
129
            # locking is between LockDir instances; aliases within
110
130
            # a single process are not detected
111
131
            lf2.attempt_lock()
112
132
            self.fail('Failed to detect lock collision')
122
142
        lf1 = LockDir(t, 'test_lock')
123
143
        lf1.create()
124
144
        lf1.attempt_lock()
 
145
        self.addCleanup(lf1.unlock)
125
146
        # lock is held, should get some info on it
126
147
        info1 = lf1.peek()
127
148
        self.assertEqual(set(info1.keys()),
141
162
        lf2 = LockDir(self.get_readonly_transport(), 'test_lock')
142
163
        self.assertEqual(lf2.peek(), None)
143
164
        lf1.attempt_lock()
 
165
        self.addCleanup(lf1.unlock)
144
166
        info2 = lf2.peek()
145
167
        self.assertTrue(info2)
146
168
        self.assertEqual(info2['nonce'], lf1.nonce)
147
169
 
148
170
    def test_30_lock_wait_fail(self):
149
171
        """Wait on a lock, then fail
150
 
        
 
172
 
151
173
        We ask to wait up to 400ms; this should fail within at most one
152
174
        second.  (Longer times are more realistic but we don't want the test
153
175
        suite to take too long, and this should do for now.)
156
178
        lf1 = LockDir(t, 'test_lock')
157
179
        lf1.create()
158
180
        lf2 = LockDir(t, 'test_lock')
 
181
        self.setup_log_reporter(lf2)
159
182
        lf1.attempt_lock()
160
183
        try:
161
184
            before = time.time()
164
187
            after = time.time()
165
188
            # it should only take about 0.4 seconds, but we allow more time in
166
189
            # case the machine is heavily loaded
167
 
            self.assertTrue(after - before <= 8.0, 
 
190
            self.assertTrue(after - before <= 8.0,
168
191
                    "took %f seconds to detect lock contention" % (after - before))
169
192
        finally:
170
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}')
171
209
 
172
210
    def test_31_lock_wait_easy(self):
173
211
        """Succeed when waiting on a lock with no contention.
175
213
        t = self.get_transport()
176
214
        lf1 = LockDir(t, 'test_lock')
177
215
        lf1.create()
 
216
        self.setup_log_reporter(lf1)
178
217
        try:
179
218
            before = time.time()
180
219
            lf1.wait_lock(timeout=0.4, poll=0.1)
182
221
            self.assertTrue(after - before <= 1.0)
183
222
        finally:
184
223
            lf1.unlock()
 
224
        self.assertEqual([], self._logged_reports)
185
225
 
186
226
    def test_32_lock_wait_succeed(self):
187
227
        """Succeed when trying to acquire a lock that gets released
188
228
 
189
 
        One thread holds on a lock and then releases it; another 
 
229
        One thread holds on a lock and then releases it; another
190
230
        tries to lock it.
191
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")
192
242
        t = self.get_transport()
193
243
        lf1 = LockDir(t, 'test_lock')
194
244
        lf1.create()
201
251
        unlocker.start()
202
252
        try:
203
253
            lf2 = LockDir(t, 'test_lock')
 
254
            self.setup_log_reporter(lf2)
204
255
            before = time.time()
205
256
            # wait and then lock
206
257
            lf2.wait_lock(timeout=0.4, poll=0.1)
209
260
        finally:
210
261
            unlocker.join()
211
262
 
212
 
    def test_33_wait(self):
213
 
        """Succeed when waiting on a lock that gets released
 
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')
214
278
 
215
 
        The difference from test_32_lock_wait_succeed is that the second 
216
 
        caller does not actually acquire the lock, but just waits for it
217
 
        to be released.  This is done over a readonly transport.
218
 
        """
 
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
219
285
        t = self.get_transport()
220
286
        lf1 = LockDir(t, 'test_lock')
221
287
        lf1.create()
227
293
        unlocker = Thread(target=wait_and_unlock)
228
294
        unlocker.start()
229
295
        try:
230
 
            lf2 = LockDir(self.get_readonly_transport(), 'test_lock')
 
296
            lf2 = LockDir(t, 'test_lock')
 
297
            self.setup_log_reporter(lf2)
231
298
            before = time.time()
232
 
            # wait but don't lock
233
 
            lf2.wait(timeout=0.4, poll=0.1)
 
299
            # wait and then lock
 
300
            lf2.lock_write()
234
301
            after = time.time()
235
 
            self.assertTrue(after - before <= 1.0)
236
 
        finally:
237
 
            unlocker.join()
 
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')
238
445
 
239
446
    def test_40_confirm_easy(self):
240
447
        """Confirm a lock that's already held"""
242
449
        lf1 = LockDir(t, 'test_lock')
243
450
        lf1.create()
244
451
        lf1.attempt_lock()
 
452
        self.addCleanup(lf1.unlock)
245
453
        lf1.confirm()
246
454
 
247
455
    def test_41_confirm_not_held(self):
259
467
        lf1.attempt_lock()
260
468
        t.move('test_lock', 'lock_gone_now')
261
469
        self.assertRaises(LockBroken, lf1.confirm)
 
470
        # Clean up
 
471
        t.move('lock_gone_now', 'test_lock')
 
472
        lf1.unlock()
262
473
 
263
474
    def test_43_break(self):
264
475
        """Break a lock whose caller has forgotten it"""
275
486
        lf2.force_break(holder_info)
276
487
        # now we should be able to take it
277
488
        lf2.attempt_lock()
 
489
        self.addCleanup(lf2.unlock)
278
490
        lf2.confirm()
279
491
 
280
492
    def test_44_break_already_released(self):
292
504
        lf2.force_break(holder_info)
293
505
        # now we should be able to take it
294
506
        lf2.attempt_lock()
 
507
        self.addCleanup(lf2.unlock)
295
508
        lf2.confirm()
296
509
 
297
510
    def test_45_break_mismatch(self):
323
536
        """Check the on-disk representation of LockDirs is as expected.
324
537
 
325
538
        There should always be a top-level directory named by the lock.
326
 
        When the lock is held, there should be a lockname/held directory 
 
539
        When the lock is held, there should be a lockname/held directory
327
540
        containing an info file.
328
541
        """
329
542
        t = self.get_transport()
344
557
        # do this without IO redirection to ensure it doesn't prompt.
345
558
        self.assertRaises(AssertionError, ld1.break_lock)
346
559
        orig_factory = bzrlib.ui.ui_factory
347
 
        # silent ui - no need for stdout
348
 
        bzrlib.ui.ui_factory = bzrlib.ui.SilentUIFactory()
349
 
        bzrlib.ui.ui_factory.stdin = StringIO("y\n")
 
560
        bzrlib.ui.ui_factory = bzrlib.ui.CannedInputUIFactory([True])
350
561
        try:
351
562
            ld2.break_lock()
352
563
            self.assertRaises(LockBroken, ld1.unlock)
353
564
        finally:
354
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
        self.requireFeature(features.not_running_as_root)
 
671
        if not osutils.supports_posix_readonly():
 
672
            raise tests.TestSkipped('Cannot induce a permission failure')
 
673
        ld1 = self.get_lock()
 
674
        lock_path = ld1.transport.local_abspath('test_lock')
 
675
        os.mkdir(lock_path)
 
676
        osutils.make_readonly(lock_path)
 
677
        self.assertRaises(errors.LockFailed, ld1.attempt_lock)
 
678
 
 
679
    def test_lock_by_token(self):
 
680
        ld1 = self.get_lock()
 
681
        token = ld1.lock_write()
 
682
        self.addCleanup(ld1.unlock)
 
683
        self.assertNotEqual(None, token)
 
684
        ld2 = self.get_lock()
 
685
        t2 = ld2.lock_write(token)
 
686
        self.addCleanup(ld2.unlock)
 
687
        self.assertEqual(token, t2)
 
688
 
 
689
    def test_lock_with_buggy_rename(self):
 
690
        # test that lock acquisition handles servers which pretend they
 
691
        # renamed correctly but that actually fail
 
692
        t = transport.get_transport('brokenrename+' + self.get_url())
 
693
        ld1 = LockDir(t, 'test_lock')
 
694
        ld1.create()
 
695
        ld1.attempt_lock()
 
696
        ld2 = LockDir(t, 'test_lock')
 
697
        # we should fail to lock
 
698
        e = self.assertRaises(errors.LockContention, ld2.attempt_lock)
 
699
        # now the original caller should succeed in unlocking
 
700
        ld1.unlock()
 
701
        # and there should be nothing left over
 
702
        self.assertEquals([], t.list_dir('test_lock'))
 
703
 
 
704
    def test_failed_lock_leaves_no_trash(self):
 
705
        # if we fail to acquire the lock, we don't leave pending directories
 
706
        # behind -- https://bugs.launchpad.net/bzr/+bug/109169
 
707
        ld1 = self.get_lock()
 
708
        ld2 = self.get_lock()
 
709
        # should be nothing before we start
 
710
        ld1.create()
 
711
        t = self.get_transport().clone('test_lock')
 
712
        def check_dir(a):
 
713
            self.assertEquals(a, t.list_dir('.'))
 
714
        check_dir([])
 
715
        # when held, that's all we see
 
716
        ld1.attempt_lock()
 
717
        self.addCleanup(ld1.unlock)
 
718
        check_dir(['held'])
 
719
        # second guy should fail
 
720
        self.assertRaises(errors.LockContention, ld2.attempt_lock)
 
721
        # no kibble
 
722
        check_dir(['held'])
 
723
 
 
724
    def test_no_lockdir_info(self):
 
725
        """We can cope with empty info files."""
 
726
        # This seems like a fairly common failure case - see
 
727
        # <https://bugs.launchpad.net/bzr/+bug/185103> and all its dupes.
 
728
        # Processes are often interrupted after opening the file
 
729
        # before the actual contents are committed.
 
730
        t = self.get_transport()
 
731
        t.mkdir('test_lock')
 
732
        t.mkdir('test_lock/held')
 
733
        t.put_bytes('test_lock/held/info', '')
 
734
        lf = LockDir(t, 'test_lock')
 
735
        info = lf.peek()
 
736
        formatted_info = lf._format_lock_info(info)
 
737
        self.assertEquals(
 
738
            ['<unknown>', '<unknown>', '<unknown>', '(unknown)'],
 
739
            formatted_info)
 
740
 
 
741
    def test_corrupt_lockdir_info(self):
 
742
        """We can cope with corrupt (and thus unparseable) info files."""
 
743
        # This seems like a fairly common failure case too - see
 
744
        # <https://bugs.edge.launchpad.net/bzr/+bug/619872> for instance.
 
745
        # In particular some systems tend to fill recently created files with
 
746
        # nul bytes after recovering from a system crash.
 
747
        t = self.get_transport()
 
748
        t.mkdir('test_lock')
 
749
        t.mkdir('test_lock/held')
 
750
        t.put_bytes('test_lock/held/info', '\0')
 
751
        lf = LockDir(t, 'test_lock')
 
752
        self.assertRaises(errors.LockCorrupt, lf.peek)
 
753
        # Currently attempt_lock gives LockContention, but LockCorrupt would be
 
754
        # a reasonable result too.
 
755
        self.assertRaises(
 
756
            (errors.LockCorrupt, errors.LockContention), lf.attempt_lock)
 
757
        self.assertRaises(errors.LockCorrupt, lf.validate_token, 'fake token')
 
758
 
 
759
    def test_missing_lockdir_info(self):
 
760
        """We can cope with absent info files."""
 
761
        t = self.get_transport()
 
762
        t.mkdir('test_lock')
 
763
        t.mkdir('test_lock/held')
 
764
        lf = LockDir(t, 'test_lock')
 
765
        # In this case we expect the 'not held' result from peek, because peek
 
766
        # cannot be expected to notice that there is a 'held' directory with no
 
767
        # 'info' file.
 
768
        self.assertEqual(None, lf.peek())
 
769
        # And lock/unlock may work or give LockContention (but not any other
 
770
        # error).
 
771
        try:
 
772
            lf.attempt_lock()
 
773
        except LockContention:
 
774
            # LockContention is ok, and expected on Windows
 
775
            pass
 
776
        else:
 
777
            # no error is ok, and expected on POSIX (because POSIX allows
 
778
            # os.rename over an empty directory).
 
779
            lf.unlock()
 
780
        # Currently raises TokenMismatch, but LockCorrupt would be reasonable
 
781
        # too.
 
782
        self.assertRaises(
 
783
            (errors.TokenMismatch, errors.LockCorrupt),
 
784
            lf.validate_token, 'fake token')
 
785
 
 
786
 
 
787
class TestLockDirHooks(TestCaseWithTransport):
 
788
 
 
789
    def setUp(self):
 
790
        super(TestLockDirHooks, self).setUp()
 
791
        self._calls = []
 
792
 
 
793
    def get_lock(self):
 
794
        return LockDir(self.get_transport(), 'test_lock')
 
795
 
 
796
    def record_hook(self, result):
 
797
        self._calls.append(result)
 
798
 
 
799
    def test_LockDir_acquired_success(self):
 
800
        # the LockDir.lock_acquired hook fires when a lock is acquired.
 
801
        LockDir.hooks.install_named_hook('lock_acquired',
 
802
                                         self.record_hook, 'record_hook')
 
803
        ld = self.get_lock()
 
804
        ld.create()
 
805
        self.assertEqual([], self._calls)
 
806
        result = ld.attempt_lock()
 
807
        lock_path = ld.transport.abspath(ld.path)
 
808
        self.assertEqual([lock.LockResult(lock_path, result)], self._calls)
 
809
        ld.unlock()
 
810
        self.assertEqual([lock.LockResult(lock_path, result)], self._calls)
 
811
 
 
812
    def test_LockDir_acquired_fail(self):
 
813
        # the LockDir.lock_acquired hook does not fire on failure.
 
814
        ld = self.get_lock()
 
815
        ld.create()
 
816
        ld2 = self.get_lock()
 
817
        ld2.attempt_lock()
 
818
        # install a lock hook now, when the disk lock is locked
 
819
        LockDir.hooks.install_named_hook('lock_acquired',
 
820
                                         self.record_hook, 'record_hook')
 
821
        self.assertRaises(errors.LockContention, ld.attempt_lock)
 
822
        self.assertEqual([], self._calls)
 
823
        ld2.unlock()
 
824
        self.assertEqual([], self._calls)
 
825
 
 
826
    def test_LockDir_released_success(self):
 
827
        # the LockDir.lock_released hook fires when a lock is acquired.
 
828
        LockDir.hooks.install_named_hook('lock_released',
 
829
                                         self.record_hook, 'record_hook')
 
830
        ld = self.get_lock()
 
831
        ld.create()
 
832
        self.assertEqual([], self._calls)
 
833
        result = ld.attempt_lock()
 
834
        self.assertEqual([], self._calls)
 
835
        ld.unlock()
 
836
        lock_path = ld.transport.abspath(ld.path)
 
837
        self.assertEqual([lock.LockResult(lock_path, result)], self._calls)
 
838
 
 
839
    def test_LockDir_released_fail(self):
 
840
        # the LockDir.lock_released hook does not fire on failure.
 
841
        ld = self.get_lock()
 
842
        ld.create()
 
843
        ld2 = self.get_lock()
 
844
        ld.attempt_lock()
 
845
        ld2.force_break(ld2.peek())
 
846
        LockDir.hooks.install_named_hook('lock_released',
 
847
                                         self.record_hook, 'record_hook')
 
848
        self.assertRaises(LockBroken, ld.unlock)
 
849
        self.assertEqual([], self._calls)
 
850
 
 
851
    def test_LockDir_broken_success(self):
 
852
        # the LockDir.lock_broken hook fires when a lock is broken.
 
853
        ld = self.get_lock()
 
854
        ld.create()
 
855
        ld2 = self.get_lock()
 
856
        result = ld.attempt_lock()
 
857
        LockDir.hooks.install_named_hook('lock_broken',
 
858
                                         self.record_hook, 'record_hook')
 
859
        ld2.force_break(ld2.peek())
 
860
        lock_path = ld.transport.abspath(ld.path)
 
861
        self.assertEqual([lock.LockResult(lock_path, result)], self._calls)
 
862
 
 
863
    def test_LockDir_broken_failure(self):
 
864
        # the LockDir.lock_broken hook does not fires when a lock is already
 
865
        # released.
 
866
        ld = self.get_lock()
 
867
        ld.create()
 
868
        ld2 = self.get_lock()
 
869
        result = ld.attempt_lock()
 
870
        holder_info = ld2.peek()
 
871
        ld.unlock()
 
872
        LockDir.hooks.install_named_hook('lock_broken',
 
873
                                         self.record_hook, 'record_hook')
 
874
        ld2.force_break(holder_info)
 
875
        lock_path = ld.transport.abspath(ld.path)
 
876
        self.assertEqual([], self._calls)