← 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: Robert Collins
  • Date: 2007-07-04 01:39:50 UTC
  • mto: This revision was merged to the branch mainline in revision 2581.
  • Revision ID: robertc@robertcollins.net-20070704013950-7pp23plwyqjvgkxg
Review feedback.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/tests/test_lockable_files.py
1
 
# Copyright (C) 2005-2011 Canonical Ltd
 
1
# Copyright (C) 2005, 2006 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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
16
 
 
17
from StringIO import StringIO
16
18
 
17
19
import bzrlib
18
 
from bzrlib import (
19
 
    errors,
20
 
    lockdir,
21
 
    osutils,
22
 
    transport,
23
 
    )
 
20
import bzrlib.errors as errors
 
21
from bzrlib.errors import BzrBadParameterNotString, NoSuchFile, ReadOnlyError
24
22
from bzrlib.lockable_files import LockableFiles, TransportLock
25
 
from bzrlib.tests import (
26
 
    TestCaseInTempDir,
27
 
    TestNotApplicable,
28
 
    )
 
23
from bzrlib import lockdir
 
24
from bzrlib.lockdir import LockDir
 
25
from bzrlib.tests import TestCaseInTempDir
29
26
from bzrlib.tests.test_smart import TestCaseWithSmartMedium
30
27
from bzrlib.tests.test_transactions import DummyWeave
31
28
from bzrlib.transactions import (PassThroughTransaction,
32
29
                                 ReadOnlyTransaction,
33
30
                                 WriteTransaction,
34
31
                                 )
 
32
from bzrlib.transport import get_transport
35
33
 
36
34
 
37
35
# these tests are applied in each parameterized suite for LockableFiles
38
 
#
39
 
# they use an old style of parameterization, but we want to remove this class
40
 
# so won't modernize them now. - mbp 20080430
41
36
class _TestLockableFiles_mixin(object):
42
37
 
 
38
    def test_read_write(self):
 
39
        self.assertRaises(NoSuchFile, self.lockable.get, 'foo')
 
40
        self.assertRaises(NoSuchFile, self.lockable.get_utf8, 'foo')
 
41
        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()
 
69
 
 
70
    def test_locks(self):
 
71
        self.lockable.lock_read()
 
72
        try:
 
73
            self.assertRaises(ReadOnlyError, self.lockable.put, 'foo', 
 
74
                              StringIO('bar\u1234'))
 
75
        finally:
 
76
            self.lockable.unlock()
 
77
 
43
78
    def test_transactions(self):
44
79
        self.assertIs(self.lockable.get_transaction().__class__,
45
80
                      PassThroughTransaction)
62
97
 
63
98
    def test__escape(self):
64
99
        self.assertEqual('%25', self.lockable._escape('%'))
65
 
 
 
100
        
66
101
    def test__escape_empty(self):
67
102
        self.assertEqual('', self.lockable._escape(''))
68
103
 
74
109
        except NotImplementedError:
75
110
            # this lock cannot be broken
76
111
            self.lockable.unlock()
77
 
            raise TestNotApplicable("%r is not breakable" % (self.lockable,))
 
112
            return
78
113
        l2 = self.get_lockable()
79
114
        orig_factory = bzrlib.ui.ui_factory
80
115
        # silent ui - no need for stdout
81
 
        bzrlib.ui.ui_factory = bzrlib.ui.CannedInputUIFactory([True])
 
116
        bzrlib.ui.ui_factory = bzrlib.ui.SilentUIFactory()
 
117
        bzrlib.ui.ui_factory.stdin = StringIO("y\n")
82
118
        try:
83
119
            l2.break_lock()
84
120
        finally:
92
128
 
93
129
    def test_lock_write_returns_None_refuses_token(self):
94
130
        token = self.lockable.lock_write()
95
 
        self.addCleanup(self.lockable.unlock)
96
 
        if token is not None:
97
 
            # This test does not apply, because this lockable supports
98
 
            # tokens.
99
 
            raise TestNotApplicable("%r uses tokens" % (self.lockable,))
100
 
        self.assertRaises(errors.TokenLockingNotSupported,
101
 
                          self.lockable.lock_write, token='token')
 
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()
102
140
 
103
141
    def test_lock_write_returns_token_when_given_token(self):
104
142
        token = self.lockable.lock_write()
105
 
        self.addCleanup(self.lockable.unlock)
106
 
        if token is None:
107
 
            # This test does not apply, because this lockable refuses
108
 
            # tokens.
109
 
            return
110
 
        new_lockable = self.get_lockable()
111
 
        token_from_new_lockable = new_lockable.lock_write(token=token)
112
 
        self.addCleanup(new_lockable.unlock)
113
 
        self.assertEqual(token, token_from_new_lockable)
 
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()
114
156
 
115
157
    def test_lock_write_raises_on_token_mismatch(self):
116
158
        token = self.lockable.lock_write()
117
 
        self.addCleanup(self.lockable.unlock)
118
 
        if token is None:
119
 
            # This test does not apply, because this lockable refuses
120
 
            # tokens.
121
 
            return
122
 
        different_token = token + 'xxx'
123
 
        # Re-using the same lockable instance with a different token will
124
 
        # raise TokenMismatch.
125
 
        self.assertRaises(errors.TokenMismatch,
126
 
                          self.lockable.lock_write, token=different_token)
127
 
        # A separate instance for the same lockable will also raise
128
 
        # TokenMismatch.
129
 
        # This detects the case where a caller claims to have a lock (via
130
 
        # the token) for an external resource, but doesn't (the token is
131
 
        # different).  Clients need a separate lock object to make sure the
132
 
        # external resource is probed, whereas the existing lock object
133
 
        # might cache.
134
 
        new_lockable = self.get_lockable()
135
 
        self.assertRaises(errors.TokenMismatch,
136
 
                          new_lockable.lock_write, token=different_token)
 
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()
137
181
 
138
182
    def test_lock_write_with_matching_token(self):
139
183
        # If the token matches, so no exception is raised by lock_write.
140
184
        token = self.lockable.lock_write()
141
 
        self.addCleanup(self.lockable.unlock)
142
 
        if token is None:
143
 
            # This test does not apply, because this lockable refuses
144
 
            # tokens.
145
 
            return
146
 
        # The same instance will accept a second lock_write if the specified
147
 
        # token matches.
148
 
        self.lockable.lock_write(token=token)
149
 
        self.lockable.unlock()
150
 
        # Calling lock_write on a new instance for the same lockable will
151
 
        # also succeed.
152
 
        new_lockable = self.get_lockable()
153
 
        new_lockable.lock_write(token=token)
154
 
        new_lockable.unlock()
 
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()
155
201
 
156
202
    def test_unlock_after_lock_write_with_token(self):
157
203
        # If lock_write did not physically acquire the lock (because it was
158
204
        # passed a token), then unlock should not physically release it.
159
205
        token = self.lockable.lock_write()
160
 
        self.addCleanup(self.lockable.unlock)
161
 
        if token is None:
162
 
            # This test does not apply, because this lockable refuses
163
 
            # tokens.
164
 
            return
165
 
        new_lockable = self.get_lockable()
166
 
        new_lockable.lock_write(token=token)
167
 
        new_lockable.unlock()
168
 
        self.assertTrue(self.lockable.get_physical_lock_status())
 
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()
169
217
 
170
218
    def test_lock_write_with_token_fails_when_unlocked(self):
171
219
        # Lock and unlock to get a superficially valid token.  This mimics a
236
284
        # But should be relockable with a token.
237
285
        self.lockable.lock_write(token=token)
238
286
        self.lockable.unlock()
239
 
        # Cleanup: we should still be able to get the lock, but we restore the
240
 
        # behavior to clearing the lock when unlocking.
241
 
        self.lockable.lock_write(token=token)
242
 
        self.lockable.dont_leave_in_place()
243
 
        self.lockable.unlock()
244
287
 
245
288
    def test_dont_leave_in_place(self):
246
289
        token = self.lockable.lock_write()
265
308
        third_lockable.unlock()
266
309
 
267
310
 
268
 
# This method of adapting tests to parameters is different to
269
 
# the TestProviderAdapters used elsewhere, but seems simpler for this
270
 
# case.
 
311
# This method of adapting tests to parameters is different to 
 
312
# the TestProviderAdapters used elsewhere, but seems simpler for this 
 
313
# case.  
271
314
class TestLockableFiles_TransportLock(TestCaseInTempDir,
272
315
                                      _TestLockableFiles_mixin):
273
316
 
274
317
    def setUp(self):
275
318
        TestCaseInTempDir.setUp(self)
276
 
        t = transport.get_transport_from_path('.')
277
 
        t.mkdir('.bzr')
278
 
        self.sub_transport = t.clone('.bzr')
 
319
        transport = get_transport('.')
 
320
        transport.mkdir('.bzr')
 
321
        self.sub_transport = transport.clone('.bzr')
279
322
        self.lockable = self.get_lockable()
280
323
        self.lockable.create_lock()
281
324
 
282
 
    def stop_server(self):
283
 
        super(TestLockableFiles_TransportLock, self).stop_server()
 
325
    def tearDown(self):
 
326
        super(TestLockableFiles_TransportLock, self).tearDown()
284
327
        # free the subtransport so that we do not get a 5 second
285
328
        # timeout due to the SFTP connection cache.
286
 
        try:
287
 
            del self.sub_transport
288
 
        except AttributeError:
289
 
            pass
 
329
        del self.sub_transport
290
330
 
291
331
    def get_lockable(self):
292
332
        return LockableFiles(self.sub_transport, 'my-lock', TransportLock)
293
 
 
 
333
        
294
334
 
295
335
class TestLockableFiles_LockDir(TestCaseInTempDir,
296
336
                              _TestLockableFiles_mixin):
298
338
 
299
339
    def setUp(self):
300
340
        TestCaseInTempDir.setUp(self)
301
 
        self.transport = transport.get_transport_from_path('.')
 
341
        self.transport = get_transport('.')
302
342
        self.lockable = self.get_lockable()
303
 
        # the lock creation here sets mode - test_permissions on branch
304
 
        # tests that implicitly, but it might be a good idea to factor
 
343
        # the lock creation here sets mode - test_permissions on branch 
 
344
        # tests that implicitly, but it might be a good idea to factor 
305
345
        # out the mode checking logic and have it applied to loackable files
306
346
        # directly. RBC 20060418
307
347
        self.lockable.create_lock()
308
348
 
309
349
    def get_lockable(self):
310
 
        return LockableFiles(self.transport, 'my-lock', lockdir.LockDir)
 
350
        return LockableFiles(self.transport, 'my-lock', LockDir)
311
351
 
312
352
    def test_lock_created(self):
313
353
        self.assertTrue(self.transport.has('my-lock'))
317
357
        self.assertFalse(self.transport.has('my-lock/held/info'))
318
358
        self.assertTrue(self.transport.has('my-lock'))
319
359
 
320
 
    def test__file_modes(self):
321
 
        self.transport.mkdir('readonly')
322
 
        osutils.make_readonly('readonly')
323
 
        lockable = LockableFiles(self.transport.clone('readonly'), 'test-lock',
324
 
                                 lockdir.LockDir)
325
 
        # The directory mode should be read-write-execute for the current user
326
 
        self.assertEqual(00700, lockable._dir_mode & 00700)
327
 
        # Files should be read-write for the current user
328
 
        self.assertEqual(00600, lockable._file_mode & 00700)
329
360
 
 
361
    # TODO: Test the lockdir inherits the right file and directory permissions
 
362
    # from the LockableFiles.
 
363
        
330
364
 
331
365
class TestLockableFiles_RemoteLockDir(TestCaseWithSmartMedium,
332
366
                              _TestLockableFiles_mixin):
341
375
        # in test_remote and test_smart as usual.
342
376
        b = self.make_branch('foo')
343
377
        self.addCleanup(b.bzrdir.transport.disconnect)
344
 
        self.transport = transport.get_transport_from_path('.')
 
378
        self.transport = get_transport('.')
345
379
        self.lockable = self.get_lockable()
346
380
 
347
381
    def get_lockable(self):