← 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: 2016-04-21 04:10:52 UTC
  • mfrom: (6616.1.1 fix-en-user-guide)
  • Revision ID: pqm@pqm.ubuntu.com-20160421041052-clcye7ns1qcl2n7w
(richard-wilbur) Ensure build of English use guide always uses English text
 even when user's locale specifies a different language. (Jelmer Vernooij)

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