← 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: Patch Queue Manager
  • Date: 2012-09-17 11:14:25 UTC
  • mfrom: (6554.1.1 stack-remove-unknown)
  • Revision ID: pqm@pqm.ubuntu.com-20120917111425-4i6r0ze0v9zm33bu
(vila) Fix obscure and misleading warning when trying to delete an unknown
 config option. (Vincent Ladeuil)

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-2011 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
16
 
 
17
 
from StringIO import StringIO
 
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
18
16
 
19
17
import bzrlib
20
 
import bzrlib.errors as errors
21
 
from bzrlib.errors import BzrBadParameterNotString, NoSuchFile, ReadOnlyError
 
18
from bzrlib import (
 
19
    errors,
 
20
    lockdir,
 
21
    osutils,
 
22
    transport,
 
23
    )
22
24
from bzrlib.lockable_files import LockableFiles, TransportLock
23
 
from bzrlib import lockdir
24
 
from bzrlib.lockdir import LockDir
25
 
from bzrlib.tests import TestCaseInTempDir
 
25
from bzrlib.tests import (
 
26
    TestCaseInTempDir,
 
27
    TestNotApplicable,
 
28
    )
26
29
from bzrlib.tests.test_smart import TestCaseWithSmartMedium
27
30
from bzrlib.tests.test_transactions import DummyWeave
28
31
from bzrlib.transactions import (PassThroughTransaction,
29
32
                                 ReadOnlyTransaction,
30
33
                                 WriteTransaction,
31
34
                                 )
32
 
from bzrlib.transport import get_transport
33
35
 
34
36
 
35
37
# 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
36
41
class _TestLockableFiles_mixin(object):
37
42
 
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
 
 
78
43
    def test_transactions(self):
79
44
        self.assertIs(self.lockable.get_transaction().__class__,
80
45
                      PassThroughTransaction)
97
62
 
98
63
    def test__escape(self):
99
64
        self.assertEqual('%25', self.lockable._escape('%'))
100
 
        
 
65
 
101
66
    def test__escape_empty(self):
102
67
        self.assertEqual('', self.lockable._escape(''))
103
68
 
109
74
        except NotImplementedError:
110
75
            # this lock cannot be broken
111
76
            self.lockable.unlock()
112
 
            return
 
77
            raise TestNotApplicable("%r is not breakable" % (self.lockable,))
113
78
        l2 = self.get_lockable()
114
79
        orig_factory = bzrlib.ui.ui_factory
115
80
        # silent ui - no need for stdout
116
 
        bzrlib.ui.ui_factory = bzrlib.ui.SilentUIFactory()
117
 
        bzrlib.ui.ui_factory.stdin = StringIO("y\n")
 
81
        bzrlib.ui.ui_factory = bzrlib.ui.CannedInputUIFactory([True])
118
82
        try:
119
83
            l2.break_lock()
120
84
        finally:
128
92
 
129
93
    def test_lock_write_returns_None_refuses_token(self):
130
94
        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()
 
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')
140
102
 
141
103
    def test_lock_write_returns_token_when_given_token(self):
142
104
        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()
 
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)
156
114
 
157
115
    def test_lock_write_raises_on_token_mismatch(self):
158
116
        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()
 
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)
181
137
 
182
138
    def test_lock_write_with_matching_token(self):
183
139
        # If the token matches, so no exception is raised by lock_write.
184
140
        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()
 
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()
201
155
 
202
156
    def test_unlock_after_lock_write_with_token(self):
203
157
        # If lock_write did not physically acquire the lock (because it was
204
158
        # passed a token), then unlock should not physically release it.
205
159
        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()
 
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())
217
169
 
218
170
    def test_lock_write_with_token_fails_when_unlocked(self):
219
171
        # Lock and unlock to get a superficially valid token.  This mimics a
284
236
        # But should be relockable with a token.
285
237
        self.lockable.lock_write(token=token)
286
238
        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()
287
244
 
288
245
    def test_dont_leave_in_place(self):
289
246
        token = self.lockable.lock_write()
308
265
        third_lockable.unlock()
309
266
 
310
267
 
311
 
# This method of adapting tests to parameters is different to 
312
 
# the TestProviderAdapters used elsewhere, but seems simpler for this 
313
 
# case.  
 
268
# This method of adapting tests to parameters is different to
 
269
# the TestProviderAdapters used elsewhere, but seems simpler for this
 
270
# case.
314
271
class TestLockableFiles_TransportLock(TestCaseInTempDir,
315
272
                                      _TestLockableFiles_mixin):
316
273
 
317
274
    def setUp(self):
318
 
        TestCaseInTempDir.setUp(self)
319
 
        transport = get_transport('.')
320
 
        transport.mkdir('.bzr')
321
 
        self.sub_transport = transport.clone('.bzr')
 
275
        super(TestLockableFiles_TransportLock, self).setUp()
 
276
        t = transport.get_transport_from_path('.')
 
277
        t.mkdir('.bzr')
 
278
        self.sub_transport = t.clone('.bzr')
322
279
        self.lockable = self.get_lockable()
323
280
        self.lockable.create_lock()
324
281
 
325
 
    def tearDown(self):
326
 
        super(TestLockableFiles_TransportLock, self).tearDown()
 
282
    def stop_server(self):
 
283
        super(TestLockableFiles_TransportLock, self).stop_server()
327
284
        # free the subtransport so that we do not get a 5 second
328
285
        # timeout due to the SFTP connection cache.
329
 
        del self.sub_transport
 
286
        try:
 
287
            del self.sub_transport
 
288
        except AttributeError:
 
289
            pass
330
290
 
331
291
    def get_lockable(self):
332
292
        return LockableFiles(self.sub_transport, 'my-lock', TransportLock)
333
 
        
 
293
 
334
294
 
335
295
class TestLockableFiles_LockDir(TestCaseInTempDir,
336
 
                              _TestLockableFiles_mixin):
 
296
                                _TestLockableFiles_mixin):
337
297
    """LockableFile tests run with LockDir underneath"""
338
298
 
339
299
    def setUp(self):
340
 
        TestCaseInTempDir.setUp(self)
341
 
        self.transport = get_transport('.')
 
300
        super(TestLockableFiles_LockDir, self).setUp()
 
301
        self.transport = transport.get_transport_from_path('.')
342
302
        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 
 
303
        # the lock creation here sets mode - test_permissions on branch
 
304
        # tests that implicitly, but it might be a good idea to factor
345
305
        # out the mode checking logic and have it applied to loackable files
346
306
        # directly. RBC 20060418
347
307
        self.lockable.create_lock()
348
308
 
349
309
    def get_lockable(self):
350
 
        return LockableFiles(self.transport, 'my-lock', LockDir)
 
310
        return LockableFiles(self.transport, 'my-lock', lockdir.LockDir)
351
311
 
352
312
    def test_lock_created(self):
353
313
        self.assertTrue(self.transport.has('my-lock'))
357
317
        self.assertFalse(self.transport.has('my-lock/held/info'))
358
318
        self.assertTrue(self.transport.has('my-lock'))
359
319
 
 
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)
360
329
 
361
 
    # TODO: Test the lockdir inherits the right file and directory permissions
362
 
    # from the LockableFiles.
363
 
        
364
330
 
365
331
class TestLockableFiles_RemoteLockDir(TestCaseWithSmartMedium,
366
 
                              _TestLockableFiles_mixin):
 
332
                                      _TestLockableFiles_mixin):
367
333
    """LockableFile tests run with RemoteLockDir on a branch."""
368
334
 
369
335
    def setUp(self):
370
 
        TestCaseWithSmartMedium.setUp(self)
 
336
        super(TestLockableFiles_RemoteLockDir, self).setUp()
371
337
        # can only get a RemoteLockDir with some RemoteObject...
372
338
        # use a branch as thats what we want. These mixin tests test the end
373
339
        # to end behaviour, so stubbing out the backend and simulating would
375
341
        # in test_remote and test_smart as usual.
376
342
        b = self.make_branch('foo')
377
343
        self.addCleanup(b.bzrdir.transport.disconnect)
378
 
        self.transport = get_transport('.')
 
344
        self.transport = transport.get_transport_from_path('.')
379
345
        self.lockable = self.get_lockable()
380
346
 
381
347
    def get_lockable(self):