← 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: Jelmer Vernooij
  • Date: 2009-07-18 21:09:00 UTC
  • mfrom: (4416.8.1 bzr.dev)
  • mto: This revision was merged to the branch mainline in revision 4547.
  • Revision ID: jelmer@samba.org-20090718210900-oht5snx25j1jyeha
Merge create_prefix fix necessary for bzr-svn.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/tests/test_lockable_files.py
1
 
# Copyright (C) 2005, 2006 Canonical Ltd
 
1
# Copyright (C) 2005, 2006, 2008 Canonical Ltd
2
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
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
from StringIO import StringIO
18
18
 
19
19
import bzrlib
20
 
import bzrlib.errors as errors
 
20
from bzrlib import (
 
21
    errors,
 
22
    lockdir,
 
23
    osutils,
 
24
    )
21
25
from bzrlib.errors import BzrBadParameterNotString, NoSuchFile, ReadOnlyError
22
26
from bzrlib.lockable_files import LockableFiles, TransportLock
23
 
from bzrlib import lockdir
24
 
from bzrlib.lockdir import LockDir
25
 
from bzrlib.tests import TestCaseInTempDir
 
27
from bzrlib.symbol_versioning import (
 
28
    deprecated_in,
 
29
    )
 
30
from bzrlib.tests import (
 
31
    TestCaseInTempDir,
 
32
    TestNotApplicable,
 
33
    )
26
34
from bzrlib.tests.test_smart import TestCaseWithSmartMedium
27
35
from bzrlib.tests.test_transactions import DummyWeave
28
36
from bzrlib.transactions import (PassThroughTransaction,
33
41
 
34
42
 
35
43
# these tests are applied in each parameterized suite for LockableFiles
 
44
#
 
45
# they use an old style of parameterization, but we want to remove this class
 
46
# so won't modernize them now. - mbp 20080430
36
47
class _TestLockableFiles_mixin(object):
37
48
 
38
49
    def test_read_write(self):
39
 
        self.assertRaises(NoSuchFile, self.lockable.get, 'foo')
40
 
        self.assertRaises(NoSuchFile, self.lockable.get_utf8, 'foo')
 
50
        self.assertRaises(NoSuchFile,
 
51
            self.applyDeprecated,
 
52
            deprecated_in((1, 5, 0)),
 
53
            self.lockable.get, 'foo')
 
54
        self.assertRaises(NoSuchFile,
 
55
            self.applyDeprecated,
 
56
            deprecated_in((1, 5, 0)),
 
57
            self.lockable.get_utf8, 'foo')
41
58
        self.lockable.lock_write()
42
 
        try:
43
 
            unicode_string = u'bar\u1234'
44
 
            self.assertEqual(4, len(unicode_string))
45
 
            byte_string = unicode_string.encode('utf-8')
46
 
            self.assertEqual(6, len(byte_string))
47
 
            self.assertRaises(UnicodeEncodeError, self.lockable.put, 'foo',
48
 
                              StringIO(unicode_string))
49
 
            self.lockable.put('foo', StringIO(byte_string))
50
 
            self.assertEqual(byte_string,
51
 
                             self.lockable.get('foo').read())
52
 
            self.assertEqual(unicode_string,
53
 
                             self.lockable.get_utf8('foo').read())
54
 
            self.assertRaises(BzrBadParameterNotString,
55
 
                              self.lockable.put_utf8,
56
 
                              'bar',
57
 
                              StringIO(unicode_string)
58
 
                              )
59
 
            self.lockable.put_utf8('bar', unicode_string)
60
 
            self.assertEqual(unicode_string,
61
 
                             self.lockable.get_utf8('bar').read())
62
 
            self.assertEqual(byte_string,
63
 
                             self.lockable.get('bar').read())
64
 
            self.lockable.put_bytes('raw', 'raw\xffbytes')
65
 
            self.assertEqual('raw\xffbytes',
66
 
                             self.lockable.get('raw').read())
67
 
        finally:
68
 
            self.lockable.unlock()
 
59
        self.addCleanup(self.lockable.unlock)
 
60
        unicode_string = u'bar\u1234'
 
61
        self.assertEqual(4, len(unicode_string))
 
62
        byte_string = unicode_string.encode('utf-8')
 
63
        self.assertEqual(6, len(byte_string))
 
64
        self.assertRaises(UnicodeEncodeError,
 
65
            self.applyDeprecated,
 
66
            deprecated_in((1, 6, 0)),
 
67
            self.lockable.put, 'foo',
 
68
            StringIO(unicode_string))
 
69
        self.applyDeprecated(
 
70
            deprecated_in((1, 6, 0)),
 
71
            self.lockable.put,
 
72
            'foo', StringIO(byte_string))
 
73
        byte_stream = self.applyDeprecated(
 
74
            deprecated_in((1, 5, 0)),
 
75
            self.lockable.get,
 
76
            'foo')
 
77
        self.assertEqual(byte_string, byte_stream.read())
 
78
        unicode_stream = self.applyDeprecated(
 
79
            deprecated_in((1, 5, 0)),
 
80
            self.lockable.get_utf8,
 
81
            'foo')
 
82
        self.assertEqual(unicode_string,
 
83
            unicode_stream.read())
 
84
        self.assertRaises(BzrBadParameterNotString,
 
85
            self.applyDeprecated,
 
86
            deprecated_in((1, 6, 0)),
 
87
            self.lockable.put_utf8,
 
88
            'bar',
 
89
            StringIO(unicode_string))
 
90
        self.applyDeprecated(
 
91
            deprecated_in((1, 6, 0)),
 
92
            self.lockable.put_utf8,
 
93
            'bar',
 
94
            unicode_string)
 
95
        unicode_stream = self.applyDeprecated(
 
96
            deprecated_in((1, 5, 0)),
 
97
            self.lockable.get_utf8,
 
98
            'bar')
 
99
        self.assertEqual(unicode_string,
 
100
            unicode_stream.read())
 
101
        byte_stream = self.applyDeprecated(
 
102
            deprecated_in((1, 5, 0)),
 
103
            self.lockable.get,
 
104
            'bar')
 
105
        self.assertEqual(byte_string, byte_stream.read())
 
106
        self.applyDeprecated(
 
107
            deprecated_in((1, 6, 0)),
 
108
            self.lockable.put_bytes,
 
109
            'raw', 'raw\xffbytes')
 
110
        byte_stream = self.applyDeprecated(
 
111
            deprecated_in((1, 5, 0)),
 
112
            self.lockable.get,
 
113
            'raw')
 
114
        self.assertEqual('raw\xffbytes', byte_stream.read())
69
115
 
70
116
    def test_locks(self):
71
117
        self.lockable.lock_read()
72
 
        try:
73
 
            self.assertRaises(ReadOnlyError, self.lockable.put, 'foo', 
74
 
                              StringIO('bar\u1234'))
75
 
        finally:
76
 
            self.lockable.unlock()
 
118
        self.addCleanup(self.lockable.unlock)
 
119
        self.assertRaises(ReadOnlyError, self.lockable.put, 'foo',
 
120
                          StringIO('bar\u1234'))
77
121
 
78
122
    def test_transactions(self):
79
123
        self.assertIs(self.lockable.get_transaction().__class__,
97
141
 
98
142
    def test__escape(self):
99
143
        self.assertEqual('%25', self.lockable._escape('%'))
100
 
        
 
144
 
101
145
    def test__escape_empty(self):
102
146
        self.assertEqual('', self.lockable._escape(''))
103
147
 
109
153
        except NotImplementedError:
110
154
            # this lock cannot be broken
111
155
            self.lockable.unlock()
112
 
            return
 
156
            raise TestNotApplicable("%r is not breakable" % (self.lockable,))
113
157
        l2 = self.get_lockable()
114
158
        orig_factory = bzrlib.ui.ui_factory
115
159
        # silent ui - no need for stdout
128
172
 
129
173
    def test_lock_write_returns_None_refuses_token(self):
130
174
        token = self.lockable.lock_write()
131
 
        try:
132
 
            if token is not None:
133
 
                # This test does not apply, because this lockable supports
134
 
                # tokens.
135
 
                return
136
 
            self.assertRaises(errors.TokenLockingNotSupported,
137
 
                              self.lockable.lock_write, token='token')
138
 
        finally:
139
 
            self.lockable.unlock()
 
175
        self.addCleanup(self.lockable.unlock)
 
176
        if token is not None:
 
177
            # This test does not apply, because this lockable supports
 
178
            # tokens.
 
179
            raise TestNotApplicable("%r uses tokens" % (self.lockable,))
 
180
        self.assertRaises(errors.TokenLockingNotSupported,
 
181
                          self.lockable.lock_write, token='token')
140
182
 
141
183
    def test_lock_write_returns_token_when_given_token(self):
142
184
        token = self.lockable.lock_write()
143
 
        try:
144
 
            if token is None:
145
 
                # This test does not apply, because this lockable refuses
146
 
                # tokens.
147
 
                return
148
 
            new_lockable = self.get_lockable()
149
 
            token_from_new_lockable = new_lockable.lock_write(token=token)
150
 
            try:
151
 
                self.assertEqual(token, token_from_new_lockable)
152
 
            finally:
153
 
                new_lockable.unlock()
154
 
        finally:
155
 
            self.lockable.unlock()
 
185
        self.addCleanup(self.lockable.unlock)
 
186
        if token is None:
 
187
            # This test does not apply, because this lockable refuses
 
188
            # tokens.
 
189
            return
 
190
        new_lockable = self.get_lockable()
 
191
        token_from_new_lockable = new_lockable.lock_write(token=token)
 
192
        self.addCleanup(new_lockable.unlock)
 
193
        self.assertEqual(token, token_from_new_lockable)
156
194
 
157
195
    def test_lock_write_raises_on_token_mismatch(self):
158
196
        token = self.lockable.lock_write()
159
 
        try:
160
 
            if token is None:
161
 
                # This test does not apply, because this lockable refuses
162
 
                # tokens.
163
 
                return
164
 
            different_token = token + 'xxx'
165
 
            # Re-using the same lockable instance with a different token will
166
 
            # raise TokenMismatch.
167
 
            self.assertRaises(errors.TokenMismatch,
168
 
                              self.lockable.lock_write, token=different_token)
169
 
            # A seperate instance for the same lockable will also raise
170
 
            # TokenMismatch.
171
 
            # This detects the case where a caller claims to have a lock (via
172
 
            # the token) for an external resource, but doesn't (the token is
173
 
            # different).  Clients need a seperate lock object to make sure the
174
 
            # external resource is probed, whereas the existing lock object
175
 
            # might cache.
176
 
            new_lockable = self.get_lockable()
177
 
            self.assertRaises(errors.TokenMismatch,
178
 
                              new_lockable.lock_write, token=different_token)
179
 
        finally:
180
 
            self.lockable.unlock()
 
197
        self.addCleanup(self.lockable.unlock)
 
198
        if token is None:
 
199
            # This test does not apply, because this lockable refuses
 
200
            # tokens.
 
201
            return
 
202
        different_token = token + 'xxx'
 
203
        # Re-using the same lockable instance with a different token will
 
204
        # raise TokenMismatch.
 
205
        self.assertRaises(errors.TokenMismatch,
 
206
                          self.lockable.lock_write, token=different_token)
 
207
        # A separate instance for the same lockable will also raise
 
208
        # TokenMismatch.
 
209
        # This detects the case where a caller claims to have a lock (via
 
210
        # the token) for an external resource, but doesn't (the token is
 
211
        # different).  Clients need a separate lock object to make sure the
 
212
        # external resource is probed, whereas the existing lock object
 
213
        # might cache.
 
214
        new_lockable = self.get_lockable()
 
215
        self.assertRaises(errors.TokenMismatch,
 
216
                          new_lockable.lock_write, token=different_token)
181
217
 
182
218
    def test_lock_write_with_matching_token(self):
183
219
        # If the token matches, so no exception is raised by lock_write.
184
220
        token = self.lockable.lock_write()
185
 
        try:
186
 
            if token is None:
187
 
                # This test does not apply, because this lockable refuses
188
 
                # tokens.
189
 
                return
190
 
            # The same instance will accept a second lock_write if the specified
191
 
            # token matches.
192
 
            self.lockable.lock_write(token=token)
193
 
            self.lockable.unlock()
194
 
            # Calling lock_write on a new instance for the same lockable will
195
 
            # also succeed.
196
 
            new_lockable = self.get_lockable()
197
 
            new_lockable.lock_write(token=token)
198
 
            new_lockable.unlock()
199
 
        finally:
200
 
            self.lockable.unlock()
 
221
        self.addCleanup(self.lockable.unlock)
 
222
        if token is None:
 
223
            # This test does not apply, because this lockable refuses
 
224
            # tokens.
 
225
            return
 
226
        # The same instance will accept a second lock_write if the specified
 
227
        # token matches.
 
228
        self.lockable.lock_write(token=token)
 
229
        self.lockable.unlock()
 
230
        # Calling lock_write on a new instance for the same lockable will
 
231
        # also succeed.
 
232
        new_lockable = self.get_lockable()
 
233
        new_lockable.lock_write(token=token)
 
234
        new_lockable.unlock()
201
235
 
202
236
    def test_unlock_after_lock_write_with_token(self):
203
237
        # If lock_write did not physically acquire the lock (because it was
204
238
        # passed a token), then unlock should not physically release it.
205
239
        token = self.lockable.lock_write()
206
 
        try:
207
 
            if token is None:
208
 
                # This test does not apply, because this lockable refuses
209
 
                # tokens.
210
 
                return
211
 
            new_lockable = self.get_lockable()
212
 
            new_lockable.lock_write(token=token)
213
 
            new_lockable.unlock()
214
 
            self.assertTrue(self.lockable.get_physical_lock_status())
215
 
        finally:
216
 
            self.lockable.unlock()
 
240
        self.addCleanup(self.lockable.unlock)
 
241
        if token is None:
 
242
            # This test does not apply, because this lockable refuses
 
243
            # tokens.
 
244
            return
 
245
        new_lockable = self.get_lockable()
 
246
        new_lockable.lock_write(token=token)
 
247
        new_lockable.unlock()
 
248
        self.assertTrue(self.lockable.get_physical_lock_status())
217
249
 
218
250
    def test_lock_write_with_token_fails_when_unlocked(self):
219
251
        # Lock and unlock to get a superficially valid token.  This mimics a
284
316
        # But should be relockable with a token.
285
317
        self.lockable.lock_write(token=token)
286
318
        self.lockable.unlock()
 
319
        # Cleanup: we should still be able to get the lock, but we restore the
 
320
        # behavior to clearing the lock when unlocking.
 
321
        self.lockable.lock_write(token=token)
 
322
        self.lockable.dont_leave_in_place()
 
323
        self.lockable.unlock()
287
324
 
288
325
    def test_dont_leave_in_place(self):
289
326
        token = self.lockable.lock_write()
308
345
        third_lockable.unlock()
309
346
 
310
347
 
311
 
# This method of adapting tests to parameters is different to 
312
 
# the TestProviderAdapters used elsewhere, but seems simpler for this 
313
 
# case.  
 
348
# This method of adapting tests to parameters is different to
 
349
# the TestProviderAdapters used elsewhere, but seems simpler for this
 
350
# case.
314
351
class TestLockableFiles_TransportLock(TestCaseInTempDir,
315
352
                                      _TestLockableFiles_mixin):
316
353
 
326
363
        super(TestLockableFiles_TransportLock, self).tearDown()
327
364
        # free the subtransport so that we do not get a 5 second
328
365
        # timeout due to the SFTP connection cache.
329
 
        del self.sub_transport
 
366
        try:
 
367
            del self.sub_transport
 
368
        except AttributeError:
 
369
            pass
330
370
 
331
371
    def get_lockable(self):
332
372
        return LockableFiles(self.sub_transport, 'my-lock', TransportLock)
333
 
        
 
373
 
334
374
 
335
375
class TestLockableFiles_LockDir(TestCaseInTempDir,
336
376
                              _TestLockableFiles_mixin):
340
380
        TestCaseInTempDir.setUp(self)
341
381
        self.transport = get_transport('.')
342
382
        self.lockable = self.get_lockable()
343
 
        # the lock creation here sets mode - test_permissions on branch 
344
 
        # tests that implicitly, but it might be a good idea to factor 
 
383
        # the lock creation here sets mode - test_permissions on branch
 
384
        # tests that implicitly, but it might be a good idea to factor
345
385
        # out the mode checking logic and have it applied to loackable files
346
386
        # directly. RBC 20060418
347
387
        self.lockable.create_lock()
348
388
 
349
389
    def get_lockable(self):
350
 
        return LockableFiles(self.transport, 'my-lock', LockDir)
 
390
        return LockableFiles(self.transport, 'my-lock', lockdir.LockDir)
351
391
 
352
392
    def test_lock_created(self):
353
393
        self.assertTrue(self.transport.has('my-lock'))
357
397
        self.assertFalse(self.transport.has('my-lock/held/info'))
358
398
        self.assertTrue(self.transport.has('my-lock'))
359
399
 
 
400
    def test__file_modes(self):
 
401
        self.transport.mkdir('readonly')
 
402
        osutils.make_readonly('readonly')
 
403
        lockable = LockableFiles(self.transport.clone('readonly'), 'test-lock',
 
404
                                 lockdir.LockDir)
 
405
        # The directory mode should be read-write-execute for the current user
 
406
        self.assertEqual(00700, lockable._dir_mode & 00700)
 
407
        # Files should be read-write for the current user
 
408
        self.assertEqual(00600, lockable._file_mode & 00700)
360
409
 
361
 
    # TODO: Test the lockdir inherits the right file and directory permissions
362
 
    # from the LockableFiles.
363
 
        
364
410
 
365
411
class TestLockableFiles_RemoteLockDir(TestCaseWithSmartMedium,
366
412
                              _TestLockableFiles_mixin):