← 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

- refactor handling of short option names

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/tests/test_lockable_files.py
1
 
# Copyright (C) 2005, 2006 by Canonical Ltd
2
 
 
3
 
# This program is free software; you can redistribute it and/or modify
4
 
# it under the terms of the GNU General Public License as published by
5
 
# the Free Software Foundation; either version 2 of the License, or
6
 
# (at your option) any later version.
7
 
 
8
 
# This program is distributed in the hope that it will be useful,
9
 
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
 
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
11
 
# GNU General Public License for more details.
12
 
 
13
 
# You should have received a copy of the GNU General Public License
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
18
 
 
19
 
from bzrlib.branch import Branch
20
 
from bzrlib.errors import BzrBadParameterNotString, NoSuchFile, ReadOnlyError
21
 
from bzrlib.lockable_files import LockableFiles, TransportLock
22
 
from bzrlib.lockdir import LockDir
23
 
from bzrlib.tests import TestCaseInTempDir
24
 
from bzrlib.tests.test_transactions import DummyWeave
25
 
from bzrlib.transactions import (PassThroughTransaction,
26
 
                                 ReadOnlyTransaction,
27
 
                                 WriteTransaction,
28
 
                                 )
29
 
from bzrlib.transport import get_transport
30
 
 
31
 
 
32
 
# these tests are applied in each parameterized suite for LockableFiles
33
 
class _TestLockableFiles_mixin(object):
34
 
 
35
 
    def test_read_write(self):
36
 
        self.assertRaises(NoSuchFile, self.lockable.get, 'foo')
37
 
        self.assertRaises(NoSuchFile, self.lockable.get_utf8, 'foo')
38
 
        self.lockable.lock_write()
39
 
        try:
40
 
            unicode_string = u'bar\u1234'
41
 
            self.assertEqual(4, len(unicode_string))
42
 
            byte_string = unicode_string.encode('utf-8')
43
 
            self.assertEqual(6, len(byte_string))
44
 
            self.assertRaises(UnicodeEncodeError, self.lockable.put, 'foo', 
45
 
                              StringIO(unicode_string))
46
 
            self.lockable.put('foo', StringIO(byte_string))
47
 
            self.assertEqual(byte_string,
48
 
                             self.lockable.get('foo').read())
49
 
            self.assertEqual(unicode_string,
50
 
                             self.lockable.get_utf8('foo').read())
51
 
            self.assertRaises(BzrBadParameterNotString,
52
 
                              self.lockable.put_utf8,
53
 
                              'bar',
54
 
                              StringIO(unicode_string)
55
 
                              )
56
 
            self.lockable.put_utf8('bar', unicode_string)
57
 
            self.assertEqual(unicode_string, 
58
 
                             self.lockable.get_utf8('bar').read())
59
 
            self.assertEqual(byte_string, 
60
 
                             self.lockable.get('bar').read())
61
 
        finally:
62
 
            self.lockable.unlock()
63
 
 
64
 
    def test_locks(self):
65
 
        self.lockable.lock_read()
66
 
        try:
67
 
            self.assertRaises(ReadOnlyError, self.lockable.put, 'foo', 
68
 
                              StringIO('bar\u1234'))
69
 
        finally:
70
 
            self.lockable.unlock()
71
 
 
72
 
    def test_transactions(self):
73
 
        self.assertIs(self.lockable.get_transaction().__class__,
74
 
                      PassThroughTransaction)
75
 
        self.lockable.lock_read()
76
 
        try:
77
 
            self.assertIs(self.lockable.get_transaction().__class__,
78
 
                          ReadOnlyTransaction)
79
 
        finally:
80
 
            self.lockable.unlock()
81
 
        self.assertIs(self.lockable.get_transaction().__class__,
82
 
                      PassThroughTransaction)
83
 
        self.lockable.lock_write()
84
 
        self.assertIs(self.lockable.get_transaction().__class__,
85
 
                      WriteTransaction)
86
 
        # check that finish is called:
87
 
        vf = DummyWeave('a')
88
 
        self.lockable.get_transaction().register_dirty(vf)
89
 
        self.lockable.unlock()
90
 
        self.assertTrue(vf.finished)
91
 
 
92
 
    def test__escape(self):
93
 
        self.assertEqual('%25', self.lockable._escape('%'))
94
 
        
95
 
    def test__escape_empty(self):
96
 
        self.assertEqual('', self.lockable._escape(''))
97
 
 
98
 
 
99
 
# This method of adapting tests to parameters is different to 
100
 
# the TestProviderAdapters used elsewhere, but seems simpler for this 
101
 
# case.  
102
 
class TestLockableFiles_TransportLock(TestCaseInTempDir,
103
 
                                      _TestLockableFiles_mixin):
104
 
 
105
 
    def setUp(self):
106
 
        super(TestLockableFiles_TransportLock, self).setUp()
107
 
        transport = get_transport('.')
108
 
        transport.mkdir('.bzr')
109
 
        sub_transport = transport.clone('.bzr')
110
 
        self.lockable = LockableFiles(sub_transport, 'my-lock', TransportLock)
111
 
        self.lockable.create_lock()
112
 
        
113
 
 
114
 
class TestLockableFiles_LockDir(TestCaseInTempDir,
115
 
                              _TestLockableFiles_mixin):
116
 
    """LockableFile tests run with LockDir underneath"""
117
 
 
118
 
    def setUp(self):
119
 
        super(TestLockableFiles_LockDir, self).setUp()
120
 
        self.transport = get_transport('.')
121
 
        self.lockable = LockableFiles(self.transport, 'my-lock', LockDir)
122
 
        # the lock creation here sets mode - test_permissions on branch 
123
 
        # tests that implicitly, but it might be a good idea to factor 
124
 
        # out the mode checking logic and have it applied to loackable files
125
 
        # directly. RBC 20060418
126
 
        self.lockable.create_lock()
127
 
 
128
 
    def test_lock_is_lockdir(self):
129
 
        """Created instance should use a LockDir.
130
 
        
131
 
        This primarily tests the mixin adapter works properly.
132
 
        """
133
 
        ## self.assertIsInstance(self.lockable, LockableFiles)
134
 
        ## self.assertIsInstance(self.lockable._lock_strategy,
135
 
                              ## LockDirStrategy)
136
 
 
137
 
    def test_lock_created(self):
138
 
        self.assertTrue(self.transport.has('my-lock'))
139
 
        self.lockable.lock_write()
140
 
        self.assertTrue(self.transport.has('my-lock/held/info'))
141
 
        self.lockable.unlock()
142
 
        self.assertFalse(self.transport.has('my-lock/held/info'))
143
 
        self.assertTrue(self.transport.has('my-lock'))
144
 
 
145
 
 
146
 
    # TODO: Test the lockdir inherits the right file and directory permissions
147
 
    # from the LockableFiles.