← 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-04-19 02:27:44 UTC
  • mto: This revision was merged to the branch mainline in revision 2426.
  • Revision ID: robertc@robertcollins.net-20070419022744-pfdqz42kp1wizh43
``make docs`` now creates a man page at ``man1/bzr.1`` fixing bug 107388.
(Robert Collins)

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
 
    )
29
 
from bzrlib.tests.test_smart import TestCaseWithSmartMedium
 
23
from bzrlib.lockdir import LockDir
 
24
from bzrlib.tests import TestCaseInTempDir
30
25
from bzrlib.tests.test_transactions import DummyWeave
31
26
from bzrlib.transactions import (PassThroughTransaction,
32
27
                                 ReadOnlyTransaction,
33
28
                                 WriteTransaction,
34
29
                                 )
 
30
from bzrlib.transport import get_transport
35
31
 
36
32
 
37
33
# 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
34
class _TestLockableFiles_mixin(object):
42
35
 
 
36
    def test_read_write(self):
 
37
        self.assertRaises(NoSuchFile, self.lockable.get, 'foo')
 
38
        self.assertRaises(NoSuchFile, self.lockable.get_utf8, 'foo')
 
39
        self.lockable.lock_write()
 
40
        try:
 
41
            unicode_string = u'bar\u1234'
 
42
            self.assertEqual(4, len(unicode_string))
 
43
            byte_string = unicode_string.encode('utf-8')
 
44
            self.assertEqual(6, len(byte_string))
 
45
            self.assertRaises(UnicodeEncodeError, self.lockable.put, 'foo', 
 
46
                              StringIO(unicode_string))
 
47
            self.lockable.put('foo', StringIO(byte_string))
 
48
            self.assertEqual(byte_string,
 
49
                             self.lockable.get('foo').read())
 
50
            self.assertEqual(unicode_string,
 
51
                             self.lockable.get_utf8('foo').read())
 
52
            self.assertRaises(BzrBadParameterNotString,
 
53
                              self.lockable.put_utf8,
 
54
                              'bar',
 
55
                              StringIO(unicode_string)
 
56
                              )
 
57
            self.lockable.put_utf8('bar', unicode_string)
 
58
            self.assertEqual(unicode_string,
 
59
                             self.lockable.get_utf8('bar').read())
 
60
            self.assertEqual(byte_string,
 
61
                             self.lockable.get('bar').read())
 
62
            self.lockable.put_bytes('raw', 'raw\xffbytes')
 
63
            self.assertEqual('raw\xffbytes',
 
64
                             self.lockable.get('raw').read())
 
65
        finally:
 
66
            self.lockable.unlock()
 
67
 
 
68
    def test_locks(self):
 
69
        self.lockable.lock_read()
 
70
        try:
 
71
            self.assertRaises(ReadOnlyError, self.lockable.put, 'foo', 
 
72
                              StringIO('bar\u1234'))
 
73
        finally:
 
74
            self.lockable.unlock()
 
75
 
43
76
    def test_transactions(self):
44
77
        self.assertIs(self.lockable.get_transaction().__class__,
45
78
                      PassThroughTransaction)
62
95
 
63
96
    def test__escape(self):
64
97
        self.assertEqual('%25', self.lockable._escape('%'))
65
 
 
 
98
        
66
99
    def test__escape_empty(self):
67
100
        self.assertEqual('', self.lockable._escape(''))
68
101
 
74
107
        except NotImplementedError:
75
108
            # this lock cannot be broken
76
109
            self.lockable.unlock()
77
 
            raise TestNotApplicable("%r is not breakable" % (self.lockable,))
 
110
            return
78
111
        l2 = self.get_lockable()
79
112
        orig_factory = bzrlib.ui.ui_factory
80
113
        # silent ui - no need for stdout
81
 
        bzrlib.ui.ui_factory = bzrlib.ui.CannedInputUIFactory([True])
 
114
        bzrlib.ui.ui_factory = bzrlib.ui.SilentUIFactory()
 
115
        bzrlib.ui.ui_factory.stdin = StringIO("y\n")
82
116
        try:
83
117
            l2.break_lock()
84
118
        finally:
92
126
 
93
127
    def test_lock_write_returns_None_refuses_token(self):
94
128
        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')
 
129
        try:
 
130
            if token is not None:
 
131
                # This test does not apply, because this lockable supports
 
132
                # tokens.
 
133
                return
 
134
            self.assertRaises(errors.TokenLockingNotSupported,
 
135
                              self.lockable.lock_write, token='token')
 
136
        finally:
 
137
            self.lockable.unlock()
102
138
 
103
139
    def test_lock_write_returns_token_when_given_token(self):
104
140
        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)
 
141
        try:
 
142
            if token is None:
 
143
                # This test does not apply, because this lockable refuses
 
144
                # tokens.
 
145
                return
 
146
            new_lockable = self.get_lockable()
 
147
            token_from_new_lockable = new_lockable.lock_write(token=token)
 
148
            try:
 
149
                self.assertEqual(token, token_from_new_lockable)
 
150
            finally:
 
151
                new_lockable.unlock()
 
152
        finally:
 
153
            self.lockable.unlock()
114
154
 
115
155
    def test_lock_write_raises_on_token_mismatch(self):
116
156
        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)
 
157
        try:
 
158
            if token is None:
 
159
                # This test does not apply, because this lockable refuses
 
160
                # tokens.
 
161
                return
 
162
            different_token = token + 'xxx'
 
163
            # Re-using the same lockable instance with a different token will
 
164
            # raise TokenMismatch.
 
165
            self.assertRaises(errors.TokenMismatch,
 
166
                              self.lockable.lock_write, token=different_token)
 
167
            # A seperate instance for the same lockable will also raise
 
168
            # TokenMismatch.
 
169
            # This detects the case where a caller claims to have a lock (via
 
170
            # the token) for an external resource, but doesn't (the token is
 
171
            # different).  Clients need a seperate lock object to make sure the
 
172
            # external resource is probed, whereas the existing lock object
 
173
            # might cache.
 
174
            new_lockable = self.get_lockable()
 
175
            self.assertRaises(errors.TokenMismatch,
 
176
                              new_lockable.lock_write, token=different_token)
 
177
        finally:
 
178
            self.lockable.unlock()
137
179
 
138
180
    def test_lock_write_with_matching_token(self):
139
181
        # If the token matches, so no exception is raised by lock_write.
140
182
        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()
 
183
        try:
 
184
            if token is None:
 
185
                # This test does not apply, because this lockable refuses
 
186
                # tokens.
 
187
                return
 
188
            # The same instance will accept a second lock_write if the specified
 
189
            # token matches.
 
190
            self.lockable.lock_write(token=token)
 
191
            self.lockable.unlock()
 
192
            # Calling lock_write on a new instance for the same lockable will
 
193
            # also succeed.
 
194
            new_lockable = self.get_lockable()
 
195
            new_lockable.lock_write(token=token)
 
196
            new_lockable.unlock()
 
197
        finally:
 
198
            self.lockable.unlock()
155
199
 
156
200
    def test_unlock_after_lock_write_with_token(self):
157
201
        # If lock_write did not physically acquire the lock (because it was
158
202
        # passed a token), then unlock should not physically release it.
159
203
        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())
 
204
        try:
 
205
            if token is None:
 
206
                # This test does not apply, because this lockable refuses
 
207
                # tokens.
 
208
                return
 
209
            new_lockable = self.get_lockable()
 
210
            new_lockable.lock_write(token=token)
 
211
            new_lockable.unlock()
 
212
            self.assertTrue(self.lockable.get_physical_lock_status())
 
213
        finally:
 
214
            self.lockable.unlock()
169
215
 
170
216
    def test_lock_write_with_token_fails_when_unlocked(self):
171
217
        # Lock and unlock to get a superficially valid token.  This mimics a
236
282
        # But should be relockable with a token.
237
283
        self.lockable.lock_write(token=token)
238
284
        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
285
 
245
286
    def test_dont_leave_in_place(self):
246
287
        token = self.lockable.lock_write()
265
306
        third_lockable.unlock()
266
307
 
267
308
 
268
 
# This method of adapting tests to parameters is different to
269
 
# the TestProviderAdapters used elsewhere, but seems simpler for this
270
 
# case.
 
309
# This method of adapting tests to parameters is different to 
 
310
# the TestProviderAdapters used elsewhere, but seems simpler for this 
 
311
# case.  
271
312
class TestLockableFiles_TransportLock(TestCaseInTempDir,
272
313
                                      _TestLockableFiles_mixin):
273
314
 
274
315
    def setUp(self):
275
316
        TestCaseInTempDir.setUp(self)
276
 
        t = transport.get_transport('.')
277
 
        t.mkdir('.bzr')
278
 
        self.sub_transport = t.clone('.bzr')
 
317
        transport = get_transport('.')
 
318
        transport.mkdir('.bzr')
 
319
        self.sub_transport = transport.clone('.bzr')
279
320
        self.lockable = self.get_lockable()
280
321
        self.lockable.create_lock()
281
322
 
282
 
    def stop_server(self):
283
 
        super(TestLockableFiles_TransportLock, self).stop_server()
 
323
    def tearDown(self):
 
324
        super(TestLockableFiles_TransportLock, self).tearDown()
284
325
        # free the subtransport so that we do not get a 5 second
285
326
        # timeout due to the SFTP connection cache.
286
 
        try:
287
 
            del self.sub_transport
288
 
        except AttributeError:
289
 
            pass
 
327
        del self.sub_transport
290
328
 
291
329
    def get_lockable(self):
292
330
        return LockableFiles(self.sub_transport, 'my-lock', TransportLock)
293
 
 
 
331
        
294
332
 
295
333
class TestLockableFiles_LockDir(TestCaseInTempDir,
296
334
                              _TestLockableFiles_mixin):
298
336
 
299
337
    def setUp(self):
300
338
        TestCaseInTempDir.setUp(self)
301
 
        self.transport = transport.get_transport('.')
 
339
        self.transport = get_transport('.')
302
340
        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
 
341
        # the lock creation here sets mode - test_permissions on branch 
 
342
        # tests that implicitly, but it might be a good idea to factor 
305
343
        # out the mode checking logic and have it applied to loackable files
306
344
        # directly. RBC 20060418
307
345
        self.lockable.create_lock()
308
346
 
309
347
    def get_lockable(self):
310
 
        return LockableFiles(self.transport, 'my-lock', lockdir.LockDir)
 
348
        return LockableFiles(self.transport, 'my-lock', LockDir)
311
349
 
312
350
    def test_lock_created(self):
313
351
        self.assertTrue(self.transport.has('my-lock'))
317
355
        self.assertFalse(self.transport.has('my-lock/held/info'))
318
356
        self.assertTrue(self.transport.has('my-lock'))
319
357
 
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
 
 
330
 
 
331
 
class TestLockableFiles_RemoteLockDir(TestCaseWithSmartMedium,
332
 
                              _TestLockableFiles_mixin):
333
 
    """LockableFile tests run with RemoteLockDir on a branch."""
334
 
 
335
 
    def setUp(self):
336
 
        TestCaseWithSmartMedium.setUp(self)
337
 
        # can only get a RemoteLockDir with some RemoteObject...
338
 
        # use a branch as thats what we want. These mixin tests test the end
339
 
        # to end behaviour, so stubbing out the backend and simulating would
340
 
        # defeat the purpose. We test the protocol implementation separately
341
 
        # in test_remote and test_smart as usual.
342
 
        b = self.make_branch('foo')
343
 
        self.addCleanup(b.bzrdir.transport.disconnect)
344
 
        self.transport = transport.get_transport('.')
345
 
        self.lockable = self.get_lockable()
346
 
 
347
 
    def get_lockable(self):
348
 
        # getting a new lockable involves opening a new instance of the branch
349
 
        branch = bzrlib.branch.Branch.open(self.get_url('foo'))
350
 
        self.addCleanup(branch.bzrdir.transport.disconnect)
351
 
        return branch.control_files
 
358
 
 
359
    # TODO: Test the lockdir inherits the right file and directory permissions
 
360
    # from the LockableFiles.