~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/tests/test_workingtree.py

  • Committer: Aaron Bentley
  • Date: 2008-03-11 14:29:08 UTC
  • mto: This revision was merged to the branch mainline in revision 3264.
  • Revision ID: aaron@aaronbentley.com-20080311142908-yyrvcpn2mldt0fnn
Update documentation to reflect conflict-handling difference

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
# Copyright (C) 2005, 2006 Canonical Ltd
 
2
# Authors:  Robert Collins <robert.collins@canonical.com>
 
3
#
 
4
# This program is free software; you can redistribute it and/or modify
 
5
# it under the terms of the GNU General Public License as published by
 
6
# the Free Software Foundation; either version 2 of the License, or
 
7
# (at your option) any later version.
 
8
#
 
9
# This program is distributed in the hope that it will be useful,
 
10
# but WITHOUT ANY WARRANTY; without even the implied warranty of
 
11
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 
12
# GNU General Public License for more details.
 
13
#
 
14
# You should have received a copy of the GNU General Public License
 
15
# along with this program; if not, write to the Free Software
 
16
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
17
 
 
18
from cStringIO import StringIO
 
19
import os
 
20
 
 
21
from bzrlib import (
 
22
    bzrdir,
 
23
    conflicts,
 
24
    errors,
 
25
    workingtree,
 
26
    )
 
27
from bzrlib.branch import Branch
 
28
from bzrlib.bzrdir import BzrDir
 
29
from bzrlib.lockdir import LockDir
 
30
from bzrlib.mutabletree import needs_tree_write_lock
 
31
from bzrlib.symbol_versioning import zero_thirteen
 
32
from bzrlib.tests import TestCase, TestCaseWithTransport, TestSkipped
 
33
from bzrlib.transport import get_transport
 
34
from bzrlib.workingtree import (
 
35
    TreeEntry,
 
36
    TreeDirectory,
 
37
    TreeFile,
 
38
    TreeLink,
 
39
    )
 
40
 
 
41
 
 
42
class TestTreeDirectory(TestCaseWithTransport):
 
43
 
 
44
    def test_kind_character(self):
 
45
        self.assertEqual(TreeDirectory().kind_character(), '/')
 
46
 
 
47
 
 
48
class TestTreeEntry(TestCaseWithTransport):
 
49
 
 
50
    def test_kind_character(self):
 
51
        self.assertEqual(TreeEntry().kind_character(), '???')
 
52
 
 
53
 
 
54
class TestTreeFile(TestCaseWithTransport):
 
55
 
 
56
    def test_kind_character(self):
 
57
        self.assertEqual(TreeFile().kind_character(), '')
 
58
 
 
59
 
 
60
class TestTreeLink(TestCaseWithTransport):
 
61
 
 
62
    def test_kind_character(self):
 
63
        self.assertEqual(TreeLink().kind_character(), '')
 
64
 
 
65
 
 
66
class TestDefaultFormat(TestCaseWithTransport):
 
67
 
 
68
    def test_get_set_default_format(self):
 
69
        old_format = workingtree.WorkingTreeFormat.get_default_format()
 
70
        # default is 3
 
71
        self.assertTrue(isinstance(old_format, workingtree.WorkingTreeFormat3))
 
72
        workingtree.WorkingTreeFormat.set_default_format(SampleTreeFormat())
 
73
        try:
 
74
            # the default branch format is used by the meta dir format
 
75
            # which is not the default bzrdir format at this point
 
76
            dir = bzrdir.BzrDirMetaFormat1().initialize('.')
 
77
            dir.create_repository()
 
78
            dir.create_branch()
 
79
            result = dir.create_workingtree()
 
80
            self.assertEqual(result, 'A tree')
 
81
        finally:
 
82
            workingtree.WorkingTreeFormat.set_default_format(old_format)
 
83
        self.assertEqual(old_format, workingtree.WorkingTreeFormat.get_default_format())
 
84
 
 
85
 
 
86
class SampleTreeFormat(workingtree.WorkingTreeFormat):
 
87
    """A sample format
 
88
 
 
89
    this format is initializable, unsupported to aid in testing the 
 
90
    open and open_downlevel routines.
 
91
    """
 
92
 
 
93
    def get_format_string(self):
 
94
        """See WorkingTreeFormat.get_format_string()."""
 
95
        return "Sample tree format."
 
96
 
 
97
    def initialize(self, a_bzrdir, revision_id=None, from_branch=None,
 
98
                   accelerator_tree=None, hardlink=False):
 
99
        """Sample branches cannot be created."""
 
100
        t = a_bzrdir.get_workingtree_transport(self)
 
101
        t.put_bytes('format', self.get_format_string())
 
102
        return 'A tree'
 
103
 
 
104
    def is_supported(self):
 
105
        return False
 
106
 
 
107
    def open(self, transport, _found=False):
 
108
        return "opened tree."
 
109
 
 
110
 
 
111
class TestWorkingTreeFormat(TestCaseWithTransport):
 
112
    """Tests for the WorkingTreeFormat facility."""
 
113
 
 
114
    def test_find_format(self):
 
115
        # is the right format object found for a working tree?
 
116
        # create a branch with a few known format objects.
 
117
        self.build_tree(["foo/", "bar/"])
 
118
        def check_format(format, url):
 
119
            dir = format._matchingbzrdir.initialize(url)
 
120
            dir.create_repository()
 
121
            dir.create_branch()
 
122
            format.initialize(dir)
 
123
            t = get_transport(url)
 
124
            found_format = workingtree.WorkingTreeFormat.find_format(dir)
 
125
            self.failUnless(isinstance(found_format, format.__class__))
 
126
        check_format(workingtree.WorkingTreeFormat3(), "bar")
 
127
        
 
128
    def test_find_format_no_tree(self):
 
129
        dir = bzrdir.BzrDirMetaFormat1().initialize('.')
 
130
        self.assertRaises(errors.NoWorkingTree,
 
131
                          workingtree.WorkingTreeFormat.find_format,
 
132
                          dir)
 
133
 
 
134
    def test_find_format_unknown_format(self):
 
135
        dir = bzrdir.BzrDirMetaFormat1().initialize('.')
 
136
        dir.create_repository()
 
137
        dir.create_branch()
 
138
        SampleTreeFormat().initialize(dir)
 
139
        self.assertRaises(errors.UnknownFormatError,
 
140
                          workingtree.WorkingTreeFormat.find_format,
 
141
                          dir)
 
142
 
 
143
    def test_register_unregister_format(self):
 
144
        format = SampleTreeFormat()
 
145
        # make a control dir
 
146
        dir = bzrdir.BzrDirMetaFormat1().initialize('.')
 
147
        dir.create_repository()
 
148
        dir.create_branch()
 
149
        # make a branch
 
150
        format.initialize(dir)
 
151
        # register a format for it.
 
152
        workingtree.WorkingTreeFormat.register_format(format)
 
153
        # which branch.Open will refuse (not supported)
 
154
        self.assertRaises(errors.UnsupportedFormatError, workingtree.WorkingTree.open, '.')
 
155
        # but open_downlevel will work
 
156
        self.assertEqual(format.open(dir), workingtree.WorkingTree.open_downlevel('.'))
 
157
        # unregister the format
 
158
        workingtree.WorkingTreeFormat.unregister_format(format)
 
159
 
 
160
 
 
161
class TestWorkingTreeFormat3(TestCaseWithTransport):
 
162
    """Tests specific to WorkingTreeFormat3."""
 
163
 
 
164
    def test_disk_layout(self):
 
165
        control = bzrdir.BzrDirMetaFormat1().initialize(self.get_url())
 
166
        control.create_repository()
 
167
        control.create_branch()
 
168
        tree = workingtree.WorkingTreeFormat3().initialize(control)
 
169
        # we want:
 
170
        # format 'Bazaar-NG Working Tree format 3'
 
171
        # inventory = blank inventory
 
172
        # pending-merges = ''
 
173
        # stat-cache = ??
 
174
        # no inventory.basis yet
 
175
        t = control.get_workingtree_transport(None)
 
176
        self.assertEqualDiff('Bazaar-NG Working Tree format 3',
 
177
                             t.get('format').read())
 
178
        self.assertEqualDiff(t.get('inventory').read(), 
 
179
                              '<inventory format="5">\n'
 
180
                              '</inventory>\n',
 
181
                             )
 
182
        self.assertEqualDiff('### bzr hashcache v5\n',
 
183
                             t.get('stat-cache').read())
 
184
        self.assertFalse(t.has('inventory.basis'))
 
185
        # no last-revision file means 'None' or 'NULLREVISION'
 
186
        self.assertFalse(t.has('last-revision'))
 
187
        # TODO RBC 20060210 do a commit, check the inventory.basis is created 
 
188
        # correctly and last-revision file becomes present.
 
189
 
 
190
    def test_uses_lockdir(self):
 
191
        """WorkingTreeFormat3 uses its own LockDir:
 
192
            
 
193
            - lock is a directory
 
194
            - when the WorkingTree is locked, LockDir can see that
 
195
        """
 
196
        t = self.get_transport()
 
197
        url = self.get_url()
 
198
        dir = bzrdir.BzrDirMetaFormat1().initialize(url)
 
199
        repo = dir.create_repository()
 
200
        branch = dir.create_branch()
 
201
        try:
 
202
            tree = workingtree.WorkingTreeFormat3().initialize(dir)
 
203
        except errors.NotLocalUrl:
 
204
            raise TestSkipped('Not a local URL')
 
205
        self.assertIsDirectory('.bzr', t)
 
206
        self.assertIsDirectory('.bzr/checkout', t)
 
207
        self.assertIsDirectory('.bzr/checkout/lock', t)
 
208
        our_lock = LockDir(t, '.bzr/checkout/lock')
 
209
        self.assertEquals(our_lock.peek(), None)
 
210
        tree.lock_write()
 
211
        self.assertTrue(our_lock.peek())
 
212
        tree.unlock()
 
213
        self.assertEquals(our_lock.peek(), None)
 
214
 
 
215
    def test_missing_pending_merges(self):
 
216
        control = bzrdir.BzrDirMetaFormat1().initialize(self.get_url())
 
217
        control.create_repository()
 
218
        control.create_branch()
 
219
        tree = workingtree.WorkingTreeFormat3().initialize(control)
 
220
        tree._control_files._transport.delete("pending-merges")
 
221
        self.assertEqual([], tree.get_parent_ids())
 
222
 
 
223
 
 
224
class TestFormat2WorkingTree(TestCaseWithTransport):
 
225
    """Tests that are specific to format 2 trees."""
 
226
 
 
227
    def create_format2_tree(self, url):
 
228
        return self.make_branch_and_tree(
 
229
            url, format=bzrdir.BzrDirFormat6())
 
230
 
 
231
    def test_conflicts(self):
 
232
        # test backwards compatability
 
233
        tree = self.create_format2_tree('.')
 
234
        self.assertRaises(errors.UnsupportedOperation, tree.set_conflicts,
 
235
                          None)
 
236
        file('lala.BASE', 'wb').write('labase')
 
237
        expected = conflicts.ContentsConflict('lala')
 
238
        self.assertEqual(list(tree.conflicts()), [expected])
 
239
        file('lala', 'wb').write('la')
 
240
        tree.add('lala', 'lala-id')
 
241
        expected = conflicts.ContentsConflict('lala', file_id='lala-id')
 
242
        self.assertEqual(list(tree.conflicts()), [expected])
 
243
        file('lala.THIS', 'wb').write('lathis')
 
244
        file('lala.OTHER', 'wb').write('laother')
 
245
        # When "text conflict"s happen, stem, THIS and OTHER are text
 
246
        expected = conflicts.TextConflict('lala', file_id='lala-id')
 
247
        self.assertEqual(list(tree.conflicts()), [expected])
 
248
        os.unlink('lala.OTHER')
 
249
        os.mkdir('lala.OTHER')
 
250
        expected = conflicts.ContentsConflict('lala', file_id='lala-id')
 
251
        self.assertEqual(list(tree.conflicts()), [expected])
 
252
 
 
253
 
 
254
class TestNonFormatSpecificCode(TestCaseWithTransport):
 
255
    """This class contains tests of workingtree that are not format specific."""
 
256
 
 
257
    def test_gen_file_id(self):
 
258
        file_id = self.applyDeprecated(zero_thirteen, workingtree.gen_file_id,
 
259
                                      'filename')
 
260
        self.assertStartsWith(file_id, 'filename-')
 
261
 
 
262
    def test_gen_root_id(self):
 
263
        file_id = self.applyDeprecated(zero_thirteen, workingtree.gen_root_id)
 
264
        self.assertStartsWith(file_id, 'tree_root-')
 
265
        
 
266
 
 
267
class InstrumentedTree(object):
 
268
    """A instrumented tree to check the needs_tree_write_lock decorator."""
 
269
 
 
270
    def __init__(self):
 
271
        self._locks = []
 
272
 
 
273
    def lock_tree_write(self):
 
274
        self._locks.append('t')
 
275
 
 
276
    @needs_tree_write_lock
 
277
    def method_with_tree_write_lock(self, *args, **kwargs):
 
278
        """A lock_tree_write decorated method that returns its arguments."""
 
279
        return args, kwargs
 
280
 
 
281
    @needs_tree_write_lock
 
282
    def method_that_raises(self):
 
283
        """This method causes an exception when called with parameters.
 
284
        
 
285
        This allows the decorator code to be checked - it should still call
 
286
        unlock.
 
287
        """
 
288
 
 
289
    def unlock(self):
 
290
        self._locks.append('u')
 
291
 
 
292
 
 
293
class TestInstrumentedTree(TestCase):
 
294
 
 
295
    def test_needs_tree_write_lock(self):
 
296
        """@needs_tree_write_lock should be semantically transparent."""
 
297
        tree = InstrumentedTree()
 
298
        self.assertEqual(
 
299
            'method_with_tree_write_lock',
 
300
            tree.method_with_tree_write_lock.__name__)
 
301
        self.assertEqual(
 
302
            "A lock_tree_write decorated method that returns its arguments.",
 
303
            tree.method_with_tree_write_lock.__doc__)
 
304
        args = (1, 2, 3)
 
305
        kwargs = {'a':'b'}
 
306
        result = tree.method_with_tree_write_lock(1,2,3, a='b')
 
307
        self.assertEqual((args, kwargs), result)
 
308
        self.assertEqual(['t', 'u'], tree._locks)
 
309
        self.assertRaises(TypeError, tree.method_that_raises, 'foo')
 
310
        self.assertEqual(['t', 'u', 't', 'u'], tree._locks)
 
311
 
 
312
 
 
313
class TestRevert(TestCaseWithTransport):
 
314
 
 
315
    def test_revert_conflicts_recursive(self):
 
316
        this_tree = self.make_branch_and_tree('this-tree')
 
317
        self.build_tree_contents([('this-tree/foo/',),
 
318
                                  ('this-tree/foo/bar', 'bar')])
 
319
        this_tree.add(['foo', 'foo/bar'])
 
320
        this_tree.commit('created foo/bar')
 
321
        other_tree = this_tree.bzrdir.sprout('other-tree').open_workingtree()
 
322
        self.build_tree_contents([('other-tree/foo/bar', 'baz')])
 
323
        other_tree.commit('changed bar')
 
324
        self.build_tree_contents([('this-tree/foo/bar', 'qux')])
 
325
        this_tree.commit('changed qux')
 
326
        this_tree.merge_from_branch(other_tree.branch)
 
327
        self.assertEqual(1, len(this_tree.conflicts()))
 
328
        this_tree.revert(['foo'])
 
329
        self.assertEqual(0, len(this_tree.conflicts()))
 
330
 
 
331
 
 
332
class TestAutoResolve(TestCaseWithTransport):
 
333
 
 
334
    def test_auto_resolve(self):
 
335
        base = self.make_branch_and_tree('base')
 
336
        self.build_tree_contents([('base/hello', 'Hello')])
 
337
        base.add('hello', 'hello_id')
 
338
        base.commit('Hello')
 
339
        other = base.bzrdir.sprout('other').open_workingtree()
 
340
        self.build_tree_contents([('other/hello', 'hELLO')])
 
341
        other.commit('Case switch')
 
342
        this = base.bzrdir.sprout('this').open_workingtree()
 
343
        self.failUnlessExists('this/hello')
 
344
        self.build_tree_contents([('this/hello', 'Hello World')])
 
345
        this.commit('Add World')
 
346
        this.merge_from_branch(other.branch)
 
347
        self.assertEqual([conflicts.TextConflict('hello', None, 'hello_id')],
 
348
                         this.conflicts())
 
349
        this.auto_resolve()
 
350
        self.assertEqual([conflicts.TextConflict('hello', None, 'hello_id')],
 
351
                         this.conflicts())
 
352
        self.build_tree_contents([('this/hello', '<<<<<<<')])
 
353
        this.auto_resolve()
 
354
        self.assertEqual([conflicts.TextConflict('hello', None, 'hello_id')],
 
355
                         this.conflicts())
 
356
        self.build_tree_contents([('this/hello', '=======')])
 
357
        this.auto_resolve()
 
358
        self.assertEqual([conflicts.TextConflict('hello', None, 'hello_id')],
 
359
                         this.conflicts())
 
360
        self.build_tree_contents([('this/hello', '\n>>>>>>>')])
 
361
        remaining, resolved = this.auto_resolve()
 
362
        self.assertEqual([conflicts.TextConflict('hello', None, 'hello_id')],
 
363
                         this.conflicts())
 
364
        self.assertEqual([], resolved)
 
365
        self.build_tree_contents([('this/hello', 'hELLO wORLD')])
 
366
        remaining, resolved = this.auto_resolve()
 
367
        self.assertEqual([], this.conflicts())
 
368
        self.assertEqual([conflicts.TextConflict('hello', None, 'hello_id')],
 
369
                         resolved)
 
370
        self.failIfExists('this/hello.BASE')
 
371
 
 
372
    def test_auto_resolve_dir(self):
 
373
        tree = self.make_branch_and_tree('tree')
 
374
        self.build_tree(['tree/hello/'])
 
375
        tree.add('hello', 'hello-id')
 
376
        file_conflict = conflicts.TextConflict('file', None, 'hello-id')
 
377
        tree.set_conflicts(conflicts.ConflictList([file_conflict]))
 
378
        tree.auto_resolve()
 
379
 
 
380
 
 
381
class TestFindTrees(TestCaseWithTransport):
 
382
 
 
383
    def test_find_trees(self):
 
384
        self.make_branch_and_tree('foo')
 
385
        self.make_branch_and_tree('foo/bar')
 
386
        # Sticking a tree inside a control dir is heinous, so let's skip it
 
387
        self.make_branch_and_tree('foo/.bzr/baz')
 
388
        self.make_branch('qux')
 
389
        trees = workingtree.WorkingTree.find_trees('.')
 
390
        self.assertEqual(2, len(list(trees)))