← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/tests/test_lockable_files.py

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2008-05-29 15:57:16 UTC
  • mfrom: (3427.5.9 dep_warnings)
  • Revision ID: pqm@pqm.ubuntu.com-20080529155716-0w3kic8lioa63231
(jam) Enable Deprecation Warnings when running -Werror and when
        running selftest

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/tests/test_lockable_files.py
1
 
# Copyright (C) 2005, 2006 by Canonical Ltd
2
 
 
 
1
# Copyright (C) 2005, 2006, 2008 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
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16
16
 
17
17
from StringIO import StringIO
18
18
 
19
 
from bzrlib.branch import Branch
 
19
import bzrlib
 
20
from bzrlib import (
 
21
    errors,
 
22
    lockdir,
 
23
    osutils,
 
24
    )
20
25
from bzrlib.errors import BzrBadParameterNotString, NoSuchFile, ReadOnlyError
21
26
from bzrlib.lockable_files import LockableFiles, TransportLock
22
 
from bzrlib.lockdir import LockDir
 
27
from bzrlib.symbol_versioning import (
 
28
    deprecated_in,
 
29
    )
23
30
from bzrlib.tests import TestCaseInTempDir
 
31
from bzrlib.tests.test_smart import TestCaseWithSmartMedium
24
32
from bzrlib.tests.test_transactions import DummyWeave
25
33
from bzrlib.transactions import (PassThroughTransaction,
26
34
                                 ReadOnlyTransaction,
30
38
 
31
39
 
32
40
# these tests are applied in each parameterized suite for LockableFiles
 
41
#
 
42
# they use an old style of parameterization, but we want to remove this class
 
43
# so won't modernize them now. - mbp 20080430
33
44
class _TestLockableFiles_mixin(object):
34
45
 
35
46
    def test_read_write(self):
36
 
        self.assertRaises(NoSuchFile, self.lockable.get, 'foo')
37
 
        self.assertRaises(NoSuchFile, self.lockable.get_utf8, 'foo')
 
47
        self.assertRaises(NoSuchFile,
 
48
            self.applyDeprecated,
 
49
            deprecated_in((1, 5, 0)),
 
50
            self.lockable.get, 'foo')
 
51
        self.assertRaises(NoSuchFile,
 
52
            self.applyDeprecated,
 
53
            deprecated_in((1, 5, 0)),
 
54
            self.lockable.get_utf8, 'foo')
38
55
        self.lockable.lock_write()
39
56
        try:
40
57
            unicode_string = u'bar\u1234'
41
58
            self.assertEqual(4, len(unicode_string))
42
59
            byte_string = unicode_string.encode('utf-8')
43
60
            self.assertEqual(6, len(byte_string))
44
 
            self.assertRaises(UnicodeEncodeError, self.lockable.put, 'foo', 
45
 
                              StringIO(unicode_string))
46
 
            self.lockable.put('foo', StringIO(byte_string))
47
 
            self.assertEqual(byte_string,
48
 
                             self.lockable.get('foo').read())
 
61
            self.assertRaises(UnicodeEncodeError,
 
62
                self.applyDeprecated,
 
63
                deprecated_in((1, 6, 0)),
 
64
                self.lockable.put, 'foo',
 
65
                StringIO(unicode_string))
 
66
            self.applyDeprecated(
 
67
                deprecated_in((1, 6, 0)),
 
68
                self.lockable.put,
 
69
                'foo', StringIO(byte_string))
 
70
            byte_stream = self.applyDeprecated(
 
71
                deprecated_in((1, 5, 0)),
 
72
                self.lockable.get,
 
73
                'foo')
 
74
            self.assertEqual(byte_string, byte_stream.read())
 
75
            unicode_stream = self.applyDeprecated(
 
76
                deprecated_in((1, 5, 0)),
 
77
                self.lockable.get_utf8,
 
78
                'foo')
49
79
            self.assertEqual(unicode_string,
50
 
                             self.lockable.get_utf8('foo').read())
 
80
                unicode_stream.read())
51
81
            self.assertRaises(BzrBadParameterNotString,
52
 
                              self.lockable.put_utf8,
53
 
                              'bar',
54
 
                              StringIO(unicode_string)
55
 
                              )
56
 
            self.lockable.put_utf8('bar', unicode_string)
57
 
            self.assertEqual(unicode_string, 
58
 
                             self.lockable.get_utf8('bar').read())
59
 
            self.assertEqual(byte_string, 
60
 
                             self.lockable.get('bar').read())
 
82
                self.applyDeprecated,
 
83
                deprecated_in((1, 6, 0)),
 
84
                self.lockable.put_utf8,
 
85
                'bar',
 
86
                StringIO(unicode_string))
 
87
            self.applyDeprecated(
 
88
                deprecated_in((1, 6, 0)),
 
89
                self.lockable.put_utf8,
 
90
                'bar',
 
91
                unicode_string)
 
92
            unicode_stream = self.applyDeprecated(
 
93
                deprecated_in((1, 5, 0)),
 
94
                self.lockable.get_utf8,
 
95
                'bar')
 
96
            self.assertEqual(unicode_string,
 
97
                unicode_stream.read())
 
98
            byte_stream = self.applyDeprecated(
 
99
                deprecated_in((1, 5, 0)),
 
100
                self.lockable.get,
 
101
                'bar')
 
102
            self.assertEqual(byte_string, byte_stream.read())
 
103
            self.applyDeprecated(
 
104
                deprecated_in((1, 6, 0)),
 
105
                self.lockable.put_bytes,
 
106
                'raw', 'raw\xffbytes')
 
107
            byte_stream = self.applyDeprecated(
 
108
                deprecated_in((1, 5, 0)),
 
109
                self.lockable.get,
 
110
                'raw')
 
111
            self.assertEqual('raw\xffbytes', byte_stream.read())
61
112
        finally:
62
113
            self.lockable.unlock()
63
114
 
64
115
    def test_locks(self):
65
116
        self.lockable.lock_read()
66
117
        try:
67
 
            self.assertRaises(ReadOnlyError, self.lockable.put, 'foo', 
 
118
            self.assertRaises(ReadOnlyError, self.lockable.put, 'foo',
68
119
                              StringIO('bar\u1234'))
69
120
        finally:
70
121
            self.lockable.unlock()
95
146
    def test__escape_empty(self):
96
147
        self.assertEqual('', self.lockable._escape(''))
97
148
 
 
149
    def test_break_lock(self):
 
150
        # some locks are not breakable
 
151
        self.lockable.lock_write()
 
152
        try:
 
153
            self.assertRaises(AssertionError, self.lockable.break_lock)
 
154
        except NotImplementedError:
 
155
            # this lock cannot be broken
 
156
            self.lockable.unlock()
 
157
            return
 
158
        l2 = self.get_lockable()
 
159
        orig_factory = bzrlib.ui.ui_factory
 
160
        # silent ui - no need for stdout
 
161
        bzrlib.ui.ui_factory = bzrlib.ui.SilentUIFactory()
 
162
        bzrlib.ui.ui_factory.stdin = StringIO("y\n")
 
163
        try:
 
164
            l2.break_lock()
 
165
        finally:
 
166
            bzrlib.ui.ui_factory = orig_factory
 
167
        try:
 
168
            l2.lock_write()
 
169
            l2.unlock()
 
170
        finally:
 
171
            self.assertRaises(errors.LockBroken, self.lockable.unlock)
 
172
            self.assertFalse(self.lockable.is_locked())
 
173
 
 
174
    def test_lock_write_returns_None_refuses_token(self):
 
175
        token = self.lockable.lock_write()
 
176
        try:
 
177
            if token is not None:
 
178
                # This test does not apply, because this lockable supports
 
179
                # tokens.
 
180
                return
 
181
            self.assertRaises(errors.TokenLockingNotSupported,
 
182
                              self.lockable.lock_write, token='token')
 
183
        finally:
 
184
            self.lockable.unlock()
 
185
 
 
186
    def test_lock_write_returns_token_when_given_token(self):
 
187
        token = self.lockable.lock_write()
 
188
        try:
 
189
            if token is None:
 
190
                # This test does not apply, because this lockable refuses
 
191
                # tokens.
 
192
                return
 
193
            new_lockable = self.get_lockable()
 
194
            token_from_new_lockable = new_lockable.lock_write(token=token)
 
195
            try:
 
196
                self.assertEqual(token, token_from_new_lockable)
 
197
            finally:
 
198
                new_lockable.unlock()
 
199
        finally:
 
200
            self.lockable.unlock()
 
201
 
 
202
    def test_lock_write_raises_on_token_mismatch(self):
 
203
        token = self.lockable.lock_write()
 
204
        try:
 
205
            if token is None:
 
206
                # This test does not apply, because this lockable refuses
 
207
                # tokens.
 
208
                return
 
209
            different_token = token + 'xxx'
 
210
            # Re-using the same lockable instance with a different token will
 
211
            # raise TokenMismatch.
 
212
            self.assertRaises(errors.TokenMismatch,
 
213
                              self.lockable.lock_write, token=different_token)
 
214
            # A seperate instance for the same lockable will also raise
 
215
            # TokenMismatch.
 
216
            # This detects the case where a caller claims to have a lock (via
 
217
            # the token) for an external resource, but doesn't (the token is
 
218
            # different).  Clients need a seperate lock object to make sure the
 
219
            # external resource is probed, whereas the existing lock object
 
220
            # might cache.
 
221
            new_lockable = self.get_lockable()
 
222
            self.assertRaises(errors.TokenMismatch,
 
223
                              new_lockable.lock_write, token=different_token)
 
224
        finally:
 
225
            self.lockable.unlock()
 
226
 
 
227
    def test_lock_write_with_matching_token(self):
 
228
        # If the token matches, so no exception is raised by lock_write.
 
229
        token = self.lockable.lock_write()
 
230
        try:
 
231
            if token is None:
 
232
                # This test does not apply, because this lockable refuses
 
233
                # tokens.
 
234
                return
 
235
            # The same instance will accept a second lock_write if the specified
 
236
            # token matches.
 
237
            self.lockable.lock_write(token=token)
 
238
            self.lockable.unlock()
 
239
            # Calling lock_write on a new instance for the same lockable will
 
240
            # also succeed.
 
241
            new_lockable = self.get_lockable()
 
242
            new_lockable.lock_write(token=token)
 
243
            new_lockable.unlock()
 
244
        finally:
 
245
            self.lockable.unlock()
 
246
 
 
247
    def test_unlock_after_lock_write_with_token(self):
 
248
        # If lock_write did not physically acquire the lock (because it was
 
249
        # passed a token), then unlock should not physically release it.
 
250
        token = self.lockable.lock_write()
 
251
        try:
 
252
            if token is None:
 
253
                # This test does not apply, because this lockable refuses
 
254
                # tokens.
 
255
                return
 
256
            new_lockable = self.get_lockable()
 
257
            new_lockable.lock_write(token=token)
 
258
            new_lockable.unlock()
 
259
            self.assertTrue(self.lockable.get_physical_lock_status())
 
260
        finally:
 
261
            self.lockable.unlock()
 
262
 
 
263
    def test_lock_write_with_token_fails_when_unlocked(self):
 
264
        # Lock and unlock to get a superficially valid token.  This mimics a
 
265
        # likely programming error, where a caller accidentally tries to lock
 
266
        # with a token that is no longer valid (because the original lock was
 
267
        # released).
 
268
        token = self.lockable.lock_write()
 
269
        self.lockable.unlock()
 
270
        if token is None:
 
271
            # This test does not apply, because this lockable refuses
 
272
            # tokens.
 
273
            return
 
274
 
 
275
        self.assertRaises(errors.TokenMismatch,
 
276
                          self.lockable.lock_write, token=token)
 
277
 
 
278
    def test_lock_write_reenter_with_token(self):
 
279
        token = self.lockable.lock_write()
 
280
        try:
 
281
            if token is None:
 
282
                # This test does not apply, because this lockable refuses
 
283
                # tokens.
 
284
                return
 
285
            # Relock with a token.
 
286
            token_from_reentry = self.lockable.lock_write(token=token)
 
287
            try:
 
288
                self.assertEqual(token, token_from_reentry)
 
289
            finally:
 
290
                self.lockable.unlock()
 
291
        finally:
 
292
            self.lockable.unlock()
 
293
        # The lock should be unlocked on disk.  Verify that with a new lock
 
294
        # instance.
 
295
        new_lockable = self.get_lockable()
 
296
        # Calling lock_write now should work, rather than raise LockContention.
 
297
        new_lockable.lock_write()
 
298
        new_lockable.unlock()
 
299
 
 
300
    def test_second_lock_write_returns_same_token(self):
 
301
        first_token = self.lockable.lock_write()
 
302
        try:
 
303
            if first_token is None:
 
304
                # This test does not apply, because this lockable refuses
 
305
                # tokens.
 
306
                return
 
307
            # Relock the already locked lockable.  It should return the same
 
308
            # token.
 
309
            second_token = self.lockable.lock_write()
 
310
            try:
 
311
                self.assertEqual(first_token, second_token)
 
312
            finally:
 
313
                self.lockable.unlock()
 
314
        finally:
 
315
            self.lockable.unlock()
 
316
 
 
317
    def test_leave_in_place(self):
 
318
        token = self.lockable.lock_write()
 
319
        try:
 
320
            if token is None:
 
321
                # This test does not apply, because this lockable refuses
 
322
                # tokens.
 
323
                return
 
324
            self.lockable.leave_in_place()
 
325
        finally:
 
326
            self.lockable.unlock()
 
327
        # At this point, the lock is still in place on disk
 
328
        self.assertRaises(errors.LockContention, self.lockable.lock_write)
 
329
        # But should be relockable with a token.
 
330
        self.lockable.lock_write(token=token)
 
331
        self.lockable.unlock()
 
332
 
 
333
    def test_dont_leave_in_place(self):
 
334
        token = self.lockable.lock_write()
 
335
        try:
 
336
            if token is None:
 
337
                # This test does not apply, because this lockable refuses
 
338
                # tokens.
 
339
                return
 
340
            self.lockable.leave_in_place()
 
341
        finally:
 
342
            self.lockable.unlock()
 
343
        # At this point, the lock is still in place on disk.
 
344
        # Acquire the existing lock with the token, and ask that it is removed
 
345
        # when this object unlocks, and unlock to trigger that removal.
 
346
        new_lockable = self.get_lockable()
 
347
        new_lockable.lock_write(token=token)
 
348
        new_lockable.dont_leave_in_place()
 
349
        new_lockable.unlock()
 
350
        # At this point, the lock is no longer on disk, so we can lock it.
 
351
        third_lockable = self.get_lockable()
 
352
        third_lockable.lock_write()
 
353
        third_lockable.unlock()
 
354
 
98
355
 
99
356
# This method of adapting tests to parameters is different to 
100
357
# the TestProviderAdapters used elsewhere, but seems simpler for this 
103
360
                                      _TestLockableFiles_mixin):
104
361
 
105
362
    def setUp(self):
106
 
        super(TestLockableFiles_TransportLock, self).setUp()
 
363
        TestCaseInTempDir.setUp(self)
107
364
        transport = get_transport('.')
108
365
        transport.mkdir('.bzr')
109
 
        sub_transport = transport.clone('.bzr')
110
 
        self.lockable = LockableFiles(sub_transport, 'my-lock', TransportLock)
 
366
        self.sub_transport = transport.clone('.bzr')
 
367
        self.lockable = self.get_lockable()
111
368
        self.lockable.create_lock()
 
369
 
 
370
    def tearDown(self):
 
371
        super(TestLockableFiles_TransportLock, self).tearDown()
 
372
        # free the subtransport so that we do not get a 5 second
 
373
        # timeout due to the SFTP connection cache.
 
374
        del self.sub_transport
 
375
 
 
376
    def get_lockable(self):
 
377
        return LockableFiles(self.sub_transport, 'my-lock', TransportLock)
112
378
        
113
379
 
114
380
class TestLockableFiles_LockDir(TestCaseInTempDir,
116
382
    """LockableFile tests run with LockDir underneath"""
117
383
 
118
384
    def setUp(self):
119
 
        super(TestLockableFiles_LockDir, self).setUp()
 
385
        TestCaseInTempDir.setUp(self)
120
386
        self.transport = get_transport('.')
121
 
        self.lockable = LockableFiles(self.transport, 'my-lock', LockDir)
 
387
        self.lockable = self.get_lockable()
 
388
        # the lock creation here sets mode - test_permissions on branch 
 
389
        # tests that implicitly, but it might be a good idea to factor 
 
390
        # out the mode checking logic and have it applied to loackable files
 
391
        # directly. RBC 20060418
122
392
        self.lockable.create_lock()
123
393
 
124
 
    def test_lock_is_lockdir(self):
125
 
        """Created instance should use a LockDir.
126
 
        
127
 
        This primarily tests the mixin adapter works properly.
128
 
        """
129
 
        ## self.assertIsInstance(self.lockable, LockableFiles)
130
 
        ## self.assertIsInstance(self.lockable._lock_strategy,
131
 
                              ## LockDirStrategy)
 
394
    def get_lockable(self):
 
395
        return LockableFiles(self.transport, 'my-lock', lockdir.LockDir)
132
396
 
133
397
    def test_lock_created(self):
134
398
        self.assertTrue(self.transport.has('my-lock'))
138
402
        self.assertFalse(self.transport.has('my-lock/held/info'))
139
403
        self.assertTrue(self.transport.has('my-lock'))
140
404
 
141
 
 
142
 
    # TODO: Test the lockdir inherits the right file and directory permissions
143
 
    # from the LockableFiles.
 
405
    def test__file_modes(self):
 
406
        self.transport.mkdir('readonly')
 
407
        osutils.make_readonly('readonly')
 
408
        lockable = LockableFiles(self.transport.clone('readonly'), 'test-lock',
 
409
                                 lockdir.LockDir)
 
410
        # The directory mode should be read-write-execute for the current user
 
411
        self.assertEqual(00700, lockable._dir_mode & 00700)
 
412
        # Files should be read-write for the current user
 
413
        self.assertEqual(00600, lockable._file_mode & 00700)
 
414
 
 
415
 
 
416
class TestLockableFiles_RemoteLockDir(TestCaseWithSmartMedium,
 
417
                              _TestLockableFiles_mixin):
 
418
    """LockableFile tests run with RemoteLockDir on a branch."""
 
419
 
 
420
    def setUp(self):
 
421
        TestCaseWithSmartMedium.setUp(self)
 
422
        # can only get a RemoteLockDir with some RemoteObject...
 
423
        # use a branch as thats what we want. These mixin tests test the end
 
424
        # to end behaviour, so stubbing out the backend and simulating would
 
425
        # defeat the purpose. We test the protocol implementation separately
 
426
        # in test_remote and test_smart as usual.
 
427
        b = self.make_branch('foo')
 
428
        self.addCleanup(b.bzrdir.transport.disconnect)
 
429
        self.transport = get_transport('.')
 
430
        self.lockable = self.get_lockable()
 
431
 
 
432
    def get_lockable(self):
 
433
        # getting a new lockable involves opening a new instance of the branch
 
434
        branch = bzrlib.branch.Branch.open(self.get_url('foo'))
 
435
        self.addCleanup(branch.bzrdir.transport.disconnect)
 
436
        return branch.control_files